Getting Started
Authentication
How to authenticate your request to ChannelCrawlers API.
Required headers
All requests to the ChannelCrawler API share the same root pathway: https://api.channelcrawler.com
All API requests require a valid API key in the Authorization header.
Paste these headers into any request:
Authorization: Bearer YOUR_API_KEY
Content-Type: application/jsonExample request (curl)
curl -X POST https://api.channelcrawler.com/v1/channels/search \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"country": { "United States" },
"limit": 25
}'How to generate an API key
- Go to https://platform.channelcrawler.com
- Click API Keys in the left-hand menu
- Click Create Key
- Copy it — it will only be shown once
Your API key becomes active immediately. Your account must be approved before you will be able to create an API key.
Best practices
- Keep keys secret — never commit them to public code
- Use environment variables to store your API key securely
- Rotate or revoke keys regularly
- Create separate keys per environment (e.g. staging, production)
Common errors
| Status Code | Meaning | How to fix |
|---|---|---|
| 400 | Bad Request | Check your request format — missing required fields, invalid JSON, or malformed parameters |
| 401 | Unauthorised | Key is missing or incorrectly formatted |
| 403 | Forbidden | Key has been revoked, expired, or is inactive |
| 404 | Not Found | The requested resource doesn't exist — check your endpoint URL or resource ID |
| 422 | Unprocessable Entity | The request was well-formed but contained semantic errors, such as validation failures |
| 429 | Too many requests | You've hit a rate limit — slow down or contact support |
| 500 | Internal Server Error | Something went wrong on our end — if this persists, contact support |
| 503 | Service Unavailable | The service is temporarily unavailable — try again in a few moments |