Skip to main content
GET
/
list
/
zip
Get All Available Zip Codes
curl --request GET \
  --url https://api.shovels.ai/v2/list/zip \
  --header 'X-API-Key: <api-key>'
{
  "items": [
    {
      "zip_code": "90001"
    },
    {
      "zip_code": "90002"
    },
    {
      "zip_code": "90003"
    },
    {
      "zip_code": "90004"
    },
    {
      "zip_code": "90005"
    },
    {
      "zip_code": "90006"
    },
    {
      "zip_code": "90007"
    },
    {
      "zip_code": "90008"
    },
    {
      "zip_code": "90009"
    },
    {
      "zip_code": "90010"
    }
  ],
  "size": 50,
  "next_cursor": "example_cursor"
}

Documentation Index

Fetch the complete documentation index at: https://docs.shovels.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
cursor
string | null

Cursor for pagination

​
size
integer
default:50
Required range: 1 <= x <= 100

Response

A list of available ZIP codes

Paginated response for ZIP codes view.

​
items
ZipCodesView · 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.