APIHub
Back to Explore

US Street Address

The US Street Address API validates single or batch US postal addresses, returning standardized address candidates along with optional enrichment such as component analysis, Project US@ formatting, and IANA‑timezone details.

Data Validation
apiKeyQuery
HTTPS
CORS: Yes
Description enriched
Visit official documentation

Latency

742ms p95

Uptime

100.0% 30d

Playground

Verified

live

Endpoints

REST · JSON
GET

/street-address

Validate a single address

  • auth-id (query, required) — Authentication ID (required)
  • auth-token (query, required) — Authentication token (required)
  • street (query) — The street line of the address, or the entire address (freeform).
  • city (query) — The city name.
  • state (query) — The state name or abbreviation.
  • zipcode (query) — The ZIP Code.
  • candidates (query) — Maximum number of addresses returned when the input is ambiguous (default 1, max 10).
  • match (query) — Match output strategy: strict, invalid, or enhanced.
  • format (query) — Output format: default or project-usa.
  • features (query) — Comma‑separated list of extra features (e.g., component-analysis, iana-timezone).
  • input_id (query) — Pass‑through identifier for the input address (up to 36 characters).
  • street2 (query) — Any extra address information.
  • secondary (query) — Apartment, suite, or office number.
  • addressee (query) — Name of the person or company as submitted by the client.
  • urbanization (query) — Neighborhood (only Puerto Rican addresses).
  • lastline (query) — City, state, and ZIP Code combined.
  • county_source (query) — Source for county information: postal (default) or geographic.
POST

/street-address

Validate multiple addresses in one request

  • auth-id (query, required) — Authentication ID (required)
  • auth-token (query, required) — Authentication token (required)
  • format (query) — Output format: default or project-usa.
  • features (query) — Comma‑separated list of extra features (e.g., component-analysis, iana-timezone).
  • Content-Type (header, required) — application/json; charset=utf-8

2 endpoints auto-detected

Authentication

This API uses an API key, passed as the "auth-id" query parameter. No OAuth required.

curl -X GET \
  "https://www.smarty.com/docs/cloud/us-street-api/street-address?auth-id=YOUR_API_KEY"

www.smarty.com · HTTPS only