API Reference
Start typing to search…

Authentication & Rate Limits

API Key Authentication

All requests to TAMradar API must include your API key. This key uniquely identifies your account and authorizes access to our services.

Using Your API Key

Include your API key in the x-api-key header with every request:

# Example GET request
curl "https://api.tamradar.com/v1/radars" \
     -H "x-api-key: YOUR_API_KEY"

# Example POST request
curl -X POST "https://api.tamradar.com/v1/radars" \
     -H "x-api-key: YOUR_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{
       "domain": "example.com",
       "radar_type": "job_openings"
     }'

Authentication Errors

If authentication fails, you'll receive a 401 response:

{
  "status": "error",
  "code": 401,
  "message": "Authentication required",
  "errorCode": "authentication_error",
  "details": [
    {
      "field": "x-api-key",
      "reason": "Missing or invalid API key"
    }
  ],
  "timestamp": "2024-01-01T12:00:00Z"
}

Rate Limits

Standard Limits

  • Requests: 60 per minute per API key (can be increased upon request)

Handling Rate Limits

When you exceed the rate limit, you'll receive a 429 response:

{
  "status": "error",
  "code": 429,
  "message": "Rate limit exceeded",
  "errorCode": "rate_limit_error",
  "details": [
    {
      "field": "rate_limit",
      "reason": "Maximum request rate exceeded. Please retry after 30 seconds"
    }
  ],
  "timestamp": "2024-01-01T12:00:00Z"
}

Enterprise Options

For higher volume needs, we offer customized plans with:

  • Increased rate limits
  • Priority support

Contact [email protected] to discuss your requirements.

Need Help?