countries

Get list of Countries

Get list of Country records. All parameters are optional

get/v3/countries/

Query parameters

id_ininteger[]

Multiple values may be separated by commas.

iso_alpha2_instring[]

Multiple values may be separated by commas.

iso_alpha3_instring[]

Multiple values may be separated by commas.

orderingstring[]

Ordering fields: id, name, iso_alpha2, iso_alpha3

  • id - id
  • -id - id (descending)
  • name - Country name
  • -name - Country name (descending)
  • iso_alpha2 - Country ISO 3166-1 alpha-2
  • -iso_alpha2 - Country ISO 3166-1 alpha-2 (descending)
  • iso_alpha3 - Country ISO 3166-1 alpha-3
  • -iso_alpha3 - Country ISO 3166-1 alpha-3 (descending)
pageinteger

A page number within the paginated result set.

searchstring

Search by country name, ISO 3166-1 alpha-2 and ISO 3166-1 alpha-3 codes

Response

countinteger
nextstring uri nullable
previousstring uri nullable
per_pageinteger

Example response

{
  "count": 123,
  "next": "http://api.example.org/example_page/?page=4",
  "previous": "http://api.example.org/example_page/?page=2",
  "per_page": 20
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.