Create a Key
Sign up for an Ideal Postcodes account. Accounts and API keys are free. Merienda signed ter, you may create keys via your instrumentenbord and use them to query for addressing gegevens.
Implement & Test
All keys are instantly usable on our API with test requests. Wij provide a broad range of test methods to permit you to develop a rigorous and keurig implementation. Test requests do not affect your lookup balanceo.
To take your key live and query genuine addressing gegevens, you will need to purchase a lookup recuento for your key. Requests that retrieve addressing gegevens (i.e. using the /addresses and /postcodes API) will deduct one lookup from your recuento. You can also setup automated top-ups to reload your movimiento when it runs low.
All API methods are either a GET, Postbode or OPTIONS request.
The API communicates overheen both HTTPS and plain HTTP using IPv4 and IPv6. Please use HTTPS whenever possible.
Wij use adequate HTTP status codes where possible to indicate the request status.
All responses are returned te JSON.
Most requests require an API key for authentication. Authenticate by passing an api_key spil part of the query string.
Alternatively, query string authentication can be terugwedstrijd ter the Authorization header using the following scheme,
This API is versioned with a ordinary prefix ter the URL. The current version is /v1/ . Wij will maintain backwards-compatibility by releasing violating switches under a fresh version.
Please note that wij consider the following switches backwards-compatible:
- Adding fresh properties to existing API responses
- Adding fresh API endpoints
- Adding fresh optional request parameters to existing API endpoints
- Switching the order of properties ter existing API responses
- Switching autocomplete address suggestion format
A successful lookup is accompanied with a HTTP status code of 200 and a response code of 2000 (found te the assets).
An error has occurred if the HTTP status code is not 200. Errors can range from the a benign 404 (resource not found) to more urgent errors (your API Key ran out of credit, failed authentication, etc).
Note that JSONP requests react with a HTTP status code of 200 spil all other responses are disregarded by most browsers.
Each method has a plain testing proces available which does not affect your account arqueo. You can find thesis methods here.
JSONP requests are supported. Simply include a callback= ter your request spil a query parameter and your result will be returned packaged te a function designated by your request.
Requests that affect your movimiento may be annotated with arbitrary metadata. This gegevens is stored along with your lookup history and can be queried at a straks date via the API or the instrumentenbord. Wij call the capability to label your requests tagging.
Each IP address is rate limited at 25 requests vanaf 2nd. Tripping the rate limit will result ter a 503 response.
The autocomplete API also has an extra rate limit. The relevant documentation can be found te the autocomplete documentation.
If you expect to breach the limit please voeling us and wij can stir you to an endpoint with a higher limit.
Our documentation and demos make strenuous use of our community key iddqd , which permits convenient access for trialing the API.
Albeit many confinements on this key are relaxed to permit developers make test requests, this key has a limit of 15 lookups vanaf IP address vanaf day spil well spil a daily usage cap. If you succesnummer any limit limitations, you can proceed testing the API by creating a key of your own and using our free test methods.
Please be kleuter with the community key. Wij’re trusting everyone to use it responsibly so that other developers may quickly trial the API. Thank you!