GET
/
list
/
zip
curl --request GET \
  --url https://api.shovels.ai/v2/list/zip \
  --header 'X-API-Key: <api-key>'
{
  "items": [
    {
      "zip_code": "90001",
      "zip_code_exts": [
        "1234",
        "1235"
      ]
    },
    {
      "zip_code": "90002",
      "zip_code_exts": [
        "1235",
        "1236"
      ]
    },
    {
      "zip_code": "90003",
      "zip_code_exts": [
        "1236",
        "1237"
      ]
    },
    {
      "zip_code": "90004",
      "zip_code_exts": [
        "1237",
        "1238"
      ]
    },
    {
      "zip_code": "90005",
      "zip_code_exts": [
        "1334",
        "1335"
      ]
    },
    {
      "zip_code": "90006",
      "zip_code_exts": [
        "1434",
        "1435"
      ]
    },
    {
      "zip_code": "90007",
      "zip_code_exts": [
        "1534",
        "1535"
      ]
    },
    {
      "zip_code": "90008",
      "zip_code_exts": [
        "1634",
        "1635"
      ]
    },
    {
      "zip_code": "90009",
      "zip_code_exts": [
        "1734",
        "1735"
      ]
    },
    {
      "zip_code": "90010",
      "zip_code_exts": [
        "1834",
        "1835"
      ]
    }
  ],
  "page": 1,
  "size": 50,
  "next_page": 2
}

Authorizations

​
X-API-Key
string
header
required

Query Parameters

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

Response

200
application/json
A list of available ZIP codes
​
items
object[]
required

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

ZIP codes and ZIP code extensions that appear on permits.

​
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.

Was this page helpful?