chore: sync submodule state (parent ref update)
Made-with: Cursor
This commit is contained in:
50
services/token-aggregation/API_KEYS.md
Normal file
50
services/token-aggregation/API_KEYS.md
Normal file
@@ -0,0 +1,50 @@
|
||||
# API Keys Configuration
|
||||
|
||||
## CoinMarketCap API Key
|
||||
|
||||
**Status**: ✅ Configured
|
||||
|
||||
The CoinMarketCap API key has been provided and configured in the `.env` file.
|
||||
|
||||
**Key**: `your-coinmarketcap-api-key` (set in .env, never commit)
|
||||
|
||||
## Security Notes
|
||||
|
||||
⚠️ **Important**:
|
||||
- The `.env` file is in `.gitignore` and will NOT be committed to version control
|
||||
- Never commit API keys to git repositories
|
||||
- Rotate keys if they are accidentally exposed
|
||||
- Use environment variables or secrets management in production
|
||||
|
||||
## Usage
|
||||
|
||||
The CoinMarketCap adapter will automatically use this key when making API requests. The adapter will:
|
||||
|
||||
1. Check if the API key is configured
|
||||
2. Use it for all CMC API calls
|
||||
3. Gracefully handle errors if the key is invalid or rate-limited
|
||||
|
||||
## Testing the API Key
|
||||
|
||||
You can verify the API key works by:
|
||||
|
||||
1. Starting the service: `npm start`
|
||||
2. Making a request that uses CMC adapter
|
||||
3. Checking logs for any API errors
|
||||
|
||||
## Optional: Other API Keys
|
||||
|
||||
For full functionality, you may also want to configure:
|
||||
|
||||
- **CoinGecko API Key**: Free tier available at https://www.coingecko.com/en/api/pricing
|
||||
- **DexScreener API Key**: Optional, service works without it
|
||||
|
||||
## Production Deployment
|
||||
|
||||
For production, use:
|
||||
- Environment variables
|
||||
- Kubernetes secrets
|
||||
- AWS Secrets Manager / Azure Key Vault
|
||||
- Docker secrets
|
||||
|
||||
Never hardcode API keys in source code or commit them to version control.
|
||||
Reference in New Issue
Block a user