{"openapi":"3.1.0","info":{"title":"nord","version":"15.0.0"},"paths":{"/openapi.json":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApi"}}}}}}},"/schema.proto":{"get":{"responses":{"200":{"description":"plain text","content":{"text/plain; charset=utf-8":{}}}}}},"/info":{"get":{"description":"List of markets and tokens.","responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketsInfo"}}}}}}},"/markets/live":{"get":{"description":"Live market info such as index price, funding rate, and so on.","responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketsLiveInfo"}}}}}}},"/action":{"get":{"description":"Query for past executed actions.","parameters":[{"in":"query","name":"from","description":"Start action ID (exclusive)","required":true,"schema":{"description":"Start action ID (exclusive)","type":"integer","format":"uint64","minimum":0.0}},{"in":"query","name":"to","description":"End action ID (inclusive)","required":true,"schema":{"description":"End action ID (inclusive)","type":"integer","format":"uint64","minimum":0.0}},{"in":"query","name":"clientVersion","description":"Optionally provided binary version of client, so nord server can ensure all actions provided are executable by client.","schema":{"description":"Optionally provided binary version of client, so nord server can ensure all actions provided are executable by client.","anyOf":[{"$ref":"#/components/schemas/ExecutableVersion"},{"type":"null"}]}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ActionsItem"}}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RangeTooLarge"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotImplemented"}}}}}},"post":{"description":"Send an action to nord to execute. This doesn't use `Protobuf<T>` since we want to length-delimit this message. `body` - (length prefix of action, action data protobuf, and signature). signature has exact length, but depend on action kind. body is exact payload used via other transports and journalled for rexecution","parameters":[{"in":"header","name":"content-type","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/octet-stream":{}},"required":true},"responses":{"200":{"description":"byte stream","content":{"application/octet-stream":{}}},"415":{"description":"","headers":{"accept":{"description":"Expected request media type","style":"simple","required":true,"schema":{"title":"String","type":"string"},"example":"application/octet-stream"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptedMediaType"}}}},"413":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayloadTooLarge"}}}}}}},"/action/last-executed-id":{"get":{"description":"Query for the last executed action id.","responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"integer","format":"uint64","minimum":0.0}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionNotFound"}}}}}}},"/timestamp":{"get":{"description":"Query for the current logical timestamp of the engine.","responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"integer","format":"uint64","minimum":0.0}}}}}}},"/event/last-acked-nonce":{"get":{"description":"The last acknowledged event nonce. Use this to ascertain if a given withdrawal was processed by nord.","responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"integer","format":"uint64","minimum":0.0}}}}}}},"/ws/{streams}":{"get":{"description":"Websocket subscription to `streams`.","parameters":[{"in":"path","name":"streams","description":"where `streams` is `trades@{symbol} | deltas@{symbol} | account@{account id} | candle@{symbol}:{resolution} [&, ...]` e.g. `/ws/trades@BTCUSDC&deltas@BTCUSDC&account@42&candle@BTCUSDC:60`","required":true,"schema":{"description":"where `streams` is `trades@{symbol} | deltas@{symbol} | account@{account id} | candle@{symbol}:{resolution} [&, ...]` e.g. `/ws/trades@BTCUSDC&deltas@BTCUSDC&account@42&candle@BTCUSDC:60`","type":"string"}}],"responses":{"101":{"description":"websocket upgrade","headers":{"connection":{"style":"simple","schema":{"type":"string","enum":["upgrade"],"const":"upgrade","example":"upgrade"}},"upgrade":{"style":"simple","schema":{"type":"string","enum":["websocket"],"const":"websocket","example":"websocket"}},"sec-websocket-key":{"style":"simple","schema":{"type":"string"}},"sec-websocket-protocol":{"style":"simple","schema":{"type":"string"}}}}}}},"/market/{market_id}/fees/{fee_kind}/{account_id}":{"get":{"description":"Returns value. If negative, fee is charged from account.","parameters":[{"in":"path","name":"market_id","required":true,"schema":{"type":"integer","format":"uint32","minimum":0.0}},{"in":"path","name":"fee_kind","required":true,"schema":{"$ref":"#/components/schemas/FillRole"}},{"in":"path","name":"account_id","description":"Account for which evaluate fee for.","required":true,"schema":{"description":"Account for which evaluate fee for.","type":"integer","format":"uint32","minimum":0.0}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"number","format":"double"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserNotFound"}}}}}}},"/market/{market_id}/orderbook":{"get":{"description":"Get the orderbook for a given market.","parameters":[{"in":"path","name":"market_id","required":true,"schema":{"type":"integer","format":"uint32","minimum":0.0}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderbookInfo"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketNotFound"}}}}}}},"/market/{market_id}/stats":{"get":{"description":"Returns stats for a given market, such as open interest, volume, index price, etc.","parameters":[{"in":"path","name":"market_id","required":true,"schema":{"type":"integer","format":"uint32","minimum":0.0}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketStats"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketNotFound"}}}}}}},"/tokens/{token_id}/stats":{"get":{"description":"Get the price of a given token.","parameters":[{"in":"path","name":"token_id","required":true,"schema":{"type":"integer","format":"uint32","minimum":0.0}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenStats"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenNotFound"}}}}}}},"/user/{pubkey}":{"get":{"description":"List account ids and sessions for a user.","parameters":[{"in":"path","name":"pubkey","description":"User's solana public key","required":true,"schema":{"description":"User's solana public key","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserNotFound"}}}}}}},"/account/{account_id}/fees/withdrawal":{"get":{"description":"If protocol is healthy, it will be some amount expressed in USDC unit, like 1 USDC or 0.1 USDC. For example if 1 ETH is 10_000 USDC price, and fee 1 USDC, that means that user will get 0.9999 ETH instead of 1 ETH.\n\nIf protocol in unhealthy, withdrawal fee will be proportional to protocol debt.","parameters":[{"in":"path","name":"account_id","description":"Account for which evaluate fee for.","required":true,"schema":{"description":"Account for which evaluate fee for.","type":"integer","format":"uint32","minimum":0.0}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"number","format":"double"}}}}}}},"/account/{account_id}/orders":{"get":{"description":"Get all orders for a specific account with pagination","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"integer","format":"uint32","minimum":0.0}},{"in":"query","name":"startInclusive","description":"fetch results starting with this page; query starts with first entry if page isn't specified","schema":{"description":"fetch results starting with this page; query starts with first entry if page isn't specified","type":["integer","null"],"format":"uint64","minimum":0.0}},{"in":"query","name":"pageSize","description":"Query returns up to 50 trades in one go.","schema":{"description":"Query returns up to 50 trades in one go.","default":null,"type":["integer","null"],"format":"uint8","minimum":1.0}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageResult_for_uint64_and_OrderInfo"}}}}}}},"/account/{account_id}":{"get":{"description":"Given `account_id`, returns account summary information: balances, positions, open orders for account","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"integer","format":"uint32","minimum":0.0}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserNotFound"}}}}}}},"/account/{account_id}/history/pnl":{"get":{"description":"Fetch full history of PnL updates for an account.","parameters":[{"in":"path","name":"account_id","description":"Account for which to retrieve PnL history","required":true,"schema":{"description":"Account for which to retrieve PnL history","type":"integer","format":"uint32","minimum":0.0}},{"in":"query","name":"marketId","description":"Optional market filter by market id.","schema":{"description":"Optional market filter by market id.","default":null,"type":["integer","null"],"format":"uint32","minimum":0.0}},{"in":"query","name":"since","description":"start with this timestamp (RFC3339); defaults to UNIX epoch start","schema":{"description":"start with this timestamp (RFC3339); defaults to UNIX epoch start","default":null,"type":"string"}},{"in":"query","name":"until","description":"end with this timestamp (RFC3339); defaults to current date-time","schema":{"description":"end with this timestamp (RFC3339); defaults to current date-time","default":null,"type":"string"}},{"in":"query","name":"startInclusive","description":"fetch results starting with this page; query starts with first entry if page isn't specified","schema":{"description":"fetch results starting with this page; query starts with first entry if page isn't specified","type":["integer","null"],"format":"uint64","minimum":0.0}},{"in":"query","name":"pageSize","description":"Query returns up to 50 trades in one go.","schema":{"description":"Query returns up to 50 trades in one go.","default":null,"type":["integer","null"],"format":"uint8","minimum":1.0}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageResult_for_uint64_and_AccountPnlInfo"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserNotFound"}}}}}}},"/account/{account_id}/history/funding":{"get":{"description":"Fetch full history of funding payments for an account.","parameters":[{"in":"path","name":"account_id","description":"Account for which to retrieve funding history","required":true,"schema":{"description":"Account for which to retrieve funding history","type":"integer","format":"uint32","minimum":0.0}},{"in":"query","name":"marketId","description":"Optional market filter by market id.","schema":{"description":"Optional market filter by market id.","default":null,"type":["integer","null"],"format":"uint32","minimum":0.0}},{"in":"query","name":"since","description":"start with this timestamp (RFC3339); defaults to UNIX epoch start","schema":{"description":"start with this timestamp (RFC3339); defaults to UNIX epoch start","default":null,"type":"string"}},{"in":"query","name":"until","description":"end with this timestamp (RFC3339); defaults to current date-time","schema":{"description":"end with this timestamp (RFC3339); defaults to current date-time","default":null,"type":"string"}},{"in":"query","name":"startInclusive","description":"fetch results starting with this page; query starts with first entry if page isn't specified","schema":{"description":"fetch results starting with this page; query starts with first entry if page isn't specified","type":["string","null"]}},{"in":"query","name":"pageSize","description":"Query returns up to 50 trades in one go.","schema":{"description":"Query returns up to 50 trades in one go.","default":null,"type":["integer","null"],"format":"uint8","minimum":1.0}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageResult_for_String_and_AccountFundingInfo"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserNotFound"}}}}}}},"/account/{account_id}/triggers/history":{"get":{"parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"integer","format":"uint32","minimum":0.0}},{"in":"query","name":"since","description":"start with this timestamp (RFC3339); defaults to UNIX epoch start","schema":{"description":"start with this timestamp (RFC3339); defaults to UNIX epoch start","default":null,"type":"string"}},{"in":"query","name":"until","description":"end with this timestamp (RFC3339); defaults to current date-time","schema":{"description":"end with this timestamp (RFC3339); defaults to current date-time","default":null,"type":"string"}},{"in":"query","name":"startInclusive","description":"fetch results starting with this page; query starts with first entry if page isn't specified","schema":{"description":"fetch results starting with this page; query starts with first entry if page isn't specified","type":["integer","null"],"format":"uint64","minimum":0.0}},{"in":"query","name":"pageSize","description":"Query returns up to 50 trades in one go.","schema":{"description":"Query returns up to 50 trades in one go.","default":null,"type":["integer","null"],"format":"uint8","minimum":1.0}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageResult_for_uint64_and_Trigger"}}}}}}},"/account/{account_id}/triggers":{"get":{"parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"integer","format":"uint32","minimum":0.0}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":["array","null"],"items":{"$ref":"#/components/schemas/TriggerInfo"}}}}}}}},"/triggers/active":{"get":{"parameters":[{"in":"query","name":"startInclusive","description":"fetch results starting with this page; query starts with first entry if page isn't specified","schema":{"description":"fetch results starting with this page; query starts with first entry if page isn't specified","type":["integer","null"],"format":"uint64","minimum":0.0}},{"in":"query","name":"pageSize","description":"Query returns up to 50 trades in one go.","schema":{"description":"Query returns up to 50 trades in one go.","default":null,"type":["integer","null"],"format":"uint8","minimum":1.0}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageResult_for_uint64_and_TriggerInfo"}}}}}}},"/accounts/count":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"integer","format":"uint","minimum":0.0}}}}}}},"/account/{account_id}/pubkey":{"get":{"parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"integer","format":"uint32","minimum":0.0}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"string"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserNotFound"}}}}}}},"/order/{order_id}":{"get":{"description":"Given order identifier, return order summary. Works for order which were immediately filled, partially filled, cancelled or fully filled.","parameters":[{"in":"path","name":"order_id","required":true,"schema":{"type":"integer","format":"uint64","minimum":0.0}}],"responses":{"200":{"description":"Order summary. Use order_id to application side join with trades as needed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderInfo"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderNotFound"}}}}}}},"/order/{order_id}/trades":{"get":{"description":"Get trades for a specific order with pagination","parameters":[{"in":"path","name":"order_id","required":true,"schema":{"type":"integer","format":"uint64","minimum":0.0}},{"in":"query","name":"startInclusive","description":"fetch results starting with this page; query starts with first entry if page isn't specified","schema":{"description":"fetch results starting with this page; query starts with first entry if page isn't specified","type":["integer","null"],"format":"uint64","minimum":0.0}},{"in":"query","name":"pageSize","description":"Query returns up to 50 trades in one go.","schema":{"description":"Query returns up to 50 trades in one go.","default":null,"type":["integer","null"],"format":"uint8","minimum":1.0}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageResult_for_uint64_and_Trade"}}}}}}},"/trades":{"get":{"description":"Ordered from present to past.\n\nPagination Besides set of trades in `trades` array, endpoint returns `accountId` and actual values for `since` and `until` if they weren't specified by client.\n\nTo fetch it, client should pass `since` and `until` returned and add `nextStartInclusive`'s value as `startInclusive` parameter. If `nextStartInclusive` is absent, it means there's no more data to fetch, even if 50 entries were returned.","parameters":[{"in":"query","name":"takerId","schema":{"default":null,"type":["integer","null"],"format":"uint32","minimum":0.0}},{"in":"query","name":"takerSide","schema":{"default":null,"anyOf":[{"$ref":"#/components/schemas/Side"},{"type":"null"}]}},{"in":"query","name":"makerId","schema":{"default":null,"type":["integer","null"],"format":"uint32","minimum":0.0}},{"in":"query","name":"marketId","schema":{"default":null,"type":["integer","null"],"format":"uint32","minimum":0.0}},{"in":"query","name":"since","description":"start with this timestamp (RFC3339); defaults to UNIX epoch start","schema":{"description":"start with this timestamp (RFC3339); defaults to UNIX epoch start","default":null,"type":"string"}},{"in":"query","name":"until","description":"end with this timestamp (RFC3339); defaults to current date-time","schema":{"description":"end with this timestamp (RFC3339); defaults to current date-time","default":null,"type":"string"}},{"in":"query","name":"startInclusive","description":"fetch results starting with this page; query starts with first entry if page isn't specified","schema":{"description":"fetch results starting with this page; query starts with first entry if page isn't specified","type":["integer","null"],"format":"uint64","minimum":0.0}},{"in":"query","name":"pageSize","description":"Query returns up to 50 trades in one go.","schema":{"description":"Query returns up to 50 trades in one go.","default":null,"type":["integer","null"],"format":"uint8","minimum":1.0}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageResult_for_uint64_and_Trade"}}}}}}},"/state/download":{"get":{"description":"Returns state download link and metadata, as defined by nearest(up to equality) snapshot `time` or `action_id`` or `timestamp`. If not specified, returns latest snapshot. Example: /state/download?actionId=1 /state/download?time&2025-09-22T12:34:56Z /state/download?timestamp&1695380000 - Does not implemented yet. To get the latest snap use: /state/download - w/o any params.\n\nThe link from responce can be inserted to search bar in browser to download.","responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StateDownloadMeta"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotImplemented"}}}}}}},"/state/download/{snapshot_id}":{"get":{"description":"Typical HTTP file download endpoint. Actually same as provided by S3 storages. Means supports Range header, Content-Length, Content-Type, ETag and so on, and relevant headers.","parameters":[{"in":"path","name":"snapshot_id","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SnapshotNotFound"}}}}}}},"/state/info":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StateInfo"}}}}}}},"/state/info/hist":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StateHistInfo"}}}}}}},"/fee/brackets/info":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"type":"array","items":[{"$ref":"#/components/schemas/FeeTierId"},{"$ref":"#/components/schemas/FeeTierConfig"}],"maxItems":2,"minItems":2}}}}}}}},"/account/{account_id}/fee/tier":{"get":{"parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"integer","format":"uint32","minimum":0.0}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeeTierId"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserNotFound"}}}}}}},"/accounts/fee-tiers":{"get":{"description":"List fee tiers assigned to accounts.","parameters":[{"in":"query","name":"tier","schema":{"default":null,"anyOf":[{"$ref":"#/components/schemas/FeeTierId"},{"type":"null"}]}},{"in":"query","name":"startInclusive","description":"fetch results starting with this page; query starts with first entry if page isn't specified","schema":{"description":"fetch results starting with this page; query starts with first entry if page isn't specified","type":["integer","null"],"format":"uint32","minimum":0.0}},{"in":"query","name":"pageSize","description":"Query returns up to 50 trades in one go.","schema":{"description":"Query returns up to 50 trades in one go.","default":null,"type":["integer","null"],"format":"uint8","minimum":1.0}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageResult_for_uint32_and_AccountFeeTier"}}}}}}},"/admin":{"get":{"description":"List of assigned admins.","responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AdminInfo"}}}}}}}},"/account/volume":{"get":{"description":"Get trading volume for an account\n\nOptionally, you can specify a market to get volume for. If not specified, array of (MarketId, Volume) is returned.\n\nReturns raw values, caller must rescale to base token decimals","parameters":[{"in":"query","name":"accountId","required":true,"schema":{"type":"integer","format":"uint32","minimum":0.0}},{"in":"query","name":"marketId","schema":{"type":["integer","null"],"format":"uint32","minimum":0.0}},{"in":"query","name":"since","description":"start with this timestamp (RFC3339); defaults to UNIX epoch start","schema":{"description":"start with this timestamp (RFC3339); defaults to UNIX epoch start","default":null,"type":"string"}},{"in":"query","name":"until","description":"end with this timestamp (RFC3339); defaults to current date-time","schema":{"description":"end with this timestamp (RFC3339); defaults to current date-time","default":null,"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AccountVolumeInfo"}}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserNotFound"}}}}}}},"/account/{account_id}/history/withdrawal":{"get":{"description":"Fetch full history of withdrawals for an account.","parameters":[{"in":"path","name":"account_id","description":"Account ID for which to fetch withdrawal history.","required":true,"schema":{"description":"Account ID for which to fetch withdrawal history.","type":"integer","format":"uint32","minimum":0.0}},{"in":"query","name":"since","description":"start with this timestamp (RFC3339); defaults to UNIX epoch start","schema":{"description":"start with this timestamp (RFC3339); defaults to UNIX epoch start","default":null,"type":"string"}},{"in":"query","name":"until","description":"end with this timestamp (RFC3339); defaults to current date-time","schema":{"description":"end with this timestamp (RFC3339); defaults to current date-time","default":null,"type":"string"}},{"in":"query","name":"startInclusive","description":"fetch results starting with this page; query starts with first entry if page isn't specified","schema":{"description":"fetch results starting with this page; query starts with first entry if page isn't specified","type":["integer","null"],"format":"uint64","minimum":0.0}},{"in":"query","name":"pageSize","description":"Query returns up to 50 trades in one go.","schema":{"description":"Query returns up to 50 trades in one go.","default":null,"type":["integer","null"],"format":"uint8","minimum":1.0}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageResult_for_uint64_and_WithdrawalInfo"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserNotFound"}}}}}}},"/account/{account_id}/history/deposit":{"get":{"description":"Fetch full history of deposits for an account.","parameters":[{"in":"path","name":"account_id","description":"Account ID for which to fetch deposit history.","required":true,"schema":{"description":"Account ID for which to fetch deposit history.","type":"integer","format":"uint32","minimum":0.0}},{"in":"query","name":"since","description":"start with this timestamp (RFC3339); defaults to UNIX epoch start","schema":{"description":"start with this timestamp (RFC3339); defaults to UNIX epoch start","default":null,"type":"string"}},{"in":"query","name":"until","description":"end with this timestamp (RFC3339); defaults to current date-time","schema":{"description":"end with this timestamp (RFC3339); defaults to current date-time","default":null,"type":"string"}},{"in":"query","name":"startInclusive","description":"fetch results starting with this page; query starts with first entry if page isn't specified","schema":{"description":"fetch results starting with this page; query starts with first entry if page isn't specified","type":["integer","null"],"format":"uint64","minimum":0.0}},{"in":"query","name":"pageSize","description":"Query returns up to 50 trades in one go.","schema":{"description":"Query returns up to 50 trades in one go.","default":null,"type":["integer","null"],"format":"uint8","minimum":1.0}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageResult_for_uint64_and_DepositInfo"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserNotFound"}}}}}}},"/account/{account_id}/history/transfer":{"get":{"description":"Fetch full history of transfers for an account (both sent and received).","parameters":[{"in":"path","name":"account_id","description":"Account ID for which to fetch transfer history.","required":true,"schema":{"description":"Account ID for which to fetch transfer history.","type":"integer","format":"uint32","minimum":0.0}},{"in":"query","name":"since","description":"start with this timestamp (RFC3339); defaults to UNIX epoch start","schema":{"description":"start with this timestamp (RFC3339); defaults to UNIX epoch start","default":null,"type":"string"}},{"in":"query","name":"until","description":"end with this timestamp (RFC3339); defaults to current date-time","schema":{"description":"end with this timestamp (RFC3339); defaults to current date-time","default":null,"type":"string"}},{"in":"query","name":"startInclusive","description":"fetch results starting with this page; query starts with first entry if page isn't specified","schema":{"description":"fetch results starting with this page; query starts with first entry if page isn't specified","type":["integer","null"],"format":"uint64","minimum":0.0}},{"in":"query","name":"pageSize","description":"Query returns up to 50 trades in one go.","schema":{"description":"Query returns up to 50 trades in one go.","default":null,"type":["integer","null"],"format":"uint8","minimum":1.0}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageResult_for_uint64_and_Transfer"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserNotFound"}}}}}}},"/account/system/history/transfer":{"get":{"description":"Fetch full history of transfers involving the fee vault.","parameters":[{"in":"query","name":"since","description":"start with this timestamp (RFC3339); defaults to UNIX epoch start","schema":{"description":"start with this timestamp (RFC3339); defaults to UNIX epoch start","default":null,"type":"string"}},{"in":"query","name":"until","description":"end with this timestamp (RFC3339); defaults to current date-time","schema":{"description":"end with this timestamp (RFC3339); defaults to current date-time","default":null,"type":"string"}},{"in":"query","name":"startInclusive","description":"fetch results starting with this page; query starts with first entry if page isn't specified","schema":{"description":"fetch results starting with this page; query starts with first entry if page isn't specified","type":["integer","null"],"format":"uint64","minimum":0.0}},{"in":"query","name":"pageSize","description":"Query returns up to 50 trades in one go.","schema":{"description":"Query returns up to 50 trades in one go.","default":null,"type":["integer","null"],"format":"uint8","minimum":1.0}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageResult_for_uint64_and_Transfer"}}}}}}},"/account/{account_id}/history/liquidation":{"get":{"description":"Fetch full history of liquidations for an account.","parameters":[{"in":"path","name":"account_id","description":"Account ID for which to fetch liquidation history.","required":true,"schema":{"description":"Account ID for which to fetch liquidation history.","type":"integer","format":"uint32","minimum":0.0}},{"in":"query","name":"since","description":"start with this timestamp (RFC3339); defaults to UNIX epoch start","schema":{"description":"start with this timestamp (RFC3339); defaults to UNIX epoch start","default":null,"type":"string"}},{"in":"query","name":"until","description":"end with this timestamp (RFC3339); defaults to current date-time","schema":{"description":"end with this timestamp (RFC3339); defaults to current date-time","default":null,"type":"string"}},{"in":"query","name":"startInclusive","description":"fetch results starting with this page; query starts with first entry if page isn't specified","schema":{"description":"fetch results starting with this page; query starts with first entry if page isn't specified","type":["integer","null"],"format":"uint64","minimum":0.0}},{"in":"query","name":"pageSize","description":"Query returns up to 50 trades in one go.","schema":{"description":"Query returns up to 50 trades in one go.","default":null,"type":["integer","null"],"format":"uint8","minimum":1.0}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageResult_for_uint64_and_LiquidationInfo"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserNotFound"}}}}}}},"/account/system":{"get":{"description":"Special account fee vault.","responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Balance"}}}}}}}},"/accounts/liquidations/takes":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TakeAllInfo"}}}}}}}},"/health":{"get":{"description":"UNSTABLE: operational health endpoint for history catchup progress.","responses":{"200":{"description":"UNSTABLE: operational health information for history catchup progress.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthInfo"}}}}}}},"/tv":{"get":{"description":"Datafeed URL to be used in TradingView","responses":{"200":{"description":"plain text","content":{"text/plain; charset=utf-8":{}}}}}},"/market/{market_id}/history/PT1H":{"get":{"description":"Gets market updates history for some period of time. Default is hourly for last 24 hours","parameters":[{"in":"path","name":"market_id","required":true,"schema":{"type":"integer","format":"uint32","minimum":0.0}},{"in":"query","name":"pageSize","schema":{"default":24,"type":"integer","format":"uint8","minimum":1.0}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageResult_for_uint64_and_MarketHistoryInfo"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketNotFound"}}}}}}}},"components":{"schemas":{"OpenApi":{"type":"object","required":["info","openapi"],"properties":{"openapi":{"type":"string"},"info":{"description":"REQUIRED. Provides metadata about the API. The metadata MAY be used by tooling as required.","$ref":"#/components/schemas/Info"},"jsonSchemaDialect":{"description":"The default value for the `$schema` keyword within Schema Objects contained within this OAS document. This MUST be in the form of a URI.","type":["string","null"]},"servers":{"description":"An array of Server Objects, which provide connectivity information to a target server. If the servers property is not provided, or is an empty array, the default value would be a Server Object with a url value of /.","type":"array","items":{"$ref":"#/components/schemas/Server"}},"paths":{"description":"The available paths and operations for the API.","anyOf":[{"$ref":"#/components/schemas/Paths"},{"type":"null"}]},"webhooks":{"description":"The incoming webhooks that MAY be received as part of this API and that the API consumer MAY choose to implement. Closely related to the `callbacks` feature, this section describes requests initiated other than by an API call, for example by an out of band registration. The key name is a unique string to refer to each webhook, while the (optionally referenced) Path Item Object describes a request that may be initiated by the API provider and the expected responses.","type":"object","additionalProperties":{"$ref":"#/components/schemas/ReferenceOr_for_PathItem"}},"components":{"description":"An element to hold various schemas for the document.","anyOf":[{"$ref":"#/components/schemas/Components"},{"type":"null"}]},"security":{"description":"A declaration of which security mechanisms can be used across the API. The list of values includes alternative security requirement objects that can be used. Only one of the security requirement objects need to be satisfied to authorize a request. Individual operations can override this definition. Global security settings may be overridden on a per-path basis.","type":"array","items":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"tags":{"description":"A list of tags used by the document with additional metadata. The order of the tags can be used to reflect on their order by the parsing tools. Not all tags that are used by the Operation Object must be declared. The tags that are not declared MAY be organized randomly or based on the tool's logic. Each tag name in the list MUST be unique.","type":"array","items":{"$ref":"#/components/schemas/Tag"}},"externalDocs":{"description":"Additional external documentation.","anyOf":[{"$ref":"#/components/schemas/ExternalDocumentation"},{"type":"null"}]}},"additionalProperties":true},"Info":{"description":"The object provides metadata about the API. The metadata MAY be used by the clients if needed, and MAY be presented in editing or documentation generation tools for convenience.","type":"object","required":["title","version"],"properties":{"title":{"description":"REQUIRED. The title of the application.","type":"string"},"summary":{"description":"A short summary of the API.","type":["string","null"]},"description":{"description":"A description of the API. CommonMark syntax MAY be used for rich text representation.","type":["string","null"]},"termsOfService":{"description":"A URL to the Terms of Service for the API. This MUST be in the format of a URL.","type":["string","null"]},"contact":{"description":"The contact information for the exposed API.","anyOf":[{"$ref":"#/components/schemas/Contact"},{"type":"null"}]},"license":{"description":"The license information for the exposed API.","anyOf":[{"$ref":"#/components/schemas/License"},{"type":"null"}]},"version":{"description":"REQUIRED. The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API implementation version).","type":"string"}},"additionalProperties":true},"Contact":{"description":"Contact information for the exposed API.","type":"object","properties":{"name":{"description":"The identifying name of the contact person/organization.","type":["string","null"]},"url":{"description":"The URL pointing to the contact information. This MUST be in the format of a URL.","type":["string","null"]},"email":{"description":"The email address of the contact person/organization. This MUST be in the format of an email address.","type":["string","null"]}},"additionalProperties":true},"License":{"description":"License information for the exposed API.","type":"object","required":["name"],"properties":{"name":{"description":"REQUIRED. The license name used for the API.","type":"string"},"identifier":{"description":"An [SPDX](https://spdx.org/spdx-specification-21-web-version#h.jxpfx0ykyb60) license expression for the API. The `identifier` field is mutually exclusive of the `url` field.","type":["string","null"]},"url":{"description":"A URL to the license used for the API. This MUST be in the form of a URL. The `url` field is mutually exclusive of the `identifier` field.","type":["string","null"]}},"additionalProperties":true},"Server":{"description":"An object representing a Server.","type":"object","required":["url"],"properties":{"url":{"description":"REQUIRED. A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the OpenAPI document is being served. Variable substitutions will be made when a variable is named in {brackets}.","type":"string"},"description":{"description":"An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.","type":["string","null"]},"variables":{"description":"A map between a variable name and its value. The value is used for substitution in the server's URL template.","type":"object","additionalProperties":{"$ref":"#/components/schemas/ServerVariable"}}},"additionalProperties":true},"ServerVariable":{"description":"An object representing a Server Variable for server URL template substitution.","type":"object","required":["default"],"properties":{"enum":{"description":"An enumeration of string values to be used if the substitution options are from a limited set.","type":"array","items":{"type":"string"}},"default":{"description":"REQUIRED. The default value to use for substitution, and to send, if an alternate value is not supplied. Unlike the Schema Object's default, this value MUST be provided by the consumer.","type":"string"},"description":{"description":"An optional description for the server variable. CommonMark syntax MAY be used for rich text representation.","type":["string","null"]}},"additionalProperties":true},"Paths":{"description":"Holds the relative paths to the individual endpoints and their operations. The path is appended to the URL from the Server Object in order to construct the full URL. The Paths MAY be empty, due to Access Control List (ACL) constraints.","type":"object","additionalProperties":true},"ReferenceOr_for_PathItem":{"anyOf":[{"type":"object","required":["$ref"],"properties":{"$ref":{"description":"REQUIRED. The reference identifier. This MUST be in the form of a URI.","type":"string"},"summary":{"description":"A short summary which by default SHOULD override that of the referenced component. If the referenced object-type does not allow a `summary` field, then this field has no effect.","type":["string","null"]},"description":{"description":"A description which by default SHOULD override that of the referenced component. CommonMark syntax MAY be used for rich text representation. If the referenced object-type does not allow a `description` field, then this field has no effect.","type":["string","null"]}}},{"$ref":"#/components/schemas/PathItem"}]},"PathItem":{"description":"Describes the operations available on a single path. A Path Item MAY be empty, due to ACL constraints. The path itself is still exposed to the documentation viewer but they will not know which operations and parameters are available.","type":"object","properties":{"$ref":{"description":"Allows for a referenced definition of this path item. The referenced structure MUST be in the form of a Path Item Object.  In case a Path Item Object field appears both in the defined object and the referenced object, the behavior is undefined. See the rules for resolving Relative References.","type":["string","null"]},"summary":{"description":"An optional, string summary, intended to apply to all operations in this path.","type":["string","null"]},"description":{"description":"An optional, string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation.","type":["string","null"]},"get":{"anyOf":[{"$ref":"#/components/schemas/Operation"},{"type":"null"}]},"put":{"anyOf":[{"$ref":"#/components/schemas/Operation"},{"type":"null"}]},"post":{"anyOf":[{"$ref":"#/components/schemas/Operation"},{"type":"null"}]},"delete":{"anyOf":[{"$ref":"#/components/schemas/Operation"},{"type":"null"}]},"options":{"anyOf":[{"$ref":"#/components/schemas/Operation"},{"type":"null"}]},"head":{"anyOf":[{"$ref":"#/components/schemas/Operation"},{"type":"null"}]},"patch":{"anyOf":[{"$ref":"#/components/schemas/Operation"},{"type":"null"}]},"trace":{"anyOf":[{"$ref":"#/components/schemas/Operation"},{"type":"null"}]},"servers":{"description":"An alternative server array to service all operations in this path.","type":"array","items":{"$ref":"#/components/schemas/Server"}},"parameters":{"description":"A list of parameters that are applicable for all the operations described under this path. These parameters can be overridden at the operation level, but cannot be removed there. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location. The list can use the Reference Object to link to parameters that are defined at the OpenAPI Object's components/parameters.","type":"array","items":{"$ref":"#/components/schemas/ReferenceOr_for_Parameter"}}},"additionalProperties":true},"Operation":{"description":"Describes a single API operation on a path.","type":"object","properties":{"tags":{"description":"A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.","type":"array","items":{"type":"string"}},"summary":{"description":"A short summary of what the operation does.","type":["string","null"]},"description":{"description":"A verbose explanation of the operation behavior. CommonMark syntax MAY be used for rich text representation.","type":["string","null"]},"externalDocs":{"description":"Additional external documentation for this operation.","anyOf":[{"$ref":"#/components/schemas/ExternalDocumentation"},{"type":"null"}]},"operationId":{"description":"Unique string used to identify the operation. The id MUST be unique among all operations described in the API. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions.","type":["string","null"]},"parameters":{"description":"A list of parameters that are applicable for this operation. If a parameter is already defined at the Path Item, the new definition will override it but can never remove it. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location. The list can use the Reference Object to link to parameters that are defined at the OpenAPI Object's components/parameters.","type":"array","items":{"$ref":"#/components/schemas/ReferenceOr_for_Parameter"}},"requestBody":{"description":"The request body applicable for this operation. The requestBody is fully supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly defined semantics for request bodies. In other cases where the HTTP spec is vague (such as [GET](https://tools.ietf.org/html/rfc7231#section-4.3.1), [HEAD](https://tools.ietf.org/html/rfc7231#section-4.3.2) and [DELETE](https://tools.ietf.org/html/rfc7231#section-4.3.5)), requestBody is permitted but does not have well-defined semantics and SHOULD be avoided if possible.","anyOf":[{"$ref":"#/components/schemas/ReferenceOr_for_RequestBody"},{"type":"null"}]},"responses":{"description":"The list of possible responses as they are returned from executing this operation.","anyOf":[{"$ref":"#/components/schemas/Responses"},{"type":"null"}]},"deprecated":{"description":"Declares this operation to be deprecated.Default value is false.","type":"boolean"},"security":{"description":"A declaration of which security mechanisms can be used for this operation. The list of values includes alternative security requirement objects that can be used. Only one of the security requirement objects need to be satisfied to authorize a request. This definition overrides any declared top-level security. To remove a top-level security declaration, an empty array can be used.","type":"array","items":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"servers":{"description":"An alternative server array to service this operation. If an alternative server object is specified at the Path Item Object or Root level, it will be overridden by this value.","type":"array","items":{"$ref":"#/components/schemas/Server"}},"callbacks":{"description":"Callbacks for the operation.","type":"object","additionalProperties":{"$ref":"#/components/schemas/ReferenceOr_for_Map_of_ReferenceOr_for_PathItem"}}},"additionalProperties":true},"ExternalDocumentation":{"description":"Allows referencing an external resource for extended documentation.","type":"object","required":["url"],"properties":{"description":{"description":"A description of the target documentation. CommonMark syntax MAY be used for rich text representation.","type":["string","null"]},"url":{"description":"REQUIRED. The URL for the target documentation. This MUST be in the format of a URL.","type":"string"}},"additionalProperties":true},"ReferenceOr_for_Parameter":{"anyOf":[{"type":"object","required":["$ref"],"properties":{"$ref":{"description":"REQUIRED. The reference identifier. This MUST be in the form of a URI.","type":"string"},"summary":{"description":"A short summary which by default SHOULD override that of the referenced component. If the referenced object-type does not allow a `summary` field, then this field has no effect.","type":["string","null"]},"description":{"description":"A description which by default SHOULD override that of the referenced component. CommonMark syntax MAY be used for rich text representation. If the referenced object-type does not allow a `description` field, then this field has no effect.","type":["string","null"]}}},{"$ref":"#/components/schemas/Parameter"}]},"Parameter":{"oneOf":[{"description":"Describes a single operation parameter.\n\nA unique parameter is defined by a combination of a name and location.","type":"object","oneOf":[{"description":"The schema defining the type used for the parameter.","type":"object","required":["schema"],"properties":{"schema":{"$ref":"#/components/schemas/SchemaObject"}},"additionalProperties":false},{"description":"A map containing the representations for the parameter. The key is the media type and the value describes it. The map MUST only contain one entry.","type":"object","required":["content"],"properties":{"content":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/MediaType"}}},"additionalProperties":false}],"required":["in","name"],"properties":{"in":{"type":"string","enum":["query"]},"allow_reserved":{"description":"Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. This property only applies to parameters with an in value of query. The default value is false.","type":"boolean"},"style":{"description":"Describes how the parameter value will be serialized depending on the type of the parameter value. Default values (based on value of in): for query - form; for path - simple; for header - simple; for cookie - form.","$ref":"#/components/schemas/QueryStyle"},"allow_empty_value":{"description":"Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. Default value is false. If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue SHALL be ignored.","type":["boolean","null"]},"name":{"description":"REQUIRED. The name of the parameter. Parameter names are case sensitive. If in is \"path\", the name field MUST correspond to the associated path segment from the path field in the Paths Object. See Path Templating for further information.\n\nIf in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored.\n\nFor all other cases, the name corresponds to the parameter name used by the in property.","type":"string"},"description":{"description":"A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.","type":["string","null"]},"required":{"description":"Determines whether this parameter is mandatory. If the parameter location is \"path\", this property is REQUIRED and its value MUST be true. Otherwise, the property MAY be included and its default value is false.","type":"boolean"},"deprecated":{"description":"Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.","type":["boolean","null"]},"example":true,"examples":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ReferenceOr_for_Example"}},"explode":{"type":["boolean","null"]}},"additionalProperties":true},{"description":"Describes a single operation parameter.\n\nA unique parameter is defined by a combination of a name and location.","type":"object","oneOf":[{"description":"The schema defining the type used for the parameter.","type":"object","required":["schema"],"properties":{"schema":{"$ref":"#/components/schemas/SchemaObject"}},"additionalProperties":false},{"description":"A map containing the representations for the parameter. The key is the media type and the value describes it. The map MUST only contain one entry.","type":"object","required":["content"],"properties":{"content":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/MediaType"}}},"additionalProperties":false}],"required":["in","name"],"properties":{"in":{"type":"string","enum":["header"]},"style":{"description":"Describes how the parameter value will be serialized depending on the type of the parameter value. Default values (based on value of in): for query - form; for path - simple; for header - simple; for cookie - form.","$ref":"#/components/schemas/HeaderStyle"},"name":{"description":"REQUIRED. The name of the parameter. Parameter names are case sensitive. If in is \"path\", the name field MUST correspond to the associated path segment from the path field in the Paths Object. See Path Templating for further information.\n\nIf in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored.\n\nFor all other cases, the name corresponds to the parameter name used by the in property.","type":"string"},"description":{"description":"A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.","type":["string","null"]},"required":{"description":"Determines whether this parameter is mandatory. If the parameter location is \"path\", this property is REQUIRED and its value MUST be true. Otherwise, the property MAY be included and its default value is false.","type":"boolean"},"deprecated":{"description":"Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.","type":["boolean","null"]},"example":true,"examples":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ReferenceOr_for_Example"}},"explode":{"type":["boolean","null"]}},"additionalProperties":true},{"description":"Describes a single operation parameter.\n\nA unique parameter is defined by a combination of a name and location.","type":"object","oneOf":[{"description":"The schema defining the type used for the parameter.","type":"object","required":["schema"],"properties":{"schema":{"$ref":"#/components/schemas/SchemaObject"}},"additionalProperties":false},{"description":"A map containing the representations for the parameter. The key is the media type and the value describes it. The map MUST only contain one entry.","type":"object","required":["content"],"properties":{"content":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/MediaType"}}},"additionalProperties":false}],"required":["in","name"],"properties":{"in":{"type":"string","enum":["path"]},"style":{"description":"Describes how the parameter value will be serialized depending on the type of the parameter value. Default values (based on value of in): for query - form; for path - simple; for header - simple; for cookie - form.","$ref":"#/components/schemas/PathStyle"},"name":{"description":"REQUIRED. The name of the parameter. Parameter names are case sensitive. If in is \"path\", the name field MUST correspond to the associated path segment from the path field in the Paths Object. See Path Templating for further information.\n\nIf in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored.\n\nFor all other cases, the name corresponds to the parameter name used by the in property.","type":"string"},"description":{"description":"A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.","type":["string","null"]},"required":{"description":"Determines whether this parameter is mandatory. If the parameter location is \"path\", this property is REQUIRED and its value MUST be true. Otherwise, the property MAY be included and its default value is false.","type":"boolean"},"deprecated":{"description":"Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.","type":["boolean","null"]},"example":true,"examples":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ReferenceOr_for_Example"}},"explode":{"type":["boolean","null"]}},"additionalProperties":true},{"description":"Describes a single operation parameter.\n\nA unique parameter is defined by a combination of a name and location.","type":"object","oneOf":[{"description":"The schema defining the type used for the parameter.","type":"object","required":["schema"],"properties":{"schema":{"$ref":"#/components/schemas/SchemaObject"}},"additionalProperties":false},{"description":"A map containing the representations for the parameter. The key is the media type and the value describes it. The map MUST only contain one entry.","type":"object","required":["content"],"properties":{"content":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/MediaType"}}},"additionalProperties":false}],"required":["in","name"],"properties":{"in":{"type":"string","enum":["cookie"]},"style":{"description":"Describes how the parameter value will be serialized depending on the type of the parameter value. Default values (based on value of in): for query - form; for path - simple; for header - simple; for cookie - form.","$ref":"#/components/schemas/CookieStyle"},"name":{"description":"REQUIRED. The name of the parameter. Parameter names are case sensitive. If in is \"path\", the name field MUST correspond to the associated path segment from the path field in the Paths Object. See Path Templating for further information.\n\nIf in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored.\n\nFor all other cases, the name corresponds to the parameter name used by the in property.","type":"string"},"description":{"description":"A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.","type":["string","null"]},"required":{"description":"Determines whether this parameter is mandatory. If the parameter location is \"path\", this property is REQUIRED and its value MUST be true. Otherwise, the property MAY be included and its default value is false.","type":"boolean"},"deprecated":{"description":"Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.","type":["boolean","null"]},"example":true,"examples":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ReferenceOr_for_Example"}},"explode":{"type":["boolean","null"]}},"additionalProperties":true}]},"QueryStyle":{"type":"string","enum":["form","spaceDelimited","pipeDelimited","deepObject"]},"ReferenceOr_for_Example":{"anyOf":[{"type":"object","required":["$ref"],"properties":{"$ref":{"description":"REQUIRED. The reference identifier. This MUST be in the form of a URI.","type":"string"},"summary":{"description":"A short summary which by default SHOULD override that of the referenced component. If the referenced object-type does not allow a `summary` field, then this field has no effect.","type":["string","null"]},"description":{"description":"A description which by default SHOULD override that of the referenced component. CommonMark syntax MAY be used for rich text representation. If the referenced object-type does not allow a `description` field, then this field has no effect.","type":["string","null"]}}},{"$ref":"#/components/schemas/Example"}]},"Example":{"type":"object","properties":{"summary":{"description":"Short description for the example.","type":["string","null"]},"description":{"description":"Long description for the example. CommonMark syntax MAY be used for rich text representation.","type":["string","null"]},"value":{"description":"Embedded literal example. The `value` field and `externalValue` field are mutually exclusive. To represent examples of media types that cannot naturally represented in JSON or YAML, use a string value to contain the example, escaping where necessary."},"externalValue":{"description":"A URI that points to the literal example. This provides the capability to reference examples that cannot easily be included in JSON or YAML documents. The `value` field and `externalValue` field are mutually exclusive. See the rules for resolving Relative References.","type":["string","null"]}},"additionalProperties":true},"SchemaObject":{"description":"A JSON Schema.","type":"object","anyOf":[{"description":"A trivial boolean JSON Schema.\n\nThe schema `true` matches everything (always passes validation), whereas the schema `false` matches nothing (always fails validation).","type":"boolean"},{"description":"A JSON Schema object.","$ref":"#/components/schemas/SchemaObject2"}],"properties":{"externalDocs":{"description":"Additional external documentation for this schema.","anyOf":[{"$ref":"#/components/schemas/ExternalDocumentation"},{"type":"null"}]},"example":{"description":"A free-form property to include an example of an instance for this schema. To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary. **Deprecated:** The `example` property has been deprecated in favor of the JSON Schema `examples` keyword. Use of `example` is discouraged, and later versions of this specification may remove it."}}},"SchemaObject2":{"description":"A JSON Schema object.","type":"object","properties":{"type":{"description":"The `type` keyword.\n\nSee [JSON Schema Validation 6.1.1. \"type\"](https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-6.1.1) and [JSON Schema 4.2.1. Instance Data Model](https://tools.ietf.org/html/draft-handrews-json-schema-02#section-4.2.1).","anyOf":[{"$ref":"#/components/schemas/SingleOrVec_for_InstanceType"},{"type":"null"}]},"format":{"description":"The `format` keyword.\n\nSee [JSON Schema Validation 7. A Vocabulary for Semantic Content With \"format\"](https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-7).","type":["string","null"]},"enum":{"description":"The `enum` keyword.\n\nSee [JSON Schema Validation 6.1.2. \"enum\"](https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-6.1.2)","type":["array","null"],"items":true},"const":{"description":"The `const` keyword.\n\nSee [JSON Schema Validation 6.1.3. \"const\"](https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-6.1.3)"},"$ref":{"description":"The `$ref` keyword.\n\nSee [JSON Schema 8.2.4.1. Direct References with \"$ref\"](https://tools.ietf.org/html/draft-handrews-json-schema-02#section-8.2.4.1).","type":["string","null"]},"$id":{"description":"The `$id` keyword.\n\nSee [JSON Schema 8.2.2. The \"$id\" Keyword](https://tools.ietf.org/html/draft-handrews-json-schema-02#section-8.2.2).","type":["string","null"]},"title":{"description":"The `title` keyword.\n\nSee [JSON Schema Validation 9.1. \"title\" and \"description\"](https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-9.1).","type":["string","null"]},"description":{"description":"The `description` keyword.\n\nSee [JSON Schema Validation 9.1. \"title\" and \"description\"](https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-9.1).","type":["string","null"]},"default":{"description":"The `default` keyword.\n\nSee [JSON Schema Validation 9.2. \"default\"](https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-9.2)."},"deprecated":{"description":"The `deprecated` keyword.\n\nSee [JSON Schema Validation 9.3. \"deprecated\"](https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-9.3).","type":"boolean"},"readOnly":{"description":"The `readOnly` keyword.\n\nSee [JSON Schema Validation 9.4. \"readOnly\" and \"writeOnly\"](https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-9.4).","type":"boolean"},"writeOnly":{"description":"The `writeOnly` keyword.\n\nSee [JSON Schema Validation 9.4. \"readOnly\" and \"writeOnly\"](https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-9.4).","type":"boolean"},"examples":{"description":"The `examples` keyword.\n\nSee [JSON Schema Validation 9.5. \"examples\"](https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-9.5).","type":"array","items":true},"allOf":{"description":"The `allOf` keyword.\n\nSee [JSON Schema 9.2.1.1. \"allOf\"](https://tools.ietf.org/html/draft-handrews-json-schema-02#section-9.2.1.1).","type":["array","null"],"items":{"$ref":"#/components/schemas/Schema"}},"anyOf":{"description":"The `anyOf` keyword.\n\nSee [JSON Schema 9.2.1.2. \"anyOf\"](https://tools.ietf.org/html/draft-handrews-json-schema-02#section-9.2.1.2).","type":["array","null"],"items":{"$ref":"#/components/schemas/Schema"}},"oneOf":{"description":"The `oneOf` keyword.\n\nSee [JSON Schema 9.2.1.3. \"oneOf\"](https://tools.ietf.org/html/draft-handrews-json-schema-02#section-9.2.1.3).","type":["array","null"],"items":{"$ref":"#/components/schemas/Schema"}},"not":{"description":"The `not` keyword.\n\nSee [JSON Schema 9.2.1.4. \"not\"](https://tools.ietf.org/html/draft-handrews-json-schema-02#section-9.2.1.4).","anyOf":[{"$ref":"#/components/schemas/Schema"},{"type":"null"}]},"if":{"description":"The `if` keyword.\n\nSee [JSON Schema 9.2.2.1. \"if\"](https://tools.ietf.org/html/draft-handrews-json-schema-02#section-9.2.2.1).","anyOf":[{"$ref":"#/components/schemas/Schema"},{"type":"null"}]},"then":{"description":"The `then` keyword.\n\nSee [JSON Schema 9.2.2.2. \"then\"](https://tools.ietf.org/html/draft-handrews-json-schema-02#section-9.2.2.2).","anyOf":[{"$ref":"#/components/schemas/Schema"},{"type":"null"}]},"else":{"description":"The `else` keyword.\n\nSee [JSON Schema 9.2.2.3. \"else\"](https://tools.ietf.org/html/draft-handrews-json-schema-02#section-9.2.2.3).","anyOf":[{"$ref":"#/components/schemas/Schema"},{"type":"null"}]},"multipleOf":{"description":"The `multipleOf` keyword.\n\nSee [JSON Schema Validation 6.2.1. \"multipleOf\"](https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-6.2.1).","type":["number","null"],"format":"double"},"maximum":{"description":"The `maximum` keyword.\n\nSee [JSON Schema Validation 6.2.2. \"maximum\"](https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-6.2.2).","type":["number","null"],"format":"double"},"exclusiveMaximum":{"description":"The `exclusiveMaximum` keyword.\n\nSee [JSON Schema Validation 6.2.3. \"exclusiveMaximum\"](https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-6.2.3).","type":["number","null"],"format":"double"},"minimum":{"description":"The `minimum` keyword.\n\nSee [JSON Schema Validation 6.2.4. \"minimum\"](https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-6.2.4).","type":["number","null"],"format":"double"},"exclusiveMinimum":{"description":"The `exclusiveMinimum` keyword.\n\nSee [JSON Schema Validation 6.2.5. \"exclusiveMinimum\"](https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-6.2.5).","type":["number","null"],"format":"double"},"maxLength":{"description":"The `maxLength` keyword.\n\nSee [JSON Schema Validation 6.3.1. \"maxLength\"](https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-6.3.1).","type":["integer","null"],"format":"uint32","minimum":0.0},"minLength":{"description":"The `minLength` keyword.\n\nSee [JSON Schema Validation 6.3.2. \"minLength\"](https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-6.3.2).","type":["integer","null"],"format":"uint32","minimum":0.0},"pattern":{"description":"The `pattern` keyword.\n\nSee [JSON Schema Validation 6.3.3. \"pattern\"](https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-6.3.3).","type":["string","null"]},"items":{"description":"The `items` keyword.\n\nSee [JSON Schema 9.3.1.1. \"items\"](https://tools.ietf.org/html/draft-handrews-json-schema-02#section-9.3.1.1).","anyOf":[{"$ref":"#/components/schemas/SingleOrVec_for_Schema"},{"type":"null"}]},"additionalItems":{"description":"The `additionalItems` keyword.\n\nSee [JSON Schema 9.3.1.2. \"additionalItems\"](https://tools.ietf.org/html/draft-handrews-json-schema-02#section-9.3.1.2).","anyOf":[{"$ref":"#/components/schemas/Schema"},{"type":"null"}]},"maxItems":{"description":"The `maxItems` keyword.\n\nSee [JSON Schema Validation 6.4.1. \"maxItems\"](https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-6.4.1).","type":["integer","null"],"format":"uint32","minimum":0.0},"minItems":{"description":"The `minItems` keyword.\n\nSee [JSON Schema Validation 6.4.2. \"minItems\"](https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-6.4.2).","type":["integer","null"],"format":"uint32","minimum":0.0},"uniqueItems":{"description":"The `uniqueItems` keyword.\n\nSee [JSON Schema Validation 6.4.3. \"uniqueItems\"](https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-6.4.3).","type":["boolean","null"]},"contains":{"description":"The `contains` keyword.\n\nSee [JSON Schema 9.3.1.4. \"contains\"](https://tools.ietf.org/html/draft-handrews-json-schema-02#section-9.3.1.4).","anyOf":[{"$ref":"#/components/schemas/Schema"},{"type":"null"}]},"maxProperties":{"description":"The `maxProperties` keyword.\n\nSee [JSON Schema Validation 6.5.1. \"maxProperties\"](https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-6.5.1).","type":["integer","null"],"format":"uint32","minimum":0.0},"minProperties":{"description":"The `minProperties` keyword.\n\nSee [JSON Schema Validation 6.5.2. \"minProperties\"](https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-6.5.2).","type":["integer","null"],"format":"uint32","minimum":0.0},"required":{"description":"The `required` keyword.\n\nSee [JSON Schema Validation 6.5.3. \"required\"](https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-6.5.3).","type":"array","items":{"type":"string"},"uniqueItems":true},"properties":{"description":"The `properties` keyword.\n\nSee [JSON Schema 9.3.2.1. \"properties\"](https://tools.ietf.org/html/draft-handrews-json-schema-02#section-9.3.2.1).","type":"object","additionalProperties":{"$ref":"#/components/schemas/Schema"}},"patternProperties":{"description":"The `patternProperties` keyword.\n\nSee [JSON Schema 9.3.2.2. \"patternProperties\"](https://tools.ietf.org/html/draft-handrews-json-schema-02#section-9.3.2.2).","type":"object","additionalProperties":{"$ref":"#/components/schemas/Schema"}},"additionalProperties":{"description":"The `additionalProperties` keyword.\n\nSee [JSON Schema 9.3.2.3. \"additionalProperties\"](https://tools.ietf.org/html/draft-handrews-json-schema-02#section-9.3.2.3).","anyOf":[{"$ref":"#/components/schemas/Schema"},{"type":"null"}]},"propertyNames":{"description":"The `propertyNames` keyword.\n\nSee [JSON Schema 9.3.2.5. \"propertyNames\"](https://tools.ietf.org/html/draft-handrews-json-schema-02#section-9.3.2.5).","anyOf":[{"$ref":"#/components/schemas/Schema"},{"type":"null"}]}},"additionalProperties":true},"SingleOrVec_for_InstanceType":{"description":"A type which can be serialized as a single item, or multiple items.\n\nIn some contexts, a `Single` may be semantically distinct from a `Vec` containing only item.","anyOf":[{"$ref":"#/components/schemas/InstanceType"},{"type":"array","items":{"$ref":"#/components/schemas/InstanceType"}}]},"InstanceType":{"description":"The possible types of values in JSON Schema documents.\n\nSee [JSON Schema 4.2.1. Instance Data Model](https://tools.ietf.org/html/draft-handrews-json-schema-02#section-4.2.1).","type":"string","enum":["null","boolean","object","array","number","string","integer"]},"Schema":{"description":"A JSON Schema.","anyOf":[{"description":"A trivial boolean JSON Schema.\n\nThe schema `true` matches everything (always passes validation), whereas the schema `false` matches nothing (always fails validation).","type":"boolean"},{"description":"A JSON Schema object.","$ref":"#/components/schemas/SchemaObject2"}]},"SingleOrVec_for_Schema":{"description":"A type which can be serialized as a single item, or multiple items.\n\nIn some contexts, a `Single` may be semantically distinct from a `Vec` containing only item.","anyOf":[{"$ref":"#/components/schemas/Schema"},{"type":"array","items":{"$ref":"#/components/schemas/Schema"}}]},"MediaType":{"type":"object","properties":{"schema":{"anyOf":[{"$ref":"#/components/schemas/SchemaObject"},{"type":"null"}]},"example":true,"examples":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ReferenceOr_for_Example"}},"encoding":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Encoding"}}},"additionalProperties":true},"Encoding":{"description":"A single encoding definition applied to a single schema property.","type":"object","properties":{"contentType":{"description":"The Content-Type for encoding a specific property. Default value depends on the property type: for object - application/json; for array – the default is defined based on the inner type. for all other cases the default is `application/octet-stream`. The value can be a specific media type (e.g. application/json), a wildcard media type (e.g. image/*), or a comma-separated list of the two types.","type":["string","null"]},"headers":{"description":"A map allowing additional information to be provided as headers, for example Content-Disposition. Content-Type is described separately and SHALL be ignored in this section. This property SHALL be ignored if the request body media type is not a multipart.","type":"object","additionalProperties":{"$ref":"#/components/schemas/ReferenceOr_for_Header"}},"style":{"description":"Describes how a specific property value will be serialized depending on its type. See Parameter Object for details on the style property. The behavior follows the same values as query parameters, including default values. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded  or multipart/form-data. If a value is explicitly defined, then the value of `contentType` (implicit or explicit) SHALL be ignored.","anyOf":[{"$ref":"#/components/schemas/QueryStyle"},{"type":"null"}]},"explode":{"description":"When this is true, property values of type array or object generate separate parameters for each value of the array, or key-value-pair of the map. For other types of properties this property has no effect. When style is form, the default value is true. For all other styles, the default value is false. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded or multipart/form-data. If a value is explicitly defined, then the value of `contentType` (implicit or explicit) SHALL be ignored.\n\nIn this Library this value defaults to false always despite the specification.","type":"boolean"},"allowReserved":{"description":"Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded or multipart/form-data. If a value is explicitly defined, then the value of `contentType` (implicit or explicit) SHALL be ignored.","type":"boolean"}},"additionalProperties":true},"ReferenceOr_for_Header":{"anyOf":[{"type":"object","required":["$ref"],"properties":{"$ref":{"description":"REQUIRED. The reference identifier. This MUST be in the form of a URI.","type":"string"},"summary":{"description":"A short summary which by default SHOULD override that of the referenced component. If the referenced object-type does not allow a `summary` field, then this field has no effect.","type":["string","null"]},"description":{"description":"A description which by default SHOULD override that of the referenced component. CommonMark syntax MAY be used for rich text representation. If the referenced object-type does not allow a `description` field, then this field has no effect.","type":["string","null"]}}},{"$ref":"#/components/schemas/Header"}]},"Header":{"description":"The Header Object follows the structure of the Parameter Object with the following changes:\n\n1) name MUST NOT be specified, it is given in the corresponding headers map. 2) in MUST NOT be specified, it is implicitly in header. 3) All traits that are affected by the location MUST be applicable to a location of header (for example, style).","type":"object","oneOf":[{"description":"The schema defining the type used for the parameter.","type":"object","required":["schema"],"properties":{"schema":{"$ref":"#/components/schemas/SchemaObject"}},"additionalProperties":false},{"description":"A map containing the representations for the parameter. The key is the media type and the value describes it. The map MUST only contain one entry.","type":"object","required":["content"],"properties":{"content":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/MediaType"}}},"additionalProperties":false}],"properties":{"description":{"description":"A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.","type":["string","null"]},"style":{"default":"simple","$ref":"#/components/schemas/HeaderStyle"},"required":{"description":"Determines whether this parameter is mandatory. If the parameter location is \"path\", this property is REQUIRED and its value MUST be true. Otherwise, the property MAY be included and its default value is false.","type":"boolean"},"deprecated":{"description":"Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.","type":["boolean","null"]},"example":true,"examples":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ReferenceOr_for_Example"}}},"additionalProperties":true},"HeaderStyle":{"type":"string","enum":["simple"]},"PathStyle":{"type":"string","enum":["matrix","label","simple"]},"CookieStyle":{"type":"string","enum":["form"]},"ReferenceOr_for_RequestBody":{"anyOf":[{"type":"object","required":["$ref"],"properties":{"$ref":{"description":"REQUIRED. The reference identifier. This MUST be in the form of a URI.","type":"string"},"summary":{"description":"A short summary which by default SHOULD override that of the referenced component. If the referenced object-type does not allow a `summary` field, then this field has no effect.","type":["string","null"]},"description":{"description":"A description which by default SHOULD override that of the referenced component. CommonMark syntax MAY be used for rich text representation. If the referenced object-type does not allow a `description` field, then this field has no effect.","type":["string","null"]}}},{"$ref":"#/components/schemas/RequestBody"}]},"RequestBody":{"type":"object","properties":{"description":{"description":"A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.","type":["string","null"]},"content":{"description":"REQUIRED. The content of the request body. The key is a media type or media type range and the value describes it. For requests that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text/*","type":"object","additionalProperties":{"$ref":"#/components/schemas/MediaType"}},"required":{"description":"Determines if the request body is required in the request. Defaults to false.","type":"boolean"}},"additionalProperties":true},"Responses":{"type":"object","properties":{"default":{"description":"The documentation of responses other than the ones declared for specific HTTP response codes. Use this field to cover undeclared responses.","anyOf":[{"$ref":"#/components/schemas/ReferenceOr_for_Response"},{"type":"null"}]}},"additionalProperties":true},"ReferenceOr_for_Response":{"anyOf":[{"type":"object","required":["$ref"],"properties":{"$ref":{"description":"REQUIRED. The reference identifier. This MUST be in the form of a URI.","type":"string"},"summary":{"description":"A short summary which by default SHOULD override that of the referenced component. If the referenced object-type does not allow a `summary` field, then this field has no effect.","type":["string","null"]},"description":{"description":"A description which by default SHOULD override that of the referenced component. CommonMark syntax MAY be used for rich text representation. If the referenced object-type does not allow a `description` field, then this field has no effect.","type":["string","null"]}}},{"$ref":"#/components/schemas/Response"}]},"Response":{"type":"object","required":["description"],"properties":{"description":{"description":"REQUIRED. A description of the response. CommonMark syntax MAY be used for rich text representation.","type":"string"},"headers":{"description":"Maps a header name to its definition. RFC7230 states header names are case insensitive. If a response header is defined with the name \"Content-Type\", it SHALL be ignored.","type":"object","additionalProperties":{"$ref":"#/components/schemas/ReferenceOr_for_Header"}},"content":{"description":"A map containing descriptions of potential response payloads. The key is a media type or media type range and the value describes it. For responses that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text/*","type":"object","additionalProperties":{"$ref":"#/components/schemas/MediaType"}},"links":{"description":"A map of operations links that can be followed from the response. The key of the map is a short name for the link, following the naming constraints of the names for Component Objects.","type":"object","additionalProperties":{"$ref":"#/components/schemas/ReferenceOr_for_Link"}}},"additionalProperties":true},"ReferenceOr_for_Link":{"anyOf":[{"type":"object","required":["$ref"],"properties":{"$ref":{"description":"REQUIRED. The reference identifier. This MUST be in the form of a URI.","type":"string"},"summary":{"description":"A short summary which by default SHOULD override that of the referenced component. If the referenced object-type does not allow a `summary` field, then this field has no effect.","type":["string","null"]},"description":{"description":"A description which by default SHOULD override that of the referenced component. CommonMark syntax MAY be used for rich text representation. If the referenced object-type does not allow a `description` field, then this field has no effect.","type":["string","null"]}}},{"$ref":"#/components/schemas/Link"}]},"Link":{"description":"The Link object represents a possible design-time link for a response. The presence of a link does not guarantee the caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations.\n\nUnlike dynamic links (i.e. links provided in the response payload), the OAS linking mechanism does not require link information in the runtime response.\n\nFor computing links, and providing instructions to execute them, a runtime expression is used for accessing values in an operation and using them as parameters while invoking the linked operation.","type":"object","oneOf":[{"description":"A relative or absolute reference to an OAS operation. This field is mutually exclusive of the operationId field, and MUST point to an Operation Object. Relative operationRef values MAY be used to locate an existing Operation Object in the OpenAPI definition. See the rules for resolving Relative References.","type":"object","required":["operationRef"],"properties":{"operationRef":{"type":"string"}},"additionalProperties":false},{"description":"The name of an existing, resolvable OAS operation, as defined with a unique operationId. This field is mutually exclusive of the operationRef field.","type":"object","required":["operationId"],"properties":{"operationId":{"type":"string"}},"additionalProperties":false}],"properties":{"description":{"description":"A description of the link. CommonMark syntax MAY be used for rich text representation.","type":["string","null"]},"requestBody":{"description":"A literal value or {expression} to use as a request body when calling the target operation."},"parameters":{"description":"A map representing parameters to pass to an operation as specified with operationId or identified via operationRef. The key is the parameter name to be used, whereas the value can be a constant or an expression to be evaluated and passed to the linked operation. The parameter name can be qualified using the parameter location [{in}.]{name} for operations that use the same parameter name in different locations (e.g. path.id).","type":"object","additionalProperties":true},"server":{"description":"A server object to be used by the target operation.","anyOf":[{"$ref":"#/components/schemas/Server"},{"type":"null"}]}},"additionalProperties":true},"ReferenceOr_for_Map_of_ReferenceOr_for_PathItem":{"anyOf":[{"type":"object","required":["$ref"],"properties":{"$ref":{"description":"REQUIRED. The reference identifier. This MUST be in the form of a URI.","type":"string"},"summary":{"description":"A short summary which by default SHOULD override that of the referenced component. If the referenced object-type does not allow a `summary` field, then this field has no effect.","type":["string","null"]},"description":{"description":"A description which by default SHOULD override that of the referenced component. CommonMark syntax MAY be used for rich text representation. If the referenced object-type does not allow a `description` field, then this field has no effect.","type":["string","null"]}}},{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ReferenceOr_for_PathItem"}}]},"Components":{"description":"Holds a set of reusable objects for different aspects of the OAS. All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object.","type":"object","properties":{"securitySchemes":{"description":"An object to hold reusable Security Scheme Objects.","type":"object","additionalProperties":{"$ref":"#/components/schemas/ReferenceOr_for_SecurityScheme"}},"responses":{"description":"An object to hold reusable Response Objects.","type":"object","additionalProperties":{"$ref":"#/components/schemas/ReferenceOr_for_Response"}},"parameters":{"description":"An object to hold reusable Parameter Objects.","type":"object","additionalProperties":{"$ref":"#/components/schemas/ReferenceOr_for_Parameter"}},"examples":{"description":"An object to hold reusable Example Objects.","type":"object","additionalProperties":{"$ref":"#/components/schemas/ReferenceOr_for_Example"}},"requestBodies":{"description":"An object to hold reusable Request Body Objects.","type":"object","additionalProperties":{"$ref":"#/components/schemas/ReferenceOr_for_RequestBody"}},"headers":{"description":"An object to hold reusable Header Objects.","type":"object","additionalProperties":{"$ref":"#/components/schemas/ReferenceOr_for_Header"}},"schemas":{"description":"An object to hold reusable Schema Objects.","type":"object","additionalProperties":{"$ref":"#/components/schemas/SchemaObject"}},"links":{"description":"An object to hold reusable Link Objects.","type":"object","additionalProperties":{"$ref":"#/components/schemas/ReferenceOr_for_Link"}},"callbacks":{"description":"An object to hold reusable Callback Objects.","type":"object","additionalProperties":{"$ref":"#/components/schemas/ReferenceOr_for_Map_of_ReferenceOr_for_PathItem"}},"pathItems":{"description":"An object to hold reusable Path Item Objects.","type":"object","additionalProperties":{"$ref":"#/components/schemas/ReferenceOr_for_PathItem"}}},"additionalProperties":true},"ReferenceOr_for_SecurityScheme":{"anyOf":[{"type":"object","required":["$ref"],"properties":{"$ref":{"description":"REQUIRED. The reference identifier. This MUST be in the form of a URI.","type":"string"},"summary":{"description":"A short summary which by default SHOULD override that of the referenced component. If the referenced object-type does not allow a `summary` field, then this field has no effect.","type":["string","null"]},"description":{"description":"A description which by default SHOULD override that of the referenced component. CommonMark syntax MAY be used for rich text representation. If the referenced object-type does not allow a `description` field, then this field has no effect.","type":["string","null"]}}},{"$ref":"#/components/schemas/SecurityScheme"}]},"SecurityScheme":{"description":"Defines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header or as a query parameter), OAuth2's common flows (implicit, password, application and access code) as defined in RFC6749, and OpenID Connect Discovery.","oneOf":[{"type":"object","required":["in","name","type"],"properties":{"type":{"type":"string","enum":["apiKey"]},"in":{"$ref":"#/components/schemas/ApiKeyLocation"},"name":{"type":"string"},"description":{"type":["string","null"]}},"additionalProperties":true},{"type":"object","required":["scheme","type"],"properties":{"type":{"type":"string","enum":["http"]},"scheme":{"type":"string"},"bearerFormat":{"type":["string","null"]},"description":{"type":["string","null"]}},"additionalProperties":true},{"type":"object","required":["flows","type"],"properties":{"type":{"type":"string","enum":["oauth2"]},"flows":{"$ref":"#/components/schemas/OAuth2Flows"},"description":{"type":["string","null"]}},"additionalProperties":true},{"type":"object","required":["openIdConnectUrl","type"],"properties":{"type":{"type":"string","enum":["openIdConnect"]},"openIdConnectUrl":{"type":"string"},"description":{"type":["string","null"]}},"additionalProperties":true},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["mutualTLS"]},"description":{"type":["string","null"]}},"additionalProperties":true}]},"ApiKeyLocation":{"type":"string","enum":["query","header","cookie"]},"OAuth2Flows":{"type":"object","oneOf":[{"type":"object","required":["implicit"],"properties":{"implicit":{"type":"object","required":["authorizationUrl"],"properties":{"authorizationUrl":{"type":"string"},"refreshUrl":{"type":["string","null"]},"scopes":{"default":{},"type":"object","additionalProperties":{"type":"string"}}}}},"additionalProperties":false},{"type":"object","required":["password"],"properties":{"password":{"type":"object","required":["tokenUrl"],"properties":{"refreshUrl":{"type":["string","null"]},"tokenUrl":{"type":"string"},"scopes":{"default":{},"type":"object","additionalProperties":{"type":"string"}}}}},"additionalProperties":false},{"type":"object","required":["clientCredentials"],"properties":{"clientCredentials":{"type":"object","required":["tokenUrl"],"properties":{"refreshUrl":{"type":["string","null"]},"tokenUrl":{"type":"string"},"scopes":{"default":{},"type":"object","additionalProperties":{"type":"string"}}}}},"additionalProperties":false},{"type":"object","required":["authorizationCode"],"properties":{"authorizationCode":{"type":"object","required":["authorizationUrl","tokenUrl"],"properties":{"authorizationUrl":{"type":"string"},"tokenUrl":{"type":"string"},"refreshUrl":{"type":["string","null"]},"scopes":{"default":{},"type":"object","additionalProperties":{"type":"string"}}}}},"additionalProperties":false}]},"Tag":{"description":"Adds metadata to a single tag that is used by the Operation Object. It is not mandatory to have a Tag Object per tag defined in the Operation Object instances.","type":"object","required":["name"],"properties":{"name":{"description":"REQUIRED. The name of the tag.","type":"string"},"description":{"description":"A description for the tag. CommonMark syntax MAY be used for rich text representation.","type":["string","null"]},"externalDocs":{"description":"Additional external documentation for this tag.","anyOf":[{"$ref":"#/components/schemas/ExternalDocumentation"},{"type":"null"}]}},"additionalProperties":true},"MarketsInfo":{"type":"object","required":["markets","tokens"],"properties":{"markets":{"type":"array","items":{"$ref":"#/components/schemas/MarketInfo"}},"tokens":{"type":"array","items":{"$ref":"#/components/schemas/TokenInfo"}}}},"MarketInfo":{"type":"object","required":["baseTokenId","cmf","imf","marketId","mmf","priceDecimals","quoteTokenId","sizeDecimals","symbol"],"properties":{"marketId":{"type":"integer","format":"uint32","minimum":0.0},"symbol":{"type":"string"},"priceDecimals":{"type":"integer","format":"uint8","minimum":0.0},"sizeDecimals":{"type":"integer","format":"uint8","minimum":0.0},"baseTokenId":{"type":"integer","format":"uint32","minimum":0.0},"quoteTokenId":{"type":"integer","format":"uint32","minimum":0.0},"imf":{"type":"number","format":"double"},"mmf":{"type":"number","format":"double"},"cmf":{"type":"number","format":"double"}}},"TokenInfo":{"type":"object","required":["decimals","mintAddr","symbol","tokenId","weightBps"],"properties":{"tokenId":{"type":"integer","format":"uint32","minimum":0.0},"symbol":{"type":"string"},"decimals":{"type":"integer","format":"uint8","minimum":0.0},"mintAddr":{"type":"string"},"weightBps":{"type":"integer","format":"uint16","minimum":0.0}}},"MarketsLiveInfo":{"type":"object","required":["markets"],"properties":{"markets":{"type":"array","items":{"$ref":"#/components/schemas/MarketLiveInfo"}}}},"MarketLiveInfo":{"type":"object","required":["marketId"],"properties":{"marketId":{"type":"integer","format":"uint32","minimum":0.0},"frozen":{"type":"boolean"},"indexPrice":{"type":["number","null"],"format":"double"},"indexPriceConf":{"type":["number","null"],"format":"double"},"perpetuals":{"anyOf":[{"$ref":"#/components/schemas/MarketLivePerpInfo"},{"type":"null"}]}}},"MarketLivePerpInfo":{"type":"object","required":["nextFundingTime","openInterest"],"properties":{"markPrice":{"description":"Mark price of the perpetual. Null only for a new market.","type":["number","null"],"format":"double"},"projectedFundingRate":{"description":"The projected funding rate for the next funding time. Becomes null right after funding is paid, as there is not yet any data to project the next funding rate.","type":["number","null"],"format":"double"},"nextFundingTime":{"description":"The next time at which funding will be paid. Locked to the hour, though may be delayed if oracle updates are delayed.","type":"string"},"openInterest":{"description":"Current open interest for this market.","type":"number","format":"double"}}},"AcceptedMediaType":{"type":"object","required":["expected"],"properties":{"expected":{"type":"string"}}},"PayloadTooLarge":{"type":"object","required":["limit"],"properties":{"limit":{"type":"integer","format":"uint","minimum":0.0}}},"ActionsQuery":{"type":"object","required":["from","to"],"properties":{"from":{"description":"Start action ID (exclusive)","type":"integer","format":"uint64","minimum":0.0},"to":{"description":"End action ID (inclusive)","type":"integer","format":"uint64","minimum":0.0},"clientVersion":{"description":"Optionally provided binary version of client, so nord server can ensure all actions provided are executable by client.","anyOf":[{"$ref":"#/components/schemas/ExecutableVersion"},{"type":"null"}]}}},"ExecutableVersion":{"type":"string"},"ActionsItem":{"type":"object","required":["actionId","payload","physicalTime"],"properties":{"actionId":{"type":"integer","format":"uint64","minimum":0.0},"physicalTime":{"type":"string"},"payload":{"type":"string"}}},"RangeTooLarge":{"type":"object","required":["maximal","requested"],"properties":{"requested":{"type":"integer","format":"uint64","minimum":0.0},"maximal":{"type":"integer","format":"uint16","minimum":0.0}}},"NotImplemented":{"type":"object","required":["message"],"properties":{"message":{"description":"Human readable message describing what to expect next.","type":"string"}}},"ActionNotFound":{"type":"null"},"FillRole":{"description":"Returns fee parts per market per balance change per action per account. Fee is taken from user without return. Please note that some operations need some deposit which will be returned - these are not part of fees.","oneOf":[{"description":"For maker. Payed when taken. Does NOT includes placement fee. Taken from increased account balance after trade.","type":"string","enum":["maker"]},{"description":"For taker. Taken from increased account balance after trade.","type":"string","enum":["taker"]}]},"UserNotFound":{"type":"null"},"OrderbookInfo":{"type":"object","required":["asks","asksSummary","bids","bidsSummary","updateId"],"properties":{"updateId":{"type":"integer","format":"uint64","minimum":0.0},"asks":{"type":"array","items":{"type":"array","items":[{"type":"number","format":"double"},{"type":"number","format":"double"}],"maxItems":2,"minItems":2}},"bids":{"type":"array","items":{"type":"array","items":[{"type":"number","format":"double"},{"type":"number","format":"double"}],"maxItems":2,"minItems":2}},"asksSummary":{"$ref":"#/components/schemas/SideSummary"},"bidsSummary":{"$ref":"#/components/schemas/SideSummary"}}},"SideSummary":{"type":"object","required":["count","sum"],"properties":{"sum":{"type":"number","format":"double"},"count":{"type":"integer","format":"uint32","minimum":0.0}}},"MarketNotFound":{"type":"object","required":["market_id"],"properties":{"market_id":{"type":"integer","format":"uint32","minimum":0.0}}},"MarketStats":{"type":"object","required":["volumeBase24h","volumeQuote24h"],"properties":{"indexPrice":{"type":["number","null"],"format":"double"},"indexPriceConf":{"type":["number","null"],"format":"double"},"frozen":{"type":"boolean"},"volumeBase24h":{"type":"number","format":"double"},"volumeQuote24h":{"type":"number","format":"double"},"high24h":{"type":["number","null"],"format":"double"},"low24h":{"type":["number","null"],"format":"double"},"close24h":{"type":["number","null"],"format":"double"},"prevClose24h":{"type":["number","null"],"format":"double"},"perpStats":{"anyOf":[{"$ref":"#/components/schemas/PerpMarketStats"},{"type":"null"}]}}},"PerpMarketStats":{"type":"object","required":["aggregated_funding_index","funding_rate","next_funding_time","open_interest"],"properties":{"mark_price":{"type":["number","null"],"format":"double"},"aggregated_funding_index":{"type":"number","format":"double"},"funding_rate":{"type":"number","format":"double"},"next_funding_time":{"type":"string"},"open_interest":{"type":"number","format":"double"}}},"TokenStats":{"type":"object","required":["decimals","mintAddr","oracleSymbol","symbol","weightBps"],"properties":{"symbol":{"type":"string"},"decimals":{"type":"integer","format":"uint8","minimum":0.0},"mintAddr":{"type":"string"},"weightBps":{"type":"integer","format":"uint16","minimum":0.0},"oracleSymbol":{"type":"string"},"indexPrice":{"description":"Index price for the token","anyOf":[{"$ref":"#/components/schemas/TokenPrice"},{"type":"null"}]}}},"TokenPrice":{"type":"object","required":["confidence","median"],"properties":{"median":{"type":"number","format":"double"},"confidence":{"type":"number","format":"double"}}},"TokenNotFound":{"type":"null"},"User":{"type":"object","required":["accountIds","sessions"],"properties":{"accountIds":{"type":"array","items":{"type":"integer","format":"uint32","minimum":0.0}},"sessions":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/UserSession"}}}},"UserSession":{"type":"object","required":["expiry","pubkey"],"properties":{"pubkey":{"type":"string"},"expiry":{"type":"string"}}},"PageQueryPart_for_uint64":{"type":"object","properties":{"startInclusive":{"description":"fetch results starting with this page; query starts with first entry if page isn't specified","type":["integer","null"],"format":"uint64","minimum":0.0},"pageSize":{"description":"Query returns up to 50 trades in one go.","default":null,"type":["integer","null"],"format":"uint8","minimum":1.0}}},"PageResult_for_uint64_and_OrderInfo":{"type":"object","required":["items"],"properties":{"items":{"description":"Set of items for requested by query.","type":"array","items":{"$ref":"#/components/schemas/OrderInfo"}},"nextStartInclusive":{"description":"If request contains more data, this is the id is set with which next request should be performed to get next page. If no more data, then it is undefined.","type":["integer","null"],"format":"uint64","minimum":0.0}}},"OrderInfo":{"description":"Order summary. Use order_id to application side join with trades as needed.","type":"object","required":["addedAt","fillMode","isReduceOnly","marketId","marketSymbol","orderId","placedPrice","placedSize","placementOrigin","side","tokenSymbol","tradeId","traderId","updateActionId","updatedAt"],"properties":{"addedAt":{"type":"string"},"updatedAt":{"type":"string"},"tradeId":{"type":"integer","format":"uint64","minimum":0.0},"traderId":{"type":"integer","format":"uint32","minimum":0.0},"marketId":{"type":"integer","format":"uint32","minimum":0.0},"orderId":{"type":"integer","format":"uint64","minimum":0.0},"side":{"$ref":"#/components/schemas/Side"},"placedSize":{"type":"number","format":"double"},"filledSize":{"type":["number","null"],"format":"double"},"updateActionId":{"type":"integer","format":"uint64","minimum":0.0},"isReduceOnly":{"type":"boolean"},"fillMode":{"$ref":"#/components/schemas/FillMode"},"placedPrice":{"type":"number","format":"double"},"originalSizeLimit":{"type":["number","null"],"format":"double"},"originalPriceLimit":{"type":["number","null"],"format":"double"},"placementOrigin":{"$ref":"#/components/schemas/PlacementOrigin"},"finalizationReason":{"anyOf":[{"$ref":"#/components/schemas/FinalizationReason"},{"type":"null"}]},"marketSymbol":{"type":"string"},"tokenSymbol":{"type":"string"}}},"Side":{"oneOf":[{"description":"Minimum price seller willing to accept. \"Short\". -","type":"string","enum":["ask"]},{"description":"Maximum price buyer willing to pay. \"Long\". +","type":"string","enum":["bid"]}]},"FillMode":{"oneOf":[{"description":"Normal order, filled if there are opposite orders with prices equal or better than limit. Limit - requires price and one of sizes","type":"string","enum":["Limit"]},{"description":"Only place the order if it wouldn't get filled by any other, i.e. don't fill only post. This may be considered to be the opposite of `ImmediateOrCancel`. Post-only - requires price and one of sizes, plus its price not matching opposite orders","type":"string","enum":["PostOnly"]},{"description":"Order is either filled at least partially or cancelled (IoC).","type":"string","enum":["ImmediateOrCancel"]},{"description":"Order is either filled completely right away or cancelled (FoK). Similar to an IoC order but which must fill completely.","type":"string","enum":["FillOrKill"]}]},"PlacementOrigin":{"type":"string","enum":["User","Trigger","Liquidation"]},"FinalizationReason":{"type":"string","enum":["Filled","Canceled","Taken"]},"Account":{"type":"object","required":["balances","margins","orders","positions","updateId"],"properties":{"updateId":{"type":"integer","format":"uint64","minimum":0.0},"orders":{"type":"array","items":{"$ref":"#/components/schemas/OpenOrder"}},"positions":{"type":"array","items":{"$ref":"#/components/schemas/PositionSummary"}},"balances":{"type":"array","items":{"$ref":"#/components/schemas/Balance"}},"margins":{"$ref":"#/components/schemas/AccountMarginsView"}}},"OpenOrder":{"type":"object","required":["marketId","orderId","originalOrderSize","price","side","size"],"properties":{"orderId":{"type":"integer","format":"uint64","minimum":0.0},"marketId":{"type":"integer","format":"uint32","minimum":0.0},"side":{"$ref":"#/components/schemas/Side"},"size":{"type":"number","format":"double"},"price":{"type":"number","format":"double"},"originalOrderSize":{"type":"number","format":"double"},"clientOrderId":{"type":["integer","null"],"format":"uint64","minimum":0.0}}},"PositionSummary":{"description":"Summary of position. Does not provide details information about specific orders.","type":"object","required":["actionId","marketId","openOrders"],"properties":{"marketId":{"type":"integer","format":"uint32","minimum":0.0},"openOrders":{"type":"integer","format":"uint16","minimum":0.0},"perp":{"anyOf":[{"$ref":"#/components/schemas/PerpPositionUpdate"},{"type":"null"}]},"actionId":{"type":"integer","format":"uint64","minimum":0.0}}},"PerpPositionUpdate":{"type":"object","required":["baseSize","fundingPaymentPnl","isLong","price","sizePricePnl","tradingPnl","updatedFundingRateIndex"],"properties":{"baseSize":{"type":"number","format":"double"},"price":{"type":"number","format":"double"},"updatedFundingRateIndex":{"type":"number","format":"double"},"fundingPaymentPnl":{"description":"In stable coin, USDC","type":"number","format":"double"},"tradingPnl":{"description":"In stable coin, USDC","type":"number","format":"double"},"sizePricePnl":{"description":"DEPRECATED, use `trading_pnl`","type":"number","format":"double"},"isLong":{"type":"boolean"}}},"Balance":{"type":"object","required":["amount","token","tokenId"],"properties":{"tokenId":{"type":"integer","format":"uint32","minimum":0.0},"token":{"type":"string"},"amount":{"type":"number","format":"double"}}},"AccountMarginsView":{"description":"Represents account health state. Each field expressed in USD basis points per account. For example: - value of 1.0000 means 1 USD. - value of 123.0004 means 123 USD and 0.04 cent.\n\nAll values are actual only at specific moment in time - because both market and oracle prices fluctuate all the time","type":"object","required":["bankruptcy","cmf","imf","mf","mmf","omf","pn","pon"],"properties":{"omf":{"description":"Somewhat proportional to USD weighted value of account, its tokens and positive PnL; sub negative PnL, debt.\n\nSee MARKETS.md for details. Specifically have MF as basis points, divide by `pn`","type":"number","format":"double"},"mf":{"description":"Similar to OMF. See distinguishing in MARKETS.md.\n\nSpecifically have MF as basis points, divide by `pon`.","type":"number","format":"double"},"imf":{"description":"Compare with OMF. Divide by PON to get basis points value. Tells when account may or may not open orders.","type":"number","format":"double"},"cmf":{"description":"Compare with OMF. Divide by PON to get basis points value. Tells when account's orders to be cancelled.","type":"number","format":"double"},"mmf":{"description":"Compare with MF. Divide by PON to get basis points value. Tells when account positions reduced and assets sold.","type":"number","format":"double"},"pon":{"description":"Expressed in USD, can be zero. See PON in MARKETS.md for details. Somewhat proportional to open position size and orders size in OB.","type":"number","format":"double"},"pn":{"description":"Similar to `pon`. See PN in MARKETS.md.","type":"number","format":"double"},"bankruptcy":{"description":"See `bankruptcy` in MARKETS.md. In general happens if account does not have enough weighted tokens to covert his debt and negative PnL.","type":"boolean"}}},"GetAccountPnlHistoryQuery":{"type":"object","properties":{"marketId":{"description":"Optional market filter by market id.","default":null,"type":["integer","null"],"format":"uint32","minimum":0.0},"since":{"description":"start with this timestamp (RFC3339); defaults to UNIX epoch start","default":null,"type":"string"},"until":{"description":"end with this timestamp (RFC3339); defaults to current date-time","default":null,"type":"string"},"startInclusive":{"description":"fetch results starting with this page; query starts with first entry if page isn't specified","type":["integer","null"],"format":"uint64","minimum":0.0},"pageSize":{"description":"Query returns up to 50 trades in one go.","default":null,"type":["integer","null"],"format":"uint8","minimum":1.0}}},"PageResult_for_uint64_and_AccountPnlInfo":{"type":"object","required":["items"],"properties":{"items":{"description":"Set of items for requested by query.","type":"array","items":{"$ref":"#/components/schemas/AccountPnlInfo"}},"nextStartInclusive":{"description":"If request contains more data, this is the id is set with which next request should be performed to get next page. If no more data, then it is undefined.","type":["integer","null"],"format":"uint64","minimum":0.0}}},"AccountPnlInfo":{"type":"object","required":["actionId","marketId","positionSize","settledFundingPnl","time","tradingPnl"],"properties":{"time":{"description":"Time of the position update.","type":"string"},"actionId":{"description":"Action id of the update. Used for pagination.","type":"integer","format":"uint64","minimum":0.0},"marketId":{"description":"Market id of the position update.","type":"integer","format":"uint32","minimum":0.0},"tradingPnl":{"description":"PnL realized from this position update.","type":"number","format":"double"},"settledFundingPnl":{"description":"Amount of unsettled funding paid to the account. Accumulated funding payments are tracked but only paid out to the account when updates happen. Thus, PnL history might include entries with no trading pnl (for example when opening or extending a position), but will still include funding payments if needed.","type":"number","format":"double"},"positionSize":{"description":"Position size at the time of the pnl update. Positive for longs, negative for shorts.","type":"number","format":"double"},"entryPrice":{"description":"Weighted average entry price of the position after this update. Null if position was closed.","type":["number","null"],"format":"double"}}},"GetAccountFundingHistoryQuery":{"type":"object","properties":{"marketId":{"description":"Optional market filter by market id.","default":null,"type":["integer","null"],"format":"uint32","minimum":0.0},"since":{"description":"start with this timestamp (RFC3339); defaults to UNIX epoch start","default":null,"type":"string"},"until":{"description":"end with this timestamp (RFC3339); defaults to current date-time","default":null,"type":"string"},"startInclusive":{"description":"fetch results starting with this page; query starts with first entry if page isn't specified","type":["string","null"]},"pageSize":{"description":"Query returns up to 50 trades in one go.","default":null,"type":["integer","null"],"format":"uint8","minimum":1.0}}},"PageResult_for_String_and_AccountFundingInfo":{"type":"object","required":["items"],"properties":{"items":{"description":"Set of items for requested by query.","type":"array","items":{"$ref":"#/components/schemas/AccountFundingInfo"}},"nextStartInclusive":{"description":"If request contains more data, this is the id is set with which next request should be performed to get next page. If no more data, then it is undefined.","type":["string","null"]}}},"AccountFundingInfo":{"type":"object","required":["actionId","fundingPnl","marketId","positionSize","time"],"properties":{"time":{"description":"Time of the position update.","type":"string"},"actionId":{"description":"Action id of the update. Used for pagination.","type":"integer","format":"uint64","minimum":0.0},"marketId":{"description":"Market id of the position update.","type":"integer","format":"uint32","minimum":0.0},"positionSize":{"description":"Position size at the time of the pnl update. Positive for longs, negative for shorts.","type":"number","format":"double"},"fundingPnl":{"description":"Funding paid to the account for this funding period.","type":"number","format":"double"}}},"BadRequest":{"type":"null"},"PagedQuery":{"type":"object","properties":{"since":{"description":"start with this timestamp (RFC3339); defaults to UNIX epoch start","default":null,"type":"string"},"until":{"description":"end with this timestamp (RFC3339); defaults to current date-time","default":null,"type":"string"},"startInclusive":{"description":"fetch results starting with this page; query starts with first entry if page isn't specified","type":["integer","null"],"format":"uint64","minimum":0.0},"pageSize":{"description":"Query returns up to 50 trades in one go.","default":null,"type":["integer","null"],"format":"uint8","minimum":1.0}}},"PageResult_for_uint64_and_Trigger":{"type":"object","required":["items"],"properties":{"items":{"description":"Set of items for requested by query.","type":"array","items":{"$ref":"#/components/schemas/Trigger"}},"nextStartInclusive":{"description":"If request contains more data, this is the id is set with which next request should be performed to get next page. If no more data, then it is undefined.","type":["integer","null"],"format":"uint64","minimum":0.0}}},"Trigger":{"type":"object","required":["accountId","createdAt","createdAtActionId","finalizedAt","intent","kind","marketId","side","status","triggerPrice"],"properties":{"accountId":{"type":"integer","format":"uint32","minimum":0.0},"marketId":{"type":"integer","format":"uint32","minimum":0.0},"triggerPrice":{"$ref":"#/components/schemas/PositivePriceMantissa"},"limitPrice":{"anyOf":[{"$ref":"#/components/schemas/PositivePriceMantissa"},{"type":"null"}]},"limitBaseSize":{"type":["integer","null"],"format":"uint64","minimum":1.0},"limitQuoteSize":{"type":["integer","null"],"format":"uint128","minimum":1.0},"side":{"$ref":"#/components/schemas/Side"},"kind":{"$ref":"#/components/schemas/TriggerKind"},"intent":{"$ref":"#/components/schemas/Intent"},"status":{"$ref":"#/components/schemas/TriggerStatus"},"error":{"anyOf":[{"$ref":"#/components/schemas/TriggerExecError"},{"type":"null"}]},"executorId":{"type":["integer","null"],"format":"uint32","minimum":0.0},"createdAtActionId":{"type":"integer","format":"uint64","minimum":0.0},"finalizedAtActionId":{"type":["integer","null"],"format":"uint64","minimum":0.0},"createdAt":{"type":"string"},"finalizedAt":{"type":"string"}}},"PositivePriceMantissa":{"description":"63 bit integer, which is always positive","type":"integer","format":"uint64","minimum":1.0},"TriggerKind":{"type":"string","enum":["stopLoss","takeProfit"]},"Intent":{"oneOf":[{"description":"\"Risk Management\" trigger. - Stored in `PerpPosition`. - Automatically cancelled if position closes or flips. - MUST reduce the position size (Stop Loss / Take Profit).","type":"string","enum":["Decrease"]},{"description":"\"Entry\" or \"Grid\" trigger. - Stored in `Market`. - Persists even if current position closes. - Used to enter new positions or add to existing ones.","type":"string","enum":["Increase"]}]},"TriggerStatus":{"type":"string","enum":["Active","Success","Removed","Cancelled","Failed"]},"TriggerExecError":{"type":"string","enum":["noPosition","planningFailed","bankruptcy","riskCheckFailed","reduceOnlyCheckFailed","unknown"]},"TriggerInfo":{"type":"object","required":["accountId","actionId","createdAt","intent","kind","marketId","side","triggerPrice"],"properties":{"accountId":{"type":"integer","format":"uint32","minimum":0.0},"marketId":{"type":"integer","format":"uint32","minimum":0.0},"triggerPrice":{"$ref":"#/components/schemas/PositivePriceMantissa"},"limitPrice":{"anyOf":[{"$ref":"#/components/schemas/PositivePriceMantissa"},{"type":"null"}]},"limitBaseSize":{"type":["integer","null"],"format":"uint64","minimum":1.0},"limitQuoteSize":{"type":["integer","null"],"format":"uint128","minimum":1.0},"side":{"$ref":"#/components/schemas/Side"},"kind":{"$ref":"#/components/schemas/TriggerKind"},"intent":{"$ref":"#/components/schemas/Intent"},"actionId":{"description":"created_at_action_id","type":"integer","format":"uint64","minimum":0.0},"createdAt":{"type":"string"}}},"PageResult_for_uint64_and_TriggerInfo":{"type":"object","required":["items"],"properties":{"items":{"description":"Set of items for requested by query.","type":"array","items":{"$ref":"#/components/schemas/TriggerInfo"}},"nextStartInclusive":{"description":"If request contains more data, this is the id is set with which next request should be performed to get next page. If no more data, then it is undefined.","type":["integer","null"],"format":"uint64","minimum":0.0}}},"OrderNotFound":{"type":"null"},"PageResult_for_uint64_and_Trade":{"type":"object","required":["items"],"properties":{"items":{"description":"Set of items for requested by query.","type":"array","items":{"$ref":"#/components/schemas/Trade"}},"nextStartInclusive":{"description":"If request contains more data, this is the id is set with which next request should be performed to get next page. If no more data, then it is undefined.","type":["integer","null"],"format":"uint64","minimum":0.0}}},"Trade":{"type":"object","required":["actionId","baseSize","makerId","marketId","orderId","price","takerId","takerSide","time","tradeId"],"properties":{"time":{"type":"string"},"actionId":{"type":"integer","format":"uint64","minimum":0.0},"tradeId":{"type":"integer","format":"uint64","minimum":0.0},"takerId":{"type":"integer","format":"uint32","minimum":0.0},"takerSide":{"$ref":"#/components/schemas/Side"},"makerId":{"type":"integer","format":"uint32","minimum":0.0},"marketId":{"type":"integer","format":"uint32","minimum":0.0},"orderId":{"type":"integer","format":"uint64","minimum":0.0},"price":{"type":"number","format":"double"},"baseSize":{"type":"number","format":"double"}}},"TradesQuery":{"type":"object","properties":{"takerId":{"default":null,"type":["integer","null"],"format":"uint32","minimum":0.0},"takerSide":{"default":null,"anyOf":[{"$ref":"#/components/schemas/Side"},{"type":"null"}]},"makerId":{"default":null,"type":["integer","null"],"format":"uint32","minimum":0.0},"marketId":{"default":null,"type":["integer","null"],"format":"uint32","minimum":0.0},"since":{"description":"start with this timestamp (RFC3339); defaults to UNIX epoch start","default":null,"type":"string"},"until":{"description":"end with this timestamp (RFC3339); defaults to current date-time","default":null,"type":"string"},"startInclusive":{"description":"fetch results starting with this page; query starts with first entry if page isn't specified","type":["integer","null"],"format":"uint64","minimum":0.0},"pageSize":{"description":"Query returns up to 50 trades in one go.","default":null,"type":["integer","null"],"format":"uint8","minimum":1.0}}},"DownloadFilter":{"anyOf":[{"$ref":"#/components/schemas/Op_for_DataDateTime"},{"description":"If there is no exact action id snapped, nearest download. So request does not forces remote nord to execute up to new snap. It is upt to caller get actions and replay as needed. If filtered by equality, then not found returned.","$ref":"#/components/schemas/Op_for_uint64"},{"$ref":"#/components/schemas/Op_for_uint64"},{"type":"null"}]},"Op_for_DataDateTime":{"description":"Parses tag (anycase), and value in round braces using `from_str`.","oneOf":[{"type":"object","required":["le"],"properties":{"le":{"$ref":"#/components/schemas/DataDateTime"}},"additionalProperties":false}]},"DataDateTime":{"type":"string"},"Op_for_uint64":{"description":"Parses tag (anycase), and value in round braces using `from_str`.","oneOf":[{"type":"object","required":["le"],"properties":{"le":{"type":"integer","format":"uint64","minimum":0.0}},"additionalProperties":false}]},"StateDownloadMeta":{"type":"object","required":["hash","link"],"properties":{"hash":{"description":"Hash of the state file. Used as ETag.","type":"array","items":{"type":"integer","format":"uint8","minimum":0.0},"maxItems":32,"minItems":32},"link":{"description":"Link to download the state file.","type":"string","format":"uri"},"version":{"description":"Version of binary which produced this state snapshot. So can decide whether it is compatible with client. todo(repl): After upgrade release make it non-optional.","anyOf":[{"$ref":"#/components/schemas/BinaryId"},{"type":"null"}]}}},"BinaryId":{"type":"string"},"SnapshotNotFound":{"type":"string"},"StateInfo":{"type":"object","required":["state","version"],"properties":{"version":{"$ref":"#/components/schemas/ExecutableVersion"},"state":{"$ref":"#/components/schemas/EngineStateHeader"}}},"EngineStateHeader":{"type":"object","required":["action_id","action_nonce","paused","timestamp","version"],"properties":{"version":{"type":"integer","format":"uint16","minimum":0.0},"action_id":{"type":"integer","format":"uint64","minimum":0.0},"action_nonce":{"type":"integer","format":"uint64","minimum":0.0},"timestamp":{"type":"integer","format":"uint64","minimum":0.0},"paused":{"type":"boolean"}}},"StateHistInfo":{"type":"object","required":["versions"],"properties":{"versions":{"type":"array","items":{"type":"array","items":[{"type":"integer","format":"uint64","minimum":0.0},{"$ref":"#/components/schemas/ExecutableVersion"}],"maxItems":2,"minItems":2}}}},"FeeTierId":{"type":"integer","format":"uint32","minimum":0.0},"FeeTierConfig":{"description":"Use 1/1_000_000 granularity (ppm)\n\n| ppm  | decimal  | percent | |------|----------|---------| | 1    | 0.000001 | 0.0001% | | 5    | 0.000005 | 0.0005% | | 10   | 0.00001  | 0.001%  | | 50   | 0.00005  | 0.005%  | | 100  | 0.0001   | 0.01%   | | 500  | 0.0005   | 0.05%   | | 1000 | 0.001    | 0.10%   | | 5000 | 0.005    | 0.50%   | | 10000| 0.01     | 1.00%   |","type":"object","required":["maker_fee_ppm","taker_fee_ppm"],"properties":{"maker_fee_ppm":{"type":"integer","format":"uint32","minimum":0.0},"taker_fee_ppm":{"type":"integer","format":"uint32","minimum":0.0}}},"GetAccountsFeeTiersQuery":{"type":"object","properties":{"tier":{"default":null,"anyOf":[{"$ref":"#/components/schemas/FeeTierId"},{"type":"null"}]},"startInclusive":{"description":"fetch results starting with this page; query starts with first entry if page isn't specified","type":["integer","null"],"format":"uint32","minimum":0.0},"pageSize":{"description":"Query returns up to 50 trades in one go.","default":null,"type":["integer","null"],"format":"uint8","minimum":1.0}}},"PageResult_for_uint32_and_AccountFeeTier":{"type":"object","required":["items"],"properties":{"items":{"description":"Set of items for requested by query.","type":"array","items":{"$ref":"#/components/schemas/AccountFeeTier"}},"nextStartInclusive":{"description":"If request contains more data, this is the id is set with which next request should be performed to get next page. If no more data, then it is undefined.","type":["integer","null"],"format":"uint32","minimum":0.0}}},"AccountFeeTier":{"type":"object","required":["accountId","feeTier"],"properties":{"accountId":{"type":"integer","format":"uint32","minimum":0.0},"feeTier":{"$ref":"#/components/schemas/FeeTierId"}}},"AdminInfo":{"type":"object","required":["key","roles"],"properties":{"key":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}}}},"GetAccountVolumeQuery":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"integer","format":"uint32","minimum":0.0},"marketId":{"type":["integer","null"],"format":"uint32","minimum":0.0},"since":{"description":"start with this timestamp (RFC3339); defaults to UNIX epoch start","default":null,"type":"string"},"until":{"description":"end with this timestamp (RFC3339); defaults to current date-time","default":null,"type":"string"}}},"AccountVolumeInfo":{"type":"object","required":["marketId","volumeBase","volumeQuote"],"properties":{"marketId":{"type":"integer","format":"uint32","minimum":0.0},"volumeBase":{"type":"number","format":"double"},"volumeQuote":{"type":"number","format":"double"}}},"PageResult_for_uint64_and_WithdrawalInfo":{"type":"object","required":["items"],"properties":{"items":{"description":"Set of items for requested by query.","type":"array","items":{"$ref":"#/components/schemas/WithdrawalInfo"}},"nextStartInclusive":{"description":"If request contains more data, this is the id is set with which next request should be performed to get next page. If no more data, then it is undefined.","type":["integer","null"],"format":"uint64","minimum":0.0}}},"WithdrawalInfo":{"type":"object","required":["accountId","actionId","amount","balance","fee","time","tokenId"],"properties":{"time":{"type":"string"},"actionId":{"type":"integer","format":"uint64","minimum":0.0},"accountId":{"type":"integer","format":"uint32","minimum":0.0},"tokenId":{"type":"integer","format":"uint32","minimum":0.0},"amount":{"type":"number","format":"double"},"balance":{"type":"number","format":"double"},"fee":{"type":"number","format":"double"},"destPubkey":{"type":["string","null"]}}},"PageResult_for_uint64_and_DepositInfo":{"type":"object","required":["items"],"properties":{"items":{"description":"Set of items for requested by query.","type":"array","items":{"$ref":"#/components/schemas/DepositInfo"}},"nextStartInclusive":{"description":"If request contains more data, this is the id is set with which next request should be performed to get next page. If no more data, then it is undefined.","type":["integer","null"],"format":"uint64","minimum":0.0}}},"DepositInfo":{"type":"object","required":["accountId","actionId","amount","balance","eventIndex","time","tokenId"],"properties":{"time":{"type":"string"},"actionId":{"type":"integer","format":"uint64","minimum":0.0},"accountId":{"type":"integer","format":"uint32","minimum":0.0},"tokenId":{"type":"integer","format":"uint32","minimum":0.0},"amount":{"type":"number","format":"double"},"balance":{"type":"number","format":"double"},"eventIndex":{"type":"integer","format":"uint64","minimum":0.0}}},"PageResult_for_uint64_and_Transfer":{"type":"object","required":["items"],"properties":{"items":{"description":"Set of items for requested by query.","type":"array","items":{"$ref":"#/components/schemas/Transfer"}},"nextStartInclusive":{"description":"If request contains more data, this is the id is set with which next request should be performed to get next page. If no more data, then it is undefined.","type":["integer","null"],"format":"uint64","minimum":0.0}}},"Transfer":{"type":"object","required":["actionId","amount","idx","time","tokenId"],"properties":{"time":{"type":"string"},"actionId":{"type":"integer","format":"uint64","minimum":0.0},"idx":{"description":"Transfer index within the action. Always `0` today since a single action produces at most one transfer; reserved for future multi-transfer scenarios (atomics, liquidations).","type":"integer","format":"uint16","minimum":0.0},"fromAccountId":{"description":"`None` when the origin is the fee vault (`FeeVaultTransferred` action).","type":["integer","null"],"format":"uint32","minimum":0.0},"toAccountId":{"description":"`None` when the destination is the fee vault (`Transfer` with `AccountRef::Special`).","type":["integer","null"],"format":"uint32","minimum":0.0},"tokenId":{"type":"integer","format":"uint32","minimum":0.0},"amount":{"type":"integer","format":"uint64","minimum":1.0}}},"PageResult_for_uint64_and_LiquidationInfo":{"type":"object","required":["items"],"properties":{"items":{"description":"Set of items for requested by query.","type":"array","items":{"$ref":"#/components/schemas/LiquidationInfo"}},"nextStartInclusive":{"description":"If request contains more data, this is the id is set with which next request should be performed to get next page. If no more data, then it is undefined.","type":["integer","null"],"format":"uint64","minimum":0.0}}},"LiquidationInfo":{"type":"object","required":["actionId","fee","liquidateeId","liquidationKind","liquidatorId","postCmf","postImf","postMf","postMmf","postOmf","postPn","postPon","preCmf","preImf","preMf","preMmf","preOmf","prePn","prePon","time"],"properties":{"time":{"type":"string"},"actionId":{"type":"integer","format":"uint64","minimum":0.0},"liquidatorId":{"type":"integer","format":"uint32","minimum":0.0},"liquidateeId":{"type":"integer","format":"uint32","minimum":0.0},"fee":{"type":"number","format":"double"},"liquidationKind":{"$ref":"#/components/schemas/LiquidationKind"},"marketId":{"type":["integer","null"],"format":"uint32","minimum":0.0},"tokenId":{"type":["integer","null"],"format":"uint32","minimum":0.0},"orderId":{"type":["integer","null"],"format":"uint64","minimum":0.0},"orderPrice":{"type":["number","null"],"format":"double"},"orderSize":{"type":["number","null"],"format":"double"},"orderQuote":{"type":["number","null"],"format":"double"},"preOmf":{"type":"number","format":"double"},"preMmf":{"type":"number","format":"double"},"preImf":{"type":"number","format":"double"},"preCmf":{"type":"number","format":"double"},"prePon":{"type":"number","format":"double"},"preMf":{"type":"number","format":"double"},"prePn":{"type":"number","format":"double"},"postOmf":{"type":"number","format":"double"},"postMmf":{"type":"number","format":"double"},"postImf":{"type":"number","format":"double"},"postCmf":{"type":"number","format":"double"},"postPon":{"type":"number","format":"double"},"postMf":{"type":"number","format":"double"},"postPn":{"type":"number","format":"double"}}},"LiquidationKind":{"oneOf":[{"description":"Place an order on behalf of the user to close a position.","type":"string","enum":["place_order"]},{"description":"Cancel an order on behalf of the user if their open fraction is too small.","type":"string","enum":["cancel_order"]},{"description":"The user is bankrupt.","type":"string","enum":["bankruptcy_or_take"]}]},"TakeAllInfo":{"description":"Produced for each position taken from maker(liquidatee) by maker(backstop account)","type":"object","required":["actionId","bankruptcyPrice","baseSize","makerAccountId","marketId","settlementPrice","takerAccountId","takerSide","time"],"properties":{"time":{"type":"string"},"actionId":{"type":"integer","format":"uint64","minimum":0.0},"takerAccountId":{"type":"integer","format":"uint32","minimum":0.0},"takerSide":{"$ref":"#/components/schemas/Side"},"marketId":{"type":"integer","format":"uint32","minimum":0.0},"settlementPrice":{"$ref":"#/components/schemas/PositivePriceMantissa"},"baseSize":{"type":"integer","format":"uint64","minimum":1.0},"makerAccountId":{"type":"integer","format":"uint32","minimum":0.0},"bankruptcyPrice":{"$ref":"#/components/schemas/PositivePriceMantissa"}}},"HealthInfo":{"description":"UNSTABLE: operational health information for history catchup progress.","type":"object","required":["history","status","watermarks"],"properties":{"watermarks":{"$ref":"#/components/schemas/HealthWatermarks"},"history":{"$ref":"#/components/schemas/HealthProgressInfo"},"status":{"$ref":"#/components/schemas/HealthStatus"}}},"HealthWatermarks":{"type":"object","required":["executedActionId","historyActionId"],"properties":{"executedActionId":{"type":"integer","format":"uint64","minimum":0.0},"historyActionId":{"type":"integer","format":"uint64","minimum":0.0}}},"HealthProgressInfo":{"type":"object","required":["lastInsertAgeMs"],"properties":{"lastInsertAgeMs":{"type":"integer","format":"uint64","minimum":0.0}}},"HealthStatus":{"type":"object","required":["historyStalled"],"properties":{"historyStalled":{"type":"boolean"}}},"TvConfigResponse":{"description":"TV config query response https://www.tradingview.com/charting-library-docs/latest/connecting_data/UDF/#data-feed-configuration-data","type":"object","required":["supported_resolutions","supports_group_request","supports_marks","supports_search","supports_timescale_marks"],"properties":{"supported_resolutions":{"type":"array","items":{"$ref":"#/components/schemas/Resolution"}},"supports_group_request":{"type":"boolean"},"supports_marks":{"type":"boolean"},"supports_search":{"type":"boolean"},"supports_timescale_marks":{"type":"boolean"}}},"Resolution":{"description":"More limited resolution than history one, used in some HTTP queries","type":"string","enum":["OneMinute","FiveMinutes","FifteenMinutes","ThirtyMinutes","SixtyMinutes","FourHours","OneDay","OneWeek","OneMonth"]},"TvSymbolsQuery":{"description":"TV symbols query","type":"object","required":["symbol"],"properties":{"symbol":{"type":"string"}}},"TvSymbolsResult":{"type":"object","required":["description","exchange","format","has_empty_bars","has_intraday","has_weekly_and_monthly","listed_exchange","minmov","name","pricescale","session","supported_resolutions","ticker","timezone","type"],"properties":{"description":{"type":"string"},"exchange":{"type":"string"},"has_intraday":{"type":"boolean"},"has_empty_bars":{"type":"boolean"},"has_weekly_and_monthly":{"type":"boolean"},"format":{"$ref":"#/components/schemas/TvSymbolsFormat"},"listed_exchange":{"type":"string"},"minmov":{"type":"integer","format":"int64"},"name":{"type":"string"},"pricescale":{"type":"integer","format":"int64"},"session":{"type":"string"},"supported_resolutions":{"type":"array","items":{"$ref":"#/components/schemas/Resolution"}},"ticker":{"type":"string"},"timezone":{"type":"string"},"type":{"type":"string"}}},"TvSymbolsFormat":{"type":"string","enum":["price","volume"]},"MarketSymbolNotFound":{"type":"object","required":["symbol"],"properties":{"symbol":{"type":"string"}}},"TvSearchQuery":{"type":"object","required":["exchange","limit","query","type"],"properties":{"query":{"type":"string"},"type":{"type":"string"},"exchange":{"type":"string"},"limit":{"type":"integer","format":"uint32","minimum":0.0}}},"TvSearchResponseItem":{"type":"object","required":["description","exchange","symbol","ticker","type"],"properties":{"description":{"type":"string"},"exchange":{"type":"string"},"symbol":{"type":"string"},"ticker":{"type":"string"},"type":{"type":"string"}}},"TvHistoryQuery":{"description":"History query https://www.tradingview.com/charting-library-docs/latest/connecting_data/UDF/#bars\n\n# Extension: Accepts either: * `market_id` - raw market identifier * `symbol` - market symbol from original spec, picks first market which matches it","type":"object","required":["resolution","to"],"properties":{"market_id":{"type":["integer","null"],"format":"uint32","minimum":0.0},"symbol":{"type":["string","null"]},"from":{"type":"string"},"to":{"type":"string"},"resolution":{"$ref":"#/components/schemas/Resolution"},"countback":{"type":["integer","null"],"format":"uint16","minimum":0.0}}},"TvHistoryResponse":{"oneOf":[{"type":"object","required":["s"],"properties":{"s":{"type":"string","enum":["no_data"]},"nextTime":{"type":"string"}}},{"description":"History variant which actually contains data\n\n`f64` are used to represent values as bare numbers, see https://www.tradingview.com/charting-library-docs/latest/connecting_data/UDF/#bars `Notes` section","type":"object","required":["c","h","l","o","s","t","v"],"properties":{"s":{"type":"string","enum":["ok"]},"t":{"type":"array","items":{"type":"integer","format":"int64"}},"o":{"type":"array","items":{"type":"number","format":"double"}},"c":{"type":"array","items":{"type":"number","format":"double"}},"h":{"type":"array","items":{"type":"number","format":"double"}},"l":{"type":"array","items":{"type":"number","format":"double"}},"v":{"type":"array","items":{"type":"number","format":"double"}}}}]},"error":{"type":"object","required":["errmsg"],"properties":{"errmsg":{"type":"string"}}},"TvQuotesQuery":{"type":"object","required":["symbols"],"properties":{"symbols":{"description":"Comma-delimited list of symbols","type":"string"}}},"ok":{"type":"object","required":["d"],"properties":{"d":{"type":"array","items":{"$ref":"#/components/schemas/TvQuotesItem"}}}},"TvQuotesItem":{"description":"Quotes entry, see https://www.tradingview.com/charting-library-docs/latest/api/modules/Datafeed/#quotedata","oneOf":[{"description":"Quotes success entry, see https://www.tradingview.com/charting-library-docs/latest/api/interfaces/Datafeed.QuoteOkData/","type":"object","required":["n","s","v"],"properties":{"s":{"type":"string","enum":["ok"]},"n":{"type":"string"},"v":{"$ref":"#/components/schemas/TvQuotesValues"}}},{"description":"Quotes error entry, see https://www.tradingview.com/charting-library-docs/latest/api/interfaces/Datafeed.QuoteErrorData/\n\n# Note API spec isn't clear about entry data, it requires `v: QuoteValues`. Probably it should've been `errmsg: String`, but in order to conform to API, we leave `v: {}`, i.e. empty object","type":"object","required":["n","s","v"],"properties":{"s":{"type":"string","enum":["error"]},"n":{"type":"string"},"v":{"$ref":"#/components/schemas/TvQuotesErrorValues"}}}]},"TvQuotesValues":{"description":"Datafeed quote values, see https://www.tradingview.com/charting-library-docs/latest/api/interfaces/Datafeed.DatafeedQuoteValues/ for details Field renames are due to spec","type":"object","properties":{"ask":{"description":"Current best, i.e. lowest, ask price, if present","type":["number","null"],"format":"double"},"bid":{"description":"Current best, i.e. highest, bid price, if present","type":["number","null"],"format":"double"},"ch":{"description":"Delta between last price and previous close price","type":["number","null"],"format":"double"},"chp":{"description":"Percentage delta between last price and previous close price","type":["number","null"],"format":"double"},"description":{"type":["string","null"]},"exchange":{"type":["string","null"]},"high_price":{"type":["number","null"],"format":"double"},"low_price":{"type":["number","null"],"format":"double"},"lp":{"description":"Current last trade price, no matter whether it was bid or ask","type":["number","null"],"format":"double"},"open_price":{"description":"Trade price of the first trade which happened in current session","type":["number","null"],"format":"double"},"original_name":{"type":["string","null"]},"prev_close_price":{"description":"Last trade price of previous session","type":["number","null"],"format":"double"},"rch":{"type":["number","null"],"format":"double"},"rchp":{"type":["number","null"],"format":"double"},"rtc":{"type":["number","null"],"format":"double"},"rtc_time":{"type":"string"},"short_name":{"type":["string","null"]},"spread":{"description":"Delta between current bid and ask prices","type":["number","null"],"format":"double"},"volume":{"type":["number","null"],"format":"double"}}},"TvQuotesErrorValues":{"description":"Empty object, to make quotes item conform to API error spec","type":"object"},"GetMarketHistoryQuery":{"type":"object","properties":{"pageSize":{"default":24,"type":"integer","format":"uint8","minimum":1.0}}},"PageResult_for_uint64_and_MarketHistoryInfo":{"type":"object","required":["items"],"properties":{"items":{"description":"Set of items for requested by query.","type":"array","items":{"$ref":"#/components/schemas/MarketHistoryInfo"}},"nextStartInclusive":{"description":"If request contains more data, this is the id is set with which next request should be performed to get next page. If no more data, then it is undefined.","type":["integer","null"],"format":"uint64","minimum":0.0}}},"MarketHistoryInfo":{"type":"object","required":["actionId","fundingIndex","fundingRate","indexPrice","markPrice","marketId","time"],"properties":{"marketId":{"type":"integer","format":"uint32","minimum":0.0},"time":{"type":"string"},"actionId":{"type":"integer","format":"uint64","minimum":0.0},"fundingIndex":{"$ref":"#/components/schemas/FundingIndexMantissa"},"fundingRate":{"type":"number","format":"double"},"indexPrice":{"description":"Scaled in market price decimals","type":"number","format":"double"},"markPrice":{"type":"number","format":"double"}}},"FundingIndexMantissa":{"description":"Consist of some sum of `SignedPerMillion` weighted by `PriceMantissa`(with market decimals). Funding rate jitters around 0, so really hard to get big numbers. Is `basic points numerator * market price mantissa` unit.","type":"integer","format":"int128"},"UpdatePayload":{"oneOf":[{"description":"Market orderbook update with L2 level information (no specifics about an order nor account).","type":"object","required":["delta"],"properties":{"delta":{"type":"object","required":["asks","bids","last_update_id","market_symbol","update_id"],"properties":{"last_update_id":{"type":"integer","format":"uint64","minimum":0.0},"update_id":{"type":"integer","format":"uint64","minimum":0.0},"market_symbol":{"type":"string"},"asks":{"type":"array","items":{"type":"array","items":[{"type":"number","format":"double"},{"type":"number","format":"double"}],"maxItems":2,"minItems":2}},"bids":{"type":"array","items":{"type":"array","items":[{"type":"number","format":"double"},{"type":"number","format":"double"}],"maxItems":2,"minItems":2}}}}},"additionalProperties":false},{"description":"Market fills","type":"object","required":["trades"],"properties":{"trades":{"type":"object","required":["last_update_id","market_symbol","trades","update_id"],"properties":{"last_update_id":{"type":"integer","format":"uint64","minimum":0.0},"update_id":{"type":"integer","format":"uint64","minimum":0.0},"market_symbol":{"type":"string"},"trades":{"type":"array","items":{"$ref":"#/components/schemas/TradeUpdate"}}}}},"additionalProperties":false},{"description":"All account updates, including placement, (partial) fills, and (partial) cancellations.","type":"object","required":["account"],"properties":{"account":{"type":"object","required":["account_id","balances","cancels","fills","last_update_id","places","reduced_orders","update_id"],"properties":{"last_update_id":{"type":"integer","format":"uint64","minimum":0.0},"update_id":{"type":"integer","format":"uint64","minimum":0.0},"account_id":{"type":"integer","format":"uint32","minimum":0.0},"fills":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/FillUpdate"}},"places":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/OrderUpdate"}},"cancels":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/OrderUpdate"}},"reduced_orders":{"description":"Reduce orders: fully cancelled or partially cancelled (shrunk in-place).","type":"object","additionalProperties":{"$ref":"#/components/schemas/OrderUpdate"}},"balances":{"type":"object","additionalProperties":{"type":"number","format":"double"}}}}},"additionalProperties":false},{"type":"object","required":["liquidation"],"properties":{"liquidation":{"type":"object","required":["last_update_id","liquidations","update_id"],"properties":{"last_update_id":{"type":"integer","format":"uint64","minimum":0.0},"update_id":{"type":"integer","format":"uint64","minimum":0.0},"liquidations":{"type":"array","items":{"$ref":"#/components/schemas/LiquidationUpdate"}}}}},"additionalProperties":false}]},"TradeUpdate":{"type":"object","required":["order_id","price","side","size"],"properties":{"side":{"$ref":"#/components/schemas/Side"},"price":{"type":"number","format":"double"},"size":{"type":"number","format":"double"},"order_id":{"type":"integer","format":"uint64","minimum":0.0},"sender_tracking_id":{"deprecated":true,"type":["integer","null"],"format":"uint64","minimum":0.0}}},"FillUpdate":{"type":"object","required":["maker_id","market_id","order_id","price","quantity","remaining","side","taker_id"],"properties":{"side":{"$ref":"#/components/schemas/Side"},"quantity":{"type":"number","format":"double"},"remaining":{"type":"number","format":"double"},"price":{"type":"number","format":"double"},"order_id":{"type":"integer","format":"uint64","minimum":0.0},"market_id":{"type":"integer","format":"uint32","minimum":0.0},"maker_id":{"type":"integer","format":"uint32","minimum":0.0},"taker_id":{"type":"integer","format":"uint32","minimum":0.0},"sender_tracking_id":{"deprecated":true,"type":["integer","null"],"format":"uint64","minimum":0.0},"client_order_id":{"type":["integer","null"],"format":"uint64","minimum":0.0}}},"OrderUpdate":{"type":"object","required":["current_size","market_id","price","side"],"properties":{"side":{"$ref":"#/components/schemas/Side"},"current_size":{"description":"Absolute size of order as it became after some change.","type":"number","format":"double"},"price":{"type":"number","format":"double"},"market_id":{"type":"integer","format":"uint32","minimum":0.0},"sender_tracking_id":{"deprecated":true,"type":["integer","null"],"format":"uint64","minimum":0.0},"client_order_id":{"type":["integer","null"],"format":"uint64","minimum":0.0}}},"LiquidationUpdate":{"type":"object","required":["makerAccountId","takerAccountId","takerBalances","takerPositions"],"properties":{"makerAccountId":{"type":"integer","format":"uint32","minimum":0.0},"takerAccountId":{"type":"integer","format":"uint32","minimum":0.0},"takerBalances":{"type":"array","items":{"$ref":"#/components/schemas/LiquidationBalance"}},"takerPositions":{"type":"array","items":{"$ref":"#/components/schemas/LiquidatedPosition"}}}},"LiquidationBalance":{"type":"object","required":["amount","tokenId"],"properties":{"tokenId":{"type":"integer","format":"uint32","minimum":0.0},"amount":{"type":"number","format":"double"}}},"LiquidatedPosition":{"type":"object","required":["accountId","marketId"],"properties":{"marketId":{"type":"integer","format":"uint32","minimum":0.0},"accountId":{"type":"integer","format":"uint32","minimum":0.0},"perp":{"anyOf":[{"$ref":"#/components/schemas/PerpPosition"},{"type":"null"}]}}},"PerpPosition":{"type":"object","required":["baseSize","price","updatedFundingRateIndex"],"properties":{"baseSize":{"type":"number","format":"double"},"price":{"type":"number","format":"double"},"updatedFundingRateIndex":{"type":"number","format":"double"}}},"CandleUpdate":{"type":"object","required":["c","h","l","mid","o","res","t","v"],"properties":{"res":{"description":"TradingView resolution.","$ref":"#/components/schemas/Resolution"},"mid":{"description":"Market id.","type":"integer","format":"uint32","minimum":0.0},"t":{"description":"Timestamp in seconds.","type":"integer","format":"int64"},"o":{"description":"Open price.","type":"number","format":"double"},"h":{"description":"High price.","type":"number","format":"double"},"l":{"description":"Low price.","type":"number","format":"double"},"c":{"description":"Close price.","type":"number","format":"double"},"v":{"description":"Volume in the quote currency, i.e. USDC.","type":"number","format":"double"}}}}}}