Developers menu

Check a key

Whether the key works and its plan is LIVE: {ok, plan, limit_per_minute}. For a plugin's test button.

GET/api/v1/key

Plan LIVEKey scope liveLimit 120 a minute per key; a 304 is freeVersion 1.0.0Since 2026-09-30

This endpoint serves

Plan: LIVE. LIVE: today's session every second, alerts, ASK, the levels API and the platform integrations, and 5 LAB credits a month. Every finished session is free in REPLAY. Pricing.

Parameters

Name	What it does	Default	Error
errorsquery · 200	`200`: an error answers 200 with the same body and the real status in `X-FirmTape-Status`, for clients that cannot read a status.
keyquery · string	Legacy: the key in the address, for platforms that cannot send headers. Prefer the header.

Response

The key works.

Field	Meaning	Unit
okboolean	Always true.
planstring	`live`.
limit_per_minuteinteger	Requests a minute this key may make.

Errors

Status	Code	What to do
401	`no_key`, `bad_key`	No key. Send `Authorization: Bearer <key>` with a key of the product's scope.
403	`live_required`	No LIVE plan. Start or renew LIVE; `pricing` names the page.
429	`rate_limited`, `too_many_places`	Over a limit. Wait `Retry-After` seconds; poll with `If-None-Match`, a 304 is free.

Every code: Errors.

Caching

Answers carry an ETag: send it back as If-None-Match and an unchanged reading answers 304 with no body, not counted against the limit.

Changes

2026-09-30 Added.

OpenAPI operation checkKey in /docs/developers/openapi.json.

Request

curlPythonNode

curl \
  -H "Authorization: Bearer $FIRMTAPE_LIVE_KEY" \
  "https://firmtape.com/api/v1/key"

import os, requests

H = {"Authorization": f"Bearer {os.environ['FIRMTAPE_LIVE_KEY']}"}
r = requests.get("https://firmtape.com/api/v1/key", headers=H)
print(r.status_code, r.text[:500])

const r = await fetch("https://firmtape.com/api/v1/key", {
  method: "GET",
  headers: { Authorization: `Bearer ${process.env.FIRMTAPE_LIVE_KEY}` },
});
console.log(r.status, await r.text());

Response

200401403429

{
  "ok": true,
  "plan": "live",
  "limit_per_minute": 120
}

{
  "error": {
    "code": "no_key",
    "message": "No key was sent (Orders: no key, or one that is unknown or revoked)."
  }
}

{
  "error": {
    "code": "live_required",
    "message": "The key is real; its account holds no active LIVE plan."
  }
}

{
  "error": {
    "code": "rate_limited",
    "message": "More than 120 requests in a minute on one key."
  }
}

Headers

ETag: "3f9a0c6e21d4b7a8e5f10c2d4b7a8e5f"
X-RateLimit-Limit: 120
X-RateLimit-Remaining: 117

Measurements of dealer positioning, never a forecast or a trade call. This page is built from FirmTape's public contract, the same files the OpenAPI document is built from; the tests hold them against the route code. Markdown: /docs/developers/live/key.md.