GET
/
states
/
search
Search States
curl --request GET \
  --url https://api.shovels.ai/v2/states/search \
  --header 'X-API-Key: <api-key>'
{
  "items": [
    {
      "geo_id": "CA",
      "name": "CALIFORNIA"
    },
    {
      "geo_id": "TX",
      "name": "TEXAS"
    },
    {
      "geo_id": "MT",
      "name": "MONTANA"
    }
  ],
  "page": 1,
  "size": 3
}

Authorizations

X-API-Key
string
header
required

Query Parameters

q
string
required

The name to search for in the state fields.

Response

A list of states that match the search term.

Paginated response for states.

items
States · object[]
required

The list of items returned in the response following given criteria.

page
integer
required

The page number of the response.

size
integer
required

The number of items returned in the response.

next_page
integer | null
required

The next page number of the response.