API Documentation

Introduction

The ZIP Codes API v2 provides comprehensive postal code data for the United States and Canada. Look up ZIP codes, calculate distances, search by radius, and enrich results with census demographics, political districts, school districts, and more.

All API endpoints live under the /v2/ prefix. Responses use a consistent JSON envelope with built-in error handling and credit tracking.

Key Features

• US ZIP & ZIP+4 lookups with demographics, delivery points, and business data
• Canadian FSA & postal code lookups with province-level data
• Radius search with cross-border support (US + Canada)
• Distance calculation between any combination of ZIP codes, FSAs, postal codes, and coordinates
• 11 opt-in enrichments including ACS demographics, census boundaries, political districts, school districts, timezone, and more
• Batch processing up to 100 items per request

Authentication

All API requests require a valid API key. You can pass it in two ways:

Option 1: HTTP Header (recommended)

X-Api-Key: your_api_key

Option 2: Query Parameter

GET /v2/quick-zip?code=90210&key=your_api_key

Request & Response Format

Quick Start

Make your first API call in seconds:

curl -H "X-Api-Key: YOUR_API_KEY" \
  "https://api.zip-codes.com/v2/quick-zip?code=90210"

import requests

resp = requests.get(
    "https://api.zip-codes.com/v2/quick-zip",
    params={"code": "90210"},
    headers={"X-Api-Key": "YOUR_API_KEY"}
)
data = resp.json()
print(data["results"][0]["city"])  # Beverly Hills

const resp = await fetch(
  "https://api.zip-codes.com/v2/quick-zip?code=90210",
  { headers: { "X-Api-Key": "YOUR_API_KEY" } }
);
const data = await resp.json();
console.log(data.results[0].city); // Beverly Hills

Your Dashboard

The API Portal dashboard gives you full control over your account:

• API Keys — Create, rotate, and configure keys with per-key IP whitelisting and CORS origin restrictions.
• Usage Analytics — Daily and monthly usage charts, per-key breakdowns, and CSV export for your records.
• Billing — Manage your subscription tier, purchase credit packs, and download invoices.
• Settings — Update account details and notification preferences.

Free tier accounts start with 2,500 credits/day. Sign in to get started →

Response Format

Every API response follows a consistent envelope structure:

{
  "success": true,
  "request": { "code": "90210", "include": ["timezone"] },
  "results": ["..."],
  "error": null,
  "meta": {
    "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "version": "2.0.0",
    "timing_ms": 45,
    "credits": { "used": 2, "remaining": 74998, "breakdown": { "base": 1, "enrichments": { "timezone": 1 } } },
    "notices": []
  }
}

Notices

The meta.notices array contains non-error informational messages about request processing:

Address Matching BETA

Parse and validate a raw US street address against USPS ZIP+4 delivery-point data. Returns the standardized address, ZIP+4 code, address components, and delivery metadata. Handles partial input — city and state are optional when unambiguous.

Parameters

Credit Cost

Fixed 1 credit per request, whether or not a match is found.

Example Request

curl -H "X-Api-Key: YOUR_API_KEY" \
  "https://api.zip-codes.com/v2/address?address=350+5th+Ave%2C+New+York+NY+10118"

Example Response

{
  "success": true,
  "request": { "address": "350 5th Ave, New York NY 10118" },
  "results": [{
    "input": "350 5th Ave, New York NY 10118",
    "success": true,
    "matches": [{
      "formatted_address": "350 5TH AVE, NEW YORK, NY 10118-0110",
      "address_line1": "350 5TH AVE",
      "address_line2": "NEW YORK, NY 10118-0110",
      "address_components": {
        "number": "350",
        "pre_directional": null,
        "street": "5TH",
        "street_pre_type": null,
        "suffix": "AVE",
        "post_directional": null,
        "secondary_type": null,
        "secondary_number": null,
        "city": "NEW YORK",
        "state": "NY",
        "zip": "10118",
        "plus4": "0110",
        "country": "US"
      },
      "match_info": {
        "confidence": "high",
        "match_path": "zip_street",
        "candidates_evaluated": 4
      },
      "details": {
        "record_type": "H",
        "record_type_description": "Highrise",
        "carrier_route": "C049",
        "county_fips": "36061",
        "congressional_district": "12",
        "building_name": "EMPIRE STATE BUILDING",
        "government_building": false
      }
    }]
  }],
  "meta": { "version": "2.0.0", "timing_ms": 3, "credits": { "used": 1, "remaining": 74999 }, "notices": [] }
}

Result Fields

Match Object

Address Components

Match Info

Details (USPS Metadata)

Geographic Suggest

Typeahead search for geographic entities. Returns ZIP codes, cities/places, counties, metro areas (CBSAs), states/provinces, and Canadian FSAs matching a prefix query. Results include authoritative identifiers (FIPS, GEOID), coordinates, bounding boxes, and population data.

Parameters

Entity Types

Credit Cost

Billing based on requested limit, not results returned. Free tier requests above 15 are clamped with a FREE_TIER_LIMIT_CAPPED notice. Validation errors (missing q, invalid include) cost 0 credits.

Example Request

curl -H "X-Api-Key: YOUR_API_KEY" \
  "https://api.zip-codes.com/v2/suggest?q=spring&limit=3"

Example: With proximity bias

curl -H "X-Api-Key: YOUR_API_KEY" \
  "https://api.zip-codes.com/v2/suggest?q=spring&proximity=40.7128,-74.006&limit=3"

Example: Filtered by type and state

curl -H "X-Api-Key: YOUR_API_KEY" \
  "https://api.zip-codes.com/v2/suggest?q=cook&include=county&state=IL"

Example Response

{
  "success": true,
  "request": { "q": "spring", "limit": 3 },
  "results": [{ "success": true, "data": { "total_matched": 127, "matches": [
    { "type": "place", "name": "Springfield", "state": "MO", "country": "US", "population": 169176, "location": { "lat": 37.209, "lon": -93.2923 } },
    { "type": "zip", "name": "77373", "state": "TX", "country": "US", "city": "Spring", "population": 54298 },
    { "type": "cbsa", "name": "Springfield, MO", "state": "MO", "cbsa_code": "44180", "population": 478315 }
  ] } }],
  "meta": { "version": "2.0.0", "timing_ms": 2, "credits": { "used": 1, "remaining": 74999 }, "notices": [] }
}

Match Object Fields

Quick ZIP Lookup

Fast postal code lookup returning basic location data with optional timezone enrichment. Supports US ZIP codes (5-digit), US ZIP+4 codes, Canadian FSAs (3-character), full Canadian postal codes (6-character), and latitude/longitude coordinates for reverse geocoding.

Parameters

Supported Code Types

Available Enrichments

Credit Cost

ZIP and FSA = 1 base credit. ZIP+4 and Postal Code = 2 base credits. Coordinates add +1 to the resolved code’s cost. Each include flag adds +1 credit.

Response Fields

ZIP+4 Detail Fields

When a ZIP+4 code is looked up, the detail object is populated with delivery-point data:

Street Detail Fields

Street-level address range information within the detail.street object:

Example Request

curl -H "X-Api-Key: YOUR_API_KEY" \
  "https://api.zip-codes.com/v2/quick-zip?code=90210&include=timezone"

Example Response

{
  "success": true,
  "request": { "code": "90210", "include": ["timezone"] },
  "results": [{
    "code": "90210", "code_type": "ZIP", "country": "US",
    "city": "Beverly Hills", "state": "CA", "state_name": "California",
    "county": "Los Angeles", "county_fips": "06037",
    "location": { "lat": 34.103131, "lon": -118.416253 },
    "timezone": { "iana_name": "America/Los_Angeles", "name": "Pacific", "abbreviation": "PST", "utc_offset": -8, "observes_dst": true }
  }],
  "meta": { "version": "2.0.0", "timing_ms": 23, "credits": { "used": 2, "remaining": 74998 }, "notices": [] }
}

{
  "success": true,
  "request": { "code": "M5V", "include": ["timezone"] },
  "results": [{
    "code": "M5V", "code_type": "FSA", "country": "CA",
    "city": "Toronto", "state": "ON", "state_name": "Ontario",
    "location": { "lat": 43.638388, "lon": -79.40428 },
    "timezone": { "iana_name": "America/Toronto", "name": "Eastern", "utc_offset": -5, "observes_dst": true }
  }],
  "meta": { "version": "2.0.0", "timing_ms": 15, "credits": { "used": 2, "remaining": 74998 }, "notices": [] }
}

{
  "success": true,
  "request": { "code": "99999", "include": [] },
  "results": [],
  "error": { "code": "NOT_FOUND_ZIP", "message": "US ZIP code 99999 not found." },
  "meta": { "version": "2.0.0", "timing_ms": 8, "credits": { "used": 1, "remaining": 74999 }, "notices": [] }
}

ZIP Code Details

Comprehensive postal code lookup with rich data including demographics, business statistics, delivery points, and up to 11 optional enrichments. Returns detailed information for US ZIP codes and Canadian postal codes.

Parameters

Available Enrichments

Credit Cost

ZIP and FSA = 1 base credit. ZIP+4 and Postal Code = 2 base credits. Coordinates add +1 to the resolved code’s cost. Each include flag adds +1 credit. Example: include=timezone,census,cd on a ZIP = 4 credits.

Example Request

curl -H "X-Api-Key: YOUR_API_KEY" \
  "https://api.zip-codes.com/v2/zip?code=90210&include=timezone,demographics"

Example Response

{
  "success": true,
  "request": { "code": "90210", "include": ["timezone", "demographics"] },
  "results": [{
    "country": "US", "code": "90210", "code_type": "ZIP",
    "city": "Beverly Hills", "state": "CA", "state_name": "California",
    "county": "Los Angeles", "county_fips": "06037",
    "location": { "lat": 34.102823, "lon": -118.414661 },
    "area_codes": ["310", "323", "424", "738"],
    "elevation": { "ft": 719, "m": 219 },
    "metro": { "region": "West", "division": "Pacific", "msa": "31080", "msa_name": "Los Angeles-Long Beach-Anaheim, CA" },
    "zip_info": { "classification": "G", "classification_name": "General", "land_area_sq_mi": 10.9748, "delivery_points": { "total_active": 10634 } },
    "demographics": { "population": { "total": 21134 }, "households": { "median_income": 190382 } },
    "timezone": { "zones": [{ "iana_name": "America/Los_Angeles", "name": "Pacific", "utc_offset": -8, "pct_of_zip": 100.0 }] }
  }],
  "meta": { "version": "2.0.0", "timing_ms": 87, "credits": { "used": 3, "remaining": 74997 }, "notices": [] }
}

Base Fields (always included)

metro Sub-Fields (US only)

postal_info Sub-Fields (CA only)

Radius Search

Find all postal codes within a given radius of a center point. Specify the center via a single code parameter (ZIP, FSA, Postal Code, or lat,lon coordinates). Cross-border searches automatically include Canadian FSAs. Supports donut searches (min radius) and result limiting.

Parameters

Available Enrichments

Credit Cost

Centroid mode (default, faster): Wider bands — the first 100 miles costs 1 base credit, the next 100 costs 2, and so on up to 500 miles.

Spatial mode (precise boundaries): Narrower bands — the first 50 miles costs 1 base credit, the next 50 costs 2, and so on up to 250 miles.

Each enrichment flag you add multiplies the base.

Auto Radius

Instead of specifying a numeric radius, pass max=auto or max=auto-commute to let the API calculate an appropriate search radius for the center point. This requires a ZIP, FSA, or Postal code center (not lat/lon coordinates).

Credit cost: Using auto-radius counts as one additional data layer in the cost calculation. Example: max=auto with include=timezone = base × 3 data layers = 3 credits for a short-range search.

Example Request

curl -H "X-Api-Key: YOUR_API_KEY" \
  "https://api.zip-codes.com/v2/radius?code=48226&max=25&include=timezone"

Example Response

{
  "success": true,
  "request": { "code": "48226", "max": 25, "min": 0, "include": ["timezone"], "mode": "centroid" },
  "results": [{ "search": { "center": { "code": "48226", "city": "DETROIT", "state": "MI", "location": { "lat": 42.33, "lon": -83.05 } }, "max": 25, "mode": "centroid" },
    "matches": [
      { "country": "US", "code": "48226", "city": "Detroit", "state": "MI", "distance_miles": 0.0, "timezone": { "iana_name": "America/Detroit" } },
      { "country": "US", "code": "48233", "city": "Detroit", "state": "MI", "distance_miles": 0.47 },
      { "country": "CA", "code": "N9A", "city": "Windsor", "state": "ON", "distance_miles": 1.6 }
    ] }],
  "meta": { "version": "2.0.0", "timing_ms": 312, "credits": { "used": 2, "remaining": 74998 }, "notices": [] }
}

Search Fields

Match Fields

Distance Calculation

Calculate the great-circle distance between two points. Supports any combination of ZIP codes, ZIP+4 codes, FSAs, full Canadian postal codes, and lat/lon coordinates. Timezone data is always included at no extra cost. Each endpoint in the response includes an input_type field ("code" or "coordinates") indicating how the point was resolved.

Parameters

Credit Cost

Fixed 1 credit per pair. Timezone is always included at no extra cost.

Example Request

curl -H "X-Api-Key: YOUR_API_KEY" \
  "https://api.zip-codes.com/v2/distance?from=90210&to=10001"

Example Response

{
  "success": true,
  "request": { "from": "90210", "to": "10001" },
  "results": [{
    "from": { "country": "US", "code": "90210", "city": "BEVERLY HILLS", "state": "CA", "location": { "lat": 34.1028, "lon": -118.4147 }, "timezone": { "iana_name": "America/Los_Angeles" } },
    "to": { "country": "US", "code": "10001", "city": "NEW YORK", "state": "NY", "location": { "lat": 40.7502, "lon": -73.9971 }, "timezone": { "iana_name": "America/New_York" } },
    "distance": { "miles": 2453.39, "km": 3948.3 },
    "bearing": 65.9
  }],
  "meta": { "version": "2.0.0", "timing_ms": 31, "credits": { "used": 1, "remaining": 74999 }, "notices": [] }
}

Health Check

Returns API and database health status. No authentication required.

Three-state health: healthy (normal), degraded (DB latency >500ms), unhealthy (DB unreachable, returns HTTP 503).

{
  "success": true,
  "data": { "status": "healthy", "database": { "connected": true, "latency_ms": 3 }, "version": "2.0.0" },
  "meta": { "version": "2.0.0", "timing_ms": 5, "notices": [] }
}

Batch Requests

All four lookup endpoints support batch processing via POST. Send up to 100 items per request. Individual items can succeed or fail independently (the overall HTTP status is 200 even if some items fail).

Batch Response Meta

{
  "meta": {
    "batch": { "requested": 3, "succeeded": 2, "failed": 1 },
    "credits": { "used": 3, "remaining": 74997 },
    "notices": []
  }
}

Batch Endpoints

Example: Quick ZIP Batch

curl -X POST "https://api.zip-codes.com/v2/quick-zip/batch" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"codes": ["90210", "M5V", "99999"], "include": "timezone"}'

Partial Failure

When some items fail, the overall HTTP status is still 200. Failed items appear in the results array with success: false and a per-item error object. The meta.batch summary tells you how many succeeded and failed:

{
  "success": true,
  "results": [
    { "success": true, "code": "90210", "city": "Beverly Hills", "state": "CA", "..." : "..." },
    { "success": true, "code": "M5V", "city": "Toronto", "state": "ON", "...": "..." },
    { "success": false, "code": "99999", "error": { "code": "NOT_FOUND_ZIP", "message": "US ZIP code not found" } }
  ],
  "meta": { "batch": { "requested": 3, "succeeded": 2, "failed": 1 }, "credits": { "used": 3, "remaining": 74997 }, "notices": [] }
}

Data Enrichments

All enrichments are opt-in. Add them to the include parameter as a comma-separated list. Each enrichment adds 1 credit to the cost. Without any enrichment flags, you get base data only (1 credit).

Timezone

Returns IANA timezone data including standard and daylight saving abbreviations and UTC offsets. In the /v2/zip endpoint, returns an object with source and a zones array with percentage overlap when a ZIP code spans multiple timezones. On other endpoints, timezone is a flat object per result.

Fields Returned

{
  "source": "IANA Time Zone Database / timezone-boundary-builder",
  "zones": [{
    "iana_name": "America/Los_Angeles", "name": "Pacific",
    "abbreviation": "PST", "abbreviation_dst": "PDT",
    "utc_offset": -8, "utc_offset_dst": -7, "observes_dst": true, "pct_of_zip": 100.0
  }]
}

Census Boundaries

Returns all census geographic boundaries that overlap the ZIP code with percentage overlap calculations. Data sourced from Census Bureau TIGER/Line Cartographic Boundaries.

Included Boundary Types

Each boundary includes: geoid, name, land_area_sq_mi, water_area_sq_mi, pct_of_zip (% of ZIP this boundary covers), and pct_of_area (% of boundary this ZIP covers).

{
  "census": {
    "county": [{ "geoid": "06037", "name": "Los Angeles County", "pct_of_zip": 100.0, "pct_of_area": 0.3 }],
    "place": [{ "geoid": "0606000", "name": "Beverly Hills city", "pct_of_zip": 49.3, "pct_of_area": 95.1 }],
    "tract": [{ "geoid": "06037700900", "name": "Census Tract 7009", "pct_of_zip": 10.2 }],
    "metro_micro_cbsa_statistical_area": [{ "geoid": "31080", "name": "Los Angeles-Long Beach-Anaheim, CA Metro Area", "pct_of_zip": 100.0 }]
  }
}

Congressional Districts

Returns congressional district overlaps for the current Congress session, with primary district identification and area percentages.

Fields Returned (US)

Fields Returned (CA)

Canadian codes return federal_electoral_district with uid, name, and pct_of_zip.

{
  "congressional_district": {
    "congress": 119,
    "districts": [
      { "geoid": "0632", "state": "CA", "district_number": 32, "name": "Congressional District 32", "pct_of_zip": 62.9 },
      { "geoid": "0636", "state": "CA", "district_number": 36, "name": "Congressional District 36", "pct_of_zip": 37.1 }
    ],
    "primary": { "geoid": "0632", "state": "CA", "district_number": 32 }
  }
}

State Legislature

Returns state senate (upper chamber) and assembly/house (lower chamber) district overlaps with area percentages. US only

Fields Returned

Each district includes: geoid, name, district_code, state, state_fips, legislative_session_year, land_area_sq_mi, water_area_sq_mi, pct_of_zip, pct_of_area.

{
  "state_legislative_upper": [{ "geoid": "06024", "name": "24", "name_full": "State Senate District 24", "state": "CA", "pct_of_zip": 92.9 }],
  "state_legislative_lower": [{ "geoid": "06051", "name": "51", "name_full": "Assembly District 51", "state": "CA", "pct_of_zip": 63.5 }]
}

School Districts

Returns NCES school district data with boundary overlaps. US only

Fields Returned per District

{
  "school_district": {
    "source": "National Center for Education Statistics (NCES)", "school_year": "2024-2025",
    "districts": [{
      "leaid": "0604830", "name": "Beverly Hills Unified School District",
      "type": "unified", "grade_low": "KG", "grade_high": "12",
      "pct_of_zip": 39.9, "pct_of_area": 72.8,
      "office": { "address": "624 N. Rexford Dr.", "city": "Beverly Hills", "state": "CA", "zip": "90210" },
      "locale": { "code": "21", "description": "Suburb - Large" }
    }]
  }
}

ACS Data

American Community Survey 5-year estimates from the Census Bureau. Four separate data profiles available, each activated by its own flag. US only

All ACS fields include an estimate (est) and margin of error (moe). Percentage fields also include pct and pct_moe. Suppressed Census values are returned as null.

acs_demographic — DP05 (108 fields)

acs_social — DP02 (154 fields)

acs_economic — DP03 (137 fields)

acs_housing — DP04 (143 fields)

Historical ACS Data (2011–2024)

Append _YYYY to any ACS profile flag to request a specific year. Example: include=acs_housing_2022 returns the 2018–2022 5-Year Estimates for housing. You can request multiple years simultaneously (e.g., include=acs_economic,acs_economic_2019). Each flag costs +1 credit.

{
  "acs": {
    "geo_id": "860Z200US90210", "year": 2024,
    "product": "ACS 5-Year Estimates Data Profiles", "vintage": "2020-2024",
    "tables": { "demographic": "DP05", "social": "DP02", "economic": "DP03", "housing": "DP04" },
    "demographic": {
      "total_population": { "est": 21134, "moe": 82 },
      "sex_and_age": { "male": { "est": 10099, "pct": 47.8 }, "female": { "est": 11035, "pct": 52.2 }, "median_age": { "est": 49.3 } },
      "race": { "white": { "est": 17130, "pct": 81.1 }, "black_or_african_american": { "est": 366, "pct": 1.7 }, "asian": { "est": 1406, "pct": 6.7 } }
    }
  }
}

Demographics

Returns population, race, age, household, and business establishment data. Sourced from US Census Bureau and IRS Business Master File data.

Fields Returned

{
  "demographics": {
    "population": { "total": 21134, "estimate": 22943, "male": 10099, "female": 11035 },
    "race": { "white": 17130, "black": 366, "hispanic": 1296, "asian": 1406 },
    "age": { "median": 49.3 },
    "households": { "total": 8792, "median_income": 136490, "average_home_value": 1953100 },
    "business": { "establishments": 3142, "employees": 28853 }
  }
}

Medicare

Returns Medicare geographic identifiers used in healthcare pricing, insurance rating areas, and CMS administrative boundaries.

Fields Returned

{
  "medicare": {
    "cbsa_code": "31080", "cbsa_name": "Los Angeles-Long Beach-Anaheim, CA",
    "cbsa_type": "Metropolitan", "rating_area_id": "16", "ssa_state_county_code": "05210"
  }
}

Credit Costs

Radius Credit Costs

Formula: base × (1 + enrichment_count). Base bands differ by mode.

Centroid Mode (default) — ceil(radius / 100), max 500mi

Spatial Mode — ceil(radius / 50), max 250mi

Band boundaries are inclusive at the top: max=50 = band 1, max=51 = band 2. Decimal values are accepted: max=50.5 = band 2.

Formula Examples

• 25mi centroid, no flags → ceil(25/100) × (1 + 0) = 1 credit
• 25mi centroid, timezone → 1 × (1 + 1) = 2 credits
• 100mi centroid, acs_demographic + timezone → 1 × (1 + 2) = 3 credits
• 200mi centroid, 4 ACS flags → 2 × (1 + 4) = 10 credits
• 500mi centroid, 4 ACS + timezone → 5 × (1 + 5) = 30 credits
• 50mi spatial, no flags → ceil(50/50) × (1 + 0) = 1 credit
• 100mi spatial, 2 ACS flags → 2 × (1 + 2) = 6 credits
• 250mi spatial, 4 ACS + timezone → 5 × (1 + 5) = 30 credits

Credit Estimator

Select an endpoint and configure options to see exactly how many credits your API call will cost.

Subscription Plans

Credit Packs

Pre-purchase credits that never expire. Works alongside any plan — free or paid. If you exceed your daily free allowance or monthly subscription, purchased credits kick in automatically.

Purchased credits are used only after your free or subscription allowance is exhausted. Need a custom volume? Contact us.

Error Codes

Authentication Errors

Validation Errors

Credit & Rate Limit Errors

Framework Errors

Service Errors

Per-Item Not Found (HTTP 200)

Error Response Format

{
  "success": false,
  "results": [],
  "error": { "code": "AUTH_MISSING_KEY", "message": "API key is required. Provide via X-Api-Key header or ?key= parameter." },
  "meta": { "version": "2.0.0", "timing_ms": 1, "notices": [] }
}

Rate Limiting

All responses include rate limit headers:

Limits by Plan

When rate-limited (HTTP 429), the response includes a Retry-After header with seconds to wait:

{
  "success": false,
  "error": { "code": "RATE_LIMIT_MINUTE", "message": "Rate limit exceeded. Try again in 45 seconds." },
  "meta": { "version": "2.0.0", "timing_ms": 0, "rate_limit": { "limit": 120, "window": "1 minute", "retry_after": 45 }, "notices": [] }
}

Supported Countries

HTTP Status Codes

Summary of all HTTP status codes the API can return:

Versioning

The API uses path-based versioning. All current endpoints are under /v2/. The version is also returned in every response as meta.version.

• Backward-compatible changes (new fields, new enrichments, new endpoints) are added without a version bump.
• Breaking changes (removed fields, changed response structure) will only occur in a new version (e.g., /v3/).
• The current version (v2) is stable and actively maintained. There are no plans to deprecate it.
• If a future version is released, v2 will continue to operate for a minimum of 12 months after deprecation notice.
• See our Service Level Agreement and Terms of Service for uptime and usage commitments.

OpenAPI Specification

A machine-readable OpenAPI 3.0 specification is auto-generated from the API and always reflects the current endpoints, parameters, and response schemas.

Changelog

Notable API changes, data updates, and new features.

March 2026

• New endpoint: /v2/address — Address matching (beta). Parse and validate raw US street addresses against USPS ZIP+4 delivery-point data. Returns standardized address, ZIP+4, parsed components, and delivery metadata. Fixed 1 credit per request.

Frequently Asked Questions