Contents

Endpoints

Countries

Operations about the countries served

Relative to https://uk-cinema-api.co.uk/api/v4.

Get countries

GET/countries

Get every country the API serves, and whether your key includes it. Without a country parameter, every other endpoint reads the countries your key includes.

Response

200 Returns the countries served. (CountriesResponse)

Errors: 400, 401, 403, 429, 500
  • 400 Bad request – e.g. an invalid cursor, a country the API does not serve, a filter that is not valid, or a query parameter that the endpoint does not have. The message names the parameter.
  • 401 Unauthorized – the request requires valid authentication.
  • 403 Forbidden – authentication succeeded but access is denied (e.g., expired subscription, or a country your key does not include).
  • 429 Too Many Requests – the limit is 5 requests per second for a Pro key. A key with Ultra in one or more countries has 20. A key with Lite in all its countries has 1, and 1000 requests each day. The day starts at 00:00 UTC. The limit is for the key, not for each country. The error message gives the limit that applied.
  • 500 Internal Server Error – something went wrong on our end.
Example response
{
  "meta": {
    "total_count": 2
  },
  "data": [
    {
      "iso_code": "GB",
      "name": "United Kingdom",
      "is_access_granted": true,
      "tier": "ultra"
    },
    {
      "iso_code": "IE",
      "name": "Ireland",
      "is_access_granted": false,
      "tier": null
    }
  ]
}