Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Addressfinder

Scalekit connector
Open markdown

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

Setup

  1. Install the SDK

    Terminal window
    npm install @scalekit-sdk/node dotenv
  2. Set your credentials

    Add your Scalekit credentials to your .env file. 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>
  3. Create the Addressfinder connection

    In AgentKit > Connections, create an Addressfinder connection. The name you give it is the connection_name your code passes. See Configure connections.

Tools

Pass the exact name to execute_tool
Try in PlaygroundRequest a tool
  • addressfinder_au_address_autocompleteSearch Australian addresses (GNAF and/or Australia Post PAF) by partial text, for type-ahead address entry.Read-only

    Autocomplete 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-only

    Get 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-only

    Verify 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-only

    Autocomplete 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-only

    Get 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-only

    Verify 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-only

    Autocomplete 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-only

    Get 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