<< Back to Twitter API Documentation

 

completed_in

Description: number of seconds it took to render a search result

Example: 0.132

 

contributors

Description: contains an array of user IDs to indicate who contributed to a particular stat u

Example: 14198354

 

contributors_enabled

Description: whether or not a user has enabled contributors access to his or her account

Example: true, false

 

created_at

Description: UTC timestamp of element creation, either status or user

Example: Sat Jan 24 22:14:29 +0000 2009

 

description

Description: 160 characters or less of text that describes a user

Examples: empty (Default), I like new shiny things.

 

favorited

Description: boolean indicating if a status has been marked as a favorite by the authenticating user

Examples: true, false

 

favourites_count

Description: number of statuses a user has marked as favorite

Examples: 0, 451

 

followed_by

Description: boolean indicating if the referenced user is followed by another user.

Examples: true, false

 

following

Description: boolean indicating if the referenced user is following another user.

Examples: true, false 

 

followers_count

Description: number of users following a user's updates

Examples: 0, 4034

 

friends_count

Description: number of users a user is following

Examples: 0, 221 

 

geo

Description: the object that may contain either GeoRSS or GeoJSON data for a point

Examples: See statuses/update documentation for specific examples

 

geo_enabled

Description: whether an individual user has enabled geotagging support on his or her account

Examples: true, false

        

lang

Description: the language a user has chosen on Twitter.com for his or her account

Examples: en, fr

name

Description: full name of a registered user

Examples: Tweety Bird, Doug Williams

 

hourly_limit

Description: maximum number of API calls a user is allowed in an hour

Examples: 100

 

id

Description: a permanent unique id referencing an object, such as user or status

Examples: 1145445329 (status), 14198354 (user)

 

in_reply_to_screen_name

Description: display name for the user that wrote the status a status replies to (see screen_name)

Examples: empty, tweetybird

 

in_reply_to_status_id

Description: unique id for the status a status replies to (see id)

Examples: empty, 1047468972

 

in_reply_to_user_id

Description: unique id for the user that wrote the status a status replies to (see id)

Examples: empty, 14597523

 

location

Description: user specified string representing where they are from

Examples: empty (Default), California OR New York, NY, In The Woods, 27.893621,-82.243706 

 

max_id

Description: the maximum status_id in a search result set

Examples: 1047468972

 

name

Description: the user specified name for a saved search

Examples: empty (Default), Twitter API Chatter

 

next_page

Description: URL to the next page in the search result

Example: ?page=2&max_id=1480307926&q=%40twitterapi

 

notifications

Description: boolean indicating if a user is receiving device updates for a given user

Examples: empty (Default), true, false

 

page

Description: the page number of a search result set

Example: 1

 

position

Description: the absolute position of a saved search element in the users saved search list

Examples: empty (Default), 1

 

profile_background_color

Description: hex RGB value for a user's background color

Example: 9ae4e8 (Default)

 

profile_background_image_url

Description: location of a user's background image

Examples: empty, http://static.twitter.com/images/themes/theme1/bg.gif (Default), http://s3.amazonaws.com/twitter_production/profile_background_images/2752608/super_sweet.jpg

 

profile_background_tile

Description: boolean indicating if a user's background is tiled

Examples: true, false

 

profile_image_url

Description: location to a user's avatar file

Examples:  http://static.twitter.com/images/default_profile_normal.png (Default), http://s3.amazonaws.com/twitter_production/profile_images/14198354/sweet_avatar.jpg

 

profile_link_color

Description: hex RGB value for a user's link color

Example: 0000ff (Default)

 

profile_sidebar_border_color

Description: hex RGB value for a user's border color   

Example: 87bc44 (Default)

 

profile_sidebar_fill_color

Description: hex RGB value for a user's sidebar color

Example: e0ff92 (Default)

 

profile_text_color

Description: hex RGB value for a user's text color

Example: 000000 (Default)

 

protected

Description: boolean indicating if a user has a protected profile

Examples: true, false 

 

query

Description: the query used to form a result set

Example: %40twitterapi

 

recipient_id

Description: unique id of the user that received a direct message (see id)

Example: 1401881

 

recipient_screen_name

Description: display name of the user that sent a direct message (see screen_name)

Examples: tweetybird, dougw

 

refresh_url

Description: the URL to get a fresh result set for a given query

Examples: ?since_id=1480307926&q=%40twitterapi

 

remaining_hits

Description: number of API calls remaining for a user

Examples: 0, 43

 

reset_time

Description: time when a user's API call allocation resets

Example: Sun Jan 25 01:20:43 +0000 2009

 

reset_time_in_seconds

Description: Unix time when a user's API call allocation resets

Example: 1232846443

 

results_per_page

Description: the maximum number of results that will be returned

Example: 15 (Default)

 

screen_name

Description: display name for a user

Examples: tweetybird, dougw

 

sender_id

Description: unique id of the user that sent a direct message (see id)

Example: 6633812

 

sender_screen_name

Description: display name of the user that sent a direct message (see screen_name)

Examples: tweetybird, dougw

 

since_id

Description: the since_id passed in with a search query

Examples: 1480307926

 

source

Description: application that sent a status

Examples: web (Default), <a href="http://www.tweetdeck.com/">TweetDeck</a>

 

statuses_count

Description: the total number of status updates performed by a user, excluding direct messages sent

Examples: 0, 9423

 

text

Description: escaped and HTML encoded status body

Examples: I am eating oatmeal, The first tag is always <html>

 

time_zone

Description: a user's time zone

Examples: Central Time (US & Canada) (Default), Sydney

 

truncated

Description: boolean indicating if a status required shortening

Examples: true, false

 

url

Description: user's homepage

Examples: empty, http://downforeveryoneorjustme.com

 

utc_offset

Description: number of seconds between a user's registered time zone and Coordinated Universal Time

Examples: -21600 (Default), 36000 

 

verified

Description: indicates if a user is verified. About verified accounts.

Examples: false (Default), true