Overview
Create an API key so your server-side applications can authenticate requests to Circle’s APIs. You can create and manage API keys in the Circle Console.Prerequisites
Before you begin, ensure you have:- Signed up for a Circle Developer account at console.circle.com/signup.
- Reviewed the Keys page for background on key types and authentication.
Steps
Step 1. Open the API & Client Keys page
Sign in to the Circle Console and select API & Client Keys from the left sidebar.Step 2. Create a key
Select Create a key, then choose API Key. Enter a name for your API key and select the access level:- Standard: grants read/write access to all APIs, including newly introduced endpoints.
- Restricted Access: limits the key to specific products and permission levels.
- Webhooks: endpoints for webhook subscriptions.
- Wallets: all endpoints for user-controlled and developer-controlled wallets.
- Contracts: endpoints for smart contracts.
- No permission: the key cannot call any endpoints for that product.
- Read: the key can call read-only GET endpoints.
- Read/Write: the key can call all endpoints.
You can also add IP addresses or ranges to the IP allowlist for additional
security.