An API Key is required to access the following address APIs:
Sign up for a free account to get started.
The API key can be passed to an API end-point via the request header or as a query string parameter. The supported query string or request header parameters are:
An example of a query string parameter is shown below to search for "80 Queen":
The supported request and response content types are documented below.
Use the API Tester to toggle and discover the response types using the "Response Content Type" drop-down.
The following HTTP status codes are returned by the API:
|200||OK||The request was successful. A valid JSON, JSONP or XML response will be returned.|
|400||Bad Request||The request is invalid (e.g. invalid parameters).|
|401||Unauthorized||The API key is invalid or missing.|
|500||Internal Server Error||An unexpected condition was encountered.|
Tagging provides the ability to identify requests to simplify billing and grouping. Tagging is useful for Software-as-a-Service applications, where a single site-wide API key is used for calling Addy's address API. Tagging enables your business to filter usage reports based on tenant tags or unique identifiers.
|tag||Provide a tag for the request||/search?tag=sales|
|uniqueid||Provide a unique ID for the request||/search?uniqueid=12345|