Skip to main content
Addressfinder logo
  • Category: developer tools
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 17
  • Triggers: 0
  • Slug: ADDRESSFINDER
  • Version: 20260615_00

Tools

Slug: ADDRESSFINDER_AU_ADDRESS_AUTOCOMPLETE_APITool to perform interactive search of Australian addresses from the AddressFinder database. Use when you need to search for and autocomplete Australian addresses based on partial input.

Input Parameters

string
The partial address being searched
integer
Maximum results to return (1-100, default: 10)
string
Convert special characters: 1 for ASCII equivalents
string
Service identifier for activity monitoring
string
Response format: json or xml (default: json)
string
Address dataset source: GNAF, PAF, or GNAF,PAF (default)
string
Filter PO Box addresses: 0 (exclude), 1 (only), or omit (include all)
string
Return canonical/alias addresses: 1 (canonical only) or omit
string
Enable highlighting: 1 to wrap matches with <span class=‘af_hl’></span>
string
Comma-separated state filters (ACT, NSW, NT, QLD, SA, TAS, VIC, WA, OT)

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: ADDRESSFINDER_AU_ADDRESS_METADATATool to retrieve full metadata for an Australian address selected from the Address Autocomplete API. Use when you need complete address details including GPS coordinates and census data.

Input Parameters

string
Unique address identifier from Address Autocomplete API. Must supply either id, gnaf_id, or dpid.
string
Set to ‘1’ to include GPS coordinates in the response.
string
Australia Post delivery point identifier. Must supply either id, gnaf_id, or dpid.
string
Set to ‘1’ to convert special characters to ASCII.
integer ("2016" | "2021")
Census year - 2016 or 2021. Defaults to 2016.
string
Service identifier for activity monitoring.
string ("json" | "xml")
Response format - ‘json’ or ‘xml’. Defaults to json.
string
Address source - ‘GNAF’, ‘PAF’, or ‘GNAF,PAF’. Defaults to GNAF,PAF.
string
Unique id from the G-NAF dataset. Must supply either id, gnaf_id, or dpid.

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: ADDRESSFINDER_AU_ADDRESS_VERIFICATIONTool to verify Australian addresses against PAF/GNAF databases. Use when you need to validate or standardize an Australian address and retrieve associated metadata like coordinates, statistical identifiers, and GNAF data.

Input Parameters

string
required
Full address to be verified (e.g., ‘274 Harbour Drive, COFFS HARBOUR NSW 2450’)
string
Include latitude/longitude coordinates when available. Set to ‘1’ to enable.
string
Query PAF database for postal addresses. Set to ‘1’ to enable (default).
string
Query GNAF database for physical addresses. Set to ‘1’ to enable (default).
string
Convert special characters to ASCII equivalents. Set to ‘1’ to enable.
integer ("2016" | "2021")
Census year for statistical area identifiers (2016 or 2021).
string
Service identifier for activity monitoring.
string ("json" | "xml")
Response format: ‘json’ or ‘xml’. Defaults to ‘json’.
string
Return additional GNAF data (lga_name, lga_type_code, gnaf_id, legal_parcel_id). Set to ‘1’ to enable.
string
Set to ‘0’ to exclude PO Box-type addresses from results.
string
Filter by state(s): ACT, NSW, NT, QLD, SA, TAS, VIC, WA, OT. Comma-separated for multiple states.

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: ADDRESSFINDER_AU_LOCATION_AUTOCOMPLETE_APITool to perform interactive autocomplete search for Australian streets, suburbs, and states. Use when you need to find or suggest Australian locations based on partial input.

Input Parameters

string
required
Query string to match against Australian locations (streets, suburbs, states).
integer
Maximum number of results to return, range 1-100. Defaults to 10.
string
Service identifier for Portal activity monitoring; must be registered in your account.
string ("json" | "xml")
Response format - ‘json’ or ‘xml’. Defaults to ‘json’.
string
Secret key from Portal Credentials; required only for server-to-server calls.
integer ("0" | "1")
Set to 1 to include highlighted matching terms wrapped in <span class=‘af_hl’></span>.
string
Comma-separated state/territory codes to filter by: ACT, NSW, NT, QLD, SA, TAS, VIC, WA, OT.
string
Comma-separated filter for location types: ‘street’, ‘locality’ (suburb), ‘state’. Example: ‘street,locality’.

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: ADDRESSFINDER_AU_LOCATION_METADATA_APITool to retrieve comprehensive metadata for an Australian location (street, suburb, or state) selected from the Location Autocomplete API. Use when you need detailed information about a specific Australian location including coordinates, street details, suburb, state, and postcode.

Input Parameters

string
required
Unique location identifier from the Location Autocomplete API. This identifies the specific street, suburb, or state to retrieve metadata for.
string
Optional service identifier for tracking activity in the Portal. Must be a registered domain.
string ("json" | "xml")
Response format. Either ‘json’ or ‘xml’. Defaults to ‘json’.

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: ADDRESSFINDER_EMAIL_VERIFICATION_APITool to verify email addresses including syntax validation, domain existence, and email account verification. Use when you need to validate an email address before sending messages or storing contact information.

Input Parameters

string
required
The email address to be verified. Can contain spelling mistakes or errors that will be validated.
string
Used to identify which of your services is calling the API for activity monitoring purposes.
string ("json" | "xml")
Response format - json or xml. Default is json.
string
Comma-separated list controlling verification methods: domain, connection, provider. Default: domain,connection

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: ADDRESSFINDER_INT_ADDRESS_AUTOCOMPLETE_APITool to search for international addresses using autocomplete functionality. Use when users need to find and select addresses in supported countries (AU, BE, CA, CZ, DK, FR, DE, IE, NZ, NL, PT, SG, ES, SE, GB, US). Returns address IDs that can be used with the Address Metadata API to retrieve full address details.

Input Parameters

string
required
Partial address search query. Maximum 200 characters. This is the text that users type to search for addresses.
integer
Maximum number of results to return. Must be between 1 and 15 inclusive. Defaults to 10.
string
Service identifier for Portal activity monitoring. Must be registered in your account.
string ("json" | "xml")
Response format - either ‘json’ or ‘xml’. Defaults to ‘json’.
string
Secret key from Portal Credentials. Required for server-to-server API calls.
string ("au" | "be" | "ca" | "cz" | "dk" | "fr" | "de" | "ie" | "nz" | "nl" | "pt" | "sg" | "es" | "se" | "gb" | "us")
required
ISO 3166 alpha-2 country code for the address search. Supported countries: au (Australia), be (Belgium), ca (Canada), cz (Czech Republic), dk (Denmark), fr (France), de (Germany), ie (Ireland), nz (New Zealand), nl (Netherlands), pt (Portugal), sg (Singapore), es (Spain), se (Sweden), gb (United Kingdom), us (United States).

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: ADDRESSFINDER_INT_ADDRESS_METADATA_APITool to retrieve full metadata for an international address selected from the Address Autocomplete API. Use when you need complete address details including street metadata and optional GPS coordinates for addresses outside your primary region.

Input Parameters

string
required
Unique address identifier obtained from the Address Autocomplete API.
integer
Include GPS coordinates in the response. Set to 1 to include, 0 to exclude. Default is 0.
string
Used to identify in the Addressfinder Portal which of your services is calling the API.
string
Response format: json or xml. Default is json.
string
required
ISO 3166 alpha-2 country code (e.g., fr, us, ca, gb, au, nz, be, cz, dk, de, ie, nl, pt, sg, es, se).

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: ADDRESSFINDER_NZ_ADDRESS_AUTOCOMPLETETool to perform interactive search for New Zealand addresses. Use when you need to find closely matching NZ addresses based on partial address input. The tool searches the Addressfinder database and returns matching addresses which can then be selected by the user. Works with the Address Metadata API to retrieve associated address data using the pxid identifier.

Input Parameters

string
The partial address being searched. Provide the address query string to search for matching New Zealand addresses.
integer
Maximum number of results to return. Defaults to 10. Valid range is 1-100.
string
Set to ‘1’ to convert special characters to ASCII equivalents in the response.
string
Filter rural vs. urban addresses. Set to ‘0’ for urban addresses only, ‘1’ for rural addresses only.
string
Service identifier for activity monitoring. Used to track and monitor API usage by domain.
string
Response format - ‘json’ or ‘xml’. Defaults to json.
string
Match strictness level. ‘0’ for normal matching, ‘1’ for strict matching, ‘2’ for fuzzy matching.
string
Include or exclude PO Box style addresses. Set to ‘0’ to exclude PO Boxes, ‘1’ to include only PO Boxes.
string
Filter by NZ Post delivery status. Set to ‘0’ to exclude delivered addresses, ‘1’ to include only delivered addresses.
string
Set to ‘1’ to wrap matching terms in highlighting span tags in the response.
string
Filter by NZ region code. Valid codes are 1-9 and A-H representing different New Zealand regions.

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: ADDRESSFINDER_NZ_ADDRESS_METADATATool to retrieve full metadata for a NZ address including coordinates, census data, and postal details. Use after selecting an address from the Address Autocomplete API to get complete address information.

Input Parameters

string
Unique reference number assigned to a delivery address by NZ Post
string
Unique address identifier obtained from the Address Autocomplete API
string
Set to 1 to convert special characters to ASCII equivalents
integer
Data source year - 2018 or 2023. Default is 2023
string
Used to identify which service is calling the API for activity monitoring
string
Response format - json or xml

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: ADDRESSFINDER_NZ_ADDRESS_REVERSE_GEOCODETool to reverse geocode NZ addresses from GPS coordinates. Use when you need to find the nearest addresses to a given longitude and latitude. Returns addresses ordered by distance.

Input Parameters

string
required
Longitude in WGS84 format (example: 174.773068233188)
string
required
Latitude in WGS84 format (example: -41.2917018846201)
integer
Maximum results to return (1-100, default: 10)
string
Service identifier for portal usage tracking; must be registered
string ("json" | "xml")
Response format; accepts ‘json’ or ‘xml’

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: ADDRESSFINDER_NZ_ADDRESS_VERIFICATION_APITool to verify New Zealand addresses against the Addressfinder database. Use when you need to validate and enrich NZ addresses, correct spelling mistakes, or retrieve detailed address metadata including coordinates and postal information.

Input Parameters

string
The address to be verified. Can contain spelling mistakes.
string
ASCII conversion: ‘1’ reformats special characters to ASCII equivalents.
integer
Census year for statistics: 2018 or 2023. Default is 2023.
string
Service identifier for portal tracking purposes.
string
Response format: ‘json’ or ‘xml’. Default is ‘json’.
string
Secret key from Portal Credentials for server-to-server authentication.
string
Filter PO Box addresses: ‘0’ excludes PO Boxes, ‘1’ includes only PO Boxes.
string
Restrict search to specific NZ region. Valid codes are 1-H.

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: ADDRESSFINDER_NZ_LOCATION_AUTOCOMPLETETool to perform interactive search for New Zealand streets, suburbs, cities, and regions. Use when you need to find or autocomplete location names in New Zealand. Returns closely matching locations with unique identifiers for further metadata lookups.

Input Parameters

string
required
Query string to match against locations (streets, suburbs, cities, regions). Maximum 200 characters.
integer
Maximum number of results to return. Must be between 1 and 100. Default: 10
string ("0" | "1")
Set to ‘0’ to exclude cities, ‘1’ for cities only. Omit for all types.
string
Identifies calling service in Addressfinder Portal for analytics.
string ("json" | "xml")
Response format - ‘json’ or ‘xml’. Default: json
string ("0" | "1")
Set to ‘0’ to exclude regions, ‘1’ for regions only. Omit for all types.
string
Secret key from Portal Credentials; required for server-to-server calls.
string ("0" | "1")
Set to ‘0’ to exclude streets, ‘1’ for streets only. Omit for all types.
string ("0" | "1" | "2")
Match strictness - ‘0’ (normal), ‘1’ (strict), ‘2’ (fuzzy). Default: ‘0’
string ("0" | "1")
Set to ‘0’ to exclude suburbs, ‘1’ for suburbs only. Omit for all types.
integer ("0" | "1")
Set to 1 to highlight matched terms with ‘<span class=“af_hl”></span>’ tags.
string
Restrict results to specific region. Codes: 1-9, A-H (e.g., ‘1’ for Northland, ‘A’ for Canterbury).

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: ADDRESSFINDER_NZ_LOCATION_METADATATool to retrieve full metadata for a New Zealand location selected from the Location Autocomplete API. Use when you need detailed information including coordinates and LINZ address data for a specific location.

Input Parameters

string
required
Unique location identifier from the Location Autocomplete API.
string
Used to identify your calling service for usage tracking in the AddressFinder Portal. Must be registered in the Portal.
string ("json" | "xml")
Response format - ‘json’ or ‘xml’.
string
Secret key from Portal Credentials; only needed for server-to-server calls. Can also be passed via Authorization header.

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: ADDRESSFINDER_NZ_POI_AUTOCOMPLETE_APITool to perform interactive search for points of interest in New Zealand. Use when you need to find POIs like hospitals, cafes, or schools based on partial name matching.

Input Parameters

string
required
The query string to match against POI names and addresses
integer
Maximum results to return (1-100, default: 10)
string
Used to identify your service in the AddressFinder Portal
string ("json" | "xml")
Response format; accepts ‘json’ or ‘xml’
integer
Set to 1 to include highlighted matching text with <span class=‘af_hl’></span>

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: ADDRESSFINDER_NZPOI_METADATA_APITool to retrieve comprehensive metadata for New Zealand points of interest including coordinates and address details. Use when you need full POI information after selecting from autocomplete API.

Input Parameters

string
required
Unique POI identifier from the autocomplete API
string
Service identifier in Addressfinder Portal (must be registered)
string ("json" | "xml")
Response format - ‘json’ or ‘xml’
string
Secret key from Portal Credentials (required for server-to-server calls)

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: ADDRESSFINDER_PHONE_VERIFICATION_APITool to verify phone numbers through syntax, range checks, and network verification. Use when you need to validate a phone number’s format, line type, and connection status. Returns verified number details including line type, connection status, and formatted representations.

Input Parameters

string
Service identifier for Portal activity monitoring.
string
Response format: ‘json’ or ‘xml’. Defaults to ‘json’.
number
Maximum wait time for verification in seconds.
boolean
Require the number to be a mobile phone. Set to True to restrict to mobile numbers only.
string
required
The phone number to be verified.
string
required
ISO2 country code used when phone lacks country calling code (e.g., ‘AU’, ‘US’, ‘GB’).
string
Comma-separated ISO2 country codes restricting valid countries (e.g., ‘AU,NZ,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