{ "openapi": "3.1.0", "info": { "title": "Tickwire API", "version": "0.1.0", "description": "The Tickwire API: the /users/current/... REST API, the /v1/... routes and the terminal routes (/mt4|mt5/{id}/...). Auth: auth-token or X-API-Key header." }, "servers": [ { "url": "https://api.tickwire.io" } ], "paths": { "/.well-known/oauth-authorization-server": { "get": { "tags": [ "ai-apps-oauth" ], "summary": "As Metadata", "description": "RFC 8414 Authorization Server Metadata.", "operationId": "as_metadata__well_known_oauth_authorization_server_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/mt4/{account_id}/AccountInfo": { "get": { "tags": [ "terminal", "terminal-mt4" ], "summary": "GET /mt4/{account_id}/AccountInfo", "description": "Static account identity and configuration: name, login, server, company,\ncurrency, leverage, type, margin mode (Netting/Hedging/Exchange; always\nHedging on MT4), stop-out configuration and trade permissions.", "operationId": "terminal_mt4_account_info", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mt4/{account_id}/AccountSummary": { "get": { "tags": [ "terminal", "terminal-mt4" ], "summary": "GET /mt4/{account_id}/AccountSummary", "description": "Live financial snapshot: balance, credit, floating profit, equity, margin,\nfree margin, margin level, leverage, currency and account type\n(Demo/Contest/Real; ``Unknown`` if the terminal does not say).", "operationId": "terminal_mt4_account_summary", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mt4/{account_id}/CloseAll": { "post": { "tags": [ "terminal", "terminal-mt4" ], "summary": "POST /mt4/{account_id}/CloseAll", "description": "Close every open position, optionally only ``symbol`` and/or ``magic``\n(``magic: 0`` means manually opened), and with ``deletePending: true`` also\ndelete matching pending orders. Each ticket is its own audited, idempotent\nclose (``Idempotency-Key`` + ``#ticket``); the whole reply is replayed for\nthe same key. ``closed`` counts tickets now closed (including ones already\ngone), ``failed`` rejections, ``unknown`` lost replies.", "operationId": "terminal_mt4_close_all", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mt4/{account_id}/OpenedOrders": { "get": { "tags": [ "terminal", "terminal-mt4" ], "summary": "GET /mt4/{account_id}/OpenedOrders", "description": "All open positions (``kind: position``) and pending orders\n(``kind: pending``). Pending rows show their trigger price in ``openPrice``,\nthe current market price on their side in ``currentPrice``, and zero\nswap/profit.", "operationId": "terminal_mt4_opened_orders", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mt4/{account_id}/OrderCalcMargin": { "get": { "tags": [ "terminal", "terminal-mt4" ], "summary": "GET /mt4/{account_id}/OrderCalcMargin", "description": "Margin (account currency) needed to open ``volume`` lots of ``operation``\non ``symbol`` at ``price``. Places nothing.", "operationId": "terminal_mt4_order_calc_margin", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mt4/{account_id}/OrderCalcProfit": { "get": { "tags": [ "terminal", "terminal-mt4" ], "summary": "GET /mt4/{account_id}/OrderCalcProfit", "description": "Projected P/L (account currency) of ``volume`` lots from ``priceOpen`` to\n``priceClose``; pending operations count by direction only. Places nothing.", "operationId": "terminal_mt4_order_calc_profit", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mt4/{account_id}/OrderClose": { "post": { "tags": [ "terminal", "terminal-mt4" ], "summary": "POST /mt4/{account_id}/OrderClose", "description": "Close a position (``volume`` for a partial close; omitted or 0 closes it\nall) or delete a pending order: the ticket type decides. ``slippage`` in\npoints (default 10). Closing a ticket that is already gone is\n``outcome: no_change`` with ``isEffective: true`` and nothing sent, so a\nretried close is safe.", "operationId": "terminal_mt4_order_close", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mt4/{account_id}/OrderHistory": { "get": { "tags": [ "terminal", "terminal-mt4" ], "summary": "GET /mt4/{account_id}/OrderHistory", "description": "Closed deals (executions, not orders) in ``[from, to]``, broker server\ntime, ISO-8601 or YYYY-MM-DD; absent bounds mean all time. Each row carries\n``entry`` (In/Out/InOut/OutBy) and ``position`` (the round trip it belongs to).", "operationId": "terminal_mt4_order_history", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mt4/{account_id}/OrderModify": { "post": { "tags": [ "terminal", "terminal-mt4" ], "summary": "POST /mt4/{account_id}/OrderModify", "description": "Modify a position (``stopLoss``/``takeProfit`` only) or a pending order\n(also ``price``, ``stopLimitPrice``, ``expiration``). Omitted fields keep\ntheir current value; ``0`` clears a stop. An unknown ticket is a\n``rejected`` result with retcode 0 and nothing is sent.", "operationId": "terminal_mt4_order_modify", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mt4/{account_id}/OrderSend": { "post": { "tags": [ "terminal", "terminal-mt4" ], "summary": "POST /mt4/{account_id}/OrderSend", "description": "Submit a market (Buy/Sell) or pending (*Limit/*Stop/*StopLimit) order.\n\nBody: ``symbol``*, ``operation``* (case/separator-insensitive), ``volume``*,\n``price`` (pending), ``stopLimitPrice`` (*StopLimit), ``stopLoss``,\n``takeProfit``, ``slippage`` (points, default 10), ``expiration`` (pending;\nabsent = good till cancelled), ``comment``, ``expertId`` (magic). Unknown\nfields are refused; an unknown symbol is never sent (HTTP 500, reason\n``symbol_not_found``). A 200 only\nmeans the terminal answered: read ``success``\nand ``outcome``. Stop-limit orders on MT4 give ``not_supported_on_mt4``.", "operationId": "terminal_mt4_order_send", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mt4/{account_id}/PositionHistory": { "get": { "tags": [ "terminal", "terminal-mt4" ], "summary": "GET /mt4/{account_id}/PositionHistory", "description": "Closed positions closed within ``[from, to]``: one row per round trip with\nvolume-weighted open/close prices, summed profit/swap/commission and\n``netProfit``. A position still partly open is not listed.", "operationId": "terminal_mt4_position_history", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mt4/{account_id}/PriceHistory": { "get": { "tags": [ "terminal", "terminal-mt4" ], "summary": "GET /mt4/{account_id}/PriceHistory", "description": "OHLC bars for ``symbol`` and ``timeframe`` (M1, M5, M15, M30, H1, H4, D1,\nW1, MN1 or 5min/1h/1d) in ``[from, to]`` (broker time). Without ``from`` the\nmost recent 50 000 bars are searched. MT5-only timeframes on MT4 give\n``not_supported_on_mt4``.", "operationId": "terminal_mt4_price_history", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mt4/{account_id}/ServerTimezone": { "get": { "tags": [ "terminal", "terminal-mt4" ], "summary": "GET /mt4/{account_id}/ServerTimezone", "description": "Broker server time and its offset from UTC: ``utc = serverTime -\nutcOffsetSeconds``. ``utcOffsetSource`` says where the offset came from\n(``terminal`` or ``estimated`` from a live broker clock). If neither is\npossible the answer is 503 ``broker_offset_unknown``, never a guess.", "operationId": "terminal_mt4_server_timezone", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mt4/{account_id}/SymbolInfo": { "get": { "tags": [ "terminal", "terminal-mt4" ], "summary": "GET /mt4/{account_id}/SymbolInfo", "description": "Contract specification for ``symbol``: digits, point, spread, contract\nsize, tick size/value, volume limits, trade mode, swaps, currencies, plus\nthe current bid/ask.", "operationId": "terminal_mt4_symbol_info", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mt4/{account_id}/getQuote": { "get": { "tags": [ "terminal", "terminal-mt4" ], "summary": "GET /mt4/{account_id}/getQuote", "description": "Latest tick for ``symbol``: bid, ask, last, volume and broker time.", "operationId": "terminal_mt4_get_quote", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mt4/{account_id}/healthz": { "get": { "tags": [ "terminal", "terminal-mt4" ], "summary": "GET /mt4/{account_id}/healthz", "description": "Readiness check: 200 once the terminal is ``ready``, otherwise 503. The\nbody holds no personal data: ``{status, terminal, broker, account}``.", "operationId": "terminal_mt4_healthz", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mt4/{account_id}/livez": { "get": { "tags": [ "terminal", "terminal-mt4" ], "summary": "GET /mt4/{account_id}/livez", "description": "Liveness check: 200 while the terminal answers (whatever the broker\nlink), otherwise 503.", "operationId": "terminal_mt4_livez", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mt4/{account_id}/status": { "get": { "tags": [ "terminal", "terminal-mt4" ], "summary": "GET /mt4/{account_id}/status", "description": "Connection health in one call, always HTTP 200: ``ready`` (connected,\nlogged in, ticks live), ``starting`` (not ready yet since the terminal\nstarted, within 5 minutes), ``degraded`` (broker link down or quotes frozen)\nor ``down`` (terminal not answering). ``tickwire`` carries our full ladder\n(healthy/stale/disconnected/down) with reasons and ages.", "operationId": "terminal_mt4_status", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mt4/{account_id}/symbols": { "get": { "tags": [ "terminal", "terminal-mt4" ], "summary": "GET /mt4/{account_id}/symbols", "description": "Names of all symbols available on this terminal. Use them verbatim:\nbrokers suffix symbols (EURUSD.sd, XAUUSDm).", "operationId": "terminal_mt4_symbols", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mt5/{account_id}/AccountInfo": { "get": { "tags": [ "terminal", "terminal-mt5" ], "summary": "GET /mt5/{account_id}/AccountInfo", "description": "Static account identity and configuration: name, login, server, company,\ncurrency, leverage, type, margin mode (Netting/Hedging/Exchange; always\nHedging on MT4), stop-out configuration and trade permissions.", "operationId": "terminal_mt5_account_info", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mt5/{account_id}/AccountSummary": { "get": { "tags": [ "terminal", "terminal-mt5" ], "summary": "GET /mt5/{account_id}/AccountSummary", "description": "Live financial snapshot: balance, credit, floating profit, equity, margin,\nfree margin, margin level, leverage, currency and account type\n(Demo/Contest/Real; ``Unknown`` if the terminal does not say).", "operationId": "terminal_mt5_account_summary", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mt5/{account_id}/CloseAll": { "post": { "tags": [ "terminal", "terminal-mt5" ], "summary": "POST /mt5/{account_id}/CloseAll", "description": "Close every open position, optionally only ``symbol`` and/or ``magic``\n(``magic: 0`` means manually opened), and with ``deletePending: true`` also\ndelete matching pending orders. Each ticket is its own audited, idempotent\nclose (``Idempotency-Key`` + ``#ticket``); the whole reply is replayed for\nthe same key. ``closed`` counts tickets now closed (including ones already\ngone), ``failed`` rejections, ``unknown`` lost replies.", "operationId": "terminal_mt5_close_all", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mt5/{account_id}/OpenedOrders": { "get": { "tags": [ "terminal", "terminal-mt5" ], "summary": "GET /mt5/{account_id}/OpenedOrders", "description": "All open positions (``kind: position``) and pending orders\n(``kind: pending``). Pending rows show their trigger price in ``openPrice``,\nthe current market price on their side in ``currentPrice``, and zero\nswap/profit.", "operationId": "terminal_mt5_opened_orders", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mt5/{account_id}/OrderCalcMargin": { "get": { "tags": [ "terminal", "terminal-mt5" ], "summary": "GET /mt5/{account_id}/OrderCalcMargin", "description": "Margin (account currency) needed to open ``volume`` lots of ``operation``\non ``symbol`` at ``price``. Places nothing.", "operationId": "terminal_mt5_order_calc_margin", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mt5/{account_id}/OrderCalcProfit": { "get": { "tags": [ "terminal", "terminal-mt5" ], "summary": "GET /mt5/{account_id}/OrderCalcProfit", "description": "Projected P/L (account currency) of ``volume`` lots from ``priceOpen`` to\n``priceClose``; pending operations count by direction only. Places nothing.", "operationId": "terminal_mt5_order_calc_profit", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mt5/{account_id}/OrderClose": { "post": { "tags": [ "terminal", "terminal-mt5" ], "summary": "POST /mt5/{account_id}/OrderClose", "description": "Close a position (``volume`` for a partial close; omitted or 0 closes it\nall) or delete a pending order: the ticket type decides. ``slippage`` in\npoints (default 10). Closing a ticket that is already gone is\n``outcome: no_change`` with ``isEffective: true`` and nothing sent, so a\nretried close is safe.", "operationId": "terminal_mt5_order_close", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mt5/{account_id}/OrderHistory": { "get": { "tags": [ "terminal", "terminal-mt5" ], "summary": "GET /mt5/{account_id}/OrderHistory", "description": "Closed deals (executions, not orders) in ``[from, to]``, broker server\ntime, ISO-8601 or YYYY-MM-DD; absent bounds mean all time. Each row carries\n``entry`` (In/Out/InOut/OutBy) and ``position`` (the round trip it belongs to).", "operationId": "terminal_mt5_order_history", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mt5/{account_id}/OrderModify": { "post": { "tags": [ "terminal", "terminal-mt5" ], "summary": "POST /mt5/{account_id}/OrderModify", "description": "Modify a position (``stopLoss``/``takeProfit`` only) or a pending order\n(also ``price``, ``stopLimitPrice``, ``expiration``). Omitted fields keep\ntheir current value; ``0`` clears a stop. An unknown ticket is a\n``rejected`` result with retcode 0 and nothing is sent.", "operationId": "terminal_mt5_order_modify", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mt5/{account_id}/OrderSend": { "post": { "tags": [ "terminal", "terminal-mt5" ], "summary": "POST /mt5/{account_id}/OrderSend", "description": "Submit a market (Buy/Sell) or pending (*Limit/*Stop/*StopLimit) order.\n\nBody: ``symbol``*, ``operation``* (case/separator-insensitive), ``volume``*,\n``price`` (pending), ``stopLimitPrice`` (*StopLimit), ``stopLoss``,\n``takeProfit``, ``slippage`` (points, default 10), ``expiration`` (pending;\nabsent = good till cancelled), ``comment``, ``expertId`` (magic). Unknown\nfields are refused; an unknown symbol is never sent (HTTP 500, reason\n``symbol_not_found``). A 200 only\nmeans the terminal answered: read ``success``\nand ``outcome``. Stop-limit orders on MT4 give ``not_supported_on_mt4``.", "operationId": "terminal_mt5_order_send", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mt5/{account_id}/PositionHistory": { "get": { "tags": [ "terminal", "terminal-mt5" ], "summary": "GET /mt5/{account_id}/PositionHistory", "description": "Closed positions closed within ``[from, to]``: one row per round trip with\nvolume-weighted open/close prices, summed profit/swap/commission and\n``netProfit``. A position still partly open is not listed.", "operationId": "terminal_mt5_position_history", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mt5/{account_id}/PriceHistory": { "get": { "tags": [ "terminal", "terminal-mt5" ], "summary": "GET /mt5/{account_id}/PriceHistory", "description": "OHLC bars for ``symbol`` and ``timeframe`` (M1, M5, M15, M30, H1, H4, D1,\nW1, MN1 or 5min/1h/1d) in ``[from, to]`` (broker time). Without ``from`` the\nmost recent 50 000 bars are searched. MT5-only timeframes on MT4 give\n``not_supported_on_mt4``.", "operationId": "terminal_mt5_price_history", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mt5/{account_id}/ServerTimezone": { "get": { "tags": [ "terminal", "terminal-mt5" ], "summary": "GET /mt5/{account_id}/ServerTimezone", "description": "Broker server time and its offset from UTC: ``utc = serverTime -\nutcOffsetSeconds``. ``utcOffsetSource`` says where the offset came from\n(``terminal`` or ``estimated`` from a live broker clock). If neither is\npossible the answer is 503 ``broker_offset_unknown``, never a guess.", "operationId": "terminal_mt5_server_timezone", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mt5/{account_id}/SymbolInfo": { "get": { "tags": [ "terminal", "terminal-mt5" ], "summary": "GET /mt5/{account_id}/SymbolInfo", "description": "Contract specification for ``symbol``: digits, point, spread, contract\nsize, tick size/value, volume limits, trade mode, swaps, currencies, plus\nthe current bid/ask.", "operationId": "terminal_mt5_symbol_info", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mt5/{account_id}/getQuote": { "get": { "tags": [ "terminal", "terminal-mt5" ], "summary": "GET /mt5/{account_id}/getQuote", "description": "Latest tick for ``symbol``: bid, ask, last, volume and broker time.", "operationId": "terminal_mt5_get_quote", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mt5/{account_id}/healthz": { "get": { "tags": [ "terminal", "terminal-mt5" ], "summary": "GET /mt5/{account_id}/healthz", "description": "Readiness check: 200 once the terminal is ``ready``, otherwise 503. The\nbody holds no personal data: ``{status, terminal, broker, account}``.", "operationId": "terminal_mt5_healthz", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mt5/{account_id}/livez": { "get": { "tags": [ "terminal", "terminal-mt5" ], "summary": "GET /mt5/{account_id}/livez", "description": "Liveness check: 200 while the terminal answers (whatever the broker\nlink), otherwise 503.", "operationId": "terminal_mt5_livez", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mt5/{account_id}/status": { "get": { "tags": [ "terminal", "terminal-mt5" ], "summary": "GET /mt5/{account_id}/status", "description": "Connection health in one call, always HTTP 200: ``ready`` (connected,\nlogged in, ticks live), ``starting`` (not ready yet since the terminal\nstarted, within 5 minutes), ``degraded`` (broker link down or quotes frozen)\nor ``down`` (terminal not answering). ``tickwire`` carries our full ladder\n(healthy/stale/disconnected/down) with reasons and ages.", "operationId": "terminal_mt5_status", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mt5/{account_id}/symbols": { "get": { "tags": [ "terminal", "terminal-mt5" ], "summary": "GET /mt5/{account_id}/symbols", "description": "Names of all symbols available on this terminal. Use them verbatim:\nbrokers suffix symbols (EURUSD.sd, XAUUSDm).", "operationId": "terminal_mt5_symbols", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/oauth/authorize": { "get": { "tags": [ "ai-apps-oauth" ], "summary": "Authorize", "description": "Validate the request, then send the browser to the consent page.", "operationId": "authorize_oauth_authorize_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/oauth/consent/decide": { "post": { "tags": [ "ai-apps-oauth" ], "summary": "Consent Decide", "description": "Approve or deny; answers where to send the browser next.", "operationId": "consent_decide_oauth_consent_decide_post", "parameters": [ { "name": "X-Reason", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Reason" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Tickwire-CSRF", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Tickwire-Csrf" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/oauth/consent/view": { "post": { "tags": [ "ai-apps-oauth" ], "summary": "Consent View", "description": "What the consent page shows, plus a consent token bound to this session.", "operationId": "consent_view_oauth_consent_view_post", "parameters": [ { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-Tickwire-CSRF", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Tickwire-Csrf" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/oauth/register": { "post": { "tags": [ "ai-apps-oauth" ], "summary": "Register", "description": "RFC 7591 Dynamic Client Registration.", "operationId": "register_oauth_register_post", "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/oauth/revoke": { "post": { "tags": [ "ai-apps-oauth" ], "summary": "Revoke", "description": "RFC 7009 token revocation.", "operationId": "revoke_oauth_revoke_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/oauth/token": { "post": { "tags": [ "ai-apps-oauth" ], "summary": "Token", "description": "Exchange an authorization code or a refresh token for tokens. Never\nretry a refresh token that was refused: start a new sign-in instead.", "operationId": "token_oauth_token_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/users/current/accounts": { "get": { "tags": [ "provisioning" ], "summary": "List Accounts", "operationId": "list_accounts_users_current_accounts_get", "parameters": [ { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 1000, "minimum": 1, "default": 1000, "title": "Limit" } }, { "name": "version", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "null" } ], "title": "Version" } }, { "name": "type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type" } }, { "name": "state", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "State" } }, { "name": "connectionStatus", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Connectionstatus" } }, { "name": "deploymentStatus", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "deployed", "undeployed", "failed" ], "type": "string" }, { "type": "null" } ], "title": "Deploymentstatus" } }, { "name": "query", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Query" } }, { "name": "provisioningProfileId", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provisioningprofileid" } }, { "name": "region", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Region" } }, { "name": "tags", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Tags" } }, { "name": "sortOrder", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "asc", "desc" ], "type": "string" }, { "type": "null" } ], "title": "Sortorder" } }, { "name": "api-version", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api-Version" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "provisioning" ], "summary": "Create Account", "operationId": "create_account_users_current_accounts_post", "parameters": [ { "name": "transaction-id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Transaction-Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional; replays the first answer", "title": "Idempotency-Key" }, "description": "Optional; replays the first answer" }, { "name": "X-Actor", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Who is acting (audit log)", "title": "X-Actor" }, "description": "Who is acting (audit log)" }, { "name": "X-Reason", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Why (audit log; percent-encode non-ASCII)", "title": "X-Reason" }, "description": "Why (audit log; percent-encode non-ASCII)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewTradingAccount" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users/current/accounts/{account_id}": { "get": { "tags": [ "provisioning" ], "summary": "Get Account", "operationId": "get_account_users_current_accounts__account_id__get", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "provisioning" ], "summary": "Update Account", "operationId": "update_account_users_current_accounts__account_id__put", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional; replays the first answer", "title": "Idempotency-Key" }, "description": "Optional; replays the first answer" }, { "name": "X-Actor", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Who is acting (audit log)", "title": "X-Actor" }, "description": "Who is acting (audit log)" }, { "name": "X-Reason", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Why (audit log; percent-encode non-ASCII)", "title": "X-Reason" }, "description": "Why (audit log; percent-encode non-ASCII)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTradingAccount" } } } }, "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "provisioning" ], "summary": "Delete Account", "operationId": "delete_account_users_current_accounts__account_id__delete", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "executeForAllReplicas", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Executeforallreplicas" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional; replays the first answer", "title": "Idempotency-Key" }, "description": "Optional; replays the first answer" }, { "name": "X-Actor", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Who is acting (audit log)", "title": "X-Actor" }, "description": "Who is acting (audit log)" }, { "name": "X-Reason", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Why (audit log; percent-encode non-ASCII)", "title": "X-Reason" }, "description": "Why (audit log; percent-encode non-ASCII)" } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users/current/accounts/{account_id}/account-information": { "get": { "tags": [ "account" ], "summary": "Account Information", "operationId": "account_information_users_current_accounts__account_id__account_information_get", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "refreshTerminalState", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Refreshterminalstate" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users/current/accounts/{account_id}/audit": { "get": { "tags": [ "tickwire extras" ], "summary": "Account Audit", "operationId": "account_audit_users_current_accounts__account_id__audit_get", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 1000, "minimum": 1, "default": 100, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users/current/accounts/{account_id}/calculate-margin": { "post": { "tags": [ "trading" ], "summary": "Calculate Margin", "description": "Margin for an order: ``{margin}``, or ``{}`` if not calculable.", "operationId": "calculate_margin_users_current_accounts__account_id__calculate_margin_post", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users/current/accounts/{account_id}/capabilities": { "get": { "tags": [ "account" ], "summary": "Capabilities", "operationId": "capabilities_users_current_accounts__account_id__capabilities_get", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users/current/accounts/{account_id}/credentials": { "put": { "tags": [ "provisioning" ], "summary": "Set Credentials", "operationId": "set_credentials_users_current_accounts__account_id__credentials_put", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional; replays the first answer", "title": "Idempotency-Key" }, "description": "Optional; replays the first answer" }, { "name": "X-Actor", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Who is acting (audit log)", "title": "X-Actor" }, "description": "Who is acting (audit log)" }, { "name": "X-Reason", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Why (audit log; percent-encode non-ASCII)", "title": "X-Reason" }, "description": "Why (audit log; percent-encode non-ASCII)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Credentials" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users/current/accounts/{account_id}/deploy": { "post": { "tags": [ "provisioning" ], "summary": "Deploy", "operationId": "deploy_users_current_accounts__account_id__deploy_post", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "executeForAllReplicas", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Executeforallreplicas" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional; replays the first answer", "title": "Idempotency-Key" }, "description": "Optional; replays the first answer" }, { "name": "X-Actor", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Who is acting (audit log)", "title": "X-Actor" }, "description": "Who is acting (audit log)" }, { "name": "X-Reason", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Why (audit log; percent-encode non-ASCII)", "title": "X-Reason" }, "description": "Why (audit log; percent-encode non-ASCII)" } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users/current/accounts/{account_id}/enable-account-features": { "post": { "tags": [ "provisioning" ], "summary": "Enable Account Features", "operationId": "enable_account_features_users_current_accounts__account_id__enable_account_features_post", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional; replays the first answer", "title": "Idempotency-Key" }, "description": "Optional; replays the first answer" }, { "name": "X-Actor", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Who is acting (audit log)", "title": "X-Actor" }, "description": "Who is acting (audit log)" }, { "name": "X-Reason", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Why (audit log; percent-encode non-ASCII)", "title": "X-Reason" }, "description": "Why (audit log; percent-encode non-ASCII)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountFeatures" } } } }, "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users/current/accounts/{account_id}/enable-copy-factory-api": { "post": { "tags": [ "provisioning" ], "summary": "Enable the copy trading API", "operationId": "enable_copy_trading_users_current_accounts__account_id__enable_copy_trading_api_post", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional; replays the first answer", "title": "Idempotency-Key" }, "description": "Optional; replays the first answer" }, { "name": "X-Actor", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Who is acting (audit log)", "title": "X-Actor" }, "description": "Who is acting (audit log)" }, { "name": "X-Reason", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Why (audit log; percent-encode non-ASCII)", "title": "X-Reason" }, "description": "Why (audit log; percent-encode non-ASCII)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CopyTradingEnable" } } } }, "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users/current/accounts/{account_id}/enable-metastats-api": { "post": { "tags": [ "provisioning" ], "summary": "Enable the trading statistics API", "operationId": "enable_trading_stats_users_current_accounts__account_id__enable_trading_stats_api_post", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional; replays the first answer", "title": "Idempotency-Key" }, "description": "Optional; replays the first answer" }, { "name": "X-Actor", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Who is acting (audit log)", "title": "X-Actor" }, "description": "Who is acting (audit log)" }, { "name": "X-Reason", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Why (audit log; percent-encode non-ASCII)", "title": "X-Reason" }, "description": "Why (audit log; percent-encode non-ASCII)" } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users/current/accounts/{account_id}/enable-risk-management-api": { "post": { "tags": [ "provisioning" ], "summary": "Enable Risk Management", "operationId": "enable_risk_management_users_current_accounts__account_id__enable_risk_management_api_post", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional; replays the first answer", "title": "Idempotency-Key" }, "description": "Optional; replays the first answer" }, { "name": "X-Actor", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Who is acting (audit log)", "title": "X-Actor" }, "description": "Who is acting (audit log)" }, { "name": "X-Reason", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Why (audit log; percent-encode non-ASCII)", "title": "X-Reason" }, "description": "Why (audit log; percent-encode non-ASCII)" } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users/current/accounts/{account_id}/health": { "get": { "tags": [ "tickwire extras" ], "summary": "Account Health", "operationId": "account_health_users_current_accounts__account_id__health_get", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users/current/accounts/{account_id}/historical-market-data/symbols/{symbol}/ticks": { "get": { "tags": [ "market-data" ], "summary": "Historical Ticks", "operationId": "historical_ticks_users_current_accounts__account_id__historical_market_data_symbols__symbol__ticks_get", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "symbol", "in": "path", "required": true, "schema": { "type": "string", "title": "Symbol" } }, { "name": "startTime", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Starttime" } }, { "name": "offset", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Offset" } }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users/current/accounts/{account_id}/historical-market-data/symbols/{symbol}/timeframes/{timeframe}/candles": { "get": { "tags": [ "market-data" ], "summary": "Historical Candles", "operationId": "historical_candles_users_current_accounts__account_id__historical_market_data_symbols__symbol__timeframes__timeframe__candles_get", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "symbol", "in": "path", "required": true, "schema": { "type": "string", "title": "Symbol" } }, { "name": "timeframe", "in": "path", "required": true, "schema": { "type": "string", "title": "Timeframe" } }, { "name": "startTime", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Starttime" } }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users/current/accounts/{account_id}/history-deals/position/{position_id}": { "get": { "tags": [ "history" ], "summary": "History Deals By Position", "operationId": "history_deals_by_position_users_current_accounts__account_id__history_deals_position__position_id__get", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "position_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Position Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users/current/accounts/{account_id}/history-deals/ticket/{ticket}": { "get": { "tags": [ "history" ], "summary": "History Deals By Ticket", "operationId": "history_deals_by_ticket_users_current_accounts__account_id__history_deals_ticket__ticket__get", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "ticket", "in": "path", "required": true, "schema": { "type": "string", "title": "Ticket" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users/current/accounts/{account_id}/history-deals/time/{start_time}/{end_time}": { "get": { "tags": [ "history" ], "summary": "History Deals By Time", "operationId": "history_deals_by_time_users_current_accounts__account_id__history_deals_time__start_time___end_time__get", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "start_time", "in": "path", "required": true, "schema": { "type": "string", "title": "Start Time" } }, { "name": "end_time", "in": "path", "required": true, "schema": { "type": "string", "title": "End Time" } }, { "name": "offset", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Offset" } }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users/current/accounts/{account_id}/history-orders/position/{position_id}": { "get": { "tags": [ "history" ], "summary": "History Orders By Position", "operationId": "history_orders_by_position_users_current_accounts__account_id__history_orders_position__position_id__get", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "position_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Position Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users/current/accounts/{account_id}/history-orders/ticket/{ticket}": { "get": { "tags": [ "history" ], "summary": "History Orders By Ticket", "operationId": "history_orders_by_ticket_users_current_accounts__account_id__history_orders_ticket__ticket__get", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "ticket", "in": "path", "required": true, "schema": { "type": "string", "title": "Ticket" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users/current/accounts/{account_id}/history-orders/time/{start_time}/{end_time}": { "get": { "tags": [ "history" ], "summary": "History Orders By Time", "operationId": "history_orders_by_time_users_current_accounts__account_id__history_orders_time__start_time___end_time__get", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "start_time", "in": "path", "required": true, "schema": { "type": "string", "title": "Start Time" } }, { "name": "end_time", "in": "path", "required": true, "schema": { "type": "string", "title": "End Time" } }, { "name": "offset", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Offset" } }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users/current/accounts/{account_id}/increase-reliability": { "post": { "tags": [ "provisioning" ], "summary": "Increase Reliability", "operationId": "increase_reliability_users_current_accounts__account_id__increase_reliability_post", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional; replays the first answer", "title": "Idempotency-Key" }, "description": "Optional; replays the first answer" }, { "name": "X-Actor", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Who is acting (audit log)", "title": "X-Actor" }, "description": "Who is acting (audit log)" }, { "name": "X-Reason", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Why (audit log; percent-encode non-ASCII)", "title": "X-Reason" }, "description": "Why (audit log; percent-encode non-ASCII)" } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users/current/accounts/{account_id}/orders": { "get": { "tags": [ "account" ], "summary": "Orders", "operationId": "orders_users_current_accounts__account_id__orders_get", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "refreshTerminalState", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Refreshterminalstate" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users/current/accounts/{account_id}/orders/{order_id}": { "get": { "tags": [ "account" ], "summary": "Order", "operationId": "order_users_current_accounts__account_id__orders__order_id__get", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "order_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Order Id" } }, { "name": "refreshTerminalState", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Refreshterminalstate" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users/current/accounts/{account_id}/positions": { "get": { "tags": [ "account" ], "summary": "Positions", "operationId": "positions_users_current_accounts__account_id__positions_get", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "refreshTerminalState", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Refreshterminalstate" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users/current/accounts/{account_id}/positions/{position_id}": { "get": { "tags": [ "account" ], "summary": "Position", "operationId": "position_users_current_accounts__account_id__positions__position_id__get", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "position_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Position Id" } }, { "name": "refreshTerminalState", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Refreshterminalstate" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users/current/accounts/{account_id}/redeploy": { "post": { "tags": [ "provisioning" ], "summary": "Redeploy", "operationId": "redeploy_users_current_accounts__account_id__redeploy_post", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "executeForAllReplicas", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Executeforallreplicas" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional; replays the first answer", "title": "Idempotency-Key" }, "description": "Optional; replays the first answer" }, { "name": "X-Actor", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Who is acting (audit log)", "title": "X-Actor" }, "description": "Who is acting (audit log)" }, { "name": "X-Reason", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Why (audit log; percent-encode non-ASCII)", "title": "X-Reason" }, "description": "Why (audit log; percent-encode non-ASCII)" } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users/current/accounts/{account_id}/server-time": { "get": { "tags": [ "account" ], "summary": "Server Time", "operationId": "server_time_users_current_accounts__account_id__server_time_get", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "refresh", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Refresh" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users/current/accounts/{account_id}/snapshot": { "get": { "tags": [ "tickwire extras" ], "summary": "Account Snapshot", "description": "Account information, positions, orders, health and server time in one\nread (MT4 and MT5). Agents reach it as ``GET /v1/agent/accounts/{id}/snapshot``.\n\nBody: ``{account_id, platform, as_of, complete, terminal_connected,\naccount_information, positions, orders, health, server_time}``. ``as_of`` is\nwhen the snapshot was complete (UTC); ``complete`` is true when every section\nis ``ok``; ``terminal_connected`` is ``null`` when it is not known.\n\nEach section is ``{status, read_at, age_ms, data, error?}``. ``status`` is\n``ok`` (read from a terminal connected to its broker), ``stale`` (read, but\nthe terminal was not connected, so values may be out of date) or\n``unavailable`` (``data`` is ``null`` and ``error`` is ``{error, message}``);\n``health`` and ``server_time`` are ``ok`` whenever they could be read.\nSections are read one after another: compare ``read_at`` when that matters.\n``data`` has the same shape as the individual routes; ``server_time`` gives\n``brokerUtcOffsetMinutes`` (``null`` until known, never assumed to be 0).\n\nAlways 200 (an unreadable section says so); 503 only if nothing could be read.", "operationId": "account_snapshot_users_current_accounts__account_id__snapshot_get", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users/current/accounts/{account_id}/symbols": { "get": { "tags": [ "market-data" ], "summary": "Symbols", "operationId": "symbols_users_current_accounts__account_id__symbols_get", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users/current/accounts/{account_id}/symbols/{symbol}/current-book": { "get": { "tags": [ "market-data" ], "summary": "Current Book", "operationId": "current_book_users_current_accounts__account_id__symbols__symbol__current_book_get", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "symbol", "in": "path", "required": true, "schema": { "type": "string", "title": "Symbol" } }, { "name": "keepSubscription", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Keepsubscription" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users/current/accounts/{account_id}/symbols/{symbol}/current-candles/{timeframe}": { "get": { "tags": [ "market-data" ], "summary": "Current Candle", "operationId": "current_candle_users_current_accounts__account_id__symbols__symbol__current_candles__timeframe__get", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "symbol", "in": "path", "required": true, "schema": { "type": "string", "title": "Symbol" } }, { "name": "timeframe", "in": "path", "required": true, "schema": { "type": "string", "title": "Timeframe" } }, { "name": "keepSubscription", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Keepsubscription" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users/current/accounts/{account_id}/symbols/{symbol}/current-price": { "get": { "tags": [ "market-data" ], "summary": "Current Price", "operationId": "current_price_users_current_accounts__account_id__symbols__symbol__current_price_get", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "symbol", "in": "path", "required": true, "schema": { "type": "string", "title": "Symbol" } }, { "name": "keepSubscription", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Keepsubscription" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users/current/accounts/{account_id}/symbols/{symbol}/current-tick": { "get": { "tags": [ "market-data" ], "summary": "Current Tick", "operationId": "current_tick_users_current_accounts__account_id__symbols__symbol__current_tick_get", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "symbol", "in": "path", "required": true, "schema": { "type": "string", "title": "Symbol" } }, { "name": "keepSubscription", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Keepsubscription" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users/current/accounts/{account_id}/symbols/{symbol}/specification": { "get": { "tags": [ "market-data" ], "summary": "Specification", "operationId": "specification_users_current_accounts__account_id__symbols__symbol__specification_get", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "symbol", "in": "path", "required": true, "schema": { "type": "string", "title": "Symbol" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users/current/accounts/{account_id}/symbols/{symbol}/unsubscribe": { "post": { "tags": [ "market-data" ], "summary": "Unsubscribe", "operationId": "unsubscribe_users_current_accounts__account_id__symbols__symbol__unsubscribe_post", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "symbol", "in": "path", "required": true, "schema": { "type": "string", "title": "Symbol" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users/current/accounts/{account_id}/trade": { "post": { "tags": [ "trading" ], "summary": "Trade", "description": "Execute a trade (MT4 and MT5).\n\nBody: a ``MetatraderTrade``. ``actionType`` is one of ``ORDER_TYPE_BUY|SELL``,\n``ORDER_TYPE_BUY_LIMIT|SELL_LIMIT|BUY_STOP|SELL_STOP``,\n``ORDER_TYPE_BUY_STOP_LIMIT|SELL_STOP_LIMIT`` (MT5 only), ``POSITION_MODIFY``,\n``POSITION_PARTIAL``, ``POSITION_CLOSE_ID``, ``POSITION_CLOSE_BY``,\n``POSITIONS_CLOSE_SYMBOL``, ``ORDER_MODIFY`` or ``ORDER_CANCEL``. Relative\nSL/TP units, ``fillingModes``, ``expiration``, ``slippage``, ``magic``,\n``comment`` + ``clientId`` (30 characters together) and ``trailingStopLoss``\nare supported.\n\n**HTTP 200 even when the broker rejects the trade**:\n``{numericCode, stringCode, message, orderId?, positionId?}``. Success codes\nare 0, 10008, 10009, 10010 and 10025. Tickwire adds ``outcome``\n(``applied|no_change|partial|rejected|unknown``), ``isEffective``,\n``retcode`` (the terminal's own code), ``replayed`` and, for\n``POSITIONS_CLOSE_SYMBOL``, a per-position ``positions`` list.\n``outcome=unknown`` means the order may have executed: check positions and\norders before retrying. Tickwire never resends new exposure on its own.\n\nIdempotency: the ``Idempotency-Key`` header, else ``clientId``. A replay\nreturns the stored result with ``replayed: true``; the same key with a\ndifferent body is 409 ``ConflictError``. ``X-Actor`` and ``X-Reason`` go\nto the audit trail. A malformed request is 400 ``ValidationError`` with\n``details: [{parameter, message}]``; what MT4 can't do (stop-limit, DAY\nexpiry) answers ``numericCode`` -4 with ``error: not_supported_on_mt4``.", "operationId": "trade_users_current_accounts__account_id__trade_post", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } }, { "name": "X-Actor", "in": "header", "required": false, "schema": { "type": "string", "default": "unknown", "title": "X-Actor" } }, { "name": "X-Reason", "in": "header", "required": false, "schema": { "type": "string", "default": "", "title": "X-Reason" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users/current/accounts/{account_id}/trade/check": { "post": { "tags": [ "trading" ], "summary": "Trade Check", "description": "Dry-run a trade: the same body as ``/trade``. Runs every pre-flight\ncheck (and, on MT5, the terminal's own order check) and returns the\nresolved request plus margin figures. Nothing is sent.", "operationId": "trade_check_users_current_accounts__account_id__trade_check_post", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users/current/accounts/{account_id}/trailing-stop-losses": { "get": { "tags": [ "trading" ], "summary": "List Trailing", "description": "Trailing stop rules Tickwire runs for this account (``state``:\n``active`` | ``pending``; ``pending`` waits for its pending order to fill).", "operationId": "list_trailing_users_current_accounts__account_id__trailing_stop_losses_get", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users/current/accounts/{account_id}/trailing-stop-losses/{position_id}": { "delete": { "tags": [ "trading" ], "summary": "Delete Trailing", "description": "Stop trailing a position (the current SL stays where it is).", "operationId": "delete_trailing_users_current_accounts__account_id__trailing_stop_losses__position_id__delete", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "position_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Position Id" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } }, { "name": "X-Actor", "in": "header", "required": false, "schema": { "type": "string", "default": "unknown", "title": "X-Actor" } }, { "name": "X-Reason", "in": "header", "required": false, "schema": { "type": "string", "default": "", "title": "X-Reason" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users/current/accounts/{account_id}/undeploy": { "post": { "tags": [ "provisioning" ], "summary": "Undeploy", "operationId": "undeploy_users_current_accounts__account_id__undeploy_post", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "executeForAllReplicas", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Executeforallreplicas" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional; replays the first answer", "title": "Idempotency-Key" }, "description": "Optional; replays the first answer" }, { "name": "X-Actor", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Who is acting (audit log)", "title": "X-Actor" }, "description": "Who is acting (audit log)" }, { "name": "X-Reason", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Why (audit log; percent-encode non-ASCII)", "title": "X-Reason" }, "description": "Why (audit log; percent-encode non-ASCII)" } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users/current/narrow-down-auth-token": { "post": { "tags": [ "tokens" ], "summary": "Narrow Down", "operationId": "narrow_down_users_current_narrow_down_auth_token_post", "parameters": [ { "name": "validity-in-hours", "in": "query", "required": false, "schema": { "type": "number", "exclusiveMinimum": 0, "default": 24, "title": "Validity-In-Hours" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional; replays the first answer", "title": "Idempotency-Key" }, "description": "Optional; replays the first answer" }, { "name": "X-Actor", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Who is acting (audit log)", "title": "X-Actor" }, "description": "Who is acting (audit log)" }, { "name": "X-Reason", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Why (audit log; percent-encode non-ASCII)", "title": "X-Reason" }, "description": "Why (audit log; percent-encode non-ASCII)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users/current/provisioning-profiles": { "get": { "tags": [ "provisioning" ], "summary": "List Profiles", "operationId": "list_profiles_users_current_provisioning_profiles_get", "parameters": [ { "name": "version", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Version" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "new", "active" ], "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "type", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "mtTerminal", "managerApi" ], "type": "string" }, { "type": "null" } ], "title": "Type" } }, { "name": "query", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Query" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 1000, "minimum": 1, "default": 1000, "title": "Limit" } }, { "name": "api-version", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api-Version" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "provisioning" ], "summary": "Create Profile", "operationId": "create_profile_users_current_provisioning_profiles_post", "parameters": [ { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional; replays the first answer", "title": "Idempotency-Key" }, "description": "Optional; replays the first answer" }, { "name": "X-Actor", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Who is acting (audit log)", "title": "X-Actor" }, "description": "Who is acting (audit log)" }, { "name": "X-Reason", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Why (audit log; percent-encode non-ASCII)", "title": "X-Reason" }, "description": "Why (audit log; percent-encode non-ASCII)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewProfile" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users/current/provisioning-profiles/{profile_id}": { "get": { "tags": [ "provisioning" ], "summary": "Get Profile", "operationId": "get_profile_users_current_provisioning_profiles__profile_id__get", "parameters": [ { "name": "profile_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Profile Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "provisioning" ], "summary": "Update Profile", "operationId": "update_profile_users_current_provisioning_profiles__profile_id__put", "parameters": [ { "name": "profile_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Profile Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional; replays the first answer", "title": "Idempotency-Key" }, "description": "Optional; replays the first answer" }, { "name": "X-Actor", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Who is acting (audit log)", "title": "X-Actor" }, "description": "Who is acting (audit log)" }, { "name": "X-Reason", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Why (audit log; percent-encode non-ASCII)", "title": "X-Reason" }, "description": "Why (audit log; percent-encode non-ASCII)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateProfile" } } } }, "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "provisioning" ], "summary": "Delete Profile", "operationId": "delete_profile_users_current_provisioning_profiles__profile_id__delete", "parameters": [ { "name": "profile_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Profile Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional; replays the first answer", "title": "Idempotency-Key" }, "description": "Optional; replays the first answer" }, { "name": "X-Actor", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Who is acting (audit log)", "title": "X-Actor" }, "description": "Who is acting (audit log)" }, { "name": "X-Reason", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Why (audit log; percent-encode non-ASCII)", "title": "X-Reason" }, "description": "Why (audit log; percent-encode non-ASCII)" } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users/current/provisioning-profiles/{profile_id}/{file_name}": { "put": { "tags": [ "provisioning" ], "summary": "Upload File", "operationId": "upload_file_users_current_provisioning_profiles__profile_id___file_name__put", "parameters": [ { "name": "profile_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Profile Id" } }, { "name": "file_name", "in": "path", "required": true, "schema": { "type": "string", "title": "File Name" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional; replays the first answer", "title": "Idempotency-Key" }, "description": "Optional; replays the first answer" }, { "name": "X-Actor", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Who is acting (audit log)", "title": "X-Actor" }, "description": "Who is acting (audit log)" }, { "name": "X-Reason", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Why (audit log; percent-encode non-ASCII)", "title": "X-Reason" }, "description": "Why (audit log; percent-encode non-ASCII)" } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users/current/regions": { "get": { "tags": [ "discovery" ], "summary": "Regions", "operationId": "regions_users_current_regions_get", "parameters": [ { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "title": "Response Regions Users Current Regions Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users/current/servers/mt-client-api": { "get": { "tags": [ "discovery" ], "summary": "Client Api Domain", "operationId": "client_api_domain_users_current_servers_mt_client_api_get", "parameters": [ { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Client Api Domain Users Current Servers Mt Client Api Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users/current/tokens": { "post": { "tags": [ "tokens" ], "summary": "Create Token", "operationId": "create_token_users_current_tokens_post", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewToken" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "tokens" ], "summary": "List Tokens", "operationId": "list_tokens_users_current_tokens_get", "parameters": [ { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users/current/tokens/{token_id}": { "get": { "tags": [ "tokens" ], "summary": "Get Token", "operationId": "get_token_users_current_tokens__token_id__get", "parameters": [ { "name": "token_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Token Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "tokens" ], "summary": "Patch Token", "operationId": "patch_token_users_current_tokens__token_id__patch", "parameters": [ { "name": "token_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Token Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchToken" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "tokens" ], "summary": "Revoke Token", "operationId": "revoke_token_users_current_tokens__token_id__delete", "parameters": [ { "name": "token_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Token Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/access-rule-manifest": { "get": { "tags": [ "tokens" ], "summary": "Access Rule Manifest", "operationId": "access_rule_manifest_access_rule_manifest_get", "parameters": [ { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts": { "get": { "summary": "List Accounts", "operationId": "list_accounts_accounts_get", "parameters": [ { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "tags": [ "accounts" ] }, "post": { "summary": "Link Account", "operationId": "link_account_accounts_post", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAccount" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "tags": [ "accounts" ] } }, "/v1/accounts/{account_id}": { "get": { "summary": "Get Account", "operationId": "get_account_accounts__account_id__get", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "tags": [ "accounts" ] }, "patch": { "summary": "Patch Account", "operationId": "patch_account_accounts__account_id__patch", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchAccount" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "tags": [ "accounts" ] }, "delete": { "summary": "Unlink Account", "operationId": "unlink_account_accounts__account_id__delete", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "tags": [ "accounts" ] } }, "/v1/agent-audit": { "get": { "tags": [ "ai-agents-admin" ], "summary": "Agent Audit", "description": "The agent audit log, newest first (by ``seq``). Cursor-paginated:\n``{entries, has_more, next_cursor}``; ``before`` (a ``seq``) still works.", "operationId": "agent_audit_v1_agent_audit_get", "parameters": [ { "name": "agent_key_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Agent Key Id" } }, { "name": "account_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Account Id" } }, { "name": "before", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ], "title": "Before" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "description": "Page size, 1..500 (default 100).", "default": 100, "title": "Limit" }, "description": "Page size, 1..500 (default 100)." }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ], "description": "The next_cursor of the previous page, unchanged.", "title": "Cursor" }, "description": "The next_cursor of the previous page, unchanged." }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/agent-keys": { "post": { "tags": [ "ai-agents-admin" ], "summary": "Create Agent Key", "description": "Create an agent key scoped to accounts. The ``key`` is shown once.\n\n``Idempotency-Key`` is honoured: a replay returns the same key record\nwithout minting another key, with ``key: null`` and a ``key_notice``\nsaying it was already shown.", "operationId": "create_agent_key_v1_agent_keys_post", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } }, { "name": "X-Actor", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Actor" } }, { "name": "X-Reason", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Reason" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Body" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "ai-agents-admin" ], "summary": "List Agent Keys", "description": "Agent keys of this tenant (never the key values), oldest first.\nCursor-paginated: ``{data, has_more, next_cursor}``.", "operationId": "list_agent_keys_v1_agent_keys_get", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "description": "Page size, 1..500 (default 100).", "default": 100, "title": "Limit" }, "description": "Page size, 1..500 (default 100)." }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ], "description": "The next_cursor of the previous page, unchanged.", "title": "Cursor" }, "description": "The next_cursor of the previous page, unchanged." }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/agent-keys/{key_id}": { "get": { "tags": [ "ai-agents-admin" ], "summary": "Get Agent Key", "description": "One agent key record.", "operationId": "get_agent_key_v1_agent_keys__key_id__get", "parameters": [ { "name": "key_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Key Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "ai-agents-admin" ], "summary": "Patch Agent Key", "description": "Rename, re-scope or flip read-only.", "operationId": "patch_agent_key_v1_agent_keys__key_id__patch", "parameters": [ { "name": "key_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Key Id" } }, { "name": "X-Actor", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Actor" } }, { "name": "X-Reason", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Reason" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "ai-agents-admin" ], "summary": "Revoke Agent Key", "description": "Revoke an agent key (irreversible).", "operationId": "revoke_agent_key_v1_agent_keys__key_id__delete", "parameters": [ { "name": "key_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Key Id" } }, { "name": "X-Actor", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Actor" } }, { "name": "X-Reason", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Reason" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/agent-keys/{key_id}/kill-switch": { "put": { "tags": [ "ai-agents-admin" ], "summary": "Set Key Kill Switch", "description": "Engage or release the kill switch of one agent key.", "operationId": "set_key_kill_switch_v1_agent_keys__key_id__kill_switch_put", "parameters": [ { "name": "key_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Key Id" } }, { "name": "X-Actor", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Actor" } }, { "name": "X-Reason", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Reason" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/agent-kill-switches": { "get": { "tags": [ "ai-agents-admin" ], "summary": "List Kill Switches", "description": "Engaged account kill switches (agent-key switches are on each key), by\naccount id. Cursor-paginated: ``{accounts, has_more, next_cursor}``.", "operationId": "list_kill_switches_v1_agent_kill_switches_get", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "description": "Page size, 1..500 (default 100).", "default": 100, "title": "Limit" }, "description": "Page size, 1..500 (default 100)." }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ], "description": "The next_cursor of the previous page, unchanged.", "title": "Cursor" }, "description": "The next_cursor of the previous page, unchanged." }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/agent-kill-switches/accounts/{account_id}": { "put": { "tags": [ "ai-agents-admin" ], "summary": "Set Account Kill Switch", "description": "Engage or release the agent kill switch of one account.", "operationId": "set_account_kill_switch_v1_agent_kill_switches_accounts__account_id__put", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "X-Actor", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Actor" } }, { "name": "X-Reason", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Reason" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/agent/accounts": { "get": { "tags": [ "ai-agents" ], "summary": "Agent Accounts", "description": "Accounts this key may use, by account id. Cursor-paginated:\n``{accounts, has_more, next_cursor}``.", "operationId": "agent_accounts_v1_agent_accounts_get", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "description": "Page size, 1..500 (default 100).", "default": 100, "title": "Limit" }, "description": "Page size, 1..500 (default 100)." }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ], "description": "The next_cursor of the previous page, unchanged.", "title": "Cursor" }, "description": "The next_cursor of the previous page, unchanged." }, { "name": "X-Tickwire-Agent-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Tickwire-Agent-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/agent/accounts/{account_id}/account-information": { "get": { "tags": [ "ai-agents" ], "summary": "Agent Account Info", "description": "Balance, equity, margin… as reported by the broker (same shape as ``/users/current/…``).", "operationId": "agent_account_info_v1_agent_accounts__account_id__account_information_get", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "X-Tickwire-Agent-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Tickwire-Agent-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/agent/accounts/{account_id}/health": { "get": { "tags": [ "ai-agents" ], "summary": "Agent Health", "description": "Truthful health with evidence (connected / disconnected / unknown).", "operationId": "agent_health_v1_agent_accounts__account_id__health_get", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "X-Tickwire-Agent-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Tickwire-Agent-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/agent/accounts/{account_id}/history-deals": { "get": { "tags": [ "ai-agents" ], "summary": "Agent Deals", "description": "Deals in a bounded window (default last 24 h, max 31 days).", "operationId": "agent_deals_v1_agent_accounts__account_id__history_deals_get", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "start_time", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Start Time" } }, { "name": "end_time", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Time" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "X-Tickwire-Agent-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Tickwire-Agent-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/agent/accounts/{account_id}/orders": { "get": { "tags": [ "ai-agents" ], "summary": "Agent Orders", "description": "Pending orders (same shape as ``/users/current/accounts/{id}/orders``).", "operationId": "agent_orders_v1_agent_accounts__account_id__orders_get", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "X-Tickwire-Agent-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Tickwire-Agent-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/agent/accounts/{account_id}/positions": { "get": { "tags": [ "ai-agents" ], "summary": "Agent Positions", "description": "Open positions (same shape as ``/users/current/accounts/{id}/positions``).", "operationId": "agent_positions_v1_agent_accounts__account_id__positions_get", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "X-Tickwire-Agent-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Tickwire-Agent-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/agent/accounts/{account_id}/snapshot": { "get": { "tags": [ "ai-agents" ], "summary": "Agent Snapshot", "description": "Account information, positions, orders, health and server time in one\nread, with ``as_of`` and per-section freshness.", "operationId": "agent_snapshot_v1_agent_accounts__account_id__snapshot_get", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "X-Tickwire-Agent-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Tickwire-Agent-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/agent/accounts/{account_id}/symbols/{symbol}/current-price": { "get": { "tags": [ "ai-agents" ], "summary": "Agent Price", "description": "Current bid/ask with broker time.", "operationId": "agent_price_v1_agent_accounts__account_id__symbols__symbol__current_price_get", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "symbol", "in": "path", "required": true, "schema": { "type": "string", "title": "Symbol" } }, { "name": "X-Tickwire-Agent-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Tickwire-Agent-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/agent/accounts/{account_id}/symbols/{symbol}/specification": { "get": { "tags": [ "ai-agents" ], "summary": "Agent Spec", "description": "Symbol specification: volume limits and step, digits, contract size…", "operationId": "agent_spec_v1_agent_accounts__account_id__symbols__symbol__specification_get", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "symbol", "in": "path", "required": true, "schema": { "type": "string", "title": "Symbol" } }, { "name": "X-Tickwire-Agent-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Tickwire-Agent-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/agent/accounts/{account_id}/trade": { "post": { "tags": [ "ai-agents" ], "summary": "Agent Trade", "description": "Place, modify, close or cancel a trade. Each trade is checked against the\nkey's limits, the pre-trade hooks and the kill switches before it is sent,\nand is recorded in the audit trail.", "operationId": "agent_trade_v1_agent_accounts__account_id__trade_post", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } }, { "name": "X-Reason", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Reason" } }, { "name": "X-Tickwire-Agent-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Tickwire-Agent-Key" } } ], "requestBody": { "content": { "application/json": { "schema": { "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/agent/audit": { "get": { "tags": [ "ai-agents" ], "summary": "Agent Own Audit", "description": "This key's own audit entries, newest first. Cursor-paginated:\n``{entries, has_more, next_cursor}``.", "operationId": "agent_own_audit_v1_agent_audit_get", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "description": "Page size, 1..500 (default 50).", "default": 50, "title": "Limit" }, "description": "Page size, 1..500 (default 50)." }, { "name": "before", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ], "title": "Before" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ], "description": "The next_cursor of the previous page, unchanged.", "title": "Cursor" }, "description": "The next_cursor of the previous page, unchanged." }, { "name": "X-Tickwire-Agent-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Tickwire-Agent-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/agent/me": { "get": { "tags": [ "ai-agents" ], "summary": "Agent Me", "description": "This key's permissions, kill switches and applicable hooks.", "operationId": "agent_me_v1_agent_me_get", "parameters": [ { "name": "X-Tickwire-Agent-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Tickwire-Agent-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/agent/requests/{idempotency_key}": { "get": { "tags": [ "ai-agents" ], "summary": "Agent Request Status", "description": "What happened to the trade sent with this idempotency key.", "operationId": "agent_request_status_v1_agent_requests__idempotency_key__get", "parameters": [ { "name": "idempotency_key", "in": "path", "required": true, "schema": { "type": "string", "title": "Idempotency Key" } }, { "name": "X-Tickwire-Agent-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Tickwire-Agent-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/api-version": { "get": { "tags": [ "api version" ], "summary": "Get Api Version", "description": "The organisation's pinned API version, the latest one and every supported one.", "operationId": "get_api_version_api_version_get", "parameters": [ { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "api version" ], "summary": "Set Api Version", "description": "Pin the organisation to ``apiVersion`` (owner or admin credential; audited).", "operationId": "set_api_version_api_version_post", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } }, { "name": "X-Actor", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Actor" } }, { "name": "X-Reason", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Reason" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PinBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/billing": { "get": { "tags": [ "billing" ], "summary": "Billing", "operationId": "billing_billing_get", "parameters": [ { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/billing/upgrade": { "post": { "tags": [ "billing" ], "summary": "Upgrade", "operationId": "upgrade_billing_upgrade_post", "parameters": [ { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional; replays the first answer", "title": "Idempotency-Key" }, "description": "Optional; replays the first answer" }, { "name": "X-Actor", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Who is acting (audit log)", "title": "X-Actor" }, "description": "Who is acting (audit log)" }, { "name": "X-Reason", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Why (audit log; percent-encode non-ASCII)", "title": "X-Reason" }, "description": "Why (audit log; percent-encode non-ASCII)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpgradeBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/billing/upgrade/quote": { "get": { "tags": [ "billing" ], "summary": "Upgrade Quote", "operationId": "upgrade_quote_billing_upgrade_quote_get", "parameters": [ { "name": "accounts", "in": "query", "required": true, "schema": { "type": "integer", "maximum": 100000, "minimum": 1, "title": "Accounts" } }, { "name": "own_address", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Own Address" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/connected-apps": { "get": { "tags": [ "ai-apps-connected" ], "summary": "List Apps", "description": "Apps connected to this tenant through Sign in with Tickwire, oldest\nfirst. Cursor-paginated: ``{apps, has_more, next_cursor}``.", "operationId": "list_apps_v1_connected_apps_get", "parameters": [ { "name": "include_ended", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Include Ended" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "description": "Page size, 1..500 (default 100).", "default": 100, "title": "Limit" }, "description": "Page size, 1..500 (default 100)." }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ], "description": "The next_cursor of the previous page, unchanged.", "title": "Cursor" }, "description": "The next_cursor of the previous page, unchanged." }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/connected-apps/{grant_id}": { "delete": { "tags": [ "ai-apps-connected" ], "summary": "Disconnect App", "description": "Disconnect: revoke the app's agent key and all of its tokens.", "operationId": "disconnect_app_v1_connected_apps__grant_id__delete", "parameters": [ { "name": "grant_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Grant Id" } }, { "name": "X-Actor", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Actor" } }, { "name": "X-Reason", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Reason" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/dedicated-ips": { "get": { "tags": [ "dedicated IPs" ], "summary": "My Dedicated Ips", "description": "Your dedicated IPs and open requests: ``{ips, open_requests}``. Each IP\ngives its ``region`` code and a readable ``region_name``. If the list can't\nbe read right now the answer is ``503 temporarily_unavailable`` with\n``Retry-After``.", "operationId": "my_dedicated_ips_dedicated_ips_get", "parameters": [ { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/dedicated-ips/move-accounts": { "post": { "tags": [ "dedicated IPs" ], "summary": "My Move Accounts", "description": "Approve moving these accounts onto your dedicated IP. Each move\n**restarts the account's terminal**, so do it when no trade is in flight.\nEach result says whether the account moved and, if not, why.", "operationId": "my_move_accounts_dedicated_ips_move_accounts_post", "parameters": [ { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } }, { "name": "X-Actor", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Actor" } }, { "name": "X-Reason", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Reason" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MoveAccounts" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/events/{event_id}/resend": { "post": { "tags": [ "webhooks" ], "summary": "Resend Event", "description": "Queue an event again to every endpoint that received it (or ``webhookId``).", "operationId": "resend_event_events__event_id__resend_post", "parameters": [ { "name": "event_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Event Id" } }, { "name": "webhookId", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Webhookid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } }, { "name": "X-Actor", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Actor" } }, { "name": "X-Reason", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Reason" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/execution/accounts/{account_id}/trade": { "post": { "tags": [ "ai-agents" ], "summary": "Guarded Trade", "description": "Trade with an ordinary API key under the same checks agent keys get:\npre-trade hooks with ``applies_to: all``, kill switches and the audit\ntrail. Same body and answers as the agent trade route.", "operationId": "guarded_trade_v1_execution_accounts__account_id__trade_post", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } }, { "name": "X-Reason", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Reason" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/known-mt-servers/{version}/search": { "get": { "tags": [ "discovery" ], "summary": "Search Servers", "operationId": "search_servers_known_mt_servers__version__search_get", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "integer", "title": "Version" } }, { "name": "query", "in": "query", "required": false, "schema": { "type": "string", "default": "", "title": "Query" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Search Servers Known Mt Servers Version Search Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/meta/whoami": { "get": { "tags": [ "meta" ], "summary": "Whoami", "operationId": "whoami_meta_whoami_get", "parameters": [ { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Whoami Meta Whoami Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orders": { "post": { "tags": [ "batch-orders" ], "summary": "Batch orders", "description": "Send one order to several accounts at once (at most 20 legs).\n\nEvery leg inherits ``defaults`` and may override any of it, including with a\nfalsy value (``slippage: 0`` means zero). Fields are snake_case: ``symbol``,\n``operation`` (buy, sell, buyLimit, sellLimit, buyStop, sellStop,\nbuyStopLimit, sellStopLimit), ``volume``, ``price``, ``slippage``,\n``stop_loss``, ``take_profit``, ``stop_limit_price``, ``expiration``,\n``comment``, ``expert_id`` and, on the leg, ``account_id``. ``results``\nmirrors ``orders`` one for one.\n\nLeg ``status``: ``filled`` (the broker accepted), ``rejected`` (the broker\nrefused; ``retcode`` says why), ``invalid`` (the terminal refused the\nrequest), ``unavailable`` (terminal up but not trading), ``unreachable`` (no\nterminal), ``timeout`` (**unknown**: it may have executed, including when the\nbroker's reply was lost; reconcile or replay with the same\n``Idempotency-Key``, never blind-retry).\n\nValidation is all-or-nothing, execution is not. Errors: 400\n``invalid_batch`` / ``unknown_account`` / ``unreachable_account`` (with\n``require_reachable``), 401, 403 (read-only key), 409\n``idempotency_in_flight``, 422 ``idempotency_key_reused``, 429\n``rate_limited`` (60 batches a minute per organisation, with\n``Retry-After``), 503 ``idempotency_unavailable``. ``Idempotency-Key`` (at\nmost 128 characters) replays the stored response for 15 minutes with\n``idempotent_replay: true``; each leg also carries its own derived key, so a\nretry never double-fills a leg that already executed. Every leg is in its\naccount's audit trail.", "operationId": "batch_orders_orders_post", "parameters": [ { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orders/close": { "post": { "tags": [ "batch-orders" ], "summary": "Batch close", "description": "Close by selector (or explicit tickets) across several accounts at once\n(at most 20 accounts, 20 orders each; more come back ``skipped``).\n\nEach account entry is a selector (``symbol`` required, ``*`` for all, typed\nliterally; ``symbol_match`` ``exact`` or ``base`` to accept broker suffixes\nlike ``.sd`` / ``m``; ``side`` long, short or any; ``kind`` position\n(default), pending or any; ``magic``) or an explicit ``tickets`` list, never\nboth. ``volume`` closes part of each matched position. Accounts run\nconcurrently; the tickets of one account run in sequence.\n\nAccount ``status``: closed, partial, failed, nothing_matched (not an error),\nunavailable / unreachable / invalid (the lookup failed, so nothing is\nknown), timeout (orders may have closed). Ticket ``status``: closed,\nrejected, invalid, unavailable, unreachable, timeout (may have closed),\nskipped (never sent). A ticket that was already gone counts as ``closed``\nwith a message saying so. Errors and ``Idempotency-Key`` work as on\n``POST /v1/orders``.", "operationId": "batch_close_orders_close_post", "parameters": [ { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/pretrade-holds": { "get": { "tags": [ "ai-agents-admin" ], "summary": "List Holds", "description": "Holds, newest first (``created_at``, then ``id``). Cursor-paginated:\n``{data, has_more, next_cursor}``; the cursor is bound to ``status`` and\n``account_id``.", "operationId": "list_holds_v1_pretrade_holds_get", "parameters": [ { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "account_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Account Id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "description": "Page size, 1..500 (default 100).", "default": 100, "title": "Limit" }, "description": "Page size, 1..500 (default 100)." }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ], "description": "The next_cursor of the previous page, unchanged.", "title": "Cursor" }, "description": "The next_cursor of the previous page, unchanged." }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/pretrade-holds/{hold_id}": { "get": { "tags": [ "ai-agents-admin" ], "summary": "Get Hold", "description": "One hold.", "operationId": "get_hold_v1_pretrade_holds__hold_id__get", "parameters": [ { "name": "hold_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Hold Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/pretrade-holds/{hold_id}/cancel": { "post": { "tags": [ "ai-agents-admin" ], "summary": "Cancel Hold", "description": "Owner override: reject a pending hold. Nothing is sent.", "operationId": "cancel_hold_v1_pretrade_holds__hold_id__cancel_post", "parameters": [ { "name": "hold_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Hold Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/pretrade-holds/{hold_id}/release": { "post": { "tags": [ "ai-agents" ], "summary": "Release Hold", "description": "Approve or reject a hold; signed with the holding hook's secret.", "operationId": "release_hold_v1_pretrade_holds__hold_id__release_post", "parameters": [ { "name": "hold_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Hold Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/pretrade-hooks": { "post": { "tags": [ "ai-agents-admin" ], "summary": "Create Hook", "description": "Register a pre-trade decision hook. The ``secret`` is shown once.\n\n``Idempotency-Key`` is honoured: a replay returns the same hook without\nregistering another, with ``secret: null`` and a ``secret_notice``.", "operationId": "create_hook_v1_pretrade_hooks_post", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } }, { "name": "X-Actor", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Actor" } }, { "name": "X-Reason", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Reason" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Body" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "ai-agents-admin" ], "summary": "List Hooks", "description": "This tenant's hooks (never the secrets), oldest first.\nCursor-paginated: ``{data, has_more, next_cursor}``.", "operationId": "list_hooks_v1_pretrade_hooks_get", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "description": "Page size, 1..500 (default 100).", "default": 100, "title": "Limit" }, "description": "Page size, 1..500 (default 100)." }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ], "description": "The next_cursor of the previous page, unchanged.", "title": "Cursor" }, "description": "The next_cursor of the previous page, unchanged." }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/pretrade-hooks/{hook_id}": { "get": { "tags": [ "ai-agents-admin" ], "summary": "Get Hook", "description": "One hook.", "operationId": "get_hook_v1_pretrade_hooks__hook_id__get", "parameters": [ { "name": "hook_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Hook Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "ai-agents-admin" ], "summary": "Patch Hook", "description": "Change url, applies_to, fail_mode, timeout, hold TTL or enabled.", "operationId": "patch_hook_v1_pretrade_hooks__hook_id__patch", "parameters": [ { "name": "hook_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Hook Id" } }, { "name": "X-Actor", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Actor" } }, { "name": "X-Reason", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Reason" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "ai-agents-admin" ], "summary": "Delete Hook", "description": "Remove a hook. Its pending holds stay pending until they expire.", "operationId": "delete_hook_v1_pretrade_hooks__hook_id__delete", "parameters": [ { "name": "hook_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Hook Id" } }, { "name": "X-Actor", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Actor" } }, { "name": "X-Reason", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Reason" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/pretrade-hooks/{hook_id}/rotate-secret": { "post": { "tags": [ "ai-agents-admin" ], "summary": "Rotate Hook Secret", "description": "Issue a new signing secret (shown once); the old one stops working.\nWith ``Idempotency-Key`` a replay rotates nothing and answers ``secret:\nnull`` with a ``secret_notice``.", "operationId": "rotate_hook_secret_v1_pretrade_hooks__hook_id__rotate_secret_post", "parameters": [ { "name": "hook_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Hook Id" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } }, { "name": "X-Actor", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Actor" } }, { "name": "X-Reason", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Reason" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/private-servers": { "get": { "summary": "List Servers", "operationId": "list_servers_private_servers_get", "parameters": [ { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "tags": [ "private servers" ] }, "post": { "summary": "Buy Server", "operationId": "buy_server_private_servers_post", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePrivateServer" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "tags": [ "private servers" ] } }, "/v1/private-servers/regions": { "get": { "summary": "Regions", "operationId": "regions_private_servers_regions_get", "parameters": [ { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "tags": [ "private servers" ] } }, "/v1/private-servers/{server_id}": { "get": { "summary": "Get Server", "operationId": "get_server_private_servers__server_id__get", "parameters": [ { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Server Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "tags": [ "private servers" ] }, "patch": { "summary": "Resize Server", "operationId": "resize_server_private_servers__server_id__patch", "parameters": [ { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Server Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchPrivateServer" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "tags": [ "private servers" ] }, "delete": { "summary": "Cancel Server", "operationId": "cancel_server_private_servers__server_id__delete", "parameters": [ { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Server Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "tags": [ "private servers" ] } }, "/v1/private-servers/{server_id}/accounts": { "post": { "summary": "Add Server Account", "operationId": "add_server_account_private_servers__server_id__accounts_post", "parameters": [ { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Server Id" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivateServerAddAccount" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "tags": [ "private servers" ] } }, "/v1/private-servers/{server_id}/accounts/{account_id}": { "delete": { "summary": "Remove Server Account", "operationId": "remove_server_account_private_servers__server_id__accounts__account_id__delete", "parameters": [ { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Server Id" } }, { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "tags": [ "private servers" ] } }, "/v1/readonly-keys": { "get": { "summary": "List Ro Keys", "operationId": "list_ro_keys_readonly_keys_get", "parameters": [ { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "tags": [ "read-only keys" ] }, "post": { "summary": "Create Ro Key", "description": "Create a read-only key. ``key`` is shown once and can't be shown again. With\n``Idempotency-Key`` a replay creates nothing and answers ``key: null``\nwith a ``key_notice`` saying it was already shown.", "operationId": "create_ro_key_readonly_keys_post", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateReadonlyKey" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "tags": [ "read-only keys" ] } }, "/v1/readonly-keys/{key_id}": { "get": { "summary": "Get Ro Key", "operationId": "get_ro_key_readonly_keys__key_id__get", "parameters": [ { "name": "key_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Key Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "tags": [ "read-only keys" ] }, "patch": { "summary": "Patch Ro Key", "operationId": "patch_ro_key_readonly_keys__key_id__patch", "parameters": [ { "name": "key_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Key Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchReadonlyKey" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "tags": [ "read-only keys" ] }, "delete": { "summary": "Delete Ro Key", "operationId": "delete_ro_key_readonly_keys__key_id__delete", "parameters": [ { "name": "key_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Key Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "tags": [ "read-only keys" ] } }, "/v1/readonly-keys/{key_id}/rotate": { "post": { "summary": "Rotate Ro Key", "description": "Issue a new value for a read-only key (same id, scope and accounts);\nthe old value stops working. The new ``key`` is shown once\n(``key_notice``). With ``Idempotency-Key`` a replay rotates nothing and\nanswers ``key: null`` with a ``key_notice`` saying it was already shown;\nthe same ``Idempotency-Key`` on another key's rotate answers ``409\nidempotency_conflict``.", "operationId": "rotate_ro_key_readonly_keys__key_id__rotate_post", "parameters": [ { "name": "key_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Key Id" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "tags": [ "read-only keys" ] } }, "/v1/request-logs": { "get": { "tags": [ "request logs" ], "summary": "List Request Logs", "description": "The organisation's request log, newest first (metadata only).", "operationId": "list_request_logs_request_logs_get", "parameters": [ { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 16 }, { "type": "null" } ], "title": "Status" } }, { "name": "method", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 10 }, { "type": "null" } ], "title": "Method" } }, { "name": "route", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ], "title": "Route" } }, { "name": "errorCode", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 64 }, { "type": "null" } ], "title": "Errorcode" } }, { "name": "keyId", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "title": "Keyid" } }, { "name": "accountId", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "title": "Accountid" } }, { "name": "requestId", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "title": "Requestid" } }, { "name": "since", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Since" } }, { "name": "until", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Until" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 64 }, { "type": "null" } ], "title": "Cursor" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/request-logs/summary": { "get": { "tags": [ "request logs" ], "summary": "Request Log Summary", "description": "Totals, error rate and the top error codes and routes over the last ``hours``.", "operationId": "request_log_summary_request_logs_summary_get", "parameters": [ { "name": "hours", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 336, "minimum": 1, "default": 24, "title": "Hours" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/request-logs/{log_id}": { "get": { "tags": [ "request logs" ], "summary": "Get Request Log", "description": "One call; body excerpts only for a full-access key with the writer role.", "operationId": "get_request_log_request_logs__log_id__get", "parameters": [ { "name": "log_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Log Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/sandbox": { "get": { "tags": [ "sandbox" ], "summary": "Sandbox Info", "description": "Public description of the sandbox; no key needed. ``{sandbox: true,\nserver, keyPrefix, maxAccounts, signup, magicLogins: [{login, scenario}]}``.\n``signup`` says whether anonymous sign-up is open; each magic login, used as\nthe account login on the sandbox server, plays its scenario (see the\nSandbox guide).", "operationId": "sandbox_info_v1_sandbox_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/v1/sandbox/keys": { "post": { "tags": [ "sandbox" ], "summary": "Create Key", "description": "A ``twsk_`` key for the caller's sandbox (linked to a live tenant).\n``Idempotency-Key`` is honoured: a replay mints nothing and answers\n``apiKey: null`` with an ``apiKeyNotice``.", "operationId": "create_key_v1_sandbox_keys_post", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/KeyBody" }, { "type": "null" } ], "title": "Body" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/sandbox/signup": { "post": { "tags": [ "sandbox" ], "summary": "Signup", "description": "Anonymous sandbox sign-up: a sandbox, a **restricted** ``twsk_`` key and\none deployed account (login ``1000``, server ``Tickwire-Sandbox``).\n\nBody (optional): ``{\"platform\": \"mt5\"|\"mt4\"}``. 201 ``{sandbox: true,\nrestricted: true, tenantId, apiKey, account: {id, platform, server, login,\nstate, connectionStatus}}``. The key is shown once. A restricted key may\nmanage its accounts, trade, stream and read; anything else that changes\nstate (webhooks, pre-trade hooks, agent keys, more keys or tokens) answers\n403 ``sandbox_key_restricted``. Sign-ups are limited per client address (5 an\nhour, 10 a day) and in total; over a limit, 429 ``rate_limited`` with\n``Retry-After``. 403 ``forbidden`` when sign-up is turned off. Anonymous\nsandboxes unused for 7 days are deleted.", "operationId": "signup_v1_sandbox_signup_post", "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SandboxSignupBody" }, { "type": "null" } ], "title": "Body" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/subscription": { "get": { "summary": "Subscription", "operationId": "subscription_subscription_get", "parameters": [ { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "tags": [ "billing" ] } }, "/v1/wallet": { "get": { "summary": "Wallet", "operationId": "wallet_wallet_get", "parameters": [ { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "tags": [ "billing" ] } }, "/v1/wallet/assets": { "get": { "summary": "Wallet Assets", "operationId": "wallet_assets_wallet_assets_get", "parameters": [ { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "tags": [ "billing" ] } }, "/v1/wallet/topup": { "post": { "summary": "Create Topup", "operationId": "create_topup_wallet_topup_post", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTopup" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "tags": [ "billing" ] } }, "/v1/wallet/topup/{topup_id}": { "get": { "summary": "Get Topup", "operationId": "get_topup_wallet_topup__topup_id__get", "parameters": [ { "name": "topup_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Topup Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "tags": [ "billing" ] } }, "/v1/wallet/topup/{topup_id}/confirm": { "post": { "summary": "Confirm Topup", "operationId": "confirm_topup_wallet_topup__topup_id__confirm_post", "parameters": [ { "name": "topup_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Topup Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "tags": [ "billing" ] } }, "/v1/wallet/topups": { "get": { "summary": "List Topups", "operationId": "list_topups_wallet_topups_get", "parameters": [ { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "tags": [ "billing" ] } }, "/v1/webhook-event-types": { "get": { "tags": [ "webhooks" ], "summary": "Event Types", "description": "Every webhook event type, with a description, its source and an example envelope.", "operationId": "event_types_webhook_event_types_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/v1/webhook-events/trigger": { "post": { "tags": [ "webhooks" ], "summary": "Trigger", "description": "Publish one test event of a catalog type (any type in the sandbox; live: ``webhook.test``).", "operationId": "trigger_webhook_events_trigger_post", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } }, { "name": "X-Actor", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Actor" } }, { "name": "X-Reason", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Reason" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TriggerBody" } } } }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/webhook-listeners": { "post": { "tags": [ "webhooks" ], "summary": "Create Listener", "description": "Start a local-forwarding listener: its signing secret and the current cursor.", "operationId": "create_listener_webhook_listeners_post", "parameters": [ { "name": "X-Actor", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Actor" } }, { "name": "X-Reason", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Reason" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/webhook-listeners/{listener_id}/events": { "get": { "tags": [ "webhooks" ], "summary": "Listener Events", "description": "The tenant's events after the ``after`` cursor, each signed with the listener secret.", "operationId": "listener_events_webhook_listeners__listener_id__events_get", "parameters": [ { "name": "listener_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Listener Id" } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 64, "default": "", "title": "After" } }, { "name": "types", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Types" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/webhooks": { "get": { "summary": "List Webhooks", "operationId": "list_webhooks_webhooks_get", "parameters": [ { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "tags": [ "webhooks" ] }, "post": { "summary": "Create Webhook", "operationId": "create_webhook_webhooks_post", "parameters": [ { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWebhook" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "tags": [ "webhooks" ] } }, "/v1/webhooks/{webhook_id}": { "get": { "summary": "Get Webhook", "operationId": "get_webhook_webhooks__webhook_id__get", "parameters": [ { "name": "webhook_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Webhook Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "tags": [ "webhooks" ] }, "delete": { "summary": "Delete Webhook", "operationId": "delete_webhook_webhooks__webhook_id__delete", "parameters": [ { "name": "webhook_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Webhook Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "tags": [ "webhooks" ] }, "patch": { "tags": [ "webhooks" ], "summary": "Patch Endpoint", "description": "Change the event filter (``enabledEvents``), URL or description.", "operationId": "patch_endpoint_webhooks__webhook_id__patch", "parameters": [ { "name": "webhook_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Webhook Id" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } }, { "name": "X-Actor", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Actor" } }, { "name": "X-Reason", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Reason" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchEndpoint" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/webhooks/{webhook_id}/deliveries": { "get": { "tags": [ "webhooks" ], "summary": "List Deliveries", "description": "The endpoint's deliveries, newest first (``{data, hasMore, nextCursor}``).", "operationId": "list_deliveries_webhooks__webhook_id__deliveries_get", "parameters": [ { "name": "webhook_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Webhook Id" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "eventType", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Eventtype" } }, { "name": "eventId", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Eventid" } }, { "name": "since", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Since" } }, { "name": "until", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Until" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/webhooks/{webhook_id}/deliveries/{delivery_id}": { "get": { "tags": [ "webhooks" ], "summary": "Get Delivery", "description": "One delivery with every attempt, the signed payload and the last response body.", "operationId": "get_delivery_webhooks__webhook_id__deliveries__delivery_id__get", "parameters": [ { "name": "webhook_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Webhook Id" } }, { "name": "delivery_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Delivery Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/webhooks/{webhook_id}/deliveries/{delivery_id}/resend": { "post": { "tags": [ "webhooks" ], "summary": "Resend Delivery", "description": "Queue this delivery's event again to the endpoint. Returns the new delivery (202).", "operationId": "resend_delivery_webhooks__webhook_id__deliveries__delivery_id__resend_post", "parameters": [ { "name": "webhook_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Webhook Id" } }, { "name": "delivery_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Delivery Id" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } }, { "name": "X-Actor", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Actor" } }, { "name": "X-Reason", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Reason" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/webhooks/{webhook_id}/disable": { "post": { "tags": [ "webhooks" ], "summary": "Disable Endpoint", "description": "Stop deliveries to an endpoint; unfinished deliveries are closed as failed.", "operationId": "disable_endpoint_webhooks__webhook_id__disable_post", "parameters": [ { "name": "webhook_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Webhook Id" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } }, { "name": "X-Actor", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Actor" } }, { "name": "X-Reason", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Reason" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/webhooks/{webhook_id}/enable": { "post": { "tags": [ "webhooks" ], "summary": "Enable Endpoint", "description": "Re-enable an endpoint (after an automatic disable, or your own).", "operationId": "enable_endpoint_webhooks__webhook_id__enable_post", "parameters": [ { "name": "webhook_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Webhook Id" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } }, { "name": "X-Actor", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Actor" } }, { "name": "X-Reason", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Reason" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/webhooks/{webhook_id}/reveal-secret": { "post": { "tags": [ "webhooks" ], "summary": "Reveal Secret", "description": "The current signing secret (and the previous one during a rotation overlap).", "operationId": "reveal_secret_webhooks__webhook_id__reveal_secret_post", "parameters": [ { "name": "webhook_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Webhook Id" } }, { "name": "X-Actor", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Actor" } }, { "name": "X-Reason", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Reason" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/webhooks/{webhook_id}/rotate-secret": { "post": { "tags": [ "webhooks" ], "summary": "Rotate Secret", "description": "New signing secret; the old one stays valid for ``overlapHours`` (default 24).", "operationId": "rotate_secret_webhooks__webhook_id__rotate_secret_post", "parameters": [ { "name": "webhook_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Webhook Id" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } }, { "name": "X-Actor", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Actor" } }, { "name": "X-Reason", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Reason" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/RotateSecret" }, { "type": "null" } ], "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/webhooks/{webhook_id}/settings": { "get": { "tags": [ "webhooks" ], "summary": "Endpoint Settings", "description": "Endpoint status, failure streak, event filter and secret-rotation state.", "operationId": "endpoint_settings_webhooks__webhook_id__settings_get", "parameters": [ { "name": "webhook_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Webhook Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "auth-token", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth-Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } } }, "components": { "schemas": { "AccountFeatures": { "properties": { "copyFactoryApi": { "anyOf": [ { "$ref": "#/components/schemas/CopyTradingEnable" }, { "type": "null" } ] }, "riskManagementApiEnabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Riskmanagementapienabled" }, "metastatsApiEnabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Metastatsapienabled" }, "reliabilityIncreased": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Reliabilityincreased" }, "allocateDedicatedIp": { "anyOf": [ { "type": "string", "enum": [ "ipv4", "none" ] }, { "type": "null" } ], "title": "Allocatededicatedip" } }, "type": "object", "title": "AccountFeatures" }, "CopyTradingEnable": { "properties": { "copyFactoryRoles": { "items": { "type": "string", "enum": [ "PROVIDER", "SUBSCRIBER" ] }, "type": "array", "title": "Copyfactoryroles" }, "copyFactoryResourceSlots": { "anyOf": [ { "type": "integer", "maximum": 64, "minimum": 1 }, { "type": "null" } ], "title": "Copyfactoryresourceslots" } }, "type": "object", "required": [ "copyFactoryRoles" ], "title": "CopyTradingEnable" }, "CreateAccount": { "properties": { "platform": { "type": "string", "enum": [ "mt4", "mt5" ], "title": "Platform", "default": "mt5" }, "server": { "type": "string", "title": "Server" }, "login": { "type": "integer", "title": "Login" }, "password": { "type": "string", "title": "Password" }, "nickname": { "type": "string", "title": "Nickname", "default": "" }, "trade_ea_symbol": { "type": "string", "title": "Trade Ea Symbol", "default": "" }, "proxy_address": { "type": "string", "title": "Proxy Address", "default": "" }, "proxy_type": { "type": "string", "title": "Proxy Type", "default": "" }, "proxy_auth": { "type": "string", "title": "Proxy Auth", "default": "" }, "proxy_local_port": { "type": "integer", "title": "Proxy Local Port", "default": 0 } }, "type": "object", "required": [ "server", "login", "password" ], "title": "CreateAccount" }, "CreatePrivateServer": { "properties": { "slots": { "type": "integer", "minimum": 1, "title": "Slots" }, "region": { "type": "string", "title": "Region" }, "name": { "type": "string", "title": "Name" } }, "type": "object", "required": [ "slots", "region", "name" ], "title": "CreatePrivateServer" }, "CreateReadonlyKey": { "properties": { "name": { "type": "string", "title": "Name" }, "scope": { "type": "string", "enum": [ "all", "selected" ], "title": "Scope", "default": "all" }, "account_ids": { "items": { "type": "string" }, "type": "array", "title": "Account Ids" } }, "type": "object", "required": [ "name" ], "title": "CreateReadonlyKey" }, "CreateTopup": { "properties": { "amount_eur_cents": { "type": "integer", "exclusiveMinimum": 0, "title": "Amount Eur Cents" }, "method": { "type": "string", "enum": [ "crypto", "manual" ], "title": "Method", "default": "crypto" } }, "type": "object", "required": [ "amount_eur_cents" ], "title": "CreateTopup" }, "CreateWebhook": { "properties": { "url": { "type": "string", "title": "Url" }, "secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Secret" } }, "type": "object", "required": [ "url" ], "title": "CreateWebhook" }, "Credentials": { "properties": { "login": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ], "title": "Login" }, "password": { "type": "string", "minLength": 1, "title": "Password" } }, "type": "object", "required": [ "password" ], "title": "Credentials" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "KeyBody": { "properties": { "name": { "type": "string", "title": "Name", "default": "sandbox" } }, "additionalProperties": false, "type": "object", "title": "KeyBody" }, "MoveAccounts": { "properties": { "account_ids": { "items": { "type": "string" }, "type": "array", "maxItems": 200, "minItems": 1, "title": "Account Ids" } }, "type": "object", "required": [ "account_ids" ], "title": "MoveAccounts" }, "NewProfile": { "properties": { "name": { "type": "string", "maxLength": 256, "minLength": 1, "title": "Name" }, "version": { "type": "integer", "enum": [ 4, 5 ], "title": "Version" }, "brokerTimezone": { "type": "string", "title": "Brokertimezone" }, "brokerDSTSwitchTimezone": { "type": "string", "title": "Brokerdstswitchtimezone" }, "type": { "type": "string", "enum": [ "mtTerminal", "managerApi" ], "title": "Type", "default": "mtTerminal" }, "managerLogin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Managerlogin" }, "managerPassword": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Managerpassword" }, "managerServer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Managerserver" } }, "type": "object", "required": [ "name", "version", "brokerTimezone", "brokerDSTSwitchTimezone" ], "title": "NewProfile" }, "NewToken": { "properties": { "name": { "type": "string", "maxLength": 256, "title": "Name", "default": "" }, "kind": { "type": "string", "enum": [ "api", "account" ], "title": "Kind", "default": "api" }, "applications": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Applications" }, "roles": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Roles" }, "accountIds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Accountids" }, "readOnly": { "type": "boolean", "title": "Readonly", "default": false }, "ttlInHours": { "anyOf": [ { "type": "number", "maximum": 43800, "exclusiveMinimum": 0 }, { "type": "null" } ], "title": "Ttlinhours" }, "ipAllowlist": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Ipallowlist" } }, "type": "object", "title": "NewToken" }, "NewTradingAccount": { "properties": { "name": { "type": "string", "maxLength": 256, "minLength": 1, "title": "Name" }, "server": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Server" }, "login": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ], "title": "Login" }, "password": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Password" }, "platform": { "anyOf": [ { "type": "string", "enum": [ "mt4", "mt5" ] }, { "type": "null" } ], "title": "Platform" }, "provisioningProfileId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provisioningprofileid" }, "magic": { "type": "integer", "minimum": 0, "title": "Magic", "default": 0 }, "manualTrades": { "type": "boolean", "title": "Manualtrades", "default": false }, "slippage": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ], "title": "Slippage" }, "quoteStreamingIntervalInSeconds": { "type": "number", "minimum": 0, "title": "Quotestreamingintervalinseconds", "default": 2.5 }, "tags": { "items": { "type": "string" }, "type": "array", "title": "Tags" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Metadata" }, "reliability": { "type": "string", "enum": [ "regular", "high" ], "title": "Reliability", "default": "regular" }, "resourceSlots": { "type": "integer", "maximum": 64, "minimum": 1, "title": "Resourceslots", "default": 1 }, "copyFactoryResourceSlots": { "type": "integer", "maximum": 64, "minimum": 1, "title": "Copyfactoryresourceslots", "default": 1 }, "region": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Region" }, "type": { "type": "string", "enum": [ "cloud", "cloud-g1", "cloud-g2" ], "title": "Type", "default": "cloud-g2" }, "symbol": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Symbol" }, "baseCurrency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Basecurrency" }, "copyFactoryRoles": { "items": { "type": "string", "enum": [ "PROVIDER", "SUBSCRIBER" ] }, "type": "array", "title": "Copyfactoryroles" }, "riskManagementApiEnabled": { "type": "boolean", "title": "Riskmanagementapienabled", "default": false }, "metastatsApiEnabled": { "type": "boolean", "title": "Metastatsapienabled", "default": false }, "allocateDedicatedIp": { "anyOf": [ { "type": "string", "enum": [ "ipv4", "none" ] }, { "type": "null" } ], "title": "Allocatededicatedip" }, "keywords": { "items": { "type": "string" }, "type": "array", "title": "Keywords" }, "serverAddress": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Serveraddress" } }, "type": "object", "required": [ "name", "server" ], "title": "NewTradingAccount" }, "PatchAccount": { "properties": { "trade_ea_symbol": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Trade Ea Symbol" } }, "type": "object", "title": "PatchAccount" }, "PatchEndpoint": { "properties": { "enabledEvents": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "maxItems": 100 }, { "type": "null" } ], "title": "Enabledevents" }, "url": { "anyOf": [ { "type": "string", "maxLength": 2000, "minLength": 8 }, { "type": "null" } ], "title": "Url" }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ], "title": "Description" } }, "type": "object", "title": "PatchEndpoint" }, "PatchPrivateServer": { "properties": { "slots": { "type": "integer", "minimum": 1, "title": "Slots" } }, "type": "object", "required": [ "slots" ], "title": "PatchPrivateServer" }, "PatchReadonlyKey": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "scope": { "anyOf": [ { "type": "string", "enum": [ "all", "selected" ] }, { "type": "null" } ], "title": "Scope" }, "account_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Account Ids" } }, "type": "object", "title": "PatchReadonlyKey" }, "PatchToken": { "properties": { "name": { "anyOf": [ { "type": "string", "maxLength": 256 }, { "type": "null" } ], "title": "Name" }, "ipAllowlist": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Ipallowlist" } }, "type": "object", "title": "PatchToken" }, "PinBody": { "properties": { "apiVersion": { "type": "string", "maxLength": 32, "minLength": 1, "title": "Apiversion" } }, "type": "object", "required": [ "apiVersion" ], "title": "PinBody" }, "PrivateServerAddAccount": { "properties": { "platform": { "type": "string", "enum": [ "mt4", "mt5" ], "title": "Platform", "default": "mt5" }, "server": { "type": "string", "title": "Server" }, "login": { "type": "integer", "title": "Login" }, "password": { "type": "string", "title": "Password" }, "nickname": { "type": "string", "title": "Nickname", "default": "" }, "trade_ea_symbol": { "type": "string", "title": "Trade Ea Symbol", "default": "" } }, "type": "object", "required": [ "server", "login", "password" ], "title": "PrivateServerAddAccount" }, "RotateSecret": { "properties": { "secret": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ], "title": "Secret" }, "overlapHours": { "type": "number", "title": "Overlaphours", "default": 24 } }, "type": "object", "title": "RotateSecret" }, "TriggerBody": { "properties": { "type": { "type": "string", "maxLength": 100, "minLength": 1, "title": "Type" }, "accountId": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "title": "Accountid" } }, "additionalProperties": false, "type": "object", "required": [ "type" ], "title": "TriggerBody" }, "UpdateProfile": { "properties": { "name": { "anyOf": [ { "type": "string", "maxLength": 256, "minLength": 1 }, { "type": "null" } ], "title": "Name" }, "brokerTimezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Brokertimezone" }, "brokerDSTSwitchTimezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Brokerdstswitchtimezone" }, "managerLogin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Managerlogin" }, "managerPassword": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Managerpassword" }, "managerServer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Managerserver" } }, "type": "object", "title": "UpdateProfile" }, "UpdateTradingAccount": { "properties": { "name": { "anyOf": [ { "type": "string", "maxLength": 256, "minLength": 1 }, { "type": "null" } ], "title": "Name" }, "password": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Password" }, "server": { "anyOf": [ { "type": "string", "maxLength": 128, "minLength": 1 }, { "type": "null" } ], "title": "Server" }, "magic": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Magic" }, "manualTrades": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Manualtrades" }, "slippage": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ], "title": "Slippage" }, "quoteStreamingIntervalInSeconds": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ], "title": "Quotestreamingintervalinseconds" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Metadata" }, "copyFactoryRoles": { "anyOf": [ { "items": { "type": "string", "enum": [ "PROVIDER", "SUBSCRIBER" ] }, "type": "array" }, { "type": "null" } ], "title": "Copyfactoryroles" }, "resourceSlots": { "anyOf": [ { "type": "integer", "maximum": 64, "minimum": 1 }, { "type": "null" } ], "title": "Resourceslots" }, "copyFactoryResourceSlots": { "anyOf": [ { "type": "integer", "maximum": 64, "minimum": 1 }, { "type": "null" } ], "title": "Copyfactoryresourceslots" }, "metastatsApiEnabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Metastatsapienabled" }, "allocateDedicatedIp": { "anyOf": [ { "type": "string", "enum": [ "ipv4", "none" ] }, { "type": "null" } ], "title": "Allocatededicatedip" }, "serverAddress": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Serveraddress" } }, "type": "object", "title": "UpdateTradingAccount" }, "UpgradeBody": { "properties": { "accounts": { "type": "integer", "maximum": 100000, "minimum": 1, "title": "Accounts" }, "own_address": { "type": "boolean", "title": "Own Address", "default": false } }, "type": "object", "required": [ "accounts" ], "title": "UpgradeBody" }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" }, "input": { "title": "Input" }, "ctx": { "type": "object", "title": "Context" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" }, "SandboxSignupBody": { "properties": { "platform": { "type": "string", "enum": [ "mt4", "mt5" ], "title": "Platform", "default": "mt5" } }, "additionalProperties": false, "type": "object", "title": "SignupBody" } }, "securitySchemes": { "authToken": { "type": "apiKey", "in": "header", "name": "auth-token" }, "apiKey": { "type": "apiKey", "in": "header", "name": "X-API-Key" } } }, "security": [ { "authToken": [] }, { "apiKey": [] } ] }