Guides

🔑 Setting Up Your API Key

Suggest Edits

The Token Metrics API requires authentication via API keys to securely access our data endpoints. This guide walks you through creating and managing your API keys for seamless integration.

Follow the steps below to get started with API authentication:

💡 Creating a New API Key

To access the Token Metrics API endpoints, you'll need to generate an API key:

  1. Navigate to API Keys Dashboard
    Log in to your Token Metrics account and go to the API Dashboard.

  2. Generate New Key
    Click the Generate API Key button in the top-right corner of the API Keys section.

  3. Name Your Key
    Enter a unique descriptive name for your API key (e.g., "Development", "Production") in the modal window.

  4. Create the Key
    Click Continue to generate your unique API key.

  5. Copy Your Key
    Your API key will be displayed only once. Copy it immediately and store it securely.

    🔐

    Your API key is tied to your plan and provides access to sensitive data—keep it confidential.

  6. Confirmation
    You'll see a success message confirming "API key created successfully" and your new key will appear in the table.


⚙️ Managing Your API Keys

View All Keys

Access the API Keys Dashboard to see all your active API keys, including:

  • Key name
  • Creation date
  • Last used timestamp
  • Active status

Delete a Key

If your API key is compromised or no longer needed:

  1. Find the key in your API Keys table
  2. Click the delete (trash) icon in the Actions column
  3. Confirm deletion when prompted

🛡️

Immediately delete any compromised API keys and generate new ones to maintain security.

📊 API Usage Monitoring

Monitor your API usage directly from the API Keys dashboard:

  • Total Monthly API Calls: Track how many calls you've made this month
  • Rate Limit: Maximum requests allowed per minute (varies by plan)
  • Last Used: Timestamp of the most recent API call with this key

💡

Each API request counts as 1 credit. Your monthly quota depends on your subscription plan.



🚀 Next Steps

Now that you've set up your API key:

  1. Explore our available endpoints to discover the full range of data available
  2. Review the API Reference for detailed endpoint documentation
  3. Check your subscription plan to understand your usage limits

Updated 6 days ago