This document is generated by Aladia.

Aladia API

Search States

Developing

GET

/global/states/search

This endpoint searches states using country names and state names.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.aladia.io/v2/global/states/search?name=Amhara Region&countryName=Ethiopia&limit=50&next=&prev=&sortBy=&sortDirection=asc&query=' \
--header 'apikey: '

Response Example

200 - Success

{
  "data": [
    {
      "id": "66dacd0d773e6e2d12a51374",
      "name": "reprehenderit dolorum dolorum",
      "countryName": "provident repellendus illo",
      "stateCode": "est pariatur"
    },
    {
      "id": "66dacd0d773e6e2d12a51377",
      "name": "labore consequatur amet",
      "countryName": "adipisci iste maxime",
      "stateCode": "commodo in deserunt nulla"
    }
  ],
  "cursor": {
    "next": null,
    "prev": null,
    "totalItems": 2
  }
}

Request

Query Params

name

string

optional

Name of the state

Example:

Amhara Region

countryName

string

optional

Country where the state belongs

Example:

Ethiopia

limit

integer

optional

Number of documents per page in the response

Default:

string

optional

Next token cursor, to navigate towards the next page

string

optional

Previous token cursor, to navigate towards the previous page

sortBy

string

optional

Optional field to be used as a sorting reference

sortDirection

enum<string>

optional

Set the results in ascending (asc) or descending (desc) direction

Allowed values:

ascdesc

Default:

asc

query

string

optional

The search query string.

Header Params

apikey

string

optional

Example:

Responses

🟢200Success

application/json

Body

data

array[object (state.model) {6}]

required

string

required

id of the state

name

string

optional

name of the state

countryName

string

optional

country where the state belongs

stateCode

string

optional

the code of the state

latitude

string

optional

Latitiude of the state

longitude

string

optional

Longitude of the state

cursor

object (cursor)

required

string | null

required

string | null

required

totalItems

integer

required

🟠422Parameter Error

Modified at 2025-04-09 13:57:48

List All States

List All Cities