Friendships

POST /api/friendships/create.json

Subscribe to status updates from specified user.

Form Parameters:
 
  • user_id – ID of the user for whom to return results for
  • screen_name – handle of the user for whom to return results for
Request Headers:
 
  • Authorization – username and password or OAuth token to authenticate

Example response: User object

POST /api/friendships/destroy.json

Unsubscribe to status updates from specified user.

Form Parameters:
 
  • user_id – ID of the user for whom to return results for
  • screen_name – handle of the user for whom to return results for
Request Headers:
 
  • Authorization – username and password or OAuth token to authenticate

Example response: User object

GET /api/friendships/exists.json

Show if source_user follows target_user.

Query Parameters:
 
  • source_user – user that is following. Can be an ID or username
  • target_user – user that is following. Can be an ID or username

Example response:

true
GET /api/friendships/show.json

Show detailed information about the relationship between two users.

Query Parameters:
 
  • source_id (int) – (optional) ID of the subject user
  • source_screen_name (str) – (optional) handle of the subject user
  • target_id (int) – (optional) ID of the target user
  • target_screen_name (str) – (optional) handle of the target user

Example response: Relationship object