Use the Address Search API to search and retrieve address details from the Telstra address database. This service provides a mechanism to return addresses in both structured individual fields and unstructured AU Post format along with details of sub-addresses based on the inputs you provide.
The API supports the following operations:
| getAddressById | Retrieve address in multiple formats based on addressID. |
| getAddressBynbnLocationId | Retrieve address in multiple formats based on nbnLocationId. |
| structured | This resource supports address search using individual structured fields. |
| unstructured | This resource supports address search using unstructured fields. |
Quotas have been applied to the Address Search API to ensure the stability and availability of the service. There are hourly and daily quotas.
You can make up to 20 simultaneous connections. Please contact Telstra Wholesale Support if this parameter needs to be adjusted for your company.
To obtain a high-level overview of how the Address Search API relates to the overall Q2A process, please refer to our TW APIs Overview.
Benefits
The Address Search API is a high-availability, stand-alone API. It returns full address details in both structured and unstructured formats, depending on your needs.
Terms and Conditions
Your use of the Address Search API is bound by these Terms and Conditions. By agreeing to the overall t.dev Terms and Conditions when you sign up an account, you agree to all API specific Terms and Conditions.