Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

HUD - US Department of Housing and Urban Development ZIP Code Crosswalk API

ZIP code to geographic area crosswalk queries

HUD - US Department of Housing and Urban Development ZIP Code Crosswalk API is one of 10 APIs that HUD - US Department of Housing and Urban Development publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include ZIP Code Crosswalk. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 1 operation across 1 path, and defines 3 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against a single base URL, https://www.huduser.gov/hudapi/public.

1 operations 1 paths 3 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://www.huduser.gov/hudapi/public/fmr
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

HUD - US Department of Housing and Urban Development ZIP Code Crosswalk API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer token obtained by registering at https://www.huduser.gov/hudapi/public/register

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

ZIP Code Crosswalk 1

ZIP code to geographic area crosswalk queries

GET
/usps
ZIP Code Crosswalk Query
getZIPCrosswalk 4 params → 200401400404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are CrosswalkRecord (10 properties), CrosswalkResponse (1 property), ErrorResponse (1 property). Each schema is shown below with its type and property counts.

ErrorResponse
object
1 property
CrosswalkRecord
object
A single crosswalk mapping record
10 properties
CrosswalkResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hud-zip-code-crosswalk-api-openapi.yml Raw ↑

Other APIs HUD - US Department of Housing and Urban Development publishes across the network.

HUD User Fair Market Rents API
HUD User Income Limits API
HUD User USPS ZIP Code Crosswalk API
HUD User CHAS API
HUD Housing Counselor Search API
HUD - US Department of Housing and Urban Development CHAS API
HUD - US Department of Housing and Urban Development Fair Market Rents API
HUD - US Department of Housing and Urban Development Housing Counseling API
HUD - US Department of Housing and Urban Development Income Limits API