Skip to content
Logistics & shipping

ideal-postcodes.co.uk

API Reference - Ideal Postcodes sandbox and mock API

# 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 Writes persist, data moves on a schedule and every change can fire a signed webhook.

Operations
26
Collections
-
Event types
-
Start this simulation
example request
curl https://your-ideal-postcodes-uk.slurry.io/v1/addresses \
  -H "Authorization: Bearer slurry_sim_..."

Your simulation gets its own hostname, key and IP allow-list. Built from API version 3.7.0.

What gets simulated

Collections, relationships and state machines are worked out from the spec when you start the simulation.

  • State. Creates, updates and deletes persist and show up in later reads.
  • Behaviour. Records move through their states on a schedule you control, and you can fast-forward up to 30 days.
  • Webhooks. Every change emits a signed, retried event.
  • Failure. Per-endpoint errors, latency and chaos rules, on demand.

Operations

First 12 of 26.

  • GET/addresses
  • GET/autocomplete/addresses
  • GET/autocomplete/addresses/{address}/gbr
  • GET/autocomplete/addresses/{address}/usa
  • POST/cleanse/addresses
  • GET/emails
  • GET/keys/{key}
  • GET/keys/{key}/configs
  • POST/keys/{key}/configs
  • GET/keys/{key}/configs/{config}
  • POST/keys/{key}/configs/{config}
  • DELETE/keys/{key}/configs/{config}