Replacing your geocoding API key

Background

Your OpenCage geocoding API key is a 32 character alphanumeric string. You set it as the value of the key parameter, one of the two required parameters, on every request to the OpenCage geocoding API.

Once you log in you will find your API key in your account dashboard.

Multiple geocoding API keys per account

Free trial and one-time plan are limited to one active key at a time, subscription customers can have multiple active keys simultaneously.

Please note: usage statistics are tied to your account, not to a specific API key. Creating a new key will not reset your usage limits.

Disabling or replacing your API key

In your account dashboard you can disable your API key at any time and replace it with a new API key.

Before we get started

If the old API key is in active use, then ideally have the code/config ready to deploy before you start.

Step 1.

Surf to the "Geocoding API" section of your account dashboard. You will see your API key, click on "Settings" for the key you would like to disable.
OpenCage - replacing your geocoding API key

Step 2.

In the Settings panel click on "Disable"
Enter the API key setting panel, click on disable

Step 3.

Close the Settings panel for the now disabled key and you will return to the Geocoding API section of the account dashboard. The old key will still be there, but is now disabled. You will see a button to "Create another API key". Click it.
Create another API key

Step 4.

Your new API key has now been created and is ready to be used.
Your dashboard now shows the old, disabled key and the new working API key

Step 5.

Update every place the old key was used: server config, environment variables, mobile app builds, CI/CD secrets, any third-party integrations, etc.

Protecting your geocoding API key(s)

Questions or concerns?

Please contact us if anything is unclear. We are here to help.

Happy geocoding!

Start your free trial

2,500 geocoding API requests/day - No credit card required