Docs

Numbers

Countries

Pass either the catalog code or ISO-2 on rent and catalog requests. United States is the default.

Catalog code or ISO-2

List countries with GET /api/v1/countries (or GET /api/public/countries, no key). Each row has a catalog code and ISO-2 iso. Either is accepted as country.

  • United States: 187 or US (default)
  • United Kingdom: 16 or GB
  • Most other countries use ISO-2 directly (IN, DE, …)

Do not omit the field and assume a country

If you send an unknown value, the API returns INVALID_COUNTRY. Omitted country defaults to the US catalog (187 / US).

Which kinds are available

  • S.1 is US-only.
  • S.2 and S.5 are available in many countries — check kinds on the country list.

Endpoints

GET/api/v1/countries

List countries

Countries you can pass as country=US or country=187. kinds lists which short-term types are offered there.

Response

JSON
{
  "default": "187",
  "count": 120,
  "countries": [
    { "code": "187", "iso": "US", "name": "United States", "kinds": ["s1", "s2", "s5"] }
  ]
}
GET/api/public/countriesPublic

List countries (public)

Same country list, no API key.