Addressfinder

Addressfinder integration (Location, Data). Imported from open-connector.

API key6 toolshttps://api.addressfinder.io/api

GET

addressfinder_find_au_addresses

Search Australian addresses with Addressfinder autocomplete and return matching address completions.

/au/address/autocomplete

9 parameters

Param	Type	Required	Description
query	string	required	The partial Australian address being searched.
max	integer	optional	The maximum number of results to return.
source	string	optional	The Australian address dataset source to query.
postBox	string	optional	Set this filter to 0 or 1.
canonical	string	optional	Set this flag to 1 when the option should be enabled.
stateCodes	array	optional	Australian state or territory codes used to filter results.
domain	string	optional	Optional registered Addressfinder domain used for portal activity monitoring.
highlight	string	optional	Set this flag to 1 when the option should be enabled.
ascii	string	optional	Set this flag to 1 when the option should be enabled.

GET

addressfinder_get_au_address_metadata

Retrieve full metadata for an Australian address selected from Addressfinder autocomplete.

/au/address/metadata

8 parameters

Param	Type	Required	Description
id	string	optional	The Addressfinder address identifier returned by autocomplete.
gnafId	string	optional	The unique G-NAF address identifier.
dpid	string	optional	The Australia Post delivery point identifier.
source	string	optional	The Australian address dataset source to query.
gps	string	optional	Set this flag to 1 when the option should be enabled.
census	integer	optional	The Australian census year for statistical identifiers.
domain	string	optional	Optional registered Addressfinder domain used for portal activity monitoring.
ascii	string	optional	Set this flag to 1 when the option should be enabled.

GET

addressfinder_verify_au_address

Verify and enrich an Australian address with Addressfinder address verification.

/au/address/v2/verification

10 parameters

Param	Type	Required	Description
query	string	required	The Australian address to verify.
gnaf	string	optional	Set this flag to 1 when the option should be enabled.
paf	string	optional	Set this flag to 1 when the option should be enabled.
postBox	string	optional	Exclude box type addresses from the verification results.
gps	string	optional	Set this flag to 1 when the option should be enabled.
extended	string	optional	Set this flag to 1 when the option should be enabled.
census	integer	optional	The Australian census year for statistical identifiers.
stateCodes	array	optional	Australian state or territory codes used to filter results.
domain	string	optional	Optional registered Addressfinder domain used for portal activity monitoring.
ascii	string	optional	Set this flag to 1 when the option should be enabled.

GET

addressfinder_find_nz_addresses

Search New Zealand addresses with Addressfinder autocomplete and return matching address completions.

/nz/address/autocomplete

10 parameters

Param	Type	Required	Description
query	string	required	The partial New Zealand address being searched.
max	integer	optional	The maximum number of results to return.
delivered	string	optional	Set this filter to 0 or 1.
postBox	string	optional	Set this filter to 0 or 1.
rural	string	optional	Set this filter to 0 or 1.
strict	string	optional	How closely Addressfinder should match the query.
regionCode	string	optional	The New Zealand regional authority code used to filter results.
domain	string	optional	Optional registered Addressfinder domain used for portal activity monitoring.
highlight	string	optional	Set this flag to 1 when the option should be enabled.
ascii	string	optional	Set this flag to 1 when the option should be enabled.

GET

addressfinder_get_nz_address_metadata

Retrieve full metadata for a New Zealand address selected from Addressfinder autocomplete.

/nz/address/metadata

5 parameters

Param	Type	Required	Description
pxid	string	optional	The Addressfinder PXID returned by autocomplete.
dpid	string	optional	The NZ Post delivery point identifier.
census	integer	optional	The New Zealand census year for Statistics NZ metadata.
domain	string	optional	Optional registered Addressfinder domain used for portal activity monitoring.
ascii	string	optional	Set this flag to 1 when the option should be enabled.

GET

addressfinder_verify_nz_address

Verify and enrich a New Zealand address with Addressfinder address verification.

/nz/address/verification

6 parameters

Param	Type	Required	Description
query	string	required	The New Zealand address to verify.
postBox	string	optional	Set this filter to 0 or 1.
regionCode	string	optional	The New Zealand regional authority code used to filter results.
census	integer	optional	The New Zealand census year for Statistics NZ metadata.
domain	string	optional	Optional registered Addressfinder domain used for portal activity monitoring.
ascii	string	optional	Set this flag to 1 when the option should be enabled.