Returned Objects
From Justin.tv API Wiki
Contents |
Domain Objects
Bold fields are modifiable via appropriate update requests.
Stream Object
<stream>
- bitrate
- category
- embed_( count, ratio )
- embed_enabled
- language
- name
- publisher_buffer
- stream_count
- subcategory
- up_time
- video_codec
- video_( height, width )
- <channel> (extended)
- ... (see #Channel_Object)
User Object
<user>
- id
- login
- image_url_( huge, large, medium, small, tiny )
- profile_url
- sex
- broadcaster
- favorite_quotes
- location
- name
- profile_about
- profile_( background_color, header_bg_color, header_border_color, header_text_color, link_color )
- profile_image (warning: write-only, not returned in object)
Channel Object
<channel>
- id
- image_url_( huge, large, medium, small, tiny )
- screen_cap_( huge, large, medium, small )
- login
- mature
- producer
- category_title
- channel_url
- subcategory_title
- category (Justin.tv Categories)
- language
- subcategory (Justin.tv Categories)
- tags
- timezone
- title
- status
- --- extended channel data below ---
- embed_code
- channel_background_image_url
- channel_header_image_url
- about
- anonymous_chatters_allowed (boolean, takes "true" or "false")
- description
- channel_text_color
- channel_link_color
- channel_column_color
- channel_background_color
- channel_background_image (warning: write-only, not returned in object)
- channel_header_image (warning: write-only, not returned in object)
- profile_image (warning: write-only, not returned in object)
Event Object
<event>
- channel_id
- description
- id
- length (in seconds)
- start_time (in UTC)
- tags
- title
- <channel> (limited)
- ... (see #Channel_Object)
Archive Object
<archive>
- channel_id
- format
- id
- length
- start_time
- video_file_url
Callback Object
<callback>
- <channel> (limited)
- ... (see #Channel_Object)
- event
- url
Stream Event
<stream_event>
- <created_on>
- <event>
- <channel>
- ... (see #Channel_Object)
Category Object
<category>
- <keyword>
- <icon>
- <name>
- <short_name>
- <channels_count>
- <viewers_count>
- <subcategories>
<subcategory>
- <keyword>
- <name>
- <short_name>
Embed Object
<oembed>
- <html>
- <author_name>
- <author_url>
- <title>
- <provider_url>
- <width>
- <height>
- <type>
- <version>
- <thumbnail_url>
- <thumbnail_width>
- <thumbnail_height>
Errors
JSON
{
'error': {
'field': 'error condition(s)'
},
'url': '/api/.../...'
}
XML
<hash>
<url>/api/.../...</url>
<error>
<field>error condition(s)</field>
</error>
</hash>
