GET
/
cities
/
search
curl --request GET \
  --url https://api.shovels.ai/v2/cities/search \
  --header 'X-API-Key: <api-key>'
{
  "items": [
    {
      "geo_id": "Q2l0eV8xMjM0NQ",
      "name": "SAN FRANCISCO, SAN FRANCISCO, CA",
      "state": "CA"
    },
    {
      "geo_id": "A22eV8yMzQ1Ng",
      "name": "SAN RAMON, CONTRA COSTA COUNTY, CA",
      "state": "CA"
    },
    {
      "geo_id": "B2l0eV8yMzQ1rr",
      "name": "SAN DIEGO, SAN DIEGO COUNTY, CA",
      "state": "CA"
    }
  ],
  "page": 1,
  "size": 3
}

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
q
string
required

The name to search for in the city fields.

Response

200
application/json

A list of cities that match the search text.

Generic paginated response for geographical entities.