Get choosable states
Returns all states or administrative regions for the specified country.
State names are returned according to the data stored for the country. The country is selected using its country code.
If no states are found for the specified country, the endpoint returns HTTP 200 with an empty data array.
/api/choosable-statescountry-codestringCountry code used to select the states or administrative regions. Defaults to an empty string.
States found, or no states available for the specified country.
servicestringrequiredName of the API service.
api_versionstringrequiredAPI version.
response_typestringrequiredIdentifier of the response type.
statusintegerrequiredHTTP status code of the response.
200timestampstring<date-time>requiredTime at which the response was generated.
metadataGetChoosableStates.ChoosableStatesMetadataMetadata returned by the choosable states endpoint.
Show propertiesHide properties
country_codestringCountry code used to select the states.
state_countintegerNumber of states or administrative regions returned.
response_time_msintegerServer-side response time in milliseconds.
dataGetChoosableStates.State[]requiredList of states or administrative regions.
Show propertiesHide properties
GetChoosableStates.Statestate_codestring | anyrequiredCode identifying the state or administrative region.
Show propertiesHide properties
stringanystate_namestring | anyrequiredName of the state or administrative region.
Show propertiesHide properties
stringanymessagestringHuman-readable response message.
Internal server error.
servicestringrequiredName of the API service.
api_versionstringrequiredAPI version.
response_typestringrequiredIdentifier of the response type.
statusintegerrequiredHTTP status code of the response.
500timestampstring<date-time>requiredTime at which the response was generated.
metadataGetChoosableStates.ChoosableStatesMetadataMetadata returned by the choosable states endpoint.
Show propertiesHide properties
country_codestringCountry code used to select the states.
state_countintegerNumber of states or administrative regions returned.
response_time_msintegerServer-side response time in milliseconds.
dataanyResponse payload.
Show propertiesHide properties
anyanymessagestringHuman-readable response message.