Skip to main content
GET
/
counties
/
search
Search Counties
curl --request GET \
  --url https://api.shovels.ai/v2/counties/search \
  --header 'X-API-Key: <api-key>'
{
  "items": [
    {
      "geo_id": "Q291bnR5XzEyMzQ1",
      "name": "Los Angeles County, CA",
      "state": "CA"
    },
    {
      "geo_id": "A291bnR5XzEyMzQ1",
      "name": "Harris County, TX",
      "state": "TX"
    },
    {
      "geo_id": "B291bnR5XzEyMzQ1",
      "name": "Cook County, IL",
      "state": "IL"
    }
  ],
  "page": 1,
  "size": 3
}

Authorizations

X-API-Key
string
header
required

Query Parameters

q
string
required

The name to search for in the county fields.

Response

A list of counties that match the search text.

Generic paginated response for geographical entities.

items
GeoEntitiesRead · 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.

I