Loading
Loading
Retrieve all ZIP or postal codes for a given state, province, or region within a country. Results are paginated with up to 500 codes per page.
Provide the region and country to retrieve all ZIP codes in that administrative area. Covers global postal systems including USPS, Royal Mail PAF, and more.
Authorize every request with your API key, passed either as a header or as a query parameter:
X-apiKeyapiKeyThis is version v1.0 of the API.
region and country are required. Use page to paginate through large result sets.
formatoptionalStringdefault: jsonResponse format: 'json' (default) or 'xml'.
regionoptionalStringName of the state, province, or region to search ZIP codes in. Either region or region_code is required.
region_codeoptionalStringISO Code of the state, province, or region to search ZIP codes in. Either region or region_code is required. region_code takes priority if both are given.
countryrequiredStringCountry where the region exists. Must be in ISO 3166-1 alpha-2 format.
pageoptionalIntegerdefault: 1Page number for paginated results (up to 500 codes per page). Must be greater than 0.
Returns 200 OK with pagination metadata and a codes array of ZIP code strings.
total_resultsTotal number of ZIP codes found.
total_pagesTotal number of pages. Each page contains up to 500 results.
current_pageCurrent page number.
current_page_sizeNumber of ZIP codes returned in this page.
codesArray of ZIP codes or postal code strings for the queried location.
Besides the response body, every response carries custom headers you can use to track credit usage, and concurrency usage on endpoints that enforce a concurrency limit. See the Custom Response Headers documentation and the endpoints with concurrency limits for more details.
X-Concurrent-Threadsheaderconcurrency-limited endpointsSpecifies the maximum number of concurrent requests allowed.
X-Concurrent-Threads-Activeheaderconcurrency-limited endpointsIndicates the number of active concurrent requests being processed.
X-AF-Credits-Costheaderall responsesSpecifies the number of credits consumed by the current request.
See the HTTP Status Codes documentation for a complete reference of common API errors and HTTP status codes.
Only ISO 3166-1 alpha-2 codes country codes are supported.
The page number must be greater than 0.
No postal/zip codes found for the provided region XYZNOTAREGION in country US.