List and filter countries

get https://api.referential.io/v1/country

All provided query parameters are compounding (AND)

Query Params

name

string

search by name using 'contains' in the specified language, english by default

prefix

string

search by name using "begins with" in the specified language, english by default

continent

string

search by continent name using 'contains' in the specified language, english by default

continent_code

string

search by two letter iso continent code using 'contains'

iso_a2

string

search by exact match two letter iso a2 country code

iso_a3

string

search by contains three letter iso a3 country code

dial_code

integer

search by dial_code using 'contains'

currency

string

find by currency using 'contains'

currency_code

string

find country on two letter iso currency code using 'contains'

currency_num_code

string

find country on two three digit iso currency num code using 'contains'

iso_code

string

find country on two three digit iso currency num code using 'contains'

lang

string

Defaults to en

two letter iso code in what language to return results in, if available, otherwise in english

string

ip address v4 or v6 of the resource you want to locate

limit

integer

1 to 1000

integer limit of results returned. 1000 max.

order

string

Defaults to asc

sort direction of results by value of 'sort' field. one of asc or desc.

fields

string

comma delimited list of additional fields for each city in result. Any of iso_a2,timezone,state_code,state_hasc. By default returns city id and name in chosen language

Responses

404

The query has no results. Check your parameters in case there are any spelling issues. The language requested may not be supported.

5XX

Server error, probably a bug.

200Succeefully list countries