Skip to main content
GET
/
cities
/
search
Search Cities
curl --request GET \
  --url https://api.shovels.ai/v2/cities/search \
  --header 'X-API-Key: <api-key>'
{
  "items": [
    {
      "geo_id": "<string>",
      "name": "<string>",
      "state": "<string>"
    }
  ],
  "size": 123,
  "next_cursor": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
q
string
required

The name to search for in the city fields.

Response

A list of cities that match the search text.

Paginated response for geographical entities.

​
items
GeoEntitiesRead · object[]
required

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

​
size
integer
required

The number of items returned in the response.

​
next_cursor
string | null
required

The cursor for retrieving the next page of results.