List states and provinces

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

Get a list of up to 1000 states matching optional query filter critiera in the specified language sorted alphabetically by name

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

iso_a2

string

search by exact match two letter iso a2 country code

lang

string

Defaults to en

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

state_code

string

search by exact match on state code of state (will return 0 or 1 result)

state_hasc

string

search by exact match hasc state code of state (will return 0 or 1 result)

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 result.

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.

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://api.referential.io/v1/state?lang=en&order=asc' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successfully list states