> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Postal Data API

> Postal Data API validates and looks up postal codes, locations, coordinates, and regional metadata across more than 240 countries and territories.

![Postal Data API logo](https://mintcdn.com/composio-preview/HvfZXDijhFOaKyF5/images/toolkits/postal_data_api.svg?fit=max\&auto=format\&n=HvfZXDijhFOaKyF5\&q=85\&s=1f68d02792370e6fd13f8e5fdd8cb697)

* **Category:** developer tools
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 6
* **Triggers:** 0
* **Slug:** `POSTAL_DATA_API`
* **Version:** 00000000\_00

## Tools

> [accordion] Get API Information
>
> **Slug:** `POSTAL_DATA_API_GET_API_INFORMATION`
>
> Return Postal Data API version, coverage, usage guidance, current balance, and configured rate-limit status when returned, for connectivity or service discovery. The provider does not document this endpoint as unbilled, so assume it may consume one query.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Postal Code Metadata
>
> **Slug:** `POSTAL_DATA_API_GET_POSTAL_CODE_METADATA`
>
> Return all available country-specific metadata for a postal code, such as coordinates, timezone, county, elevation, and administrative levels. The metadata fields vary by country and availability. Each successful call consumes one Postal Data API query.
>
> #### Input Parameters
>
> **postal\_code** `string` *required*
>
> Postal code whose full metadata should be returned; pass it as a string to preserve leading zeros.
>
> **country\_code** `string`
>
> Two-letter ISO 3166-1 alpha-2 country code. Defaults to US.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Look Up Postal Code
>
> **Slug:** `POSTAL_DATA_API_LOOKUP_POSTAL_CODE`
>
> Look up the city, region, and coordinates for a postal code. Use this for a concise location result; use Get Postal Code Metadata for country-specific administrative details. Each successful call consumes one query.
>
> #### Input Parameters
>
> **postal\_code** `string` *required*
>
> Postal code to look up. Pass it as a string to preserve leading zeros.
>
> **country\_code** `string`
>
> Two-letter ISO 3166-1 alpha-2 country code. Defaults to US.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Postal Codes by City
>
> **Slug:** `POSTAL_DATA_API_SEARCH_POSTAL_CODES_BY_CITY`
>
> Return all postal codes matching a city and optional region, including fuzzy-match details. For US searches, provide a state name or state code. Each successful call consumes one Postal Data API query.
>
> #### Input Parameters
>
> **city** `string` *required*
>
> City name to search for.
>
> **state** `string`
>
> Full state or region name. For US searches, provide this or state\_code.
>
> **state\_code** `string`
>
> Two-letter US state abbreviation. For US searches, provide this or state.
>
> **country\_code** `string`
>
> Two-letter ISO 3166-1 alpha-2 country code. Defaults to US.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Validate Postal Code
>
> **Slug:** `POSTAL_DATA_API_VALIDATE_POSTAL_CODE`
>
> Check whether one postal code exists without treating a nonexistent code as an execution error. Inspect valid in the response. Each successful call consumes one Postal Data API query.
>
> #### Input Parameters
>
> **postal\_code** `string` *required*
>
> Postal code to validate. Pass it as a string to preserve leading zeros.
>
> **country\_code** `string`
>
> Two-letter ISO 3166-1 alpha-2 country code. Defaults to US.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Validate Postal Codes in Bulk
>
> **Slug:** `POSTAL_DATA_API_VALIDATE_POSTAL_CODES_BULK`
>
> Validate 1 to 1,000 postal codes synchronously, including mixed-country batches. Results preserve input order and report per-record failures. A batch of N records consumes N queries and is rejected atomically if balance or rate-limit budget is insufficient.
>
> #### Input Parameters
>
> **records** `array` *required*
>
> Between 1 and 1,000 postal-code records to validate synchronously.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
