- Previous: Affiliate Program
- Up: Introduction to Netflix API Documentation
- Next: Branding Requirements
REST API Reference
This chapter includes the following sections:
Getting Started with the REST API
This section covers the following topics:
Additional information about using the REST API is also available:
This section describes the common characteristics of the Netflix REST API resources, which fall into the following categories:
- Catalog Resources - Represents all of the available media (that is, titles) in the Netflix catalog. Together, the Catalog and its subordinate resources support searches against the catalog, requests for title details, and searches for titles that have similar characteristics to a specified title. .
- User Resources - The User resource API provides information about specified subscribers, including rental options and history, personal ratings and recommendations, and queues. Retrieving this information generally requires authorization.
- Security Resources - The security resources are based on the OAuth Core 1.0 protocol for authenticating Netflix subscribers and for obtaining the user's authorization for your application, which consists of request and access tokens to act on the subscriber's protected Netflix resources.
The following attributes apply to all REST resources:
- All resources are located at: http://api.netflix.com
- All parameters are optional.
- All resources may return any of the status codes listed in Status Codes Common to All Resources.. Additional status or error codes potentially returned by a resource are listed specifically for that resource.
- When items are shown in italics in method signatures, you should replace the item with a value.
Note: Netflix may have a tool available that helps you navigate these REST API and set resource parameters. Check the developer website for details.
How to Use REST Reference Pages
The reference descriptions for the resources generally include the following:
- The resource syntax
- A description of what the resource does
- The HTTP GET verb is the default method that a resource supports and its description pertains to that verb. If the resource supports other HTTP methods, then these other methods are listed.
- The parameters for the resource. All parameters are optional, except for the OAuth access control parameters. See Authentication Overview for instructions on forming the OAuth access control parameters.
- The response returned by the resource
- Status codes that are specific to this resource. See HTTP Status Codes for an overview of all of the status codes used by the API.
- An example of the response
The Catalog resources are divided into the following task categories:
Searching the Catalog.
Retrieving Title Details.
Searching for People.
Searching the Catalog
The following resources are used for searching the Netflix catalog for titles.
- catalog/titles. - Search for a media title in the catalog.
- catalog/titles/autocomplete. - Search for title matches using a partial title string
- catalog/titles/index. - Returns an index of titles in the Netflix catalog
Conducts a search of the catalog for titles of movies and television series by season. Currently, it is not possible to search for television shows by series. Catalog tiles can be found at the URL http:/api.netflix.com/catalog/titles.
Results Example
The following is an example of part of a response to a catalog/titles request:
- <catalog_titles>
- <number_of_results>1140</number_of_results>
- <start_index>0</start_index>
- <results_per_page>10</results_per_page>
- <catalog_title>
- <id>http://api.netflix.com/catalog/titles/movies/60021896</id><title short="Star"
- regular="Star"></title>
- <box_art small="http://alien2.netflix.com/us/boxshots/tiny/60021896.jpg"
- medium="http://alien2.netflix.com/us/boxshots/small/60021896.jpg"
- large="http://alien2.netflix.com/us/boxshots/large/60021896.jpg"></box_art>
- <link href="http://api.netflix.com/catalog/titles/movies/60021896/synopsis"
- rel="http://schemas.netflix.com/catalog/titles/synopsis" title="synopsis"></link>
- <release_year>2001</release_year>
- <category scheme="http://api.netflix.com/categories/mpaa_ratings" label="NR"></category>
- <category scheme="http://api.netflix.com/categories/genres" label="Foreign"></category>
- <link href="http://api.netflix.com/catalog/titles/movies/60021896/cast"
- rel="http://schemas.netflix.com/catalog/people.cast" title="cast"></link>
- <link href="http://api.netflix.com/catalog/titles/movies/60021896/directors"
- rel="http://schemas.netflix.com/catalog/people.directors" title="directors"></link>
- <link href="http://api.netflix.com/catalog/titles/movies/60021896/format_availability"
- rel="http://schemas.netflix.com/catalog/titles/format_availability" title="formats"></link>
- <link href="http://api.netflix.com/catalog/titles/movies/60021896/screen_formats"
- rel="http://schemas.netflix.com/catalog/titles/screen_formats" title="screen formats"></link
- <link href="http://api.netflix.com/catalog/titles/movies/60021896/languages_and_audio"
- rel="http://schemas.netflix.com/catalog/title/languages_and_audio"
- title="languages and audio"></link>
- <average_rating>1.9</average_rating>
- <link href="http://api.netflix.com/catalog/titles/movies/60021896/similars"
- rel="http://schemas.netflix.com/catalog/titles.similars" title="similars"></link>
- <link href="http://www.netflix.com/Movie/Star/60021896" rel="alternate" title="webpage"></link>
- </catalog_title>
- <catalog_title>
- <id>http://api.netflix.com/catalog/titles/movies/17985448</id>
- <title short="Lone Star" regular="Lone Star"></title>
- <box_art small="http://alien2.netflix.com/us/boxshots/tiny/17985448.jpg"
- medium="http://alien2.netflix.com/us/boxshots/small/17985448.jpg"
- large="http://alien2.netflix.com/us/boxshots/large/17985448.jpg"></box_art>
- <link href="http://api.netflix.com/catalog/titles/movies/17985448/synopsis"
- rel="http://schemas.netflix.com/catalog/titles/synopsis" title="synopsis"></link>
- <release_year>1996</release_year>
- <category scheme="http://api.netflix.com/categories/mpaa_ratings" label="R"></category>
- <category scheme="http://api.netflix.com/categories/genres" label="Drama"></category>
- <link href="http://api.netflix.com/catalog/titles/movies/17985448/cast"
- rel="http://schemas.netflix.com/catalog/people.cast" title="cast"></link>
- <link href="http://api.netflix.com/catalog/titles/movies/17985448/directors"
- rel="http://schemas.netflix.com/catalog/people.directors" title="directors"></link>
- <link href="http://api.netflix.com/catalog/titles/movies/17985448/awards"
- rel="http://schemas.netflix.com/catalog/titles/awards" title="awards"></link>
- <link href="http://api.netflix.com/catalog/titles/movies/17985448/format_availability"
- rel="http://schemas.netflix.com/catalog/titles/format_availability" title="formats"></link>
- <link href="http://api.netflix.com/catalog/titles/movies/17985448/screen_formats"
- rel="http://schemas.netflix.com/catalog/titles/screen_formats" title="screen formats"></link>
- <link href="http://api.netflix.com/catalog/titles/movies/17985448/languages_and_audio"
- rel="http://schemas.netflix.com/catalog/titles/languages_and_audio"
- title="languages and audio"></link>
- <average_rating>3.7</average_rating>
- <link href="http://api.netflix.com/catalog/titles/movies/17985448/similars"
- rel="http://schemas.netflix.com/catalog/titles.similars" title="similars"></link>
- <link href="http://www.netflix.com/Movie/Lone_Star/17985448" rel="alternate"
- title="webpage"></link>
- </catalog_title>
- </catalog_titles>
Searches the catalog for movies and television series whose title matches a partial search text. Returned title names can then be passed to the title search methods to conduct the actual search. The autocomplete method only applies to titles. This resource can be found at http://api.netflix.com/catalog/titles/autocomplete.
|
The partial or complete search term to use to search for title matches in the catalog. |
|
Results
Returns movie and television titles that match a partial search text. The title names can be passed to the title search API to conduct the actual search.
Results Example
The following is an example response to catalog/autocomplete:
<autocomplete>
<autocomplete_item>
<title short="Step Brothers"></title>
</autocomplete_item>
<autocomplete_item>
<title short="Step Into Liquid"></title>
</autocomplete_item>
<autocomplete_item>
<title short="Step Up"></title>
</autocomplete_item>
<autocomplete_item>
<title short="Step Up 2 the Streets"></title>
</autocomplete_item>
<autocomplete_item>
<title short="Step Your Game Up: Part 5: The Journal Story"></title>
</autocomplete_item>
<autocomplete_item>
<title short="Stephanie Daley"></title>
</autocomplete_item>
<autocomplete_item>
<title short="Stephen King's The Mist"></title>
</autocomplete_item>
<autocomplete_item>
<title short="Stephen Sondheim's Putting It Together"></title>
</autocomplete_item>
<autocomplete_item>
<title short="Stepmom"></title>
</autocomplete_item>
<autocomplete_item>
<title short="The Stepford Wives"></title>
</autocomplete_item>
</autocomplete>
Returns an index of all titles in the catalog. The titles index is intended for partners with their own movie or TV catalogs who want to find corresponding titles in the Netflix catalog. The index data returned by the method includes titles, release dates (year of release), production studio name, and top cast members. You can use this data to interlink titles. In addition, the returned data includes Netflix title URLs, media formats, and availability windows. Each title entry in the returned data includes an update date, which indicates the last time the title data was updated.
The index is available at http://api.netflix.com/catalog/titles/index.
Preauthorization is required to access AMG (All Movie Guide) or TMS (TMS Entertainment, Ltd.) identifiers.
|
Include AMG identifiers in title index items. (Requires preauthorization) |
|
|
Include TMS identifiers in title index items. (Requires preauthorization) |
|
Results
Returns an index of all titles in the Netflix catalog. You can use the index data to interlink titles.
Results Example
The following is an example of catalog/titles/index response:
- <catalog_title_index>
- <title_index_item>
- <id>http://api.netflix.com/catalog/titles/movies/512381</id>
- <updated>1217404229</updated>
- <category scheme="http://api.netflix.com/categories/genres" label="Children &
- Family" term="Children & Family"></category>
- <link href="http://api.netflix.com/catalog/people/20001977"
- rel="http://schemas.netflix.com/catalog/person.actor" title="Anna Paquin"></link>
- <link href="http://api.netflix.com/catalog/people/23599"
- rel="http://schemas.netflix.com/catalog/person.actor"
- title="Dana Delany"></link>
- <link href="http://api.netflix.com/catalog/people/21741"
- rel="http://schemas.netflix.com/catalog/person.actor" title="Jeff Daniels"></link>
- <release_year>1996</release_year>
- <link href="http://www.netflix.com/Movie/Fly_Away_Home/512381" rel="alternate"
- title=" web page"></link>
- <external_ids>
- <id rel="http://schemas.netflix.com/catalog/id.upc">0043396824393</id>
- <id rel="http://schemas.netflix.com/catalog/id.upc">0043396060463</id>
- <id rel="http://schemas.netflix.com/catalog/id.amg">V 154424</id>
- </external_ids>
- <delivery_formats>
- <availability available_from="1199174400">
- <category scheme="http://api.netflix.com/categories/title_format" label="instant"
- term="instant"></category>
- </availability>
- <availability available_from="862297200">
- <category scheme="http://api.netflix.com/categories/title_format" label="DVD"
- term="DVD"></category>
- </availability>
- </delivery_formats>
- </title_index_item>
- <title_index_item>
- <id>http://api.netflix.com/catalog/titles/movies/517905</id>
- <category scheme="http://api.netflix.com/categories/genres" label="Drama"
- term="Drama"></category>
- <link href="http://api.netflix.com/catalog/people/100637"
- rel="http://schemas.netflix.com/catalog/person.actor" title="Elijah Wood"></link>
- <link href="http://api.netflix.com/catalog/people/98401"
- rel="http://schemas.netflix.com/catalog/person.actor" title="George Wendt"></link>
- <link href="http://api.netflix.com/catalog/people/34976"
- rel="http://schemas.netflix.com/catalog/person.actor" title="Isabel Glasser"></link>
- <link href="http://api.netflix.com/catalog/people/21028"
- rel="http://schemas.netflix.com/catalog/person.actor" title="Jamie Lee Curtis"></link>
- <link href="http://api.netflix.com/catalog/people/34396"
- rel="http://schemas.netflix.com/catalog/person.actor" title="Mel Gibson"></link>
- <release_year>1992</release_year>
- <link href="http://www.netflix.com/Movie/Forever_Young/517905" rel="alternate"
- title=" web page"></link>
- <external_ids>
- <id rel="http://schemas.netflix.com/catalog/id.upc">0085391257127</id>
- <id rel="http://schemas.netflix.com/catalog/id.amg">V 18235</id>
- </external_ids>
- <delivery_formats>
- <availability available_from="872665200">
- <category scheme="http://api.netflix.com/categories/title_format" label="DVD"
- term="DVD"></category>
- </availability>
- </delivery_formats>
- </title_index_item>
- </catalog_title_index>
Title Details
Use these movie and television series season API, described in this section, to retrieve details for specific catalog titles. The API consists of a set of subresources within one resource URL type, catalog/titles, that returns all details for the requested title.
Note: For each title, you can find the URLs to retrieve the title's details in the responses from other resource queries (e.g., search results, queue responses, and so forth) that reference titles. The links within those responses contain the URLs for retrieving a title's details. You should never attempt to construct a title URL directly.
Here are some example title URLs for different types of titles:
- catalog/titles/movies/12345678- Returns details about a specific movie title.
- catalog/titles/series/12345678- Returns details about a specific television series.
- catalog/titles/series/12345678/seasons/87654321- Returns details about season collections for a specific television series
- catalog/titles/programs/12345678- Returns details about a specific television program
- catalog/titles/discs/12345678- Returns details about a specified DVD disc
Use these resources to retrieve all details for a particular catalog title. A title can be a movie, a television series, a television series by season, a single television program, or a disc. Each resource returns the details appropriate to the requested title type.
| Parameters | |
|---|---|
| OAuth access control | Consumer key + signature (Required) |
Results
Returns the details associated with the specified title. The actual details that are returned vary according to the type of the title. The tables below indicate the details returned for the different types of titles.
For titles that are movies, the response can include the following data:
| Movie Data | Description |
|---|---|
| Title (short, regular, and sortable versions) | The title of the movie. Can be stored in a shortened form, the complete title, or as a version normalized for sorting. |
| Synopsis (short and regular versions) | A summary of the movie. The short form is appropriate for situations where screen real estate is limited. |
| Release year | The original release date for the movie |
| MPAA rating | The voluntary rating system (G, PG, PG-13, R, and NC-17) from the Motion Picture Association of America |
| TV rating | The rating system for television programs (see http://www.netflix.com/Help?id=1632 ) |
| Genre | The categories under which the movie is classified, with links to recommended movies in that genre |
| Cast | The actors in the cast with links to their data in the people file |
| Director | The director of the movie |
| Length | The length of the movie in seconds |
| Box art references (small, medium, and large) | The artwork from the cover of the DVD case, in three different sizes |
| Popularity rating | The 1 to 5-star rating of the movie, based on the number of Netflix subscribers who have rated the movie |
| Awards | The industry awards and nominations for the movie, if any |
| Bonus materials | An additional DVD with related content |
| Delivery formats | DVD, Blu-Ray, instant viewing with availability windows |
| Screen format | The width to height ratio for normal viewing of the movie |
| Language and sound | The language and Dolby digital mode in which the movie was recorded |
| Netflix web site URL | The Netflix page showing the details of the movie |
| Official movie site URL | The studio's web page for the movie |
| Related titles | Links to other movies within the series, if appropriate |
For titles that are television program series and seasons, the response can include the following data:
| Television Program Data | Description |
|---|---|
| Title (short, regular, and sortable versions) | The title of the program. Can be stored in a shortened form, the complete title, or as a version normalized for sorting. |
| Synopsis (short and regular versions) | A summary of the program's season. The short form is appropriate for situations where screen real estate is limited. |
| Release year | The original release date for the beginning of the program's season |
| MPAA rating | The voluntary rating system (G, PG, PG-13, R, and NC-17) from the Motion Picture Association of America |
| TV rating | The rating system for television programs (see http://www.netflix.com/Help?id=1632) |
| Genre | The categories under which the program is classified, with links to recommended programs in that genre |
| Cast | The actors in the cast with links to their data in the people file |
|
The artwork from the cover of the DVD case, in three different sizes |
|
|
The 1 to 5-star rating of the program, based on the number of Netflix subscribers who have rated it |
|
|
The language and Dolby digital mode in which the program was recorded |
|
Results Example
The following is an example of a response to a movie search:
- <catalog_title>
- <id>
- http://api.netflix.com/catalog/titles/series/70023522/seasons/70023522
- </id>
- <title short="The Office: Season 1" regular="The Office: Season 1"/>
- <box_art small="http://alien2.netflix.com/us/boxshots/tiny/70023522.jpg"
- medium="http://alien2.netflix.com/us/boxshots/small/70023522.jpg"
- large="http://alien2.netflix.com/us/boxshots/large/70023522.jpg"/>
- <link href="http://api.netflix.com/catalog/titles/series/70023522/seasons/70023522/synopsis"
- rel="http://schemas.netflix.com/catalog/titles/synopsis" title="synopsis"/>
- <release_year>2005</release_year>
- <category scheme="http://api.netflix.com/categories/tv_ratings" label="TV-14"/>
- <category scheme="http://api.netflix.com/categories/genres" label="Television"/>
- <category scheme="http://api.netflix.com/categories/genres" label="TV Sitcoms"/>
- <category scheme="http://api.netflix.com/categories/genres" label="TV Comedies"/>
- <category scheme="http://api.netflix.com/categories/genres" label="Must-See TV Comedies"/>
- <runtime>8700</runtime>
- <link href=
- "http://api.netflix.com/catalog/titles/series/70023522/seasons/70023522/format_availability"
- rel="http://schemas.netflix.com/catalog/titles/format_availability" title="formats"/>
- <link href=
- "http://api.netflix.com/catalog/titles/series/70023522/seasons/70023522/screen_formats"
- rel="http://schemas.netflix.com/catalog/titles/screen_formats" title="screen formats"/>
- <link href="http://api.netflix.com/catalog/titles/series/70023522/seasons/70023522/cast"
- rel="http://schemas.netflix.com/catalog/people.cast" title="cast"/>
- <link href="http://api.netflix.com/catalog/titles/series/70023522/seasons/70023522/directors"
- rel="http://schemas.netflix.com/catalog/people.directors" title="directors"/>
- <link href=
- "http://api.netflix.com/catalog/titles/series/70023522/seasons/70023522/languages_and_audio"
- rel="http://schemas.netflix.com/catalog/titles/languages_and_audio"
- title="languages and audio"/>
- <average_rating>4.3</average_rating>
- <link href="http://api.netflix.com/catalog/titles/series/70023522"
- rel="http://schemas.netflix.com/catalog/titles.series" title="series"/>
- <link href="http://api.netflix.com/catalog/titles/series/70023522/seasons/70023522/episodes"
- rel="http://schemas.netflix.com/catalog/programs" title="episodes"/>
- <link href="http://api.netflix.com/catalog/titles/series/70023522/seasons/70023522/similars"
- rel="http://schemas.netflix.com/catalog/titles.similars" title="similars"/>
- <link href="http://www.nbc.com/nbc/The_Office/"
- rel="http://schemas.netflix.com/catalog/titles/official_url" title="official webpage"/>
- <link href="http://www.netflix.com/Movie/The_Office_Season_1/70023522" rel="alternate"
- title="webpage"/>
- </catalog_title>
This resources returns a list of titles similar to the parent title resource. The similars resource URL can be found in the response of any title resource and will have a URL like the following :catalog/titles/12345678/similars.
Results Example
The following is part of a response that might be returned by this resource.
- <catalog_titles>
- <number_of_results>120</number_of_results>
- <start_index>0</start_index>
- <results_per_page>2</results_per_page>
- <catalog_title>
- <id>http://api.netflix.com/catalog/titles/movies/60003959</id><title short="Bird"
- regular="Bird"></title>
- <etag>515873819112</etag>
- <box_art small="http://alien2.netflix.com/us/boxshots/tiny/60003959.jpg"
- medium="http://alien2.netflix.com/us/boxshots/small/60003959.jpg"
- large="http://alien2.netflix.com/us/boxshots/large/60003959.jpg"></box_art>
- <link href="http://api.netflix.com/catalog/titles/movies/60003959/synopsis"
- rel="http://schemas.netflix.com/catalog/titles/synopsis" title="synopsis"></link>
- <release_year>1988</release_year>
- <category scheme="http://api.netflix.com/categories/mpaa_ratings" label="R"></category>
- <category scheme="http://api.netflix.com/categories/genres" label="Drama"></category>
- <link href="http://api.netflix.com/catalog/titles/movies/60003959/cast"
- rel="http://schemas.netflix.com/catalog/people.cast" title="cast"></link>
- <link href="http://api.netflix.com/catalog/titles/movies/60003959/directors"
- rel="http://schemas.netflix.com/catalog/people.directors" title="directors"></link>
- <link href="http://api.netflix.com/catalog/titles/movies/60003959/awards"
- rel="http://schemas.netflix.com/catalog/titles/awards" title="awards"></link>
- <link href="http://api.netflix.com/catalog/titles/movies/60003959/format_availability"
- rel="http://schemas.netflix.com/catalog/titles/format_availability" title="formats"></link>
- <link href="http://api.netflix.com/catalog/titles/movies/60003959/screen_formats"
- rel="http://schemas.netflix.com/catalog/titles/screen_formats"
- title="screen formats"></link>
- <link href="http://api.netflix.com/catalog/titles/movies/60003959/languages_and_audio"
- rel="http://schemas.netflix.com/catalog/titles/languages_and_audio"
- title="languages and audio"></link>
- <average_rating>3.4</average_rating>
- <link href="http://www.netflix.com/Movie/Bird/60003959" rel="alternate"
- title="webpage"></link>
- </catalog_title>
- <catalog_title>
- <id>http://api.netflix.com/catalog/titles/movies/70019224</id>
- <title short="Hotel Rwanda" regular="Hotel Rwanda"></title>
- <box_art small="http://alien2.netflix.com/us/boxshots/tiny/70019224.jpg"
- medium="http://alien2.netflix.com/us/boxshots/small/70019224.jpg"
- large="http://alien2.netflix.com/us/boxshots/large/70019224.jpg"></box_art>
- <link href="http://api.netflix.com/catalog/titles/movies/70019224/synopsis"
- rel="http://schemas.netflix.com/catalog/titles/synopsis" title="synopsis"></link>
- <release_year>2005</release_year>
- <category scheme="http://api.netflix.com/categories/mpaa_ratings"
- label="PG-13"></category>
- <category scheme="http://api.netflix.com/categories/genres" label="Drama"></category>
- <link href="http://api.netflix.com/catalog/titles/movies/70019224/cast"
- rel="http://schemas.netflix.com/catalog/people.cast" title="cast"></link>
- <link href="http://api.netflix.com/catalog/titles/movies/70019224/directors"
- rel="http://schemas.netflix.com/catalog/people.directors" title="directors"></link>
- <link href="http://api.netflix.com/catalog/titles/movies/70019224/awards"
- rel="http://schemas.netflix.com/catalog/titles/awards" title="awards"></link>
- <link href="http://api.netflix.com/catalog/titles/movies/70019224/format_availability"
- rel="http://schemas.netflix.com/catalog/titles/format_availability" title="formats"></link>
- <link href="http://api.netflix.com/catalog/titles/movies/70019224/screen_formats"
- rel="http://schemas.netflix.com/catalog/titles/screen_formats"
- title="screen formats"></link>
- <link href="http://api.netflix.com/catalog/titles/movies/70019224/languages_and_audio"
- rel="http://schemas.netflix.com/catalog/titles/languages_and_audio"
- title="languages and audio"></link>
- <average_rating>4.2</average_rating>
- <link href="http://www.netflix.com/Movie/Hotel_Rwanda/70019224"
- rel="alternate" title="webpage"></link>
- </catalog_title>
- </catalog_titles>
-
catalog/people
Searches for people in the catalog by name or portion of the name.
Results
Returns results that include catalog title entries with people that match the specified name. Results include references to persondetails. Each person resource will have a URL like the following: catalog/people/12345678.
Results Example
The following is an example from a response to a catalog/people request:
- <people>
- <number_of_results>1452</number_of_results>
- <start_index>0</start_index>
- results_per_page>2</results_per_page>
- <person>
- <id>http://api.netflix.com/catalog/people/152672</id>
- <name>Penélope Cruz</name>
- <bio><![CDATA[Always the performer, Penélope Cruz (born April 28, 1974, in Madrid, Spain) began
- re-enacting TV commercials when she was a toddler and studied classical ballet during her youth.
- Her big break, however, came at age 15 when she beat out hundreds of girls at a talent agency
- audition.&NFp;Cruz captured audiences' attention with her roles in 1992's Jamon, Jamon and
- Belle Epoque (which received an Oscar nod for Best Foreign Film). In 1999, her work with director
- Pedro Almodovar on the Best Foreign Film Oscar winner All About My Mother brought her first
- international recognition.&NFp;Fluent in Spanish, Italian, French and English, Cruz
- continues to work in American and international productions, appearing in such films as
- All the Pretty Horses (2000) and Vanilla Sky (a remake of Eduardo Noriega's Open Your Eyes,
- in which she also starred). Her turn in Almodovar's Volver (2006) gained her an Oscar nod.]]></bio>
- <link href="http://api.netflix.com/catalog/people/152672/filmography"
- rel="http://schemas.netflix.com/catlog/person/filmography" title="filmography"></link>
- <link href="http://www.netflix.com/RoleDisplay/Penelope_Cruz/152672" rel="alternate"
- title="webpage"></link>
- </person>
- <person>
- <id>http://api.netflix.com/catalog/people/20064096</id>
- <name>Valerie Cruz</name>
- <link href="http://api.netflix.com/catalog/people/20064096/filmography"
- rel="http://schemas.netflix.com/catlog/person/filmography" title="filmography"></link>
- <link href="http://www.netflix.com/RoleDisplay/Valerie_Cruz/20064096"
- rel="alternate" title="webpage"></link>
- </person>
- </people>
You can retrieve detailed information for a person in the Catalog, using that person's ID, including a bio, featured titles, and a complete list of titles.
Results
For the specified person, returns a bio and a list of all titles with which that person is associated.
Results Example
The following is an example response:
- <person>
- <id>http://api.netflix.com/catalog/people/152672</id>
- <name>Penélope Cruz</name>
- <bio><![CDATA[Always the performer, Penélope Cruz (born April 28, 1974, in Madrid, Spain) began
- re-enacting TV commercials when she was a toddler and studied classical ballet during her youth.
- Her big break, however, came at age 15 when she beat out hundreds of girls at a talent agency
- audition.&NFp;Cruz captured audiences' attention with her roles in 1992's Jamon, Jamon and
- Belle Epoque (which received an Oscar nod for Best Foreign Film). In 1999, her work with director
- Pedro Almodovar on the Best Foreign Film Oscar winner All About My Mother brought her first
- international recognition.&NFp;Fluent in Spanish, Italian, French and English, Cruz
- continues to work in American and international productions, appearing in such films as
- All the Pretty Horses (2000) and Vanilla Sky (a remake of Eduardo Noriega's Open Your Eyes, in
- which she also starred). Her turn in Almodovar's Volver (2006) gained her an Oscar nod.]]></bio>
- <link href="http://api.netflix.com/catalog/people/152672/filmography"
- rel="http://schemas.netflix.com/catlog/person/filmography" title="filmography"></link>
- <link href="http://www.netflix.com/RoleDisplay/Penelope_Cruz/152672" rel="alternate"
- title="webpage"></link>
- </person>
The User resource API provides information about a specified subscriber, referred to as the user. You use these resources to retrieve information covering a user's rental options and history, plus his or her ratings and recommendations. The User resources include the queue management API resources, which let you retrieve and manipulate items in a user's queue. The User resource also provides a list of Atom feed URLs that can be accessed programmatically by applications. These feeds have security tokens embedded within them. As a result, they can be consumed by applications that cannot authenticate using the OAuth protocol.
The User resources are divided into the following task categories:
User Feeds and Rental Options.
Managing Queues.
Updating a Queue.
Tracking Discs.
Managing Rental History.
User Title Ratings.
Retrieving Reviews.
Retrieving Recommendations.
Users
Returns information about the specified user. A user resource has a URL like: http://api.netflix.com/users/12345678. The response includes:
- Name of the user or subscriber
- Queues associated with the user's account
- The user's preferred disc format: HD DVD, Blu-ray, or DVD
Results
Returns the name of the user, the user's associated queues, and preferred disc format, among other user information.
Results Example
The following is a sample response to this request:
- <user>
- <user_id>T1PambOVJXcoWzNRQEyacp76BnRn0TIJdxKGyklbY0srg-</user_id>
- <first_name>Jane</first_name>
- <last_name>Smith</last_name>
- <can_instant_watch>true</can_instant_watch>
- <preferred_formats>
- <category scheme="http://api.netflix.com/catalog/titles/format" label="HD DVD"></category>
- <category scheme="http://api.netflix.com/catalog/titles/format" label="DVD"></category>
- </preferred_formats>
- <link href="http://api.netflix.com/users/T1PambOVJXcoWzNRQEyacp76BnRn0TIJdxKGyklbY0srg-/queues"
- rel="http://schemas.netflix.com/queues" title="queues"></link>
- <link href="http://api.netflix.com/users/T1PambOVJXcoWzNRQEyacp76BnRn0TIJdxKGyklbY0srg-/rental_history"
- rel="http://schemas.netflix.com/rental_history" title="rental history"></link>
- <link href="http://api.netflix.com/users/T1PambOVJXcoWzNRQEyacp76BnRn0TIJdxKGyklbY0srg-/recommendations"
- rel="http://schemas.netflix.com/recommendations" title="recommendations"></link>
- <link href="http://api.netflix.com/users/T1PambOVJXcoWzNRQEyacp76BnRn0TIJdxKGyklbY0srg-/title_states"
- rel="http://schemas.netflix.com/title_states" title="title states"></link>
- <link href="http://api.netflix.com/users/T1PambOVJXcoWzNRQEyacp76BnRn0TIJdxKGyklbY0srg-/ratings"
- rel="http://schemas.netflix.com/ratings" title="ratings"></link>
- <link href="http://api.netflix.com/users/T1PambOVJXcoWzNRQEyacp76BnRn0TIJdxKGyklbY0srg-/reviews"
- rel="http://schemas.netflix.com/reviews" title="reviews"></link>
- </user>
-
users/current
Current User (reflection)
This resource returns a link to the currently authenticated user. You can access the active user's associated API resource without extracing the user ID from the OAuth access token response. This was implemented to make use of OAuth libraries that don't support standard response extension easier to use.
| Parameters | |
|---|---|
| OAuth access control | Consumer key + access token + signature. (Required) |
Results
The call returns a single "link" containing the URL that can be used to make REST calls for additional resources for this user.
Example Results
The following is a smaple of a plain XML (POX) response to this request:
- <resource>
- link href="http://api.netflix.com/users/T1tareQFowlmc8aiTEXBcQ5aed9h_Z8zdmSX1SnrKoOCA-" rel="http://schemas.netflix.com/user.current" title="current user"></link>
- </resource>
Many of the user-related resources are available as feeds. Each user response contains a link to a list of the user's feeds. This list will have a URL like http://api.netflix.com/users/12345678. When a resource is accessed as a feed, you do not have to supply any OAuth security token since the URL for the feed includes an embedded security token.
This resource returns a list of URLs of all Atom feeds that are available for the specified user. Each URL that is returned has a security token embedded within it so that the feed may be accessed without passing any further OAuth tokens. The embedded security token is valid for as long as the user allows the application to access the Netflix service on the user's behalf.
OPML (Outline Processor Markup Language, an XML format for outlines) is supported as an additional output format for this resource.
Results Example
The following is a sample of a plain XML (POX) response to this request:
- <resource>
- <link href="http://api.netflix.com/users/T1tareQFowlmc8aiTEXBcQ5aed9h_Z8zdmSX1SnrKoOCA-
- /queues/disc?feed_token=T1u.tZSbY9311F5W0C5eVQXaJ49.KBapZdwjuCiUBzhoJ_.lTGnmES6JfOZbrxsFzf&
- oauth_consumer_key=v9s778n692e9qvd83wfj9t8c&output=atom"
- rel="http://schemas.netflix.com/feed.queues.disc" title="DVD Queue "></link>
- <link href="http://api.netflix.com/users/T1tareQFowlmc8aiTEXBcQ5aed9h_Z8zdmSX1SnrKoOCA-/queues/
- disc?feed_token=T1u.tZSbY9311F5W0C5eVQXaJ49.KBapZdwjuCiUBzhoJ_.lTGnmES6JfOZbrxsFzf&
- oauth_consumer_key=v9s778n692e9qvd83wfj9t8c&output=atom&sort=date_added"
- rel="http://schemas.netflix.com/feed.queues.disc.recent" title="Recent Additions to DVD Queue">
- </link>
- <link href="http://api.netflix.com/users/T1tareQFowlmc8aiTEXBcQ5aed9h_Z8zdmSX1SnrKoOCA-/queues/
- instant?feed_token=T1u.tZSbY9311F5W0C5eVQXaJ49.KBapZdwjuCiUBzhoJ_.lTGnmES6JfOZbrxsFzf&
- oauth_consumer_key=v9s778n692e9qvd83wfj9t8c&output=atom"
- rel="http://schemas.netflix.com/feed.queues.instant" title="Instant Queue"></link>
- <link href="http://api.netflix.com/users/T1tareQFowlmc8aiTEXBcQ5aed9h_Z8zdmSX1SnrKoOCA-/queues/
- instant?feed_token=T1u.tZSbY9311F5W0C5eVQXaJ49.KBapZdwjuCiUBzhoJ_.lTGnmES6JfOZbrxsFzf&
- oauth_consumer_key=v9s778n692e9qvd83wfj9t8c&output=atom&sort=date_added"
- rel="http://schemas.netflix.com/feed.queues.instant.recent" title="Recent Additions to
- Instant Queue"></link>
- <link href="http://api.netflix.com/users/T1tareQFowlmc8aiTEXBcQ5aed9h_Z8zdmSX1SnrKoOCA-/
- rental_history?feed_token=T1Bj0aYRbYBu0y0AvVq6CMe63ZEiGhb6RcYu3d7apdMFfK_Dlg_qWxDSHaSP
- lAu2P3aS4KROIgGOJh4kZUZtJAvg--&oauth_consumer_key=v9s778n692e9qvd83wfj9t8c&
- output=atom" rel="http://schemas.netflix.com/feed.rental_history" title="Recent
- Rental Activity"></link>
- <link href="http://api.netflix.com/users/T1tareQFowlmc8aiTEXBcQ5aed9h_Z8zdmSX1SnrKoOCA-/
- rental_history/shipped?feed_token=T1Bj0aYRbYBu0y0AvVq6CMe63ZEiGhb6RcYu3d7apdMFfK_Dlg_q
- WxDSHaSPlAu2P3aS4KROIgGOJh4kZUZtJAvg--&oauth_consumer_key=v9s778n692e9qvd83wfj9t8c&
- output=atom" rel="http://schemas.netflix.com/feed.rental_history.shipped"
- title="Titles Shipped"></link>
- <link href="http://api.netflix.com/users/T1tareQFowlmc8aiTEXBcQ5aed9h_Z8zdmSX1SnrKoOCA-/
- rental_history/watched?feed_token=T1Bj0aYRbYBu0y0AvVq6CMe63ZEiGhb6RcYu3d7apdMFfK_Dlg_q
- WxDSHaSPlAu2P3aS4KROIgGOJh4kZUZtJAvg--&oauth_consumer_key=v9s778n692e9qvd83wfj9t8c&
- output=atom" rel="http://schemas.netflix.com/feed.rental_history.watched" title="Titles
- Watched Recently"></link>
- <link href="http://api.netflix.com/users/T1tareQFowlmc8aiTEXBcQ5aed9h_Z8zdmSX1SnrKoOCA-/
- rental_history/returned?feed_token=T1Bj0aYRbYBu0y0AvVq6CMe63ZEiGhb6RcYu3d7apdMFfK_Dlg_
- qWxDSHaSPlAu2P3aS4KROIgGOJh4kZUZtJAvg--&oauth_consumer_key=v9s778n692e9qvd83wfj9t8c&
- output=atom" rel="http://schemas.netflix.com/feed.rental_history.returned" title="Titles
- Returned Recently"></link>
- <link href="http://api.netflix.com/users/T1tareQFowlmc8aiTEXBcQ5aed9h_Z8zdmSX1SnrKoOCA-/
- at_home?feed_token=T1xAyCfQ9KxNjKvHxA3OEO1p3fDW1Y8rQlX5kyeb3Cmfn3gVSfTolF6g3cbKcdJ7RO&
- oauth_consumer_key=v9s778n692e9qvd83wfj9t8c&output=atom"
- rel="http://schemas.netflix.com/feed.at_home" title="Titles At Home"></link>
- <link href="http://api.netflix.com/users/T1tareQFowlmc8aiTEXBcQ5aed9h_Z8zdmSX1SnrKoOCA-/
- reviews?feed_token=T1VmAb9ApEYiM36d4cSLuzt4pobSXtfXhDcmLM8lwIa5Uv5EjR0Rf68w1WmnkdyDknf
- 88FSQ8TT64qQ5ZlnnuGYA--&oauth_consumer_key=v9s778n692e9qvd83wfj9t8c&output=atom"
- rel="http://schemas.netflix.com/feed.reviews" title="Reviews "></link>
- <link href="http://api.netflix.com/users/T1tareQFowlmc8aiTEXBcQ5aed9h_Z8zdmSX1SnrKoOCA-/
- recommendations?feed_token=T1PeXieDTki.jbRFpFRArljzw4fe.iTem2XYfwbv6BosZadXZFIxEQ.M8wf
- _8XvouevwsyL3B9mS8OB25crS0r0g--&oauth_consumer_key=v9s778n692e9qvd83wfj9t8c&
- output=atom" rel="http://schemas.netflix.com/feed.recommendations"
- title="Recommendations "></link>
- <link href="http://api.netflix.com/users/T1tareQFowlmc8aiTEXBcQ5aed9h_Z8zdmSX1SnrKoOCA-/
- ratings/title/actual?feed_token=T1XOCp5.fEsLoqfkNPGxwkJdE_ZK.ryzqz7w26JW520B5mT4tTAGUq
- jBmpN9KZHIhkjuPBSafYj9cGmR8e7LPEBg--&oauth_consumer_key=v9s778n692e9qvd83wfj9t8c&
- output=atom" rel="http://schemas.netflix.com/feed.ratings" title="Ratings"></link>
- </resource>
The next example shows the feed URLs when returned in OPML format:
- <opml version="2.0">
- <head>
- <title>Personal Netflix Feeds</title>
- <dateCreated>Sat, 18 Jun 2005 12:11:52 GMT</dateCreated>
- </head>
- <body>
- <outline text="DVD Queue" title="DVD Queue" type="rss" xmlUrl="http://api.netflix.com/users/
- T1CnHNCdr7uoFZoFoTtlXxm7H_FbtMI3eaW.7rcu.ssX8-/queues/disc?feed_token=xyz"/>
- <outline text="Recent Additions to DVD Queue" title="Recent Additions to DVD Queue"
- type="rss" xmlUrl="http://api.netflix.com/users/T1CnHNCdr7uoFZoFoTtlXxm7H_FbtMI3eaW.7rcu.ssX8-/
- queues/disc?feed_token=xyz&sort=date_added"/>
- <outline text=“Instant Queue” title=“Instant Queue” type="rss" xmlUrl=“http://api.netflix.com/users/
- T1CnHNCdr7uoFZoFoTtlXxm7H_FbtMI3eaW.7rcu.ssX8-/queues/instant?feed_token=xyz&sort=date_added”/>
- <outline text=“Recent Additions to Instant Queue” title=“Recent Additions to Instant Queue”
- type="rss" xmlUrl=“http://api.netflix.com/users/T1CnHNCdr7uoFZoFoTtlXxm7H_FbtMI3eaW.7rcu.ssX8-/
- queues/instant?feed_token=xyz&sort=date_added”/>
- <outline text=“Recent Rental Activity” title=“Recent Rental Activity” type="rss"
- xmlUrl=“http://api.netflix.com/users/T1CnHNCdr7uoFZoFoTtlXxm7H_FbtMI3eaW.7rcu.ssX8-/
- rental_history?feed_token=xyz”/>
- <outline text=“Titles At Home” title=“Titles At Home” type="rss" xmlUrl=“http://api.netflix.com/
- users/T1CnHNCdr7uoFZoFoTtlXxm7H_FbtMI3eaW.7rcu.ssX8-/rental_history/at_home?feed_token=xyz”/>
- <outline text=“Titles Watched Recently” title=“Titles Watched Recently” type="rss"
- xmlUrl=“http://api.netflix.com/users/T1CnHNCdr7uoFZoFoTtlXxm7H_FbtMI3eaW.7rcu.ssX8-/
- rental_history/watched?feed_token=xyz”/>
- <outline text=“Titles Returned Recently” title=“Titles Returned Recently”
- type="rss" xmlUrl=“http://api.netflix.com/users/T1CnHNCdr7uoFZoFoTtlXxm7H_FbtMI3eaW.7rcu.ssX8-/
- rental_history/returned?feed_token=xyz”/>
- <outline text="Recommendations" title=“Recommendations” type="rss"
- xmlUrl=“http://api.netflix.com/users/T1CnHNCdr7uoFZoFoTtlXxm7H_FbtMI3eaW.7rcu.ssX8-/
- recommendations?feed_token=xyz”/>
- <outline text=“Reviews” title=“Reviews” type="rss" xmlUrl=“http://api.netflix.com/users/
- T1CnHNCdr7uoFZoFoTtlXxm7H_FbtMI3eaW.7rcu.ssX8-/review?feed_token=xyz”/>
- <outline text=“Ratings” title=“Ratings” type="rss" xmlUrl=“http://api.netflix.com/users/
- T1CnHNCdr7uoFZoFoTtlXxm7H_FbtMI3eaW.7rcu.ssX8-/ratings/title/actual?feed_token=xyz”/>
- </body>
- </opml>
Use this resource to help determine a subscriber's rental options. Each user response contains a link to a to the user's title states.
Due to the fluid nature of queues and title availability, complex business logic is required to determine the rental options for a subscriber. A link to this resource can be found in any user response.
The title state resource describes the relationship between the subscriber and one or more catalog titles. The response varies depending on whether the title is delivered as a disc or is available to watch instantly.
For titles available on disc (or soon to be available on disc), the resource includes the following details:
- Indicates if the title is in the queue (In Queue)
- If not in the queue, indicates the appropriate action to add the title to the queue: Add, Add All, Save, or Save All for available formats and the user's active queues. The Add All and Save All actions are only indicated when the title represents a disc collection.
- Indicates the preferred action for the user. The preferred action is based upon the user's format preference.
For titles available to watch instantly, the response includes these details:
- If the title is in the instant watch queue (In Instant Queue)
- If not in the instant queue, the appropriate action either to add the title to that queue (Add) or play the title (Play).
-
One or more catalog title URLs for which to retrieve rental option state. Up to 500 titles states may be requested.
Results Example
The following is an example response to this request:
- <title_states>
- <link href="http://api.netflix.com/catalog/titles/movies/70036143"
- rel="http://schemas.netflix.com/id" title="title"></link>
- <title_state>
- <link href="http://api.netflix.com/users/T1DonaZPk00Jl39mXvKMpOsJ344BJtLQAh4SyvxWAV4Tk-/queues/instant"
- rel="http://schemas.netflix.com/queues/instant" title="instant queue"></link>
- <category scheme="http://api.netflix.com/catalog/titles/format" label="instant"></category>
- <category scheme="http://api.netflix.com/catalog/titles/title_states" label="play"></category>
- </title_state>
- <title_state>
- <link href="http://api.netflix.com/users/T1DonaZPk00Jl39mXvKMpOsJ344BJtLQAh4SyvxWAV4Tk-/queues/disc"
- rel="http://schemas.netflix.com/queues/disc" title="disc queue"></link>
- <category scheme="http://api.netflix.com/catalog/titles/format" label="HD DVD"></category>
- <category scheme="http://api.netflix.com/catalog/titles/title_states"
- label="unavailable"></category>
- <category scheme="http://api.netflix.com/catalog/titles/format" label="DVD"></category>
- <category scheme="http://api.netflix.com/catalog/titles/title_states" label="add"></category>
- </title_state>
- </title_states>
-
Managing Queues
Use the queue management API to retrieve and manipulate the contents of a user's queue. You can use these API resources (with the HTTP POST and DELETE verbs) to add and remove catalog titles to and from a queue, and also to move the title's location within the queue. You also use these resources (with the GET verb) to retrieve queue details, such as the current titles in the queue, their respective positions, and their availability
The following HTTP methods are used to invoke the queue management resources:
- users/userID/queues - Returns the contents of a user's queues.
- users/userID/queues/disc - GET returns details about discs in a user's queue. POST adds or moves titles within a user's disc queue.
- users/userID/queues/disc/available. - Returns details about the availability of a disc in a user's queue.
- users/userID/queues/disc/available/entryID. - GET retrieves details about the entry from the user's disc queue. DELETE deletes the specified entry from the user's disc queue.
- users/userID/queues/disc/saved. - Returns the saved status of a disc in a user's queue.
- users/userID/queues/disc/saved/entryID. - GET retrieves details about the saved entry from the user's disc queue. DELETE deletes the specified entry from the user's disc queue.
- users/userID/queues/instant - GET returns details about a user's instant watch queue. POST adds or moves titles within a user's instant watch queue.
- users/userID/queues/instant/available - Returns availability details of titles in a user's instant watch queue.
- users/userID/queues/instant/available/entryID. - GET retrieves details about the entry from the user's instant watch queue. DELETE deletes the specified entry from the user's instant watch queue.
- users/userID/queues/instant/saved - Returns the saved status of an entry in a user's instant watch queue.
- users/userID/queues/instant/saved/entryID - GET retrieves details about the saved entry from the user's instant watch queue. DELETE deletes the specified entry from the user's instant watch queue.
users/userID/queues
users/userID/queues/disc
users/userID/queues/disc/available
users/userID/queues/disc/available/entryID
users/userID/queues/disc/saved
users/userID/queues/disc/saved/entryID
users/userID/queues/instant
users/userID/queues/instant/available
users/userID/queues/instant/available/entryID
users/userID/queues/instant/saved
users/userID/queues/instant/saved/entryID
These resources return the user's disc and instant watching queues. Responses include available titles that are waiting for delivery and saved pre-release titles. Also included are the queue entry URLs for each item in the queue.
Note that the updated timestamp in Atom-formatted responses always equals the time that the queue data was requested.
Invoke these resources using either the GET, POST, or DELETE verbs. See Updating a Queue. for more information on using the queue management resources with the POST and DELETE verbs.
The following parameters apply to each queue resource. Note that these parameters are applicable for the resources when used with the GET verb.
Results
When used with the GET verb, these resources return details about the user's disc and instant watching queues, including available and saved pre-release titles, plus queue entry title URLs.
Results Example
This example is part of a response showing queue information retrieval:
- <queue>
- <etag>819873819117</etag>
- <number_of_results>220</number_of_results>
- <start_index>0</start_index>
- <results_per_page>3</results_per_page>
- <queue_item>
- <id>http://api.netflix.com/users/T1DonaZPk00Jl39mXvKMpOsJ344BJtLQAh4SyvxWAV4Tk-/
- queues/disc/available/1/251454</id>
- <position>1</position>
- <link href="http://api.netflix.com/users/T1DonaZPk00Jl39mXvKMpOsJ344BJtLQAh4SyvxWAV4Tk-/queues/disc/available"
- rel="queue_ref" title="Available Queue"></link>
- <category scheme="http://api.netflix.com/categories/queue_availability" label="available_now"></category>
- <updated>1204284910</updated>
- <category scheme="http://api.netflix.com/catalog/titles/format" label="DVD"></category>
- <link href="http://api.netflix.com/catalog/titles/movies/251454" rel="http://schemas.netflix.com/id"
- title="title"></link><title short="An American in Paris" regular="An American in Paris"></title>
- <box_art small="http://alien2.netflix.com/us/boxshots/tiny/251454.jpg"
- medium="http://alien2.netflix.com/us/boxshots/small/251454.jpg"
- large="http://alien2.netflix.com/us/boxshots/large/251454.jpg"></box_art>
- <link href="http://api.netflix.com/catalog/titles/movies/251454/synopsis"
- rel="http://schemas.netflix.com/catalog/titles/synopsis" title="synopsis"></link>
- <release_year>1951</release_year>
- <category scheme="http://api.netflix.com/categories/mpaa_ratings" label="UR"></category>
- <category scheme="http://api.netflix.com/categories/genres" label="Classics"></category>
- <link href="http://api.netflix.com/catalog/titles/movies/251454/cast"
- rel="http://schemas.netflix.com/catalog/people.cast" title="cast"></link>
- <link href="http://api.netflix.com/catalog/titles/movies/251454/directors"
- rel="http://schemas.netflix.com/catalog/people.directors" title="directors"></link>
- <link href="http://api.netflix.com/catalog/titles/movies/251454/awards"
- rel="http://schemas.netflix.com/catalog/titles/awards" title="awards"></link>
- <link href="http://api.netflix.com/catalog/titles/movies/251454/format_availability"
- rel="http://schemas.netflix.com/catalog/titles/format_availability" title="formats"></link>
- <link href="http://api.netflix.com/catalog/titles/movies/251454/screen_formats"
- rel="http://schemas.netflix.com/catalog/titles/screen_formats" title="screen formats"></link>
- <link href="http://api.netflix.com/catalog/titles/movies/251454/languages_and_audio"
- rel="http://schemas.netflix.com/catalog/titles/languages_and_audio" title="languages and audio"></link>
- <average_rating>3.7</average_rating>
- <link href="http://api.netflix.com/catalog/titles/movies/251454/similars"
- rel="http://schemas.netflix.com/catalog/titles.similars" title="similars"></link>
- <link href="http://www.netflix.com/Movie/An_American_in_Paris/251454"
- rel="alternate" title="webpage"></link>
- </queue_item>
- <queue_item>
- <id>http://api.netflix.com/users/T1DonaZPk00Jl39mXvKMpOsJ344BJtLQAh4SyvxWAV4Tk-/queues/
- disc/available/2/70038486</id>
- <position>2</position>
- <link href="http://api.netflix.com/users/T1DonaZPk00Jl39mXvKMpOsJ344BJtLQAh4SyvxWAV4Tk-/
- queues/disc/available" rel="queue_ref" title="Available Queue"></link>
- <category scheme="http://api.netflix.com/categories/queue_availability" label="available_now"></category>
- <updated>1204284933</updated>
- <category scheme="http://api.netflix.com/catalog/titles/format" label="DVD"></category>
- <link href="http://api.netflix.com/catalog/titles/movies/70038486" rel="http://schemas.netflix.com/id"
- title="title"></link><title short="Ben-Hur: Collector's Edition" regular="Ben-Hur: Collector's Edition"></title>
- <box_art small="http://alien2.netflix.com/us/boxshots/tiny/70038486.jpg"
- medium="http://alien2.netflix.com/us/boxshots/small/70038486.jpg"
- large="http://alien2.netflix.com/us/boxshots/large/70038486.jpg"></box_art>
- <link href="http://api.netflix.com/catalog/titles/movies/70038486/synopsis"
- rel="http://schemas.netflix.com/catalog/titles/synopsis" title="synopsis"></link>
- <release_year>1959</release_year>
- <category scheme="http://api.netflix.com/categories/mpaa_ratings" label="NR"></category>
- <category scheme="http://api.netflix.com/categories/genres" label="Classics"></category>
- <link href="http://api.netflix.com/catalog/titles/movies/70038486/cast"
- rel="http://schemas.netflix.com/catalog/people.cast" title="cast"></link>
- <link href="http://api.netflix.com/catalog/titles/movies/70038486/directors"
- rel="http://schemas.netflix.com/catalog/people.directors" title="directors"></link>
- <link href="http://api.netflix.com/catalog/titles/movies/70038486/awards"
- rel="http://schemas.netflix.com/catalog/titles/awards" title="awards"></link>
- <link href="http://api.netflix.com/catalog/titles/movies/70038486/format_availability"
- rel="http://schemas.netflix.com/catalog/titles/format_availability" title="formats"></link>
- <link href="http://api.netflix.com/catalog/titles/movies/70038486/screen_formats"
- rel="http://schemas.netflix.com/catalog/titles/screen_formats" title="screen formats"></link>
- <link href="http://api.netflix.com/catalog/titles/movies/70038486/languages_and_audio"
- rel="http://schemas.netflix.com/catalog/titles/languages_and_audio" title="languages and audio"></link>
- <average_rating>4.1</average_rating>
- <link href="http://api.netflix.com/catalog/titles/movies/70038486/similars"
- rel="http://schemas.netflix.com/catalog/titles.similars" title="similars"></link>
- <link href="http://www.netflix.com/Movie/Ben-Hur_Collector_s_Edition/70038486" rel="alternate" title="webpage"></link>
- </queue_item>
- <queue_item>
- <id>http://api.netflix.com/users/T1DonaZPk00Jl39mXvKMpOsJ344BJtLQAh4SyvxWAV4Tk-/queues/disc/saved/70071617</id>
- <link href="http://api.netflix.com/users/T1DonaZPk00Jl39mXvKMpOsJ344BJtLQAh4SyvxWAV4Tk-/queues/disc/saved"
- rel="http://schemas.netflix.com/queues" title="Saved Queue"></link>
- <category scheme="http://api.netflix.com/categories/queue_availability" label="saved"></category>
- <updated>1217949743</updated>
- <category scheme="http://api.netflix.com/catalog/titles/format" label="DVD"></category>
- <link href="http://api.netflix.com/catalog/titles/movies/70071617" rel="http://schemas.netflix.com/id"
- title="title"></link><title short="Triangle" regular="Triangle"></title>
- <box_art small="http://alien2.netflix.com/us/boxshots/tiny/70071617.jpg"
- medium="http://alien2.netflix.com/us/boxshots/small/70071617.jpg"
- large="http://alien2.netflix.com/us/boxshots/large/70071617.jpg"></box_art>
- <link href="http://api.netflix.com/catalog/titles/movies/70071617/synopsis"
- rel="http://schemas.netflix.com/catalog/titles/synopsis" title="synopsis"></link>
- <release_year>2007</release_year>
- <category scheme="http://api.netflix.com/categories/mpaa_ratings" label="NR"></category>
- <category scheme="http://api.netflix.com/categories/genres" label="Foreign"></category>
- <link href="http://api.netflix.com/catalog/titles/movies/70071617/cast" rel="http://schemas.netflix.com/catalog/people.cast" title="cast"></link>
- <link href="http://api.netflix.com/catalog/titles/movies/70071617/directors"
- rel="http://schemas.netflix.com/catalog/people.directors" title="directors"></link>
- <link href="http://api.netflix.com/catalog/titles/movies/70071617/format_availability"
- rel="http://schemas.netflix.com/catalog/titles/format_availability" title="formats"></link>
- <average_rating>3.3</average_rating>
- <link href="http://api.netflix.com/catalog/titles/movies/70071617/similars"
- rel="http://schemas.netflix.com/catalog/titles.similars" title="similars"></link>
- <link href="http://www.netflix.com/Movie/Triangle/70071617" rel="alternate" title="webpage"></link>
- </queue_item>
- </queue>
users/userID/queues/disc/available/entryID
users/userID/queues/disc/saved/entryID
users/userID/queues/instant/available/entryID
users/userID/queues/instant/saved/entryID
Use these resources to delete titles from a queue. Delete a catalog title from a queue by executing an HTTP DELETE operation on the queue entry URL (the entry identifier) for any title. The response to the DELETE operation lists the queue entry URLs for each queue entry.
users/userID/queues/instant
Use these two resources with the POST verb to add catalog titles to either the disc or instant watch queues or to move titles within a queue. Add the title to the queue by doing a POST operation and pass the title URL. For discs only, include the format of the title. Optionally, you may also pass in the position of the title within the queue.
These resources automatically add the title to the saved or available queue, depending on the title's format availability. A title's format availability indicates its supported formats (such as DVD and instant watching) along with each format's availability window. To see the formats and availability for a title and correlate that with the user's preferences and limits, check the user/userID/title_states resource for the title. (See users/userID/title_states..)
For titles that span multiple discs, such as a television series season on multiple DVDs, multiple queue entries are added for each disc.
If a title already exists in a queue, then you can use the format and position parameters to modify the existing queue entry.
The ETag value you pass to the operation indicates the last time that the queue was read. (The ETag value was returned with the response to the most recent queue operation.) The POST operation fails if the queue has been updated since the creation of the ETag value you are passing in. Each successful POST response returns a new ETag value.
The following parameters apply to these queue resources when used with the POST verb.
Results
When successful, returns the queue entries that were created or modified with the POST operation. If the operation involved moving a title within a queue, the resource returns only that queue item with its updated position.
The resource returns an error if a title is not available in a queue's designated format.
The POST operation fails if the queue has been updated subsequent to the ETag value passed in.
The resource also may return a partial success status message if an item in a multiple disc set can not be added or is already in the queue. The response example below illustrates a partial success status message.
Each successful (or partially successful) POST response includes a new ETag value.
Results Example
This example shows part of a queue POST response where there was partial success:
- <status>
- <status_code>201</status_code>
- <sub_code>640</sub_code>
- <message>Only some of the titles in the series or disc set could be added.</message>
- <etag>657707210550</etag>
- <resources_created>
- <queue_item>
- <id>http://api.netflix.com/users/T1argz9Jf.Skky8UdZ4XVuNkV8MaErAMAMcbR4s2_irVY-/queues/disc/available/144/27830306</id>
- <position>144</position>
- <link href="http://api.netflix.com/users/T1argz9Jf.Skky8UdZ4XVuNkV8MaErAMAMcbR4s2_irVY-/queues/disc/available"
- rel="http://schemas.netflix.com/queues.available" title="available queue"></link>
- <category scheme="http://api.netflix.com/categories/queue_availability"
- label="awaiting release” term="awaiting_release"></category>
- <updated>1217949743</updated>
- <availability_date>1217985495</availability_date>
- <category scheme="http://api.netflix.com/catalog/titles/format" label="DVD" term="DVD"></category>
- <link href="http://api.netflix.com/catalog/titles/discs/27830306"
- rel="http://schemas.netflix.com/title" title="title"></link>
- <title short="The Larry Sanders Show: Season 1: Disc 1" regular="The Larry Sanders Show: Season 1: Disc 1"></title>
- <box_art small="http://alien2.netflix.com/us/boxshots/tiny/60030437.jpg"
- medium="http://alien2.netflix.com/us/boxshots/small/60030437.jpg"
- large="http://alien2.netflix.com/us/boxshots/large/60030437.jpg"></box_art>
- <link href="http://api.netflix.com/catalog/titles/discs/27830306/synopsis"
- rel="http://schemas.netflix.com/catalog/titles/synopsis" title="synopsis"></link>
- <release_year>1992</release_year>
- <category scheme="http://api.netflix.com/categories/tv_ratings" label="TV-MA"
- term="TV-MA"></category>
- <category scheme="http://api.netflix.com/categories/genres" label="Television"
- term="Television"></category>
- <link href="http://api.netflix.com/catalog/titles/discs/27830306/cast"
- rel="http://schemas.netflix.com/catalog/people.cast" title="cast"></link>
- <link href="http://api.netflix.com/catalog/titles/discs/27830306/directors"
- rel="http://schemas.netflix.com/catalog/people.directors" title="directors"></link>
- <link href="http://api.netflix.com/catalog/titles/discs/27830306/format_availability"
- rel="http://schemas.netflix.com/catalog/titles/format_availability" title="formats"></link>
- <link href="http://api.netflix.com/catalog/titles/discs/27830306/screen_formats"
- rel="http://schemas.netflix.com/catalog/titles/screen_formats" title="screen formats"></link>
- <link href="http://api.netflix.com/catalog/titles/discs/27830306/languages_and_audio"
- rel="http://schemas.netflix.com/catalog/titles/languages_and_audio"
- title="languages and audio"></link>
- <link href="http://api.netflix.com/catalog/titles/discs/27830306/similars"
- rel="http://schemas.netflix.com/catalog/titles.similars" title="similars"></link>
- <link href="http://api.netflix.com/Movie/The_Larry_Sanders_Show_Season_1_Disc_1/27830306"
- rel="alternate" title="webpage"></link>
- </queue_item>
- <queue_item>
- <id>http://api.netflix.com/users/T1argz9Jf.Skky8UdZ4XVuNkV8MaErAMAMcbR4s2_irVY-/queues/disc/available/144/27830307</id>
- <position>144</position>
- <link href="http://api.netflix.com/users/T1argz9Jf.Skky8UdZ4XVuNkV8MaErAMAMcbR4s2_irVY-/queues/disc/available"
- rel="http://schemas.netflix.com/queues.available" title="available queue"></link>
- <category scheme="http://api.netflix.com/categories/queue_availability"
- label="awaiting release" term="awaiting_release"></category>
- <availability_date>1217985495</availability_date>
- <updated>1217949743</updated>
- <category scheme="http://api.netflix.com/catalog/titles/format" label="DVD"
- term="DVD"></category>
- <link href="http://api.netflix.com/catalog/titles/discs/278303010"
- rel="http://schemas.netflix.com/title" title="title"></link>
- <title short="The Larry Sanders Show: Season 1: Disc 5"
- regular="The Larry Sanders Show: Season 1: Disc 5"></title>
- <box_art small="http://alien2.netflix.com/us/boxshots/tiny/60030437.jpg"
- medium="http://alien2.netflix.com/us/boxshots/small/60030437.jpg"
- large="http://alien2.netflix.com/us/boxshots/large/60030437.jpg"></box_art>
- <link href="http://api.netflix.com/catalog/titles/discs/27830306/synopsis"
- rel="http://schemas.netflix.com/catalog/titles/synopsis" title="synopsis"></link>
- <release_year>1992</release_year>
- <category scheme="http://api.netflix.com/categories/tv_ratings" label="TV-MA"
- term="TV-MA"></category>
- <category scheme="http://api.netflix.com/categories/genres" label="Television"
- term="Television"></category>
- <link href="http://api.netflix.com/catalog/titles/discs/27830306/cast"
- rel="http://schemas.netflix.com/catalog/people.cast" title="cast"></link>
- <link href="http://api.netflix.com/catalog/titles/discs/27830306/directors"
- rel="http://schemas.netflix.com/catalog/people.directors" title="directors"></link>
- <link href="http://api.netflix.com/catalog/titles/discs/27830306/format_availability"
- rel="http://schemas.netflix.com/catalog/titles/format_availability" title="formats">
- </link>
- <link href="http://api.netflix.com/catalog/titles/discs/27830306/screen_formats"
- rel="http://schemas.netflix.com/catalog/titles/screen_formats"
- title="screen formats"></link>
- <link href="http://api.netflix.com/catalog/titles/discs/27830306/languages_and_audio"
- rel="http://schemas.netflix.com/catalog/titles/languages_and_audio"
- title="languages and audio"></link>
- <link href="http://api.netflix.com/catalog/titles/discs/27830306/similars"
- rel="http://schemas.netflix.com/catalog/titles.similars" title="similars"></link>
- <link href="http://api.netflix.com/Movie/The_Larry_Sanders_Show_Season_1_Disc_1527830306"
- rel="alternate" title="webpage"></link>
- </queue_item>
- </resources_created>
- <failed_title_refs>
- <link href=”http://api.netflix.com/catalog/titles/discs/60022257”
- rel=”http://schemas.netflix.com/title" title= The Larry Sanders Show: Season 1: Disc 2</id>
- </failed_title_refs>
- <already_in_queue>
- <link href=”http://api.netflix.com/catalog/titles/discs/60022258”
- rel=”http://schemas.netflix.com/title" title= The Larry Sanders Show: Season 1: Disc 3</id>
- <link href=”http://api.netflix.com/catalog/titles/discs/60022259”
- rel=”http://schemas.netflix.com/title" title= The Larry Sanders Show: Season 1: Disc 4</id>
- </already_in_queue>
- </status>
-
Tracking Discs
This API keeps track of discs that have been sent to a subscriber's home and not yet received back to the Netflix distribution center. You might use these resources in conjunction with the rental history resources. (See Managing Rental History..)
Returns a list of titles that have been shipped to a subscriber's home and not yet returned to Netflix (that is, the discs have not been received at a Netflix distribution center). When the distribution center receives a disc, the users/userID/at_home entry for the disc is purged.
Results
Returns titles that have been shipped to a subscriber's home and not yet returned to Netflix.
Results Example
The following is an example response to this request.
- <at_home>
- <number_of_results>220</number_of_results>
- <start_index>0</start_index>
- <results_per_page>2</results_per_page>
- <at_home_item>
- <id>http://api.netflix.com/users/T1DonaZPk00Jl39mXvKMpOsJ344BJtLQAh4SyvxWAV4Tk-/at_home/ 70063908</id>
- <updated>1217690664</updated>
- <shipped_date>1217418632</shipped_date>
- <estimated_arrival_date>1217487600</estimated_arrival_date>
- <link href="http://api.netflix.com/catalog/titles/programs/70063908" rel="http://schemas.netflix.com/id"
- title="title"/><title short="Pink Panther: The Pink Tail Fly" regular="The Pink Panther Classic Cartoon
- Collection: The Pink Tail Fly" episode_short="The Pink Tail Fly"></title>
- <box_art small="http://alien2.netflix.com/us/boxshots/tiny/70035020.jpg"
- medium="http://alien2.netflix.com/us/boxshots/small/70035020.jpg"
- large="http://alien2.netflix.com/us/boxshots/large/70035020.jpg"></box_art>
- <link href="http://api.netflix.com/catalog/titles/programs/70063908/synopsis"
- rel="http://schemas.netflix.com/catalog/titles/synopsis" title="synopsis"/>
- <release_year>1969</release_year>
- <category scheme="http://api.netflix.com/categories/mpaa_ratings" label="NR"></category>
- <category scheme="http://api.netflix.com/categories/genres" label="Children & Family"></category>
- <link href="http://api.netflix.com/catalog/titles/programs/70063908/cast"
- rel="http://schemas.netflix.com/catalog/people.cast" title="cast"/>
- <link href="http://api.netflix.com/catalog/titles/programs/70063908/directors"
- rel="http://schemas.netflix.com/catalog/people.directors" title="directors"/>
- <link href="http://api.netflix.com/catalog/titles/programs/70063908/format_availability"
- rel="http://schemas.netflix.com/catalog/titles/format_availability" title="formats"></link>
- <link href="http://api.netflix.com/catalog/titles/programs/70063908/similars"
- rel="http://schemas.netflix.com/catalog/titles.similars" title="similars"/>
- <link href="http://www.netflix.com/Movie/The_Pink_Panther_Classic_Cartoon_Collection_The_Pink_Tail_Fly/70063908"
- rel="alternate" title="webpage"/>
- </at_home_item>
- <at_home_item>
- <id>http://api.netflix.com/users/T1DonaZPk00Jl39mXvKMpOsJ344BJtLQAh4SyvxWAV4Tk-/at_home /70063933</id>
- <updated>1217665233</updated>
- <shipped_date>1217346128</shipped_date>
- <estimated_arrival_date>1217401200</estimated_arrival_date>
- <link href="http://api.netflix.com/catalog/titles/programs/70063933"
- rel="http://schemas.netflix.com/id" title="title"/>
- <title short="Pink Panther: Dial 'P' for Pink" regular="The Pink Panther Classic Cartoon Collection: Dial P
- for Pink" episode_short="Dial "P" for Pink"></title>
- <box_art small="http://alien2.netflix.com/us/boxshots/tiny/70035020.jpg"
- medium="http://alien2.netflix.com/us/boxshots/small/70035020.jpg"
- large="http://alien2.netflix.com/us/boxshots/large/70035020.jpg"></box_art>
- <link href="http://api.netflix.com/catalog/titles/programs/70063933/synopsis"
- rel="http://schemas.netflix.com/catalog/titles/synopsis" title="synopsis"/>
- <release_year>1969</release_year>
- <category scheme="http://api.netflix.com/categories/mpaa_ratings" label="NR"></category>
- <category scheme="http://api.netflix.com/categories/genres" label="Children & Family"></category>
- <link href="http://api.netflix.com/catalog/titles/programs/70063933/cast"
- rel="http://schemas.netflix.com/catalog/people.cast" title="cast"/>
- <link href="http://api.netflix.com/catalog/titles/programs/70063933/directors"
- rel="http://schemas.netflix.com/catalog/people.directors" title="directors"/>
- <link href="http://api.netflix.com/catalog/titles/programs/70063933/format_availability"
- rel="http://schemas.netflix.com/catalog/titles/format_availability" title="formats"/>
- <link href="http://api.netflix.com/catalog/titles/programs/70063933/similars"
- rel="http://schemas.netflix.com/catalog/titles.similars" title="similars"/>
- <link href="http://www.netflix.com/Movie/The_Pink_Panther_Classic_Cartoon_Collection_Dial_P_for_Pink/70063933"
- rel="alternate" title="webpage"/>
- </at_home_item>
- </at_home>
users/userID/rental_history
users/userID/rental_history/shipped
users/userID/rental_history/returned
users/userID/rental_history/watched
These resources return a list of titles that reflect a subscriber's rental history. Depending on the subresource you invoke, the list can include discs sent to a user's home, titles returned by a user and received by Netflix, and titles that users have watched instantly. The response results are sorted by each title's entry date into each list. Note that shipped titles are not purged from the user's rental history after they are received or returned.
The parent rental history resource (users/ userID /rental_history ) returns the contents of each of the three subresource lists.
Results
Returns a list of up to ten of the most recent titles that reflect a subscriber's rental history.
Results Example
The following is an example response to this request. The response lists recently watched titles.
- <rental_history>
- <url_template>http://api.netflix.com/users/T1CnHNCdr7uoFZoFoTtlXxm7H_FbtMI3eaW.7rcu.ssX8-/
- rental_history?{-join|&|start_index|max_results}</url_template>
- <number_of_results>155</number_of_results>
- <start_index>0</start_index>
- <results_per_page>2</results_per_page>
- <rental_history_item>
- <id>http://api.netflix.com/users/T1CnHNCdr7uoFZoFoTtlXxm7H_FbtMI3eaW.7rcu.ssX8-/
- rental_history/watched/70063995</id>
- <watched_date>1219775019</watched_date>
- <viewed_time>00:00:26</viewed_time>
- <updated>1219775019</updated>
- <category scheme="http://api.netflix.com/categories/rental_states" label="Watched" term="Watched"></category>
- <link href="http://api.netflix.com/catalog/titles/programs/70063995" rel="http://schemas.netflix.com/id"
- title="title"></link>
- <title short="Pink Panther: Think Before You Pink" regular="The Pink Panther Classic Cartoon Collection:
- Think Before You Pink" episode_short="Think Before You Pink"></title>
- <box_art small="http://alien2.netflix.com/us/boxshots/tiny/70035020.jpg"
- medium="http://alien2.netflix.com/us/boxshots/small/70035020.jpg"
- large="http://alien2.netflix.com/us/boxshots/large/70035020.jpg"></box_art>
- <link href="http://api.netflix.com/catalog/titles/programs/70063995/synopsis"
- rel="http://schemas.netflix.com/catalog/titles/synopsis" title="synopsis"></link>
- <release_year>1969</release_year>
- <category scheme="http://api.netflix.com/categories/mpaa_ratings" label="NR" term="NR"></category>
- <category scheme="http://api.netflix.com/categories/genres" label="Children & Family"
- term="Children & Family"></category>
- <link href="http://api.netflix.com/catalog/titles/programs/70063995/cast"
- rel="http://schemas.netflix.com/catalog/people.cast" title="cast"></link>
- <link href="http://api.netflix.com/catalog/titles/programs/70063995/directors"
- rel="http://schemas.netflix.com/catalog/people.directors" title="directors"></link>
- <link href="http://api.netflix.com/catalog/titles/programs/70063995/format_availability"
- rel="http://schemas.netflix.com/catalog/titles/format_availability" title="formats"></link>
- <link href="http://api.netflix.com/catalog/titles/programs/70063995/similars"
- rel="http://schemas.netflix.com/catalog/titles.similars" title="similars"></link>
- <link href="http://api.netflix.com/Movie/The_Pink_Panther_Classic_Cartoon_Collection_Think_Before_You_Pink/
- 70063995" rel="alternate" title="web page"></link>
- </rental_history_item>
- <rental_history_item>
- <id>http://api.netflix.com/users/T1CnHNCdr7uoFZoFoTtlXxm7H_FbtMI3eaW.7rcu.ssX8-/rental_history/
- at_home/860591</id>
- <shipped_date>1217418632</shipped_date>
- <estimated_arrival_date>1217487600</estimated_arrival_date>
- <updated>1217418632</updated>
- <category scheme="http://api.netflix.com/categories/rental_states" label="At Home" term="At Home"></category>
- <link href="http://api.netflix.com/catalog/titles/movies/860591" rel="http://schemas.netflix.com/id"
- title="title"></link>
- <title short="Platoon" regular="Platoon"></title>
- <box_art small="http://alien2.netflix.com/us/boxshots/tiny/860591.jpg"
- medium="http://alien2.netflix.com/us/boxshots/small/860591.jpg"
- large="http://alien2.netflix.com/us/boxshots/large/860591.jpg"></box_art>
- <link href="http://api.netflix.com/catalog/titles/movies/860591/synopsis"
- rel="http://schemas.netflix.com/catalog/titles/synopsis" title="synopsis"></link>
- <release_year>1986</release_year>
- <category scheme="http://api.netflix.com/categories/mpaa_ratings" label="R" term="R"></category>
- <category scheme="http://api.netflix.com/categories/genres" label="Drama"
