API: Search
In this page
About the Search API
The Search API is optimized to help you find the specific item you’re looking for (e.g., a specific episode, a specific show, etc.). Think of it the way you would when performing a Google search.
Ranking Search Results
Results are sorted according to the best match. Multiple factors are combined to boost the most relevant item to the top of the list of results.
Entrypoint and Parameters
The entrypoint is /v2/search
and the list of supported parameters is here below.
The API response is paginated.
Parameter | Required | Type | Description |
---|---|---|---|
q |
Yes | String | The query, keyword that each result matches |
type |
Yes | String | The kind of entity returned. Supported values are episodes and shows |
limit |
No | Number | Number of items returned in each page |
Searching Shows
Find shows matching the input query.
This method returns a paginated response of Shows, with up to 100 results per page.
Example
Searching Shows by Author
Find shows, created by the USER-ID
, matching the input query.
This method returns a paginated response of Shows, with up to 100 results per page.
Parameter | Type | Description |
---|---|---|
filter |
String | Filters episodes by listenable or editable (defaults to listenable ). If you specify filter=editable the request must be authenticated with USER-ID credentials. |
Example
Searching Episodes
Find episodes matching the input query.
This method returns a paginated response of Episodes, with up to 100 results per page.
Example
Searching Episodes by Author
Find episodes, created by the USER-ID
, matching the input query.
This method returns a paginated response of Episodes, with up to 100 results per page.
Parameter | Type | Description |
---|---|---|
filter |
String | Filters episodes by listenable or editable (defaults to listenable ). If you specify filter=editable the request must be authenticated with USER-ID credentials. |
Example
Searching Episodes by Show
Find episodes belonging to a SHOW-ID
, matching the input query.
This method returns a paginated response of Episodes, with up to 100 results per page.
Parameter | Type | Description |
---|---|---|
filter |
String | Filters episodes by listenable or editable (defaults to listenable ). If you specify filter=editable the request must be authenticated with SHOW-ID owner credentials. |