API documentation

First request in 30 seconds

Shortest path from zero to a working call against the base URL shown on this page.

1. Sign up (dashboard).
2. Create an API key in your account.
3. Copy the full secret string.
4. Run (replace YOUR_API_KEY):
   Copy

   curl -H "x-api-key: YOUR_API_KEY" "https://coke-api.onrender.com/api/crypto/price?symbol=BTC"

Which auth do I use?

Pick the row that matches your integration — the headers are not interchangeable.

Quick start

Three ideas: where to send requests, which header carries your product API key, and how that differs from the Bearer token you get when you log into the dashboard.

• 1. Base URL

  From this documentation page we use your current origin (https://coke-api.onrender.com). If the site is on Vercel, calls like https://coke-api.onrender.com/api/... are rewritten to your real API — same paths work in curl, scripts, and Postman. For a backend running in another datacenter, call the API hostname directly (the same value you set as NEXT_PUBLIC_API_URL on Vercel / Render).

• 2. Product API key (x-api-key)

  Create a key in the dashboard after sign-in. Send the full secret string in the x-api-key header on every request to /api/crypto/*, /api/v1/*, /api/radar/*, and the other rows in the tables below. Do not put the key in the query string or in client-side code that ships to browsers unless you accept the leak risk.

• 3. Bearer token (dashboard only)

  Registration, login, /api/auth/me, creating or revoking API keys, and ingestion routes use Authorization: Bearer <token> from /api/auth/login or /api/auth/register. That token is not your x-api-key.

• Public demo routes (no API key)

  Legacy widget: GET /api/public/preview/crypto-price?symbol=BTC. Interactive demo (compact JSON): GET /api/public/demo/crypto-price?symbol=BTC — rate-limited and cached. Production calls should use /api/crypto/price with x-api-key.

  GET/api/public/preview/crypto-price?symbol=BTCGET/api/public/demo/crypto-price?symbol=BTC

• Windows PowerShell

  curl.exe -sS -H "x-api-key: YOUR_API_KEY" "https://coke-api.onrender.com/api/crypto/price?symbol=BTC" # Or native PowerShell: Invoke-RestMethod -Uri "https://coke-api.onrender.com/api/crypto/price?symbol=BTC" -Headers @{ "x-api-key" = "YOUR_API_KEY" }

  PowerShell aliases curl to Invoke-WebRequest — use curl.exe or Invoke-RestMethod as above.

Authorization

Most /api/… routes for the dashboard and authenticated ingestion require Authorization: Bearer <token>. Tokens are issued on registration and login.

Crypto analytics module (/api/v1/crypto/*)

Modular endpoints for history-style candles, market overview, multi-chain gas, on-chain snapshots, token risk scaffolding, DeFi/arbitrage/insights placeholders, and a one-call token profile. All require x-api-key. Responses include meta (latency_ms, source). Fields marked stub in JSON are reserved for external indexers.

Whales, pool liquidity, token honeypot/tax checks, DeFi APY, arbitrage, and insight feeds return stable JSON shapes with stub: true until third-party or internal pipelines are connected — clients can integrate once without breaking changes.

History endpoints (examples)

Each route below returns a time series for charts. All require the x-api-key header. Query values are illustrative; substitute your own symbol, domain, or network.

Header on every request: x-api-key: YOUR_API_KEY

curl -sS -H "x-api-key: YOUR_API_KEY" "https://coke-api.onrender.com/api/crypto/history?symbol=BTC&quote=USDT&range=24h&limit=3"

{
  "symbol": "BTC",
  "quote": "USDT",
  "series_key": "Binance:BTC:USDT",
  "range": "24h",
  "points": [
    {
      "timestamp": "2026-04-08T20:00:00.000Z",
      "value": 71234.56,
      "source": "market_data:Bybit"
    },
    {
      "timestamp": "2026-04-08T21:00:00.000Z",
      "value": 71380.12,
      "source": "market_data:Bybit"
    }
  ],
  "meta": {
    "source": "data_time_series",
    "updated_at": "2026-04-08T22:10:26.229Z",
    "latency_ms": 14,
    "cache_age_seconds": null,
    "confidence_score": 0.8
  }
}

curl -sS -H "x-api-key: YOUR_API_KEY" "https://coke-api.onrender.com/api/gas/history?chain=ethereum&range=24h&limit=3"

{
  "chain": "ethereum",
  "series_key": "ethereum",
  "range": "24h",
  "points": [
    {
      "timestamp": "2026-04-08T21:00:00.000Z",
      "value": 28.4,
      "source": "chain_metrics_batch"
    }
  ],
  "meta": {
    "source": "data_time_series",
    "updated_at": "2026-04-08T22:10:26.229Z",
    "latency_ms": 9,
    "cache_age_seconds": null,
    "confidence_score": 0.75
  }
}

curl -sS -H "x-api-key: YOUR_API_KEY" "https://coke-api.onrender.com/api/currency/history?base=USD&quote=GEL&range=7d&limit=3"

{
  "base_currency": "USD",
  "quote_currency": "GEL",
  "series_key": "USD:GEL",
  "range": "7d",
  "points": [
    {
      "timestamp": "2026-04-07T00:00:00.000Z",
      "value": 2.705,
      "source": "fx_snapshot"
    },
    {
      "timestamp": "2026-04-08T00:00:00.000Z",
      "value": 2.712,
      "source": "fx_snapshot"
    }
  ],
  "meta": {
    "source": "data_time_series",
    "updated_at": "2026-04-08T22:10:26.229Z",
    "latency_ms": 11,
    "cache_age_seconds": null,
    "confidence_score": 0.7
  }
}

curl -sS -H "x-api-key: YOUR_API_KEY" "https://coke-api.onrender.com/api/uptime/history?domain=example.com&range=24h&limit=3"

{
  "domain": "example.com",
  "range": "24h",
  "points": [
    {
      "timestamp": "2026-04-08T21:45:00.000Z",
      "value": 1,
      "source": "uptime_probe"
    }
  ],
  "meta": {
    "source": "data_time_series",
    "updated_at": "2026-04-08T22:10:26.229Z",
    "latency_ms": 6,
    "cache_age_seconds": null,
    "confidence_score": null
  }
}

curl -sS -H "x-api-key: YOUR_API_KEY" "https://coke-api.onrender.com/api/latency/history?domain=example.com&range=24h&limit=3"

{
  "domain": "example.com",
  "range": "24h",
  "unit": "ms",
  "points": [
    {
      "timestamp": "2026-04-08T21:50:00.000Z",
      "value": 142,
      "source": "latency_probe"
    }
  ],
  "meta": {
    "source": "data_time_series",
    "updated_at": "2026-04-08T22:10:26.229Z",
    "latency_ms": 5,
    "cache_age_seconds": null,
    "confidence_score": null
  }
}

curl -sS -H "x-api-key: YOUR_API_KEY" "https://coke-api.onrender.com/api/chain/history?network=ethereum&metric=gas_standard_gwei&range=24h&limit=3"

{
  "chain": "ethereum",
  "metric_key": "gas_standard_gwei",
  "range": "24h",
  "points": [
    {
      "timestamp": "2026-04-08T21:55:00.000Z",
      "value": 31.2,
      "source": "chain_metric_row"
    }
  ],
  "meta": {
    "source": "chain_metric_history",
    "updated_at": "2026-04-08T22:10:26.229Z",
    "latency_ms": 10,
    "cache_age_seconds": null,
    "confidence_score": 0.85
  }
}

curl -sS -H "x-api-key: YOUR_API_KEY" "https://coke-api.onrender.com/api/domain/history?host=example.com&metric=uptime&range=24h&limit=3"

{
  "host": "example.com",
  "metric": "uptime",
  "range": "24h",
  "from": "2026-04-07T22:10:26.229Z",
  "to": "2026-04-08T22:10:26.229Z",
  "series_key": "uptime:example.com",
  "points": [
    {
      "timestamp": "2026-04-08T21:45:00.000Z",
      "value": 1,
      "source": "uptime_probe",
      "meta": null
    }
  ],
  "meta": {
    "source": "data_time_series",
    "updated_at": "2026-04-08T22:10:26.229Z",
    "latency_ms": 8,
    "cache_age_seconds": null,
    "confidence_score": 0.65
  }
}

Common mistakes

• Using Authorization: Bearer where the product API expects x-api-key (or the reverse). Dashboard session token ≠ API key.
• Putting the API key in the query string (?api_key=…) — use the x-api-key header only.
• Reusing an old key after revoke or rotation; revoked keys stop working immediately.
• On Windows PowerShell, typing curl runs Invoke-WebRequest — use curl.exe or Invoke-RestMethod (see Quick start).
• Invalid range when not using a custom window — allowed tokens are 1h, 24h, 7d, 30d, or pass both from and to as ISO-8601 UTC (max 90 days) instead of range.
• Omitting domain (or host) on /api/uptime/history or /api/latency/history — both require a non-empty domain/host.
• Treating POST /api/market-data or /api/client/* as public read API — those are internal/collector routes with Bearer, not x-api-key.

Limits & security

Each key inherits your SaaS plan: per-minute (RPM) and daily caps reset at UTC midnight. Typical defaults: Free — 1,000 requests/day, 60 RPM; Pro — 100,000/day, 120 RPM; Business — no fixed daily ceiling, 300 RPM. Exact numbers follow the ApiPlan row linked to your key. Over limit returns 429. Store keys in environment variables.

• Daily and calendar limits reset at the UTC day boundary (midnight UTC), not your local timezone.
• Plan limits (RPM, daily cap, optional monthly cap) apply per API key, not per account.
• Revoked or inactive keys are rejected immediately with 403 — there is no grace period.

The hosted collector worker (server-side collectorWorker — COLLECTOR_ENABLED=1 and/or the separate worker process, e.g. npm run start:worker) POSTs market and chain batches to /api/market-data/batch and /api/chain-metrics/batch; the server appends time-series points for history routes and dashboard sparklines. Run it 24/7 if you want full charts.

Example error bodies (JSON)

401 — missing header or unknown key:

{
  "error": true,
  "message": "x-api-key required"
}

{
  "error": true,
  "message": "Invalid API key"
}

403 — inactive / expired key, inactive plan, or blocked account (message varies):

{
  "error": true,
  "message": "API key inactive"
}

Other 403 messages include: "API key expired", "Account blocked".

429 — per-minute, daily, or monthly quota exceeded:

{
  "error": true,
  "message": "Rate limit exceeded"
}

410 Gone may appear when revealing an API key that was issued before encrypted storage — create a new key. Store x-api-key only in secrets / env vars on servers you control.