GET blocks/blocking

Updated on Wed, 2012-04-18 11:29

Returns an array of user objects that the authenticating user is blocking.

Consider using GET blocks/blocking/ids with GET users/lookup instead of this method.

Resource URL

http://api.twitter.com/1/blocks/blocking.format

Parameters

page optional

Specifies the page of results to retrieve.

Example Values: 3

per_page optional

Specifies the number of results to retrieve per page.

Example Values: 5

include_entities optional

When set to either true, t or 1, each tweet will include a node called "entities,". This node offers a variety of metadata about the tweet in a discreet structure, including: user_mentions, urls, and hashtags. While entities are opt-in on timelines at present, they will be made a default component of output in the future. See Tweet Entities for more detail on entities.

Example Values: true

skip_status optional

When set to either true, t or 1 statuses will not be included in the returned user objects.

cursor optional

Causes the list of users to be broken into pages of no more than 5000 IDs at a time. The number of IDs returned is not guaranteed to be 5000 as suspended users are filtered out after connections are queried.

To begin paging provide a value of -1 as the cursor. The response from the API will include a previous_cursor and next_cursor to allow paging back and forth.

If the cursor is not provided the API will attempt to return all IDs. For users with many connections this will probably fail. Querying without the cursor parameter is deprecated and should be avoided. The API is being updated to force the cursor to be -1 if it isn't supplied.

Example Values: 12893764510938

Example Request

GET

https://api.twitter.com/1/blocks/blocking.json?cusor=-1&include_entities=true

  1. {
  2.   "previous_cursor": 0,
  3.   "previous_cursor_str": "0",
  4.   "next_cursor": 0,
  5.   "users": [
  6.     {
  7.       "profile_sidebar_border_color": "C0DEED",
  8.       "name": "Javier Heady \r",
  9.       "profile_sidebar_fill_color": "DDEEF6",
  10.       "profile_background_tile": false,
  11.       "location": null,
  12.       "created_at": "Thu Mar 01 00:16:47 +0000 2012",
  13.       "profile_image_url": "http://a0.twimg.com/sticky/default_profile_images/default_profile_4_normal.png",
  14.       "is_translator": false,
  15.       "id_str": "509466276",
  16.       "profile_link_color": "0084B4",
  17.       "follow_request_sent": false,
  18.       "contributors_enabled": false,
  19.       "default_profile": true,
  20.       "url": null,
  21.       "favourites_count": 0,
  22.       "utc_offset": null,
  23.       "id": 509466276,
  24.       "profile_image_url_https": "https://si0.twimg.com/sticky/default_profile_images/default_profile_4_normal.png",
  25.       "listed_count": 0,
  26.       "profile_use_background_image": true,
  27.       "profile_text_color": "333333",
  28.       "lang": "en",
  29.       "protected": false,
  30.       "followers_count": 0,
  31.       "geo_enabled": false,
  32.       "description": null,
  33.       "profile_background_image_url_https": "https://si0.twimg.com/images/themes/theme1/bg.png",
  34.       "verified": false,
  35.       "time_zone": null,
  36.       "profile_background_color": "C0DEED",
  37.       "notifications": false,
  38.       "status": {
  39.         "coordinates": null,
  40.         "truncated": false,
  41.         "favorited": false,
  42.         "created_at": "Thu Mar 01 00:17:26 +0000 2012",
  43.         "id_str": "175011828630421504",
  44.         "in_reply_to_user_id_str": "119476949",
  45.         "entities": {
  46.           "urls": [
  47.             {
  48.               "expanded_url": "http://tinyurl.com/86qf88r/H5bgvt",
  49.               "url": "http://t.co/XRnL260w",
  50.               "indices": [
  51.                 15,
  52.                 35
  53.               ],
  54.               "display_url": "tinyurl.com/86qf88r/H5bgvt"
  55.             }
  56.           ],
  57.           "hashtags": [
  58.  
  59.           ],
  60.           "user_mentions": [
  61.             {
  62.               "name": "OAuth Dancer",
  63.               "id_str": "119476949",
  64.               "id": 119476949,
  65.               "indices": [
  66.                 0,
  67.                 13
  68.               ],
  69.               "screen_name": "oauth_dancer"
  70.             }
  71.           ]
  72.         },
  73.         "text": "@oauth_dancer  http://t.co/XRnL260w",
  74.         "contributors": null,
  75.         "retweet_count": 0,
  76.         "in_reply_to_status_id_str": null,
  77.         "id": 175011828630421504,
  78.         "geo": null,
  79.         "retweeted": false,
  80.         "possibly_sensitive": false,
  81.         "in_reply_to_user_id": 119476949,
  82.         "source": "<a href=\"http://mobile.twitter.com\" rel=\"nofollow\">Mobile Web</a>",
  83.         "in_reply_to_screen_name": "oauth_dancer",
  84.         "place": null,
  85.         "in_reply_to_status_id": null
  86.       },
  87.       "friends_count": 0,
  88.       "statuses_count": 4,
  89.       "profile_background_image_url": "http://a0.twimg.com/images/themes/theme1/bg.png",
  90.       "default_profile_image": true,
  91.       "show_all_inline_media": false,
  92.       "screen_name": "javierg3ong",
  93.       "following": false
  94.     }
  95.   ],
  96.   "next_cursor_str": "0"
  97. }