- Previous: API Resources
- Up: API Resources
- Next: Title Resources
Catalog Search Resources
GET /catalog/games
Returns a list of titles from a games search of the catalog.
If the 'refine' query parameter is supplied, a list of links to further refine the search is also included.
Features
- paging - items_per_page=20 by default (maximum 250)
- title expansion
| Parameter | Type | Description |
|---|---|---|
| term | string | The search string |
| refine | comma-separated list | Facet names to provide refinement links to, or the value 'all' to refine all facets.
Supported facets:
|
| genre | string | Seach a particular genre; see /categories/genres |
| format | string | Search a particular format; see /categories/format |
| certificate | string | Restrict the search to a specific certificate; see /categories/certificates/pegi, /categories/certificates/bbfc |
| purchase | string | Search a particular purchase type; see /categories/purchases |
Example:
GET /catalog/dancer
Returns a list of titles from a dancer search of the catalog.
If the 'refine' query parameter is supplied, a list of links to further refine the search is also included.
Features
- paging - items_per_page=20 by default (maximum 250)
- title expansion
| Parameter | Type | Description |
|---|---|---|
| term | string | The search string |
| refine | comma-separated list | Facet names to provide refinement links to, or the value 'all' to refine all facets.
Supported facets:
|
| role | string | Seach a particular role, see /categories/roles |
Example:
GET /catalog/video
Returns a list of titles from a video search of the catalog.
If the 'refine' query parameter is supplied, a list of links to further refine the search is also included.
Features
- paging - items_per_page=20 by default (maximum 250)
- title expansion
| Parameter | Type | Description |
|---|---|---|
| term | string | The search string |
| refine | comma-separated list | Facet names to provide refinement links to, or the value 'all' to refine all facets.
Supported facets:
|
| genre | string | Seach a particular genre; see /categories/genres |
| format | string | Search a particular format; see /categories/format |
| certificate | string | Restrict the search to a specific certificate; see /categories/certificates/pegi, /categories/certificates/bbfc |
| purchase | string | Search a particular purchase type; see /categories/purchases |
Example:
GET /catalog/voice over
Returns a list of titles from a voice over search of the catalog.
If the 'refine' query parameter is supplied, a list of links to further refine the search is also included.
Features
- paging - items_per_page=20 by default (maximum 250)
- title expansion
| Parameter | Type | Description |
|---|---|---|
| term | string | The search string |
| refine | comma-separated list | Facet names to provide refinement links to, or the value 'all' to refine all facets.
Supported facets:
|
| role | string | Seach a particular role, see /categories/roles |
Example:
GET /catalog/actor
Returns a list of titles from a actor search of the catalog.
If the 'refine' query parameter is supplied, a list of links to further refine the search is also included.
Features
- paging - items_per_page=20 by default (maximum 250)
- title expansion
| Parameter | Type | Description |
|---|---|---|
| term | string | The search string |
| refine | comma-separated list | Facet names to provide refinement links to, or the value 'all' to refine all facets.
Supported facets:
|
| role | string | Seach a particular role, see /categories/roles |
Example:
GET /catalog/director
Returns a list of titles from a director search of the catalog.
If the 'refine' query parameter is supplied, a list of links to further refine the search is also included.
Features
- paging - items_per_page=20 by default (maximum 250)
- title expansion
| Parameter | Type | Description |
|---|---|---|
| term | string | The search string |
| refine | comma-separated list | Facet names to provide refinement links to, or the value 'all' to refine all facets.
Supported facets:
|
| role | string | Seach a particular role, see /categories/roles |
Example:
GET /catalog/narrator
Returns a list of titles from a narrator search of the catalog.
If the 'refine' query parameter is supplied, a list of links to further refine the search is also included.
Features
- paging - items_per_page=20 by default (maximum 250)
- title expansion
| Parameter | Type | Description |
|---|---|---|
| term | string | The search string |
| refine | comma-separated list | Facet names to provide refinement links to, or the value 'all' to refine all facets.
Supported facets:
|
| role | string | Seach a particular role, see /categories/roles |
Example:
GET /catalog/singer
Returns a list of titles from a singer search of the catalog.
If the 'refine' query parameter is supplied, a list of links to further refine the search is also included.
Features
- paging - items_per_page=20 by default (maximum 250)
- title expansion
| Parameter | Type | Description |
|---|---|---|
| term | string | The search string |
| refine | comma-separated list | Facet names to provide refinement links to, or the value 'all' to refine all facets.
Supported facets:
|
| role | string | Seach a particular role, see /categories/roles |
Example:
GET /catalog/person
Returns a list of titles from a person search of the catalog.
If the 'refine' query parameter is supplied, a list of links to further refine the search is also included.
Features
- paging - items_per_page=20 by default (maximum 250)
- title expansion
| Parameter | Type | Description |
|---|---|---|
| term | string | The search string |
| refine | comma-separated list | Facet names to provide refinement links to, or the value 'all' to refine all facets.
Supported facets:
|
| role | string | Seach a particular role, see /categories/roles |
Example:
GET /catalog/film
Returns a list of titles from a film search of the catalog.
If the 'refine' query parameter is supplied, a list of links to further refine the search is also included.
Features
- paging - items_per_page=20 by default (maximum 250)
- title expansion
| Parameter | Type | Description |
|---|---|---|
| term | string | The search string |
| refine | comma-separated list | Facet names to provide refinement links to, or the value 'all' to refine all facets.
Supported facets:
|
| genre | string | Seach a particular genre; see /categories/genres |
| format | string | Search a particular format; see /categories/format |
| certificate | string | Restrict the search to a specific certificate; see /categories/certificates/pegi, /categories/certificates/bbfc |
| purchase | string | Search a particular purchase type; see /categories/purchases |
Example:
GET /catalog/tv
Returns a list of titles from a tv search of the catalog.
If the 'refine' query parameter is supplied, a list of links to further refine the search is also included.
Features
- paging - items_per_page=20 by default (maximum 250)
- title expansion
| Parameter | Type | Description |
|---|---|---|
| term | string | The search string |
| refine | comma-separated list | Facet names to provide refinement links to, or the value 'all' to refine all facets.
Supported facets:
|
| genre | string | Seach a particular genre; see /categories/genres |
| format | string | Search a particular format; see /categories/format |
| certificate | string | Restrict the search to a specific certificate; see /categories/certificates/pegi, /categories/certificates/bbfc |
| purchase | string | Search a particular purchase type; see /categories/purchases |
Example:
GET /catalog/title
Returns a list of titles from a title search of the catalog.
If the 'refine' query parameter is supplied, a list of links to further refine the search is also included.
Features
- paging - items_per_page=20 by default (maximum 250)
- title expansion
| Parameter | Type | Description |
|---|---|---|
| term | string | The search string |
| refine | comma-separated list | Facet names to provide refinement links to, or the value 'all' to refine all facets.
Supported facets:
|
| genre | string | Seach a particular genre; see /categories/genres |
| format | string | Search a particular format; see /categories/format |
| certificate | string | Restrict the search to a specific certificate; see /categories/certificates/pegi, /categories/certificates/bbfc |
| purchase | string | Search a particular purchase type; see /categories/purchases |
Example:
GET /catalog/drummer
Returns a list of titles from a drummer search of the catalog.
If the 'refine' query parameter is supplied, a list of links to further refine the search is also included.
Features
- paging - items_per_page=20 by default (maximum 250)
- title expansion
| Parameter | Type | Description |
|---|---|---|
| term | string | The search string |
| refine | comma-separated list | Facet names to provide refinement links to, or the value 'all' to refine all facets.
Supported facets:
|
| role | string | Seach a particular role, see /categories/roles |
Example:
- Previous: API Resources
- Up: API Resources
- Next: Title Resources
3 Comments
Isofarro – 3 years ago
Suggest using underscores instead of spaces in collection URLs, so /catalog/voice_over instead of /catalog/voice over
tehunger – 2 years ago
Paging is done with the start_index=N parameter. N starts at 1.
lewi42 – 2 years ago
I've found that /catalog/tv and /catalog/films seem to return the same results, so if you search for "Dark Knight" on either you get a result and likewise for "Father Ted".
Please sign in to post a comment.