{"openapi":"3.1.0","info":{"title":"Fathom Charts API","version":"1.0.0","description":"Order-flow indicators for futures: catalog, history, exports and keys."},"components":{"securitySchemes":{"apiKey":{"type":"http","scheme":"bearer","description":"API key `fc_live_<keyId>_<secret>`"},"portalSession":{"type":"apiKey","in":"cookie","name":"fc_session","description":"Portal session of the site; mutations also need X-CSRF-Token"}},"schemas":{"Problem":{"additionalProperties":true,"description":"RFC 9457 problem details","type":"object","required":["type","title","status","detail","code"],"properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"detail":{"type":"string"},"code":{"type":"string","enum":["INVALID_PARAMETERS","UNKNOWN_INDICATOR","UNKNOWN_INSTRUMENT","NOT_COVERED","QUOTA_EXCEEDED","RATE_LIMITED","CAPACITY","CURSOR_EXPIRED","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","UPSTREAM_ERROR","INTERNAL"],"description":"Stable error code"},"instance":{"description":"Identifier of the request","type":"string"},"errors":{"description":"With INVALID_PARAMETERS: every invalid field","type":"array","items":{"type":"object","required":["path","message"],"properties":{"path":{"description":"JSON Pointer of the offending field from the root of the request body (`/params/minimum`); `/` for the body itself","type":"string"},"message":{"type":"string"}}}},"computeUnits":{"description":"With QUOTA_EXCEEDED: estimated compute units of the request","type":"number"},"remainingComputeUnits":{"description":"With QUOTA_EXCEEDED: compute units left this period","type":"number"}}}},"headers":{"RateLimit-Limit":{"description":"Requests per minute of the account (all its keys together)","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests available right now","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the full limit is restored","schema":{"type":"integer"}},"RateLimit-Policy":{"description":"The limit and its window in seconds: `<limit>;w=60`","schema":{"type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}},"WWW-Authenticate":{"description":"`Bearer realm=\"fathomcharts\"`, plus `error=\"invalid_token\"` when a key was sent and refused","schema":{"type":"string"}},"Allow":{"description":"Methods accepted on this path","schema":{"type":"string"}}}},"paths":{"/v1/status":{"get":{"operationId":"getStatus","summary":"Source and service state","tags":["service"],"description":"Any key of the account. Whether the engine is up, the state of each served instrument and the maintenance windows announced and not over.","security":[{"apiKey":[]}],"responses":{"200":{"description":"State of the engine, of every served instrument and announced maintenance","content":{"application/json":{"schema":{"type":"object","required":["engine","instruments","maintenance"],"properties":{"engine":{"type":"object","required":["state"],"properties":{"state":{"anyOf":[{"type":"string","enum":["up"]},{"type":"string","enum":["down"]}]}}},"instruments":{"type":"array","items":{"type":"object","required":["symbol","alias","status","updatedAt"],"properties":{"symbol":{"type":"string"},"alias":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string","enum":["live"]},{"type":"string","enum":["warming"]},{"type":"string","enum":["source_delayed"]},{"type":"string","enum":["source_down"]},{"type":"string","enum":["market_closed"]}]},"updatedAt":{"pattern":"^(0|[1-9][0-9]{0,19})$","description":"Unix nanoseconds, decimal string","type":"string"}}}},"maintenance":{"description":"Maintenance announced and not over, by start (also sent as a WebSocket `notice`)","type":"array","items":{"type":"object","required":["id","startsAt","endsAt","message"],"properties":{"id":{"format":"uuid","type":"string"},"startsAt":{"pattern":"^(0|[1-9][0-9]{0,19})$","description":"Unix nanoseconds, decimal string","type":"string"},"endsAt":{"pattern":"^(0|[1-9][0-9]{0,19})$","description":"Unix nanoseconds, decimal string","type":"string"},"message":{"description":"What is done and what clients see","type":"string"}}}}},"description":"State of the engine, of every served instrument and announced maintenance"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"401":{"description":"Missing, invalid, revoked or expired credentials (UNAUTHORIZED)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden by the key, the plan or the account (FORBIDDEN)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"405":{"description":"Method not allowed on this path (METHOD_NOT_ALLOWED), with an Allow header","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Allow":{"$ref":"#/components/headers/Allow"}}},"429":{"description":"Rate limit or quota reached (RATE_LIMITED, QUOTA_EXCEEDED), with Retry-After","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}}},"500":{"description":"Internal error","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}}}}},"/v1/indicators":{"get":{"operationId":"listIndicators","summary":"Indicator catalog with parameter and output JSON Schemas","tags":["public"],"description":"Public, without a key, and not counted against any limit. Every indicator with its parameters (bounds, defaults, rules between them), the objects it publishes and the JSON Schemas of both. The answer carries an ETag: send it back in If-None-Match to get a 304 while the catalog has not changed.","responses":{"200":{"description":"The catalog","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","required":["version","engineFingerprint","products","indicators"],"properties":{"version":{"type":"integer"},"engineFingerprint":{"type":"string"},"products":{"description":"Products served (ticker roots: NQ, ES) and their trading hours; bars are counted from the session open","type":"object","additionalProperties":{"type":"object","required":["tradingHours"],"properties":{"tradingHours":{"type":"object","required":["zone","session","regularOpen"],"properties":{"zone":{"description":"IANA time zone of the exchange (America/New_York)","type":"string"},"session":{"description":"Session open and close, local HH:MM; the session spans midnight when it opens at or after its close","type":"array","items":{"type":"string"}},"regularOpen":{"description":"Open of the regular session, local HH:MM, where opening-range starts","type":"string"}}}}}},"indicators":{"type":"array","items":{"additionalProperties":true,"type":"object","required":["id","name","summary","description","origin","inputs","computeUnitsPerTrade","params","productDefaults","objects","paramsSchema","dataSchema","example"],"properties":{"id":{"description":"Identifier used in subscriptions and queries","type":"string"},"name":{"type":"string"},"summary":{"type":"string"},"description":{"type":"string"},"origin":{"type":"string","enum":["none","week","periods"],"description":"Where a computation starts before the requested range"},"inputs":{"type":"array","items":{"type":"string"}},"computeUnitsPerTrade":{"description":"Compute units charged per trade processed","type":"number"},"params":{"additionalProperties":true,"description":"Each parameter: type, bounds, default and description","type":"object","properties":{}},"productDefaults":{"additionalProperties":{"additionalProperties":true,"type":"object","properties":{}},"description":"Defaults that replace those of params for a product (ES, NQ)","type":"object","properties":{}},"objects":{"description":"Kinds of objects published, with the fields of their data","type":"array","items":{"additionalProperties":true,"type":"object","properties":{}}},"paramsSchema":{"additionalProperties":true,"description":"JSON Schema (draft 2020-12)","type":"object","properties":{}},"dataSchema":{"additionalProperties":true,"description":"JSON Schema (draft 2020-12)","type":"object","properties":{}},"example":{"additionalProperties":true,"description":"Parameters and the messages they produce","type":"object","properties":{}}}}}},"description":"The catalog"}}}},"304":{"description":"Not modified: the catalog has the ETag of If-None-Match"},"405":{"description":"Method not allowed on this path (METHOD_NOT_ALLOWED), with an Allow header","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Allow":{"$ref":"#/components/headers/Allow"}}},"500":{"description":"Internal error","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/instruments":{"get":{"operationId":"listInstruments","summary":"Instruments served: raw symbol, alias, price increment, source state","tags":["service"],"description":"Any key of the account. The contracts that can be subscribed to or queried, the alias that designates each one (NQ.front) and the state of its source.","security":[{"apiKey":[]}],"responses":{"200":{"description":"The served instruments and their source state","content":{"application/json":{"schema":{"type":"object","required":["instruments"],"properties":{"instruments":{"type":"array","items":{"type":"object","required":["symbol","alias","tickSizeNanos","status","updatedAt"],"properties":{"symbol":{"type":"string"},"alias":{"anyOf":[{"type":"string"},{"type":"null"}]},"tickSizeNanos":{"description":"Price increment, in 1e-9 units","type":"string"},"status":{"anyOf":[{"type":"string","enum":["live"]},{"type":"string","enum":["warming"]},{"type":"string","enum":["source_delayed"]},{"type":"string","enum":["source_down"]},{"type":"string","enum":["market_closed"]}]},"updatedAt":{"pattern":"^(0|[1-9][0-9]{0,19})$","description":"Unix nanoseconds, decimal string","type":"string"}}}}},"description":"The served instruments and their source state"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"401":{"description":"Missing, invalid, revoked or expired credentials (UNAUTHORIZED)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden by the key, the plan or the account (FORBIDDEN)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"405":{"description":"Method not allowed on this path (METHOD_NOT_ALLOWED), with an Allow header","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Allow":{"$ref":"#/components/headers/Allow"}}},"429":{"description":"Rate limit or quota reached (RATE_LIMITED, QUOTA_EXCEEDED), with Retry-After","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}}},"500":{"description":"Internal error","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}}}}},"/v1/keys":{"post":{"operationId":"createKey","summary":"Create an API key (the secret is returned once)","tags":["keys"],"description":"A key with the keys scope, or the portal. A key creates only keys it dominates: scopes, instruments and IP addresses within its own, an expiry no later than its own.","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["name","scopes"],"properties":{"name":{"minLength":1,"maxLength":64,"type":"string"},"scopes":{"minItems":1,"maxItems":4,"uniqueItems":true,"type":"array","items":{"type":"string","enum":["stream","history","export","keys"]}},"instruments":{"minItems":1,"maxItems":32,"uniqueItems":true,"description":"Symbols or aliases of GET /v1/instruments this key may use (case-sensitive); absent: all instruments","type":"array","items":{"pattern":"^[A-Za-z0-9][A-Za-z0-9._:-]{0,63}$","type":"string"}},"allowedIps":{"minItems":1,"maxItems":32,"uniqueItems":true,"description":"IPv4/IPv6 addresses or CIDR blocks; absent: any address","type":"array","items":{"minLength":2,"maxLength":49,"type":"string"}},"expiresAt":{"pattern":"^([1-9][0-9]{18}|1[0-7][0-9]{18}|18[0-3][0-9]{17}|184[0-3][0-9]{16}|1844[0-5][0-9]{15}|18446[0-6][0-9]{14}|184467[0-3][0-9]{13}|1844674[0-3][0-9]{12}|184467440[0-6][0-9]{10}|1844674407[0-2][0-9]{9}|18446744073[0-6][0-9]{8}|1844674407370[0-8][0-9]{6}|18446744073709[0-4][0-9]{5}|184467440737095[0-4][0-9]{4}|18446744073709550[0-9]{3}|18446744073709551[0-5][0-9]{2}|1844674407370955160[0-9]|1844674407370955161[0-4]|18446744073709551615)$","description":"Expiry, Unix nanoseconds, in the future, kept to the millisecond (the digits below are dropped); absent: never","type":"string"}}}}}},"security":[{"portalSession":[]},{"apiKey":[]}],"responses":{"201":{"description":"The new key, its full value shown once","content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","required":["id","name","displayPrefix","scopes","instruments","allowedIps","createdAt","expiresAt","revokedAt","lastUsedAt","rotatedFrom","state"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"displayPrefix":{"type":"string"},"scopes":{"type":"array","items":{"type":"string"}},"instruments":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}]},"allowedIps":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}]},"createdAt":{"pattern":"^(0|[1-9][0-9]{0,19})$","description":"Unix nanoseconds, decimal string","type":"string"},"expiresAt":{"anyOf":[{"pattern":"^(0|[1-9][0-9]{0,19})$","description":"Unix nanoseconds, decimal string","type":"string"},{"type":"null"}]},"revokedAt":{"anyOf":[{"pattern":"^(0|[1-9][0-9]{0,19})$","description":"Unix nanoseconds, decimal string","type":"string"},{"type":"null"}]},"lastUsedAt":{"anyOf":[{"pattern":"^(0|[1-9][0-9]{0,19})$","description":"Unix nanoseconds, decimal string","type":"string"},{"type":"null"}]},"rotatedFrom":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"type":"string","enum":["active","expiring","expired","revoked"],"description":"`active`: valid, no expiry; `expiring`: valid until expiresAt; `expired`: past expiresAt; `revoked`: revoked (DELETE, or rotation without grace period)"}}},{"type":"object","required":["key"],"properties":{"key":{"description":"Full key, shown once","type":"string"}}}],"description":"The new key, its full value shown once"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"description":"Invalid parameters or body not valid JSON (INVALID_PARAMETERS), with `errors`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"401":{"description":"Missing, invalid, revoked or expired credentials (UNAUTHORIZED)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden by the key, the plan or the account (FORBIDDEN)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"405":{"description":"Method not allowed on this path (METHOD_NOT_ALLOWED), with an Allow header","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Allow":{"$ref":"#/components/headers/Allow"}}},"409":{"description":"Conflict with the current state","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"413":{"description":"Request body over 16 KiB (INVALID_PARAMETERS), without `errors`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"415":{"description":"Request body with a Content-Type missing or other than application/json (INVALID_PARAMETERS), without `errors`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"429":{"description":"Rate limit or quota reached (RATE_LIMITED, QUOTA_EXCEEDED), with Retry-After","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}}},"500":{"description":"Internal error","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}}}},"get":{"operationId":"listKeys","summary":"List keys (active ones and those revoked or expired in the last 30 days)","tags":["keys"],"description":"A key with the keys scope, or the portal. The keys of the account, without their secrets, in a keys array.","security":[{"portalSession":[]},{"apiKey":[]}],"responses":{"200":{"description":"The keys of the account, without their value","content":{"application/json":{"schema":{"type":"object","required":["keys"],"properties":{"keys":{"type":"array","items":{"type":"object","required":["id","name","displayPrefix","scopes","instruments","allowedIps","createdAt","expiresAt","revokedAt","lastUsedAt","rotatedFrom","state"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"displayPrefix":{"type":"string"},"scopes":{"type":"array","items":{"type":"string"}},"instruments":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}]},"allowedIps":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}]},"createdAt":{"pattern":"^(0|[1-9][0-9]{0,19})$","description":"Unix nanoseconds, decimal string","type":"string"},"expiresAt":{"anyOf":[{"pattern":"^(0|[1-9][0-9]{0,19})$","description":"Unix nanoseconds, decimal string","type":"string"},{"type":"null"}]},"revokedAt":{"anyOf":[{"pattern":"^(0|[1-9][0-9]{0,19})$","description":"Unix nanoseconds, decimal string","type":"string"},{"type":"null"}]},"lastUsedAt":{"anyOf":[{"pattern":"^(0|[1-9][0-9]{0,19})$","description":"Unix nanoseconds, decimal string","type":"string"},{"type":"null"}]},"rotatedFrom":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"type":"string","enum":["active","expiring","expired","revoked"],"description":"`active`: valid, no expiry; `expiring`: valid until expiresAt; `expired`: past expiresAt; `revoked`: revoked (DELETE, or rotation without grace period)"}}}}},"description":"The keys of the account, without their value"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"401":{"description":"Missing, invalid, revoked or expired credentials (UNAUTHORIZED)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden by the key, the plan or the account (FORBIDDEN)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"405":{"description":"Method not allowed on this path (METHOD_NOT_ALLOWED), with an Allow header","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Allow":{"$ref":"#/components/headers/Allow"}}},"429":{"description":"Rate limit or quota reached (RATE_LIMITED, QUOTA_EXCEEDED), with Retry-After","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}}},"500":{"description":"Internal error","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}}}}},"/v1/keys/{id}/rotate":{"post":{"operationId":"rotateKey","summary":"Rotate a key: new secret, the old key stays valid during the grace period, then expires","tags":["keys"],"description":"A key with the keys scope, or the portal. The new key keeps the name, scopes, instruments, IP addresses and expiry of the old one. 409 for a key already rotated, whatever its state; 404 for a key revoked or expired without having been rotated.","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["gracePeriodSeconds"],"properties":{"gracePeriodSeconds":{"minimum":0,"maximum":604800,"description":"Seconds the old key stays valid (then it expires); 0: revoked at once","type":"integer"}}}}}},"parameters":[{"schema":{"pattern":"^[a-z2-7]{16}$","type":"string"},"in":"path","name":"id","required":true}],"security":[{"portalSession":[]},{"apiKey":[]}],"responses":{"201":{"description":"The new key, its full value shown once, and the rotated one (`previous`)","content":{"application/json":{"schema":{"allOf":[{"type":"object","allOf":[{"type":"object","required":["id","name","displayPrefix","scopes","instruments","allowedIps","createdAt","expiresAt","revokedAt","lastUsedAt","rotatedFrom","state"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"displayPrefix":{"type":"string"},"scopes":{"type":"array","items":{"type":"string"}},"instruments":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}]},"allowedIps":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}]},"createdAt":{"pattern":"^(0|[1-9][0-9]{0,19})$","description":"Unix nanoseconds, decimal string","type":"string"},"expiresAt":{"anyOf":[{"pattern":"^(0|[1-9][0-9]{0,19})$","description":"Unix nanoseconds, decimal string","type":"string"},{"type":"null"}]},"revokedAt":{"anyOf":[{"pattern":"^(0|[1-9][0-9]{0,19})$","description":"Unix nanoseconds, decimal string","type":"string"},{"type":"null"}]},"lastUsedAt":{"anyOf":[{"pattern":"^(0|[1-9][0-9]{0,19})$","description":"Unix nanoseconds, decimal string","type":"string"},{"type":"null"}]},"rotatedFrom":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"type":"string","enum":["active","expiring","expired","revoked"],"description":"`active`: valid, no expiry; `expiring`: valid until expiresAt; `expired`: past expiresAt; `revoked`: revoked (DELETE, or rotation without grace period)"}}},{"type":"object","required":["key"],"properties":{"key":{"description":"Full key, shown once","type":"string"}}}]},{"type":"object","required":["previous"],"properties":{"previous":{"type":"object","required":["id","name","displayPrefix","scopes","instruments","allowedIps","createdAt","expiresAt","revokedAt","lastUsedAt","rotatedFrom","state"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"displayPrefix":{"type":"string"},"scopes":{"type":"array","items":{"type":"string"}},"instruments":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}]},"allowedIps":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}]},"createdAt":{"pattern":"^(0|[1-9][0-9]{0,19})$","description":"Unix nanoseconds, decimal string","type":"string"},"expiresAt":{"anyOf":[{"pattern":"^(0|[1-9][0-9]{0,19})$","description":"Unix nanoseconds, decimal string","type":"string"},{"type":"null"}]},"revokedAt":{"anyOf":[{"pattern":"^(0|[1-9][0-9]{0,19})$","description":"Unix nanoseconds, decimal string","type":"string"},{"type":"null"}]},"lastUsedAt":{"anyOf":[{"pattern":"^(0|[1-9][0-9]{0,19})$","description":"Unix nanoseconds, decimal string","type":"string"},{"type":"null"}]},"rotatedFrom":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"type":"string","enum":["active","expiring","expired","revoked"],"description":"`active`: valid, no expiry; `expiring`: valid until expiresAt; `expired`: past expiresAt; `revoked`: revoked (DELETE, or rotation without grace period)"}}}}}],"description":"The new key, its full value shown once, and the rotated one (`previous`)"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"description":"Invalid parameters or body not valid JSON (INVALID_PARAMETERS), with `errors`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"401":{"description":"Missing, invalid, revoked or expired credentials (UNAUTHORIZED)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden by the key, the plan or the account (FORBIDDEN)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"404":{"description":"Unknown resource, indicator or instrument","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"405":{"description":"Method not allowed on this path (METHOD_NOT_ALLOWED), with an Allow header","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Allow":{"$ref":"#/components/headers/Allow"}}},"409":{"description":"Conflict with the current state","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"413":{"description":"Request body over 16 KiB (INVALID_PARAMETERS), without `errors`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"415":{"description":"Request body with a Content-Type missing or other than application/json (INVALID_PARAMETERS), without `errors`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"429":{"description":"Rate limit or quota reached (RATE_LIMITED, QUOTA_EXCEEDED), with Retry-After","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}}},"500":{"description":"Internal error","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}}}}},"/v1/keys/{id}":{"delete":{"operationId":"revokeKey","summary":"Revoke a key immediately (open streams are closed)","tags":["keys"],"description":"A key with the keys scope, or the portal. The key stops working at once and its open WebSocket connections are closed.","parameters":[{"schema":{"pattern":"^[a-z2-7]{16}$","type":"string"},"in":"path","name":"id","required":true}],"security":[{"portalSession":[]},{"apiKey":[]}],"responses":{"204":{"description":"Revoked","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"description":"Invalid parameters or body not valid JSON (INVALID_PARAMETERS), with `errors`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"401":{"description":"Missing, invalid, revoked or expired credentials (UNAUTHORIZED)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden by the key, the plan or the account (FORBIDDEN)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"404":{"description":"Unknown resource, indicator or instrument","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"405":{"description":"Method not allowed on this path (METHOD_NOT_ALLOWED), with an Allow header","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Allow":{"$ref":"#/components/headers/Allow"}}},"413":{"description":"Request body over 16 KiB (INVALID_PARAMETERS), without `errors`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"415":{"description":"Request body with a Content-Type missing or other than application/json (INVALID_PARAMETERS), without `errors`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"429":{"description":"Rate limit or quota reached (RATE_LIMITED, QUOTA_EXCEEDED), with Retry-After","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}}},"500":{"description":"Internal error","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}}}}},"/v1/stream-tokens":{"post":{"operationId":"createStreamToken","summary":"Browser stream token: valid 60 s, single use, sent in the WebSocket auth message","tags":["stream"],"description":"A key with the stream scope, called from your server: the browser opens the WebSocket with the token instead of the key, which never reaches it. Without a body.","security":[{"apiKey":[]}],"responses":{"201":{"description":"A single-use token opening one WebSocket connection","content":{"application/json":{"schema":{"type":"object","required":["token","expiresAt"],"properties":{"token":{"type":"string"},"expiresAt":{"pattern":"^(0|[1-9][0-9]{0,19})$","description":"Unix nanoseconds, decimal string","type":"string"}},"description":"A single-use token opening one WebSocket connection"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"description":"Invalid parameters or body not valid JSON (INVALID_PARAMETERS), with `errors`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"401":{"description":"Missing, invalid, revoked or expired credentials (UNAUTHORIZED)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden by the key, the plan or the account (FORBIDDEN)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"405":{"description":"Method not allowed on this path (METHOD_NOT_ALLOWED), with an Allow header","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Allow":{"$ref":"#/components/headers/Allow"}}},"413":{"description":"Request body over 16 KiB (INVALID_PARAMETERS), without `errors`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"415":{"description":"Request body with a Content-Type missing or other than application/json (INVALID_PARAMETERS), without `errors`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"429":{"description":"Rate limit or quota reached (RATE_LIMITED, QUOTA_EXCEEDED), with Retry-After","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}}},"500":{"description":"Internal error","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}}}}},"/v1/indicator-queries/estimate":{"post":{"operationId":"estimateIndicatorQuery","summary":"Cost estimate of a historical query, without running it","tags":["history"],"description":"A key with the history scope. The same body as the query: the contract read, the trades in the range, the compute units it would cost and the remaining budget. Nothing is charged.","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"description":"The body of the query: `untilCursor` bounds the estimate; `cursor` and `snapshot` are ignored, `limit` is checked but has no effect","type":"object","required":["instrument","indicator","from","to"],"properties":{"instrument":{"pattern":"^[A-Za-z0-9][A-Za-z0-9._:-]{0,63}$","type":"string"},"indicator":{"pattern":"^[a-z0-9][a-z0-9-]{0,63}$","type":"string"},"params":{"additionalProperties":true,"default":{},"description":"Indicator parameters, validated against the catalog paramsSchema","type":"object","properties":{}},"from":{"pattern":"^([1-9][0-9]{18}|1[0-7][0-9]{18}|18[0-3][0-9]{17}|184[0-3][0-9]{16}|1844[0-5][0-9]{15}|18446[0-6][0-9]{14}|184467[0-3][0-9]{13}|1844674[0-3][0-9]{12}|184467440[0-6][0-9]{10}|1844674407[0-2][0-9]{9}|18446744073[0-6][0-9]{8}|1844674407370[0-8][0-9]{6}|18446744073709[0-4][0-9]{5}|184467440737095[0-4][0-9]{4}|18446744073709550[0-9]{3}|18446744073709551[0-5][0-9]{2}|1844674407370955160[0-9]|1844674407370955161[0-4]|18446744073709551615)$","description":"Start of the range, Unix nanoseconds (at least 1000000000000000000, not in the future)","type":"string"},"to":{"pattern":"^([1-9][0-9]{18}|1[0-7][0-9]{18}|18[0-3][0-9]{17}|184[0-3][0-9]{16}|1844[0-5][0-9]{15}|18446[0-6][0-9]{14}|184467[0-3][0-9]{13}|1844674[0-3][0-9]{12}|184467440[0-6][0-9]{10}|1844674407[0-2][0-9]{9}|18446744073[0-6][0-9]{8}|1844674407370[0-8][0-9]{6}|18446744073709[0-4][0-9]{5}|184467440737095[0-4][0-9]{4}|18446744073709550[0-9]{3}|18446744073709551[0-5][0-9]{2}|1844674407370955160[0-9]|1844674407370955161[0-4]|18446744073709551615)$","description":"End of the range (excluded), Unix nanoseconds, after from","type":"string"},"mode":{"type":"string","enum":["live","confirmed"],"default":"live","description":"`live`: every version published in real time; `confirmed`: only the final ones (`final: true`). Same compute units"},"cursor":{"minLength":1,"maxLength":1024,"description":"Opaque page cursor (`next` of the previous page)","type":"string"},"untilCursor":{"pattern":"^(0|[1-9][0-9]{0,8}|[1-3][0-9]{9}|4[01][0-9]{8}|42[0-8][0-9]{7}|429[0-3][0-9]{6}|4294[0-8][0-9]{5}|42949[0-5][0-9]{4}|429496[0-6][0-9]{3}|4294967[01][0-9]{2}|42949672[0-8][0-9]|429496729[0-5])[.](0|[1-9][0-9]{0,8}|[1-3][0-9]{9}|4[01][0-9]{8}|42[0-8][0-9]{7}|429[0-3][0-9]{6}|4294[0-8][0-9]{5}|42949[0-5][0-9]{4}|429496[0-6][0-9]{3}|4294967[01][0-9]{2}|42949672[0-8][0-9]|429496729[0-5])[.](0|[1-9][0-9]{0,8}|[1-3][0-9]{9}|4[01][0-9]{8}|42[0-8][0-9]{7}|429[0-3][0-9]{6}|4294[0-8][0-9]{5}|42949[0-5][0-9]{4}|429496[0-6][0-9]{3}|4294967[01][0-9]{2}|42949672[0-8][0-9]|429496729[0-5])$","type":"string","description":"Stop at this stream cursor (join with the live stream)"},"limit":{"minimum":1,"maximum":10000,"default":1000,"type":"integer"},"snapshot":{"default":false,"description":"First page only: also the state at `from` (objects in progress and those that can still change), as a subscription snapshot","type":"boolean"}}}}},"description":"The body of the query: `untilCursor` bounds the estimate; `cursor` and `snapshot` are ignored, `limit` is checked but has no effect"},"security":[{"apiKey":[]}],"responses":{"200":{"description":"Cost of the query, without running it","content":{"application/json":{"schema":{"type":"object","required":["instrument","tickSizeNanos","trades","computeUnits","coveredFrom","coveredTo","missingDays","remainingComputeUnits"],"properties":{"instrument":{"description":"Contract read: an alias resolves to the contract it designated at `from`","type":"string"},"tickSizeNanos":{"description":"Price increment of that contract, in 1e-9 units","type":"string"},"trades":{"type":"number"},"computeUnits":{"type":"number"},"coveredFrom":{"anyOf":[{"pattern":"^(0|[1-9][0-9]{0,19})$","description":"Unix nanoseconds, decimal string","type":"string"},{"type":"null"}]},"coveredTo":{"anyOf":[{"pattern":"^(0|[1-9][0-9]{0,19})$","description":"Unix nanoseconds, decimal string","type":"string"},{"type":"null"}]},"missingDays":{"type":"array","items":{"type":"string"}},"remainingComputeUnits":{"type":"number"}},"description":"Cost of the query, without running it"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"description":"Invalid parameters or body not valid JSON (INVALID_PARAMETERS), with `errors`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"401":{"description":"Missing, invalid, revoked or expired credentials (UNAUTHORIZED)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"402":{"description":"Range not covered by history (NOT_COVERED): data is missing, nothing to pay","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"403":{"description":"Forbidden by the key, the plan or the account (FORBIDDEN)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"404":{"description":"Unknown resource, indicator or instrument","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"405":{"description":"Method not allowed on this path (METHOD_NOT_ALLOWED), with an Allow header","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Allow":{"$ref":"#/components/headers/Allow"}}},"413":{"description":"Request body over 16 KiB (INVALID_PARAMETERS), without `errors`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"415":{"description":"Request body with a Content-Type missing or other than application/json (INVALID_PARAMETERS), without `errors`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"429":{"description":"Rate limit or quota reached (RATE_LIMITED, QUOTA_EXCEEDED), with Retry-After","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}}},"500":{"description":"Internal error","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"502":{"description":"Upstream failure (UPSTREAM_ERROR)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"503":{"description":"Capacity reached (CAPACITY), with Retry-After","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}}}}}},"/v1/indicator-queries":{"post":{"operationId":"queryIndicator","summary":"One page of historical mutations; follow `next` for the following pages","tags":["history"],"description":"A key with the history scope. The updates an indicator published over a range, in the shape of the stream, with their cursors. The first page is checked against the remaining compute budget and each page charges the compute units it reports. 402 NOT_COVERED means the data is missing, not a payment.","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["instrument","indicator","from","to"],"properties":{"instrument":{"pattern":"^[A-Za-z0-9][A-Za-z0-9._:-]{0,63}$","type":"string"},"indicator":{"pattern":"^[a-z0-9][a-z0-9-]{0,63}$","type":"string"},"params":{"additionalProperties":true,"default":{},"description":"Indicator parameters, validated against the catalog paramsSchema","type":"object","properties":{}},"from":{"pattern":"^([1-9][0-9]{18}|1[0-7][0-9]{18}|18[0-3][0-9]{17}|184[0-3][0-9]{16}|1844[0-5][0-9]{15}|18446[0-6][0-9]{14}|184467[0-3][0-9]{13}|1844674[0-3][0-9]{12}|184467440[0-6][0-9]{10}|1844674407[0-2][0-9]{9}|18446744073[0-6][0-9]{8}|1844674407370[0-8][0-9]{6}|18446744073709[0-4][0-9]{5}|184467440737095[0-4][0-9]{4}|18446744073709550[0-9]{3}|18446744073709551[0-5][0-9]{2}|1844674407370955160[0-9]|1844674407370955161[0-4]|18446744073709551615)$","description":"Start of the range, Unix nanoseconds (at least 1000000000000000000, not in the future)","type":"string"},"to":{"pattern":"^([1-9][0-9]{18}|1[0-7][0-9]{18}|18[0-3][0-9]{17}|184[0-3][0-9]{16}|1844[0-5][0-9]{15}|18446[0-6][0-9]{14}|184467[0-3][0-9]{13}|1844674[0-3][0-9]{12}|184467440[0-6][0-9]{10}|1844674407[0-2][0-9]{9}|18446744073[0-6][0-9]{8}|1844674407370[0-8][0-9]{6}|18446744073709[0-4][0-9]{5}|184467440737095[0-4][0-9]{4}|18446744073709550[0-9]{3}|18446744073709551[0-5][0-9]{2}|1844674407370955160[0-9]|1844674407370955161[0-4]|18446744073709551615)$","description":"End of the range (excluded), Unix nanoseconds, after from","type":"string"},"mode":{"type":"string","enum":["live","confirmed"],"default":"live","description":"`live`: every version published in real time; `confirmed`: only the final ones (`final: true`). Same compute units"},"cursor":{"minLength":1,"maxLength":1024,"description":"Opaque page cursor (`next` of the previous page)","type":"string"},"untilCursor":{"pattern":"^(0|[1-9][0-9]{0,8}|[1-3][0-9]{9}|4[01][0-9]{8}|42[0-8][0-9]{7}|429[0-3][0-9]{6}|4294[0-8][0-9]{5}|42949[0-5][0-9]{4}|429496[0-6][0-9]{3}|4294967[01][0-9]{2}|42949672[0-8][0-9]|429496729[0-5])[.](0|[1-9][0-9]{0,8}|[1-3][0-9]{9}|4[01][0-9]{8}|42[0-8][0-9]{7}|429[0-3][0-9]{6}|4294[0-8][0-9]{5}|42949[0-5][0-9]{4}|429496[0-6][0-9]{3}|4294967[01][0-9]{2}|42949672[0-8][0-9]|429496729[0-5])[.](0|[1-9][0-9]{0,8}|[1-3][0-9]{9}|4[01][0-9]{8}|42[0-8][0-9]{7}|429[0-3][0-9]{6}|4294[0-8][0-9]{5}|42949[0-5][0-9]{4}|429496[0-6][0-9]{3}|4294967[01][0-9]{2}|42949672[0-8][0-9]|429496729[0-5])$","type":"string","description":"Stop at this stream cursor (join with the live stream)"},"limit":{"minimum":1,"maximum":10000,"default":1000,"type":"integer"},"snapshot":{"default":false,"description":"First page only: also the state at `from` (objects in progress and those that can still change), as a subscription snapshot","type":"boolean"}}}}}},"security":[{"apiKey":[]}],"responses":{"200":{"description":"A page of the indicator mutations","content":{"application/json":{"schema":{"type":"object","required":["instrument","tickSizeNanos","items","next","computeUnits"],"properties":{"instrument":{"description":"Contract read: an alias resolves to the contract it designated at `from`","type":"string"},"tickSizeNanos":{"description":"Price increment of that contract, in 1e-9 units","type":"string"},"snapshot":{"description":"With `snapshot: true`, on the first page: the state of the objects at `from`","type":"object","required":["cursor","items"],"properties":{"cursor":{"pattern":"^(0|[1-9][0-9]{0,8}|[1-3][0-9]{9}|4[01][0-9]{8}|42[0-8][0-9]{7}|429[0-3][0-9]{6}|4294[0-8][0-9]{5}|42949[0-5][0-9]{4}|429496[0-6][0-9]{3}|4294967[01][0-9]{2}|42949672[0-8][0-9]|429496729[0-5])[.](0|[1-9][0-9]{0,8}|[1-3][0-9]{9}|4[01][0-9]{8}|42[0-8][0-9]{7}|429[0-3][0-9]{6}|4294[0-8][0-9]{5}|42949[0-5][0-9]{4}|429496[0-6][0-9]{3}|4294967[01][0-9]{2}|42949672[0-8][0-9]|429496729[0-5])[.](0|[1-9][0-9]{0,8}|[1-3][0-9]{9}|4[01][0-9]{8}|42[0-8][0-9]{7}|429[0-3][0-9]{6}|4294[0-8][0-9]{5}|42949[0-5][0-9]{4}|429496[0-6][0-9]{3}|4294967[01][0-9]{2}|42949672[0-8][0-9]|429496729[0-5])$","type":"string","description":"Cursor of the state, as the snapshot of a subscription"},"items":{"type":"array","items":{"type":"object","required":["id","final","ts","data"],"properties":{"id":{"description":"Stable id of the object","type":"string"},"final":{"description":"true for the last version of the object, false while it can still change","type":"boolean"},"ts":{"pattern":"^(0|[1-9][0-9]{0,19})$","description":"Market time of the trade that produced this version, Unix nanoseconds","type":"string"},"data":{"additionalProperties":true,"description":"The object, as the catalog dataSchema of the indicator describes it","type":"object","properties":{}}}}}}},"items":{"type":"array","items":{"type":"object","required":["cursor","t","id","final","ts"],"properties":{"cursor":{"pattern":"^(0|[1-9][0-9]{0,8}|[1-3][0-9]{9}|4[01][0-9]{8}|42[0-8][0-9]{7}|429[0-3][0-9]{6}|4294[0-8][0-9]{5}|42949[0-5][0-9]{4}|429496[0-6][0-9]{3}|4294967[01][0-9]{2}|42949672[0-8][0-9]|429496729[0-5])[.](0|[1-9][0-9]{0,8}|[1-3][0-9]{9}|4[01][0-9]{8}|42[0-8][0-9]{7}|429[0-3][0-9]{6}|4294[0-8][0-9]{5}|42949[0-5][0-9]{4}|429496[0-6][0-9]{3}|4294967[01][0-9]{2}|42949672[0-8][0-9]|429496729[0-5])[.](0|[1-9][0-9]{0,8}|[1-3][0-9]{9}|4[01][0-9]{8}|42[0-8][0-9]{7}|429[0-3][0-9]{6}|4294[0-8][0-9]{5}|42949[0-5][0-9]{4}|429496[0-6][0-9]{3}|4294967[01][0-9]{2}|42949672[0-8][0-9]|429496729[0-5])$","type":"string","description":"Position of the update in the stream, the same as in real time"},"t":{"type":"string","enum":["upsert","remove"],"description":"`upsert`: the object is created or entirely replaced; `remove`: it is deleted"},"id":{"description":"Stable id of the object","type":"string"},"final":{"description":"true for the last version of the object, false while it can still change","type":"boolean"},"ts":{"pattern":"^(0|[1-9][0-9]{0,19})$","description":"Market time of the trade that produced this version, Unix nanoseconds","type":"string"},"data":{"additionalProperties":true,"description":"The object (absent from a `remove`), as the catalog dataSchema of the indicator describes it","type":"object","properties":{}}}}},"next":{"anyOf":[{"type":"string"},{"type":"null"}]},"computeUnits":{"type":"number"}},"description":"A page of the indicator mutations"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"description":"Invalid parameters or body not valid JSON (INVALID_PARAMETERS), with `errors`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"401":{"description":"Missing, invalid, revoked or expired credentials (UNAUTHORIZED)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"402":{"description":"Range not covered by history (NOT_COVERED): data is missing, nothing to pay","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"403":{"description":"Forbidden by the key, the plan or the account (FORBIDDEN)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"404":{"description":"Unknown resource, indicator or instrument","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"405":{"description":"Method not allowed on this path (METHOD_NOT_ALLOWED), with an Allow header","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Allow":{"$ref":"#/components/headers/Allow"}}},"410":{"description":"Cursor expired (CURSOR_EXPIRED)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"413":{"description":"Request body over 16 KiB (INVALID_PARAMETERS), without `errors`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"415":{"description":"Request body with a Content-Type missing or other than application/json (INVALID_PARAMETERS), without `errors`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"429":{"description":"Rate limit or quota reached (RATE_LIMITED, QUOTA_EXCEEDED), with Retry-After","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}}},"500":{"description":"Internal error","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"502":{"description":"Upstream failure (UPSTREAM_ERROR)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"503":{"description":"Capacity reached (CAPACITY), with Retry-After","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}}}}}},"/v1/exports":{"post":{"operationId":"createExport","summary":"Export a range as a zstd-compressed NDJSON file (one mutation per line, with its cursor); a cut export is resumed with `resume`","tags":["history"],"description":"A key with the export scope, on a plan that includes exports. The whole range in one file, charged in compute units like the query, and its compressed size against the export volume. A file without its final {\"t\":\"end\"} line was cut: send the same body with resume to continue it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["instrument","indicator","from","to"],"properties":{"instrument":{"pattern":"^[A-Za-z0-9][A-Za-z0-9._:-]{0,63}$","type":"string"},"indicator":{"pattern":"^[a-z0-9][a-z0-9-]{0,63}$","type":"string"},"params":{"additionalProperties":true,"default":{},"description":"Indicator parameters, validated against the catalog paramsSchema","type":"object","properties":{}},"from":{"pattern":"^([1-9][0-9]{18}|1[0-7][0-9]{18}|18[0-3][0-9]{17}|184[0-3][0-9]{16}|1844[0-5][0-9]{15}|18446[0-6][0-9]{14}|184467[0-3][0-9]{13}|1844674[0-3][0-9]{12}|184467440[0-6][0-9]{10}|1844674407[0-2][0-9]{9}|18446744073[0-6][0-9]{8}|1844674407370[0-8][0-9]{6}|18446744073709[0-4][0-9]{5}|184467440737095[0-4][0-9]{4}|18446744073709550[0-9]{3}|18446744073709551[0-5][0-9]{2}|1844674407370955160[0-9]|1844674407370955161[0-4]|18446744073709551615)$","description":"Start of the range, Unix nanoseconds (at least 1000000000000000000, not in the future)","type":"string"},"to":{"pattern":"^([1-9][0-9]{18}|1[0-7][0-9]{18}|18[0-3][0-9]{17}|184[0-3][0-9]{16}|1844[0-5][0-9]{15}|18446[0-6][0-9]{14}|184467[0-3][0-9]{13}|1844674[0-3][0-9]{12}|184467440[0-6][0-9]{10}|1844674407[0-2][0-9]{9}|18446744073[0-6][0-9]{8}|1844674407370[0-8][0-9]{6}|18446744073709[0-4][0-9]{5}|184467440737095[0-4][0-9]{4}|18446744073709550[0-9]{3}|18446744073709551[0-5][0-9]{2}|1844674407370955160[0-9]|1844674407370955161[0-4]|18446744073709551615)$","description":"End of the range (excluded), Unix nanoseconds, after from","type":"string"},"mode":{"type":"string","enum":["live","confirmed"],"default":"live","description":"`live`: every version published in real time; `confirmed`: only the final ones (`final: true`). Same compute units"},"resume":{"additionalProperties":false,"description":"Resumption of a cut export: same body, plus this","type":"object","required":["token"],"properties":{"token":{"pattern":"^[0-9]{1,12}[.][0-9a-f]{16}[.][0-9a-f]{64}$","description":"X-Export-Token of the first response of this export","type":"string"},"after":{"pattern":"^(0|[1-9][0-9]{0,8}|[1-3][0-9]{9}|4[01][0-9]{8}|42[0-8][0-9]{7}|429[0-3][0-9]{6}|4294[0-8][0-9]{5}|42949[0-5][0-9]{4}|429496[0-6][0-9]{3}|4294967[01][0-9]{2}|42949672[0-8][0-9]|429496729[0-5])[.](0|[1-9][0-9]{0,8}|[1-3][0-9]{9}|4[01][0-9]{8}|42[0-8][0-9]{7}|429[0-3][0-9]{6}|4294[0-8][0-9]{5}|42949[0-5][0-9]{4}|429496[0-6][0-9]{3}|4294967[01][0-9]{2}|42949672[0-8][0-9]|429496729[0-5])[.](0|[1-9][0-9]{0,8}|[1-3][0-9]{9}|4[01][0-9]{8}|42[0-8][0-9]{7}|429[0-3][0-9]{6}|4294[0-8][0-9]{5}|42949[0-5][0-9]{4}|429496[0-6][0-9]{3}|4294967[01][0-9]{2}|42949672[0-8][0-9]|429496729[0-5])$","type":"string","description":"Cursor of the last complete line received; absent: from the start"}}}}}}}},"security":[{"apiKey":[]}],"responses":{"200":{"description":"The export file: zstd-compressed NDJSON, one mutation per line with its cursor, the last line being {\"t\":\"end\"} (a file without it was cut: resume it)","headers":{"X-Export-Token":{"schema":{"type":"string"},"description":"Token resuming this export for 24 h (`resume.token`)"},"Content-Disposition":{"schema":{"type":"string"},"description":"attachment; filename=\"<indicator>-<contract>-<from>-<to>.ndjson.zst\""},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}},"content":{"application/zstd":{"schema":{"type":"string","contentMediaType":"application/zstd"}}}},"400":{"description":"Invalid parameters or body not valid JSON (INVALID_PARAMETERS), with `errors`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"401":{"description":"Missing, invalid, revoked or expired credentials (UNAUTHORIZED)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"402":{"description":"Range not covered by history (NOT_COVERED): data is missing, nothing to pay","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"403":{"description":"Forbidden by the key, the plan or the account (FORBIDDEN)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"404":{"description":"Unknown resource, indicator or instrument","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"405":{"description":"Method not allowed on this path (METHOD_NOT_ALLOWED), with an Allow header","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Allow":{"$ref":"#/components/headers/Allow"}}},"410":{"description":"Cursor expired (CURSOR_EXPIRED)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"413":{"description":"Request body over 16 KiB (INVALID_PARAMETERS), without `errors`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"415":{"description":"Request body with a Content-Type missing or other than application/json (INVALID_PARAMETERS), without `errors`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"429":{"description":"Rate limit or quota reached (RATE_LIMITED, QUOTA_EXCEEDED), with Retry-After","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}}},"500":{"description":"Internal error","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"502":{"description":"Upstream failure (UPSTREAM_ERROR)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"503":{"description":"Capacity reached (CAPACITY), with Retry-After","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}}}}}},"/v1/usage":{"get":{"operationId":"getUsage","summary":"Consumption and limits of the current period (UTC month)","tags":["service"],"description":"Any key of the account. The plan, its limits, what the account used this UTC month and what remains of its compute budget and export volume.","security":[{"apiKey":[]},{"portalSession":[]}],"responses":{"200":{"description":"Consumption and limits of the current period","content":{"application/json":{"schema":{"type":"object","required":["period","resetsAt","plan","limits","used","remaining"],"properties":{"period":{"type":"string"},"resetsAt":{"pattern":"^(0|[1-9][0-9]{0,19})$","description":"Unix nanoseconds, decimal string","type":"string"},"plan":{"type":"string","enum":["sandbox","live","history","live_history"],"description":"Plan of the offers owned"},"limits":{"type":"object","required":["computeBudget","exportBytes","restPerMinute","historyDays","includedHistoryDays","delaySeconds","maxConnections","maxSubscriptions","maxCustomConfigs","realtime"],"properties":{"computeBudget":{"type":"number"},"exportBytes":{"type":"number"},"restPerMinute":{"type":"integer"},"historyDays":{"type":"integer"},"includedHistoryDays":{"type":"integer"},"delaySeconds":{"type":"integer"},"maxConnections":{"type":"integer"},"maxSubscriptions":{"type":"integer"},"maxCustomConfigs":{"type":"integer"},"realtime":{"type":"boolean"}}},"used":{"type":"object","required":["computeUnits","historyItems","exportBytes","restRequests"],"properties":{"computeUnits":{"type":"number"},"historyItems":{"type":"number"},"exportBytes":{"type":"number"},"restRequests":{"type":"number"}}},"remaining":{"type":"object","required":["computeUnits","exportBytes"],"properties":{"computeUnits":{"type":"number"},"exportBytes":{"type":"number"}}}},"description":"Consumption and limits of the current period"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"401":{"description":"Missing, invalid, revoked or expired credentials (UNAUTHORIZED)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden by the key, the plan or the account (FORBIDDEN)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"405":{"description":"Method not allowed on this path (METHOD_NOT_ALLOWED), with an Allow header","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Allow":{"$ref":"#/components/headers/Allow"}}},"429":{"description":"Rate limit or quota reached (RATE_LIMITED, QUOTA_EXCEEDED), with Retry-After","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}}},"500":{"description":"Internal error","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}}}}}},"servers":[{"url":"https://api.fathomcharts.com"}],"tags":[{"name":"public","description":"Without authentication: the indicator catalog"},{"name":"service","description":"Instruments, service state and usage of the account"},{"name":"stream","description":"Stream tokens, to open the WebSocket from a browser"},{"name":"history","description":"Historical queries, estimates and exports"},{"name":"keys","description":"API key management"}]}