The Addressfinder connector lets your AI agent act in each user's Addressfinder account. Each user connects their own Addressfinder API key and secret once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 17 tools.
- Tools
- 17
- What they doRead · write · destructive
- 17 · 0 · 017 read0 write0 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Addressfinder connection
In AgentKit > Connections, create an Addressfinder connection. The name you give it is the
connection_nameyour code passes. See Configure connections.
Tools
Pass the exact name toexecute_tooladdressfinder_au_address_autocompleteSearch Australian addresses (GNAF and/or Australia Post PAF) by partial text, for type-ahead address entry.Read-onlyAutocomplete AU Address
Search Australian addresses (GNAF and/or Australia Post PAF) by partial text, for type-ahead address entry. Returns completions, each with full_address and id. Use this while a user types. Pass the id from the results to the matching metadata tool for the full address. Use addressfinder_au_address_verify to check a complete address in one call.
Inputs
qstringrequired- The partial address being searched. Example: 184 Will.
asciistring- Set to 1 to reformat special characters like macrons and other accents characters with their ASCII equivalent (e.g. *Pōneke* and *Café* will be returned as *Poneke* and *Cafe*). Example: 1.one of
1 canonicalstring- Return canonical and/or alias addresses - this allows for vanity suburbs, historic street names, and more: * 1 - Alias addresses are not included in the search results * Omit to return canonical and alias addresses are returned (most common option). Example: 1.one of
1 highlightstring- Returns an additional attribute in the response called highlighted_full_address. This attribute wraps the matching terms in the address with <span class='af_hl'></span> in order to highlight those terms: * 1 - Matching terms in the returned addresses are highlighted. * Omit to not return additional highlighted_full_address property. Example: 1.one of
1 maxinteger- The maximum number of results to return. The default is 10 results. Example: 10.
post_boxstring- Return PO Box style addresses. This includes PO Box, Locked Bag, GPO Box, CMB, RMS, Care PO, MS, RSD, Parcel Locker and Parcel Collect. Used with the source filter above: * 0 - Set this option to exclude PO Box style addresses from your search results * 1 - Returns only PO Box style addresses * Omit to return PO Box addresses with deliverable addresses. Example: 0.one of
01 sourcestring- Determines the source of the addresses being searched and returned. * GNAF - Returns physical addresses from the GNAF address dataset. * PAF - Returns postal addresses, including PO Box type addresses, from the Australia Post postal address file. * GNAF,PAF - Returns addresses from either of the PAF or GNAF address datasets. Defaults to GNAF,PAF. Example: GNAF,PAF.one of
GNAF,PAFGNAFPAF state_codesstring- Comma-separated state or territory codes to filter on: ACT, NSW, NT, QLD, SA, TAS, VIC, WA, OT. Example: NSW,VIC.
addressfinder_au_address_metadata_getGet the full details of an Australian address selected from autocomplete, by id, GNAF id or DPID.Read-onlyGet AU Address Metadata
Get the full details of an Australian address selected from autocomplete, by id, GNAF id or DPID. Returns the structured address (street, locality, state, postcode), identifiers and, when requested, GPS and census areas. Use after addressfinder_au_address_autocomplete. Supply one of id, gnaf_id or dpid.
Inputs
asciistring- Set to 1 to reformat special characters like macrons and other accents characters with their ASCII equivalent (e.g. *Pōneke* and *Café* will be returned as *Poneke* and *Cafe*). Example: 1.one of
1 censusinteger- Used to determine which census year’s statistical area identifiers (Meshblock, SA1 & SA2) will be returned in the response. Defaults to 2016 if omitted. Example: 2016.one of
20162021 dpidstring- Australia Post delivery point identifier. You must supply either an id, or a gnaf_id, or a dpid field. Example: 52143012.
gnaf_idstring- Unique id from the G-NAF dataset. You must supply either an id, or a gnaf_id, or a dpid field. Example: GANSW704417592.
gpsstring- Request GPS coordinates for latitude and longitude be returned when available: * 1 - GPS coordinates wil be included in the response * Omit to GPS coordinates. Example: 1.one of
1 idstring- Unique address identifier obtained from the Address Autocomplete API. You must supply either an id, or a gnaf_id, or a dpid field. Example: O3uYwEbMVYwdUqDb.
sourcestring- Determines the source of the address and metadata returned.. * GNAF - Returns physical addresses from the GNAF address dataset. * PAF - Returns postal addresses, including PO Box type addresses, from the Australia Post postal address file. * GNAF,PAF - Returns addresses from either of the PAF or GNAF address datasets. Defaults to GNAF,PAF. Example: GNAF,PAF.one of
GNAF,PAFGNAFPAF
addressfinder_au_address_verifyVerify a complete Australian address, correcting mistakes, against GNAF and/or Australia Post PAF.Read-onlyVerify AU Address
Verify a complete Australian address, correcting mistakes, against GNAF and/or Australia Post PAF. Returns matched (true/false) and the verified, structured address with identifiers. Use this to clean addresses in bulk or on form submit. Use addressfinder_au_address_autocomplete for type-ahead.
Inputs
qstringrequired- The address to be verified. Example: 274 Harbour Drive, Coffs Harbour NSW 2450.
asciistring- Set to 1 to reformat special characters like macrons and other accents characters with their ASCII equivalent (e.g. *Pōneke* and *Café* will be returned as *Poneke* and *Cafe*). Example: 1.one of
1 censusinteger- Returns statistical area identifiers (Meshblock, SA1 & SA2) from the specified census year. These attributes are only available from the GNAF database and are not returned if census is omitted. Example: 2016.one of
20162021 extendedstring- Returns lga_name, lga_type_code, gnaf_id and legal_parcel_id from the GNAF database. * 1 - Returns additional data available from GNAF. Example: 1.one of
1 gnafstring- Returns physical addresses from the GNAF database. One or both of GNAF or PAF databases need to be selected. * 1 - Queries the GNAF database. Defaults to 1. Example: 1.one of
1 gpsstring- Returns gps coordinates from the datasource specified (when available). * 1 - Returns latitude and longitude. Example: 1.one of
1 pafstring- Returns postal addresses from the PAF database. One or both of GNAF or PAF databases need to be selected. * 1 - queries the AU PAF database. Defaults to 1. Example: 1.one of
1 post_boxstring- Box type addresses are included by default (only available from PAF database). Box type addresses include PO Box, Locked Bag, GPO Box, CMB, RMS, Care PO, MS, RSD, Parcel Locker and Parcel Collect. Use this attribute to exclude them. * 0 - Excludes Box type addresses from the verification results. Example: 0.one of
0 state_codesstring- Comma-separated state or territory codes to filter on: ACT, NSW, NT, QLD, SA, TAS, VIC, WA, OT. Example: NSW,VIC.
addressfinder_au_location_autocompleteSearch Australian streets, suburbs and states by partial text.Read-onlyAutocomplete AU Location
Search Australian streets, suburbs and states by partial text. Returns completions with full_location and id. Use this when you need a place rather than a full address. Pass the id to addressfinder_au_location_metadata_get.
Inputs
qstringrequired- The query string to be matched with the location. Example: Coffs Harb.
highlightinteger- Set to 1 to include a highlighted_full_location field in results, wrapping matching terms with <span class='af_hl'></span>. Example: 0.one of
01 location_typesstring- A comma-separated list of location types to filter the results. Leave empty to allow any location type. Options are street, locality (suburb), and state. Example: street,locality.
maxinteger- Maximum number of results to return (1–100). Defaults to 10. Example: 10.
state_codesstring- Comma-separated state or territory codes to filter on: ACT, NSW, NT, QLD, SA, TAS, VIC, WA, OT. Example: NSW,VIC.
addressfinder_au_location_metadata_getGet the details of an Australian street, suburb or state selected from location autocomplete.Read-onlyGet AU Location Metadata
Get the details of an Australian street, suburb or state selected from location autocomplete. Returns the full location, state, postcode and latitude/longitude. Use after addressfinder_au_location_autocomplete.
Inputs
idstringrequired- Unique location identifier obtained from the Location Autocomplete API. Example: O3uYwEbMVYwdUqDb.
addressfinder_email_verifyVerify an email address: syntax, domain, mailbox existence and provider.Read-onlyVerify Email Address
Verify an email address: syntax, domain, mailbox existence and provider. Returns is_verified, deliverability, not_verified_code and flags for disposable, role, public and catch-all addresses. Use this before saving or emailing an address. Each verified result counts as a billed lookup.
Inputs
emailstringrequired- The email to be verified. Example: jane.smith@addressfinder.com.
featuresstring- A comma-separated list of parameters that controls the methods of verification to be completed. This will impact the query processing time and data returned in the response. Options: * domain checks if the domain is configured to receive emails; * connection checks if the email account exists; * provider checks and returns the email service provider; * format validates the syntax of the email address only. When format is the only feature, no domain, connection or provider checks are performed, so the response is returned faster and is_verified reflects the format check alone. The is_disposable, is_role, is_public and is_catch_all attributes are returned as null because they are not evaluated. Combining format with any other feature runs a standard verification. Defaults to domain,connection. Example: domain,connection.
addressfinder_intl_address_autocompleteSearch addresses in a supported country (for example GB, US, CA, FR, DE, IE, SG) by partial text.Read-onlyAutocomplete International Address
Search addresses in a supported country (for example GB, US, CA, FR, DE, IE, SG) by partial text. Returns completions with full_address and id. Use this for countries other than Australia and New Zealand. Pass the id to addressfinder_intl_address_metadata_get.
Inputs
countrystringrequired- ISO 3166 alpha-2 country code in lower case, for example gb, us, ca, fr, de, ie or sg. Example: gb.
qstringrequired- The partial address being searched. Max length 200 characters. Example: 10 Downing St.
maxinteger- The maximum number of results to return. Between 1 and 15 (inclusive). Defaults to 10. Example: 10.
addressfinder_intl_address_metadata_getGet the full details of an international address selected from autocomplete.Read-onlyGet International Address Metadata
Get the full details of an international address selected from autocomplete. Returns the structured address and, when requested, GPS coordinates. Use after addressfinder_intl_address_autocomplete with the same country.
Inputs
countrystringrequired- ISO 3166 alpha-2 country code in lower case, the same as in autocomplete. Example: gb.
idstringrequired- Unique address identifier obtained from the Address Autocomplete API. Example: GB|RM|A|12345678.
gpsinteger- Include GPS coordinates in the results if available (0 or 1). Defaults to 0. Example: 1.one of
01
addressfinder_nz_address_autocompleteSearch New Zealand addresses by partial text, for type-ahead address entry.Read-onlyAutocomplete NZ Address
Search New Zealand addresses by partial text, for type-ahead address entry. Returns completions with a (full address) and pxid. Use this while a user types. Pass the pxid to addressfinder_nz_address_metadata_get. Use addressfinder_nz_address_verify for complete addresses.
Inputs
qstringrequired- The partial address being searched. Example: 184 Will.
asciistring- Set to 1 to reformat special characters like macrons and other accents characters with their ASCII equivalent (e.g. *Pōneke* and *Café* will be returned as *Poneke* and *Cafe*). Example: 1.one of
1 deliveredstring- This filter determines if the results are either delivered or not delivered by NZ Post: * 0 A rarely used option that excludes addresses that NZ Post deliver to. * 1 - Only returns addresses that are delivered to by NZ Post. * Omit to not filter. Returns delivered and non-delivered addresses in the response. Example: 0.one of
01 highlightstring- Returns an additional attribute in the response called highlighted_a. This attribute wraps the matching terms in the address with <span class='af_hl'></span> in order to highlight those terms: * 1 - Highlighted. * Omit to not return additional highlighted_a property. Example: 1.one of
1 maxinteger- The maximum number of results to return. The default is 10 results. Example: 10.
post_boxstring- This filter includes/excludes PO Box style addresses. * 0 - Excludes PO Box type addresses from being returned in the response. * 1 - Returns only PO Box, Private Bag, Community Mailbox and Counter Delivery address types. * Omit to not filter. Returns PO Box type and standard addresses in the response. Example: 0.one of
01 region_codestring- Only return addresses within the boundary of the selected region (Regional Authority): * 1 - Only returns addresses from the Auckland Region * 2 - Only returns addresses from the Bay of Plenty Region * 3 - Only returns addresses from the Canterbury Region * 4 - Only returns addresses from the Gisbourne Region * 5 - Only returns addresses from the Hawke's Bay Region * 6 - Only returns addresses from the Manawatu-Wanganui Region * 7 - Only returns addresses from the Marlborough Region * 8 - Only returns addresses from the Nelson Region * 9 - Only returns addresses from the Northland Region * A - Only returns addresses from the Otago Region * B - Only returns addresses from the Southland Region * C - Only returns addresses from the Taranaki Region * D - Only returns addresses from the Tasman Region * E - Only returns addresses from the Waikato Region * F - Only returns addresses from the Wellington Region * G - Only returns addresses from the West Coast Region * H - Only returns addresses from the Chatham Islands Region * Omit to not filter. Returns addresses from all Regions. Example: 1.one of
123456789ABCDEFGH ruralstring- This filter includes/excludes rural/urban addresses: * 0 - Excludes addresses likely to be considered rural by a courier company. * 1 - A rarely used option that returns rural addresses only. * Omit to not filter. Returns rural and urban addresses in the response. Example: 0.one of
01 strictstring- Determines how closely matched the results should be to the q parameter: * 0 - Normal search - Allows some address elements to be omitted but does not allow spelling errors. * 1 - Strict search - Requires all address elements entered in q to be ordered and spelt correctly. * 2 - Fuzzy search - Allows spelling errors and inaccurate address elements. Defaults to 2. Example: 0.one of
012
addressfinder_nz_address_metadata_getGet the full details of a New Zealand address by pxid or DPID.Read-onlyGet NZ Address Metadata
Get the full details of a New Zealand address by pxid or DPID. Returns the structured address, postal details, coordinates and Statistics NZ areas. Use after addressfinder_nz_address_autocomplete or addressfinder_nz_address_reverse_geocode. Supply pxid or dpid.
Inputs
asciistring- Set to 1 to reformat special characters like macrons and other accents characters with their ASCII equivalent (e.g. *Pōneke* and *Café* will be returned as *Poneke* and *Cafe*). Example: 1.one of
1 censusinteger- Desired data source for Statistics NZ metadata. Defaults to 2023. Example: 2018.one of
20182023 dpidstring- Unique reference number assigned to a delivery address by NZ Post. You must supply either a pxid or dpid field. Example: 52143012.
pxidstring- Unique address identifier obtained from the NZ Address Autocomplete or NZ Address Bounding Box APIs. You must supply either a pxid or dpid field. Example: 2-.F.1W.p.0F6KG.
addressfinder_nz_address_reverse_geocodeFind the New Zealand addresses nearest to GPS coordinates, closest first.Read-onlyReverse Geocode NZ Address
Find the New Zealand addresses nearest to GPS coordinates, closest first. Returns completions with address, pxid and distance. Use this to turn a location into an address. Pass a pxid to addressfinder_nz_address_metadata_get for details.
Inputs
xstringrequired- Longitude (WGS84). Example: 174.7633.
ystringrequired- Latitude (WGS84). Example: -36.8485.
maxinteger- Maximum number of results to return (1–100). Defaults to 10. Example: 10.
addressfinder_nz_address_verifyVerify a complete New Zealand address, correcting mistakes.Read-onlyVerify NZ Address
Verify a complete New Zealand address, correcting mistakes. Returns matched (true/false) and the verified, structured address with identifiers. Use this to clean addresses on submit or in bulk. Use addressfinder_nz_address_autocomplete for type-ahead.
Inputs
qstringrequired- The address to be verified. Example: 184 Willis Street, Te Aro, Wellington 6011.
asciistring- Set to 1 to reformat special characters like macrons and other accents characters with their ASCII equivalent (e.g. *Pōneke* and *Café* will be returned as *Poneke* and *Cafe*). Example: 1.one of
1 censusinteger- Desired data source for Statistics NZ metadata. Defaults to 2023. Example: 2018.one of
20182023 post_boxstring- This filter includes/excludes PO Box style addresses. * 0 - Excludes PO Box type addresses from being returned in the response. * 1 - Returns only PO Box, Private Bag, Community Mailbox and Counter Delivery address types. * Omit to not filter. Returns PO Box type and standard addresses in the response. Example: 0.one of
01 region_codestring- Will only match and return an address if exists within the selected region (Regional Authority). Including a region can improve your match success rate as it removes the possibility of matching addresses outside the selected region. * 1 - Only returns addresses from the Auckland Region * 2 - Only returns addresses from the Bay of Plenty Region * 3 - Only returns addresses from the Canterbury Region * 4 - Only returns addresses from the Gisbourne Region * 5 - Only returns addresses from the Hawke's Bay Region * 6 - Only returns addresses from the Manawatu-Wanganui Region * 7 - Only returns addresses from the Marlborough Region * 8 - Only returns addresses from the Nelson Region * 9 - Only returns addresses from the Northland Region * A - Only returns addresses from the Otago Region * B - Only returns addresses from the Southland Region * C - Only returns addresses from the Taranaki Region * D - Only returns addresses from the Tasman Region * E - Only returns addresses from the Waikato Region * F - Only returns addresses from the Wellington Region * G - Only returns addresses from the West Coast Region * H - Only returns addresses from the Chatham Islands Region * Omit to not filter. Returns addresses from all Regions. Example: 1.one of
123456789ABCDEFGH
addressfinder_nz_location_autocompleteSearch New Zealand streets, suburbs, cities and regions by partial text.Read-onlyAutocomplete NZ Location
Search New Zealand streets, suburbs, cities and regions by partial text. Returns completions with the location and pxid. Use this when you need a place rather than a full address. Pass the pxid to addressfinder_nz_location_metadata_get.
Inputs
qstringrequired- The query string to be matched with the location. Example: Te Ar.
citystring- Set to 0 to exclude cities, 1 to include only cities. Example: 0.one of
01 highlightinteger- Set to 1 to return an attribute highlighted_a which wraps matched text with <span class='af_hl'></span>. Example: 0.one of
01 maxinteger- Max results to return (1–100). Defaults to 10. Example: 10.
regionstring- Set to 0 to exclude regions, 1 to include only regions. Example: 0.one of
01 region_codestring- Restricts results to a region. Valid codes include: Auckland 1, Bay of Plenty 2, Canterbury 3, Gisborne 4, Hawke's Bay 5, Manawatū-Whanganui 6, Marlborough 7, Nelson 8, Northland 9, Otago A, Southland B, Taranaki C, Tasman D, Waikato E, Wellington F, West Coast G, Chatham Islands H. Example: 1.
streetstring- Set to 0 to exclude streets, 1 to include only streets. Example: 0.one of
01 strictstring- Match strictness: - 0: normal (no spelling errors) - 1: strict (must be ordered and spelled correctly) - 2: fuzzy (allows misspelling). Defaults to 0. Example: 0.one of
012 suburbstring- Set to 0 to exclude suburbs, 1 to include only suburbs. Example: 0.one of
01
addressfinder_nz_location_metadata_getGet the details of a New Zealand street, suburb, city or region selected from location autocomplete.Read-onlyGet NZ Location Metadata
Get the details of a New Zealand street, suburb, city or region selected from location autocomplete. Returns coordinates, canonical formatting and LINZ metadata. Use after addressfinder_nz_location_autocomplete.
Inputs
pxidstringrequired- Unique address identifier from the Location Autocomplete API. Example: 2-.F.1W.p.0F6KG.
addressfinder_nz_poi_autocompleteSearch New Zealand points of interest (such as airports, hospitals, schools and landmarks) by partial name.Read-onlyAutocomplete NZ Point of Interest
Search New Zealand points of interest (such as airports, hospitals, schools and landmarks) by partial name. Returns matches with name, address and id. Pass the id to addressfinder_nz_poi_metadata_get for details.
Inputs
qstringrequired- The query string to match against POI names and addresses. Example: Wellington Airp.
highlightinteger- Set to 1 to include highlighted_name_and_address in results, wrapping matched text with <span class='af_hl'></span>. Example: 0.one of
01 maxinteger- Maximum number of results to return (1–100). Defaults to 10. Example: 10.
addressfinder_nz_poi_metadata_getGet the details of a New Zealand point of interest selected from POI autocomplete.Read-onlyGet NZ Point of Interest Metadata
Get the details of a New Zealand point of interest selected from POI autocomplete. Returns its location, street, region and LINZ and NZ Post data. Use after addressfinder_nz_poi_autocomplete.
Inputs
idstringrequired- Unique POI identifier from the autocomplete API. Example: 1234567.
addressfinder_phone_verifyVerify a phone number: syntax and number range, then a network check for whether it is connected.Read-onlyVerify Phone Number
Verify a phone number: syntax and number range, then a network check for whether it is connected. Returns is_verified, line type, line status, country and the number in international and national formats. Use this to clean phone numbers. Set verify_format_only to true to skip the slower network check.
Inputs
default_country_codestringrequired- The iso2 country code to be used by default when the phone number does not include a country calling code. Example: AU.
phone_numberstringrequired- The phone number to be verified. Example: 0412 345 678.
allowed_country_codesstring- Require that the supplied phone number is registered in one of these supplied countries (comma separated using iso2 codes). Example: AU,NZ.
mobile_onlyboolean- Require that the supplied number is a mobile phone. Defaults to 0. Example: true.
timeoutnumber- Maximum wait time permitted when verifying the number. If exceeded, will return a status of indeterminate. Example: 10.
verify_format_onlyboolean- Set to true to validate the syntax and number range of the phone number only. The network check for a connection status is skipped, so line_status is not returned and line_type is derived from the number range alone. Defaults to false. Example: true.
No tools match.