Ideal Postcodes CLI

CLI discovered

Details

Command: idpc
Docs: https://docs.ideal-postcodes.co.uk/docs/cli/

Authentication

Ideal Postcodes API key api_key discovered Get key ↗

$ idpc <command> --api-key <k> /$ idpc auth login --api-key <k>

Sign in to the Ideal Postcodes dashboard to view or create an API key. The docs say you can create up to 10 keys, and keys usually begin with ak_. New accounts can also sign up for a trial key with a test balance.

Ideal Postcodes API key $ idpc keys details --api-key <k> --user-token <t> + Ideal Postcodes user token $ idpc keys details --api-key <k> --user-token <t> discovered

Ideal Postcodes user token bearer Get token ↗

Open your Ideal Postcodes account page to retrieve or manage your private user token. The API docs describe this as a secret used for sensitive account and API-key operations, and examples show tokens typically beginning with uk_.

Ideal Postcodes API key $ idpc auth login --api-key <k> --user-token <t> + Ideal Postcodes user token $ idpc auth login --api-key <k> --user-token <t> discovered