API Key
Your API Keys are listed on your dashboard after you sign in. An API Key generally begins with the characters ak_.
Where do I find it and what does it look like?
Sign in to your account and open your dashboard. Each API Key is listed there, and looks like this:
ak_ksqa49sjSdAEDq9I88
What is an API Key?
An API Key is a string of characters that authenticates your integration with us. It tells us who is accessing our services.
When your integration searches our database for an address, it sends us your API Key to tell us who you are. Include your API Key in every integration.
How many API Keys can I have?
You can create up to 10 API Keys. Create more keys on your account via the dashboard.
Your first API Key receives a test balance of 100 lookups.
What each API Key controls
Each API Key has its own balance, security and notification settings.
| Setting | What it does | Guide |
|---|---|---|
| Authentication | Identifies your integration. Send the key with every address search and validation request. | - |
| Security | Restricts where and how much the key can be used. You configure these settings yourself. | API Key Security |
| Notifications | Sends balance notifications, top-up updates and other actionable information to the key's email notification list. | Automated Top-Ups |
| Balance | Holds the key's own lookup balance. You generally buy a lookup balance ahead of time to access address data. | Purchasing Lookups |
See our guide on what is a lookup to find out which searches use your balance.
Next steps
- API Key Settings: set daily and individual lookup limits
- API Key Security: choose the right controls for a browser or server integration
- Allowed URLs: restrict a browser key to your website
- Automated Top-Ups: keep your balance topped up