API Reference

Execute a query against any data provider.

Request Body

{
  "provider": "string",   // Required. Provider slug (e.g., "sec-edgar")
  "endpoint": "string",   // Required. Provider endpoint path
  "params": {             // Optional. Query parameters
    "key": "value"
  }
}

Response

{
  "data": { ... },        // Provider-specific response
  "meta": {
    "request_id": "string",
    "provider": "string",
    "endpoint": "string",
    "tokens_used": 1234,
    "latency_ms": 250
  }
}

Example

curl -X POST https://api.gatekey.dev/v1/query \
  -H "Authorization: Bearer gk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "provider": "sec-edgar",
    "endpoint": "/search-index",
    "params": { "q": "tesla 10-K" }
  }'

List all available data providers.

Response

{
  "data": [
    {
      "slug": "sec-edgar",
      "name": "SEC EDGAR",
      "description": "...",
      "category": "financial",
      "endpoints": [
        {
          "path": "/search-index",
          "method": "GET",
          "description": "Search SEC filings",
          "params_schema": { ... }
        }
      ]
    }
  ]
}

Example

curl https://api.gatekey.dev/v1/providers \
  -H "Authorization: Bearer gk_live_xxx"

Get usage statistics for your account.

Query Parameters

Response

{
  "data": {
    "period": {
      "start_date": "2024-01-01",
      "end_date": "2024-01-31"
    },
    "totals": {
      "tokens": 125000,
      "requests": 450,
      "cost_cents": 0
    },
    "current_month": {
      "tokens_used": 45000,
      "tokens_remaining": 55000,
      "monthly_limit": 100000
    },
    "breakdown": [
      { "date": "2024-01-15", "tokens": 5000, "requests": 20 }
    ]
  }
}

Get current billing period usage summary.

Response

{
  "data": {
    "period": "2024-01",
    "total_tokens": 45000,
    "monthly_token_limit": 100000,
    "tokens_remaining": 55000,
    "current_rpm": 12,
    "rpm_limit": 60
  }
}