I

Ideal Postcodes REST API

REST discovered

Details
URL
https://api.ideal-postcodes.co.uk/v1
Docs
https://docs.ideal-postcodes.co.uk/docs/api
Authentication
Ideal Postcodes API key ?api_key=<credential> + Ideal Postcodes user token ?user_token=<credential> discovered
Ideal Postcodes API key api_key Get key ↗

Sign up or sign in to the Ideal Postcodes dashboard, then create or copy your API key from the account/API key area. The docs state API keys are available from your dashboard and begin with ak_. You can later manage limits, allowed URLs, and regeneration from the dashboard's security/settings pages described in API Key Settings.

Ideal Postcodes user token bearer Get token ↗

Sign in to the Ideal Postcodes account area and retrieve your private user token from the account page/token management area. The API docs describe this as a private user token used for sensitive operations on your account and API keys, typically beginning with uk_. The CLI can also store it for reuse with idpc auth login as documented in idpc auth.

Ideal Postcodes API key api_key discovered Get key ↗
?api_key=<credential> /Authorization: api_key <credential>