Interested in working with us? We offer a superb REMOTE work opportunity for a WEB ENGINEER.
- Request and Response Format
- Charset (UTF-8)
- Rate Limiting
- Command Line Tools Used in Examples
All API access is over HTTPS, and accessed from
api.spreaker.com. The current API version is v2, so each API URL will start with:
Spreaker APIs use OAuth2 to handle user authentication. See Authentication to understand how you can obtain a valid OAuth2 token to perform API requests on behalf of the user.
In general, all
DELETE requests MUST be authenticated in order to succeed.
GET requests do not require authentication unless otherwise documented.
Once you have a valid token, you can use it in two different ways:
#### OAuth2 Token (sent in a header)
OAuth2 Token (sent as a parameter)
Authenticating with invalid credentials will return as
Request and Response Format
All data is received as JSON and wrapped in a
Example: Successful Response
If there are any errors, you will receive the most appropriate
5xx HTTP status code and the
response will include an
error object containing one or more error messages.
Example: Error Response
All timestamps are in
YYYY-MM-DD HH:MM:SS format and in the UTC timezone, except where otherwise stated.
Spreaker APIs currently support only UTF-8 charset encoding. Please, make sure your request body data is encoded in UTF-8.
Requests that return multiple items are paginated. The responses will contain
items, an array of JSON objects, and
next_url, the URL of the next “page” of data.
By default, each “page” contains 50 items. You can customize this value using the
limit query parameter to request up to 100 items.
Each API can use a different parameter to select a “page”. That way the response will contain the
You should use that particular URL for loading more content instead of constructing your own.
Some Spreaker APIs return content that can be localized, passing a supported culture via the
GET /v2/show-categories returns all available show categories in English by default, but you can get Italian category name translations by invoking:
Spreaker APIs adopt a rate limiting policy. We kindly ask you to play nicely with our APIs, and you should never hit the rate limit. In case you do hit the limit, your IP address will be temporarily blacklisted and each subsequent API request will result in the
429 Too Many Requests response.
Command Line Tools Used in Examples
Looking at the examples you can find the following command-line tools: