Zip-it API Docs

Try out the endpoints below. Sorry this isn't in Swagger.

/health:

Description

Route to test api health.

Methods:

GET /health

Expected Response:
{"message": "OK"}
Try GET /health

/zip:

Description:

Get details for a single zipcode.

Methods:

GET /zip/{zipcode}

Provide a 5-digit zipcode, like "90210".

Expected Response:
{
    "data": {
        "zip": "90210",
        "lat": "34.10103",
        "lng": "-118.41476",
        "city": "Beverly Hills",
        "state_id": "CA",
        "state_name": "California",
        "zcta": "TRUE",
        "parent_zcta": "",
        "population": "19909",
        "density": "829.1",
        "county_fips": "06037",
        "county_name": "Los Angeles",
        "county_weights": "{'06037':100}",
        "county_names_all": "Los Angeles",
        "county_fips_all": "06037",
        "imprecise": "FALSE",
        "military": "FALSE",
        "timezone": "America/Los_Angeles"
    },
    "source": "https://simplemaps.com/data/us-zips",
    "message": "OK"
}
Try GET /zip/90210

/state:

Description:

Get a detailed list of zip codes in state.

Methods:

GET /state/{state_id}

Provide a capitalized state abbreviation, like 'RI'.

Expected Response:
{
    "data": [
        {
            "zip": "02802",
            "lat": "41.95195",
            "lng": "-71.45534",
            "city": "Albion",
            "state_id": "RI",
            "state_name": "Rhode Island",
            "zcta": "TRUE",
            "parent_zcta": "",
            "population": "671",
            "density": "1552.1",
            "county_fips": "44007",
            "county_name": "Providence",
            "county_weights": "{'44007':100}",
            "county_names_all": "Providence",
            "county_fips_all": "44007",
            "imprecise": "FALSE",
            "military": "FALSE",
            "timezone": "America/New_York"
        },
        {
            "zip": "02804",
            "lat": "41.43188",
            "lng": "-71.77236",
            "city": "Ashaway",
            "state_id": "RI",
            "state_name": "Rhode Island",
            "zcta": "TRUE",
            "parent_zcta": "",
            "population": "2004",
            "density": "99.7",
            "county_fips": "44009",
            "county_name": "Washington",
            "county_weights": "{'44009':100}",
            "county_names_all": "Washington",
            "county_fips_all": "44009",
            "imprecise": "FALSE",
            "military": "FALSE",
            "timezone": "America/New_York"
        },
        ... (75 more zipcodes)
    ],
    "source": "https://simplemaps.com/data/us-zips",
    "message": "OK"
}
Try GET /state/RI