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": "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"
    }
  ],
  "size": 3
}

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.

​
total_count
TotalCount · object

Total result count (capped at 10,000). Present on first-page responses when include_count=true. null if the count query timed out.