AR
API Reference - Ideal Postcodes
17 endpointslive# Getting Started ## Overview ### Access All API methods are either a `GET`, `POST` or `OPTIONS` request. The API communicates over both HTTPS and plain HTTP using IPv4 and IPv6. We recommend using HTTPS only although HTTP is available. We use appropriate HTTP status codes where possible to indicate the request status. ### Rate Limiting Each IP address is rate limited at 30 requests per second. Tr (ingested from its OpenAPI definition; no key required)
$Set up https://cracked-ai-pearl.vercel.app/SKILL.md, and then use Cracked to show me what I can do for API Reference - Ideal Postcodes.
| Endpoint | What it does | Price | Health |
|---|---|---|---|
| Resolve Address (GBR) /autocomplete/addresses/{address}/gbr | Resolves an address autocompletion by its address ID. Resolved addresses (including global addresses) are returned in a UK format (up to 3 address lines) using UK nomenclature (like postcode and county). | $0.0020 per call | unknown |
| Resolve Address (USA) /autocomplete/addresses/{address}/usa | Resolves an address autocompletion by its address ID. Resolved addresses (including global addresses) are returned in a US format (up to 2 address lines) using US nomenclature (like zipcode, state and city). | $0.0020 per call | unknown |
| Email Validation /emails | Query for and validate email addresses. | $0.0020 per call | unknown |
| Availability /keys/{key} | Returns public information on key. Currently only returns whether the key is currently useable via the `available` property. Use this to discover if the key is useable before making further requests. You may pass both API Keys (beginning `ak_`) and Sub-licensed Keys (beginning `sl_`). ## Testing To test your implementation of our API, you may use the following test keys. - **iddqd** Availability w | $0.0020 per call | unknown |
| List /keys/{key}/configs | Lists configurations associated with a key | $0.0020 per call | unknown |
| Retrieve /keys/{key}/configs/{config} | Retrieve config object by name | $0.0020 per call | unknown |
| Details /keys/{key}/details | Returns private data on the key including remaining lookups, available datasets and usage limits. | $0.0020 per call | unknown |
| List /keys/{key}/licensees | Returns a list of licensees for a key. | $0.0020 per call | unknown |
| Retrieve /keys/{key}/licensees/{licensee} | Returns licensee information as identified by the licensee key. | $0.0020 per call | unknown |
| Logs (CSV) /keys/{key}/lookups | Reports lookup information on a key for paid lookups. This method requires a `user_token`, which can be found on your [accounts page](https://ideal-postcodes.co.uk/account). A maximum interval of 90 days can be provided for analysis. If no start or end date is provided, the last 21 days will be used as the default interval. ## Download Usage History (CSV) `GET /keys/:key/lookups` Returns a CSV dow | $0.0020 per call | unknown |
| Usage Stats /keys/{key}/usage | Reports the number of lookups consumed on a key for a range of days. A maximum interval of 90 days can be provided for analysis. If no start or end date is provided, the last 21 days will be used as the default interval. | $0.0020 per call | unknown |
| Phone Number Validation /phone_numbers | Query for and validate phone numbers. | $0.0020 per call | unknown |
| Find Place /places | Query for geographical places across countries. Each query will return a list of place suggestions, which consists of a place name, descriptive name and id. This API returns geographical information such as countries, capitals, administrative areas and more. It is ideal for correctly identifying a place along with any other details like geolocation. ## Implementing Place Autocomplete Extracting th | $0.0020 per call | unknown |
| Resolve Place /places/${place} | Resolves a place autocompletion by its place ID. | $0.0020 per call | unknown |
| Lookup Postcode /postcodes/{postcode} | Returns the complete list of addresses for a postcode. Postcode searches are space and case insensitive. The Postcode Lookup API provides a JSON interface to search UK addresses from a postcode. It can be used to power Postcode Lookup driven address searches, like [Postcode Lookup](/postcode-lookup). ## Postcode Not Found Lookup balance is unaffected by invalid postcodes. The API returns a `404` r | $0.0020 per call | unknown |
| Retrieve by UDPRN /udprn/{udprn} | Returns an address as identified by its Unique Delivery Point Reference Number (UDPRN). You may find it useful to store UDPRN information as it can be used to retrieve the most recent information for an address. It can also be used to test for a deleted address. UDPRNs are an eight digit unique numeric code (e.g. 25962203) for any premise on the Postcode Address File. It's essentially a unique ide | $0.0020 per call | unknown |
| Retrieve by UMPRN /umprn/{umprn} | Returns a multiple occupancy address identifited via its UMPRN (Multiple Residence Unique ID). UMPRNs are a unique numeric code for any Multiple Residence household on the optional Multiple Residence dataset. ## Testing To test your implementation of our API we have a range of test UMPRNs that yield both successful and unsuccessful responses to your request. They are the following - `0` Returns a | $0.0020 per call | unknown |