Skip to main content
Postal Data API logo
  • Category: developer tools
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 6
  • Triggers: 0
  • Slug: POSTAL_DATA_API
  • Version: 00000000_00

Tools

Slug: POSTAL_DATA_API_GET_API_INFORMATIONReturn 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTAL_DATA_API_GET_POSTAL_CODE_METADATAReturn 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

string
required
Postal code whose full metadata should be returned; pass it as a string to preserve leading zeros.
string
Two-letter ISO 3166-1 alpha-2 country code. Defaults to US.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTAL_DATA_API_LOOKUP_POSTAL_CODELook 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

string
required
Postal code to look up. Pass it as a string to preserve leading zeros.
string
Two-letter ISO 3166-1 alpha-2 country code. Defaults to US.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTAL_DATA_API_SEARCH_POSTAL_CODES_BY_CITYReturn 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

string
required
City name to search for.
string
Full state or region name. For US searches, provide this or state_code.
string
Two-letter US state abbreviation. For US searches, provide this or state.
string
Two-letter ISO 3166-1 alpha-2 country code. Defaults to US.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTAL_DATA_API_VALIDATE_POSTAL_CODECheck 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

string
required
Postal code to validate. Pass it as a string to preserve leading zeros.
string
Two-letter ISO 3166-1 alpha-2 country code. Defaults to US.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTAL_DATA_API_VALIDATE_POSTAL_CODES_BULKValidate 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

array
required
Between 1 and 1,000 postal-code records to validate synchronously.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not