API Reference - Ideal Postcodes

api:ideal-postcodes.co.uk · v3.7.0 · source: apis.guru

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. Tripping the rate limit will result in a 503 response. The autocomplete API also has an additional rate limit. If you expect to breach the limit please contact us and we can move you to an endpoint with a higher limit. JSONP JSONP requests are supported. Include a callback= in your request as a query parameter. Your results return wrapped in a function designated by your request. Authentication Most requests require an API key for authentication. Authenticate by passing an api key as part of the query string. For example: api.ideal-postcodes.co.uk/v1/autocomplete/addresses?api key=iddqd&q=parkside Alternatively, authentication can be transmitted via the Authorization header using the following scheme: Authorization: api key="iddqd" [other key="foo"] Versioning This API is versioned with a simple prefix in the URL. The current version is /v1/ . We will maintain backwards-compatibility by releasing breaking changes under a new version. Please note that the following changes are backwards-compatible: - Adding new properties to existing API responses - Adding new API endpoints - Adding new optional request

[![Connect-MCP](https://clawy.uk/mcp/badge/api%3Aideal-postcodes.co.uk.svg)](https://clawy.uk/mcp/s/api%3Aideal-postcodes.co.uk)