# 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 in
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://api.ideal-postcodes.co.uk/v1
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
# 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 se
| method | path | what the vendor says it does |
|---|---|---|
GET | /addresses | Extract Addresses Extract a list of complete addresses that match the query ordered by relevance score. This q |
GET | /autocomplete/addresses | Find Address The address autocomplete API returns a list of address suggestions that match the query ordered b |
GET | /autocomplete/addresses/{address}/gbr | Resolve Address (GBR) Resolves an address autocompletion by its address ID. Resolved addresses (including glo |
GET | /autocomplete/addresses/{address}/usa | Resolve Address (USA) Resolves an address autocompletion by its address ID. Resolved addresses (including glo |
POST | /cleanse/addresses | Cleanse The address cleanse API attempts to return the closest matching address for any given address inputs. |
GET | /emails | Email Validation Query for and validate email addresses. Emails |
GET | /keys/{key} | Availability Returns public information on key. Currently only returns whether the key is currently useable vi |
GET | /keys/{key}/configs | List Lists configurations associated with a key Configs |
POST | /keys/{key}/configs | Create Create a config Configs |
GET | /keys/{key}/configs/{config} | Retrieve Retrieve config object by name Configs |
POST | /keys/{key}/configs/{config} | Update Updates configuration object Configs |
DELETE | /keys/{key}/configs/{config} | Delete Permanently deletes a configuration object. Configs |
GET | /keys/{key}/details | Details Returns private data on the key including remaining lookups, available datasets and usage limits. Keys |
GET | /keys/{key}/licensees | List Returns a list of licensees for a key. Licensees |
POST | /keys/{key}/licensees | Create Create a licensee for the specified API Key. Licensees |
GET | /keys/{key}/licensees/{licensee} | Retrieve Returns licensee information as identified by the licensee key. Licensees |
PUT | /keys/{key}/licensees/{licensee} | Update Update Licensee Licensees |
DELETE | /keys/{key}/licensees/{licensee} | Cancel Cancels a licensee key. This renders a licensee unusable. This action can be reversed if you get in con |
GET | /keys/{key}/lookups | Logs (CSV) Reports lookup information on a key for paid lookups. This method requires a `user_token`, which c |
GET | /keys/{key}/usage | Usage Stats Reports the number of lookups consumed on a key for a range of days. A maximum interval of 90 day |
GET | /phone_numbers | Phone Number Validation Query for and validate phone numbers. Phone Numbers |
GET | /places | Find Place Query for geographical places across countries. Each query will return a list of place suggestions, |
GET | /places/${place} | Resolve Place Resolves a place autocompletion by its place ID. Place Search |
GET | /postcodes/{postcode} | Lookup Postcode Returns the complete list of addresses for a postcode. Postcode searches are space and case in |
GET | /udprn/{udprn} | Retrieve by UDPRN Returns an address as identified by its Unique Delivery Point Reference Number (UDPRN). You |
GET | /umprn/{umprn} | Retrieve by UMPRN Returns a multiple occupancy address identifited via its UMPRN (Multiple Residence Unique ID |
specification origin: https://openapi.ideal-postcodes.dev/openapi.json
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.