get-friends-list

GET friends/list

Returns a cursored collection of user objects for every user the specified user is following (otherwise known as their "friends").

At this time, results are ordered with the most recent following first — however, this ordering is subject to unannounced change and eventual consistency issues. Results are given in groups of 20 users and multiple "pages" of results can be navigated through using the next_cursor value in subsequent requests. See Using cursors to navigate collections for more information.

Resource URL¶

https://api.x.com/1.1/friends/list.json

Resource Information¶

Response formats	JSON
Requires authentication?	Yes
Rate limited?	Yes
Requests / 15-min window (user auth)	15
Requests / 15-min window (app auth)	15

Parameters¶

Name	Required	Description	Default Value	Example
user_id	optional	The ID of the user for whom to return results.		`12345`
screen_name	optional	The screen name of the user for whom to return results.		`noradio`
cursor	semi-optional	Causes the results to be broken into pages. If no cursor is provided, a value of `-1` will be assumed, which is the first "page." The response from the API will include a `previous_cursor` and `next_cursor` to allow paging back and forth. See Using cursors to navigate collections for more information.	`-1`	`12893764510938`
count	optional	The number of users to return per page, up to a maximum of 200.	`20`	`42`
skip_status	optional	When set to either `true`, `t` or `1` statuses will not be included in the returned user objects.	`false`	`false`
include_user_entities	optional	The user object `entities` node will not be included when set to `false`.	`true`	`false`

Example Request¶

GET https://api.x.com/1.1/friends/list.json?cursor=-1&screen_name=twitterapi&skip_status=true&include_user_entities=false

Example Response¶

{
"users": [
      {user-object},
      {user-object},
      {user-object}
  ],
  "previous_cursor": 0,
  "previous_cursor_str": "0",
  "next_cursor": 1333504313713126852,
  "next_cursor_str": "1333504313713126852"
}

For more detail, see the user-object definition.