Skip to main content
Ideal Postcodes logo
  • Category: developer tools
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 9
  • Triggers: 0
  • Slug: IDEALPOSTCODES
  • Version: 00000000_00

Tools

Slug: IDEALPOSTCODES_FIND_ADDRESS_SUGGESTIONSReturn ranked address suggestions for a partial address without resolving them; resolving a selected suggestion is a separate paid lookup.

Input Parameters

string
Bounding box used to restrict results, in the provider’s comma-separated coordinate format.
integer
Maximum suggestions to return (1-100).
string
required
Partial address to search for (maximum 150 characters).
string
IP address used to geographically bias suggestion ranking.
string
Country context used to interpret the query, such as GBR or USA.
string
Country name used to restrict suggestions.
array
Enabled address datasets to search, such as paf or mr; omit to use the key’s defaults.
string
Exact postcode used to restrict suggestions.
string
Post town used to restrict suggestions.
string
Longitude and latitude used to rank nearby suggestions, formatted as ‘longitude,latitude’.

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: IDEALPOSTCODES_FIND_PLACE_SUGGESTIONSReturn ranked country, city, and administrative-area suggestions without resolving them; resolving a selected place is a separate paid lookup.

Input Parameters

string
required
Place name or partial place name to search for.
string
IP address used to geographically bias result ranking.
string
Longitude and latitude used to rank nearby places, formatted as ‘longitude,latitude’.
string
ISO 3166-1 alpha-3 country code used to restrict results, such as GBR.
string
ISO 3166-1 alpha-3 country code used to rank matching places.

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: IDEALPOSTCODES_GET_ADDRESS_BY_IDENTIFIERRetrieve a UK address by UDPRN or UMPRN. This consumes a paid lookup, and UMPRN requires the optional Multiple Residence dataset.

Input Parameters

string
Comma-separated address fields to include in the result.
string
required
UDPRN or UMPRN value identifying the address.
string ("UDPRN" | "UMPRN")
required
Identifier kind. UMPRN requires the optional Multiple Residence dataset.

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: IDEALPOSTCODES_LOOKUP_POSTCODEReturn addresses at a UK postcode, or an Irish Eircode when enabled; successful results consume paid lookups.

Input Parameters

string
Tags to attach to paid lookups for usage reporting.
string
Comma-separated address fields to include in each result.
string
required
UK postcode, or Irish Eircode when enabled, to look up.
string
Opaque continuation cursor returned by a previous lookup of the same postcode.

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: IDEALPOSTCODES_RESOLVE_ADDRESS_SUGGESTIONResolve an address suggestion ID to a complete GBR or USA address. This consumes a paid lookup, and USA resolution requires an enabled USA dataset.

Input Parameters

string
Tags to attach to the paid lookup for usage reporting.
string ("GBR" | "USA")
required
Dataset route for the suggestion. USA requires the optional USA dataset.
string
required
Address suggestion ID returned by Find Address Suggestions.

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: IDEALPOSTCODES_RESOLVE_PLACEResolve a place suggestion ID to full geography and coordinates. This consumes a paid lookup.

Input Parameters

string
Tags to attach to the paid lookup for usage reporting.
string
required
Place suggestion ID returned by Find Place Suggestions.

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: IDEALPOSTCODES_SEARCH_ADDRESSESSearch complete UK address records by text, filters, or coordinates; successful results consume paid lookups.

Input Parameters

string
Bounding box used to restrict results, in the provider’s comma-separated coordinate format.
string
Tags to attach to paid lookups for usage reporting.
integer
Maximum addresses requested for this page (1-100); valid-postcode searches may force 100.
string
Address text to search; omit when using coordinates or filters.
string
Comma-separated address fields to include in each result.
string
Country name used to restrict results.
number
Latitude for reverse geocoding; provide together with longitude.
string
Exact postcode used to restrict results.
number
Longitude for reverse geocoding; provide together with latitude.
string
Post town used to restrict results.
string
Continuation cursor returned by a previous call for the same search.
string
Outward postcode used to restrict results.

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: IDEALPOSTCODES_VALIDATE_ADDRESSMatch and standardize a GBR or USA address with confidence details. This consumes a paid lookup, and USA verification requires the optional USPS CASS dataset.

Input Parameters

string
USA city hint; use post_town for GBR.
string
Tags to attach to the paid validation lookup for usage reporting.
string
required
Free-form address to match and standardize.
string
Two-letter USA state code hint.
string
GBR county hint.
string ("GBR" | "USA")
required
Validation dataset to use; USA requires the optional USPS CASS dataset.
string
GBR postcode hint; use zip_code for USA.
string
USA ZIP Code hint; use postcode for GBR.
string
GBR post town hint; use city for USA.

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: IDEALPOSTCODES_VALIDATE_CONTACTValidate an email address or international phone number using an optional paid dataset enabled on the connected Ideal Postcodes API key.

Input Parameters

string
Tags to attach to the paid validation lookup for usage reporting.
string
required
Email address or international phone number to validate; phone numbers must include a country code.
string ("EMAIL" | "PHONE_NUMBER")
required
Kind of contact value to validate.
boolean
For phone validation only, request current carrier data. This may consume an additional lookup.

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