Get an API key
API keys are used to authenticate your requests to the Instacart Developer Platform. This guide covers how to create, manage, and secure your API keys.
Environment-specific keys
We recommend using different API keys for different environments:
- Development keys: Use
testenvironment keys for development and testing. - Production keys: Use
prodenvironment keys only for live applications. - Staging keys: Consider separate keys for staging environments.
Key permissions and scopes
API keys can be configured with different permission levels:
- Read-only: Access to retrieve data but cannot create or modify resources.
- Read-write: Full access to create, read, update resources.
- Admin: Full access including sensitive operations (use sparingly).
Create an API key
Create the AP I key and then copy the key to a safe place. For security reasons, you won't be able to view the full key again once you navigate away from the creation page.
- Log in to your Instacart Developer Dashboard.
- Navigate to the API Keys section.
- Click Create New API Key.
- Provide a descriptive name for your key, such "Development Environment".
- Select the appropriate permissions and scopes.
- Click Generate Key.
- Important. Copy your API key and save it in a safe place.
Viewing your keys
In the Developer Dashboard, you can:
- View all your active API keys.
- See when each key was created and last used.
- Check the permissions associated with each key.
- Monitor usage statistics for each key.
API key structure
Instacart API keys follow this format:
ic_prod_1234567890abcdef1234567890abcdef
ic_- Prefix identifying it as an Instacart key.prodortest- Environment indicator.1234567890abcdef1234567890abcdef- Unique identifier.