Endpoints: 76,849MCP servers: 32,728Payout addresses: 3,825Paid calls: 6,140Letters: 84Defects: 3,890counted just now
teppi

Server definition

Hash
sha256:a2b09d2fa82898213e9ac7e616d8c236cf642ff7fcc5824347fee5ad67f537b9
What it is
What a remote MCP server returned when asked what it offers: 30 tools

The blob, as servednamed by its sha256

{ "instructions": "fxapis trades on the user's own MetaTrader 5 accounts, real or demo. Practise on a demo account first: list_accounts shows each account's environment. Before every trade, confirm account, symbol, side and volume with the user, and never trade on your own initiative. Give each new trade a fresh idempotency_key and reuse it only to retry that same call. ORDER_UNRESOLVED means the order may be live: never send it again, poll get_order until it leaves unknown. SEND_FAILED means nothing reached the broker: retry with the same key. Only ready accounts trade: call bring_accounts_online, then poll get_account_status. Volumes and prices are strings such as \"0.10\" and \"1.08450\". get_account_overview and get_symbol_snapshot answer most questions in one call. Every error carries a code and a next step: follow it, and when access is missing tell the user instead of working around it. Connecting accounts and managing keys happen in the fxapis dashboard.", "tools": [ { "description": "Starts each account's MT5 terminal in the cloud and logs it in; poll get_account_status until `ready`. Places no trades and is safe to repeat. Example: {\"account_ids\": [\"<id>\"]}", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "account_ids": { "description": "One or more account ids.", "items": { "description": "The fxapis account id (a UUID) from list_accounts — not the MT5 login number.", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" }, "maxItems": 200, "minItems": 1, "type": "array" } }, "required": [ "account_ids" ], "type": "object" }, "name": "bring_accounts_online", "outputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "properties": { "results": { "items": { "additionalProperties": {}, "properties": { "accountId": { "type": "string" }, "message": { "type": [ "string", "null" ] }, "result": { "type": "string" } }, "required": [ "accountId", "result", "message" ], "type": "object" }, "type": "array" } }, "required": [ "results" ], "type": "object" } }, { "description": "The margin an order would need, or its profit between two prices, as the broker computes it; opens nothing. The account must be online. Example: {\"account_id\": \"<id>\", \"kind\": \"margin\", \"symbol\": \"EURUSD\", \"side\": \"buy\", \"volume\": \"0.10\", \"price\": \"1.08450\"}", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "account_id": { "description": "The fxapis account id (a UUID) from list_accounts — not the MT5 login number.", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" }, "close_price": { "anyOf": [ { "pattern": "^\\d+(\\.\\d{1,8})?$", "type": "string" }, { "minimum": 0, "type": "number" } ], "description": "Exit price. Required when kind is profit. An absolute price (e.g. \"1.08450\"), not a distance in pips or points." }, "kind": { "description": "margin: required to open. profit: result between price and close_price.", "enum": [ "margin", "profit" ], "type": "string" }, "price": { "anyOf": [ { "pattern": "^\\d+(\\.\\d{1,8})?$", "type": "string" }, { "minimum": 0, "type": "number" } ], "description": "Entry price. An absolute price (e.g. \"1.08450\"), not a distance in pips or points." }, "response_format": { "description": "concise (default): what a next step needs. detailed: every field the API returns.", "enum": [ "concise", "detailed" ], "type": "string" }, "side": { "description": "buy or sell.", "enum": [ "buy", "sell" ], "type": "string" }, "symbol": { "description": "The symbol exactly as this broker names it, e.g. \"EURUSD\" — some brokers add a suffix such as \"EURUSD.r\".", "maxLength": 32, "minLength": 1, "type": "string" }, "volume": { "anyOf": [ { "pattern": "^\\d+(\\.\\d{1,8})?$", "type": "string" }, { "minimum": 0, "type": "number" } ], "description": "Order size. In lots, preferably as a string: \"0.01\" is a micro lot, \"1.00\" a standard lot." } }, "required": [ "account_id", "kind", "symbol", "side", "volume", "price" ], "type": "object" }, "name": "calculate", "outputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "properties": { "kind": { "type": "string" }, "value": { "description": "In the account's currency.", "type": [ "string", "null" ] } }, "required": [ "kind", "value" ], "type": "object" } }, { "description": "Calls off a multi-account order on the user's real broker accounts (or demo) before anything is sent. Once orders went out, close the positions instead. Example: {\"multi_account_order_id\": \"<id>\", \"idempotency_key\": \"<new uuid>\"}", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "idempotency_key": { "description": "A unique string you generate for THIS action, e.g. a fresh UUID. If a call fails or times out and you retry the same action, send the SAME key: fxapis then returns the first result instead of acting twice. Use a new key only for a genuinely new action.", "maxLength": 200, "minLength": 8, "type": "string" }, "multi_account_order_id": { "description": "The multi-account order id.", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" } }, "required": [ "multi_account_order_id", "idempotency_key" ], "type": "object" }, "name": "cancel_multi_account_order", "outputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "properties": { "multi_account_order": { "additionalProperties": {}, "properties": { "id": { "type": "string" }, "legs": { "anyOf": [ { "items": { "additionalProperties": {}, "properties": { "accountId": { "type": "string" }, "state": { "type": "string" } }, "required": [ "accountId", "state" ], "type": "object" }, "type": "array" }, { "type": "null" } ], "description": "Concise: only the accounts not filled." }, "side": { "type": [ "string", "null" ] }, "state": { "description": "planned → preparing → armed → releasing → settled; or cancelled / abandoned (nothing sent).", "type": [ "string", "null" ] }, "summary": { "anyOf": [ { "additionalProperties": {}, "properties": { "filled": { "type": "number" }, "rejected": { "type": "number" }, "skipped": { "type": "number" }, "total": { "type": "number" }, "unresolved": { "type": "number" } }, "required": [ "total", "filled", "rejected", "skipped", "unresolved" ], "type": "object" }, { "type": "null" } ] } }, "required": [ "id" ], "type": "object" } }, "required": [ "multi_account_order" ], "type": "object" } }, { "description": "Cancels a pending order on the user's real broker account (or demo) that has not triggered. If it triggered there is a position to close instead. Example: {\"order_id\": \"<id>\", \"idempotency_key\": \"<new uuid>\"}", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "idempotency_key": { "description": "A unique string you generate for THIS action, e.g. a fresh UUID. If a call fails or times out and you retry the same action, send the SAME key: fxapis then returns the first result instead of acting twice. Use a new key only for a genuinely new action.", "maxLength": 200, "minLength": 8, "type": "string" }, "order_id": { "description": "The fxapis id of the pending order.", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" } }, "required": [ "order_id", "idempotency_key" ], "type": "object" }, "name": "cancel_order", "outputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "properties": { "order": { "additionalProperties": {}, "properties": { "accountId": { "type": [ "string", "null" ] }, "brokerPositionId": { "type": [ "string", "null" ] }, "filledPrice": { "type": [ "string", "null" ] }, "filledVolume": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "needsReconciliation": { "description": "True while fxapis is confirming the result with the broker. Never resend such an order; poll get_order.", "type": [ "boolean", "null" ] }, "retcodeText": { "type": [ "string", "null" ] }, "side": { "type": [ "string", "null" ] }, "state": { "description": "One of: accepted, validating, sending, working, completed, filled, partially_filled, rejected, failed, unknown, cancelled, expired.", "type": [ "string", "null" ] }, "symbol": { "type": [ "string", "null" ] } }, "required": [ "id" ], "type": "object" } }, "required": [ "order" ], "type": "object" } }, { "description": "Closes a position on the user's real broker account (or demo), whole or by volume. Sent twice it opens the opposite position, so reuse an idempotency_key only to retry the same close. Example: {\"account_id\": \"<id>\", \"position_id\": \"<brokerPositionId>\", \"idempotency_key\": \"<new uuid>\"}", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "account_id": { "description": "The fxapis account id (a UUID) from list_accounts — not the MT5 login number.", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" }, "client_order_id": { "description": "Optional reference of your own, echoed back on the order.", "maxLength": 120, "type": "string" }, "comment": { "description": "Optional note stored on the order. MT5 keeps the first 17 characters after our reference.", "maxLength": 120, "type": "string" }, "deviation_points": { "description": "Maximum slippage in points.", "maximum": 10000, "minimum": 0, "type": "integer" }, "idempotency_key": { "description": "A unique string you generate for THIS action, e.g. a fresh UUID. If a call fails or times out and you retry the same action, send the SAME key: fxapis then returns the first result instead of acting twice. Use a new key only for a genuinely new action.", "maxLength": 200, "minLength": 8, "type": "string" }, "position_id": { "description": "The position ticket: `brokerPositionId` from list_positions.", "maxLength": 40, "minLength": 1, "type": "string" }, "volume": { "anyOf": [ { "pattern": "^\\d+(\\.\\d{1,8})?$", "type": "string" }, { "minimum": 0, "type": "number" } ], "description": "Optional: how much to close. Omit to close the whole position. In lots, preferably as a string: \"0.01\" is a micro lot, \"1.00\" a standard lot." } }, "required": [ "account_id", "position_id", "idempotency_key" ], "type": "object" }, "name": "close_position", "outputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "properties": { "order": { "additionalProperties": {}, "properties": { "accountId": { "type": [ "string", "null" ] }, "brokerPositionId": { "type": [ "string", "null" ] }, "filledPrice": { "type": [ "string", "null" ] }, "filledVolume": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "needsReconciliation": { "description": "True while fxapis is confirming the result with the broker. Never resend such an order; poll get_order.", "type": [ "boolean", "null" ] }, "retcodeText": { "type": [ "string", "null" ] }, "side": { "type": [ "string", "null" ] }, "state": { "description": "One of: accepted, validating, sending, working, completed, filled, partially_filled, rejected, failed, unknown, cancelled, expired.", "type": [ "string", "null" ] }, "symbol": { "type": [ "string", "null" ] } }, "required": [ "id" ], "type": "object" } }, "required": [ "order" ], "type": "object" } }, { "description": "One account: login, broker, state, environment, and its last-read balance, equity and free margin. Example: {\"account_id\": \"<id from list_accounts>\"}", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "account_id": { "description": "The fxapis account id (a UUID) from list_accounts — not the MT5 login number.", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" }, "response_format": { "description": "concise (default): what a next step needs. detailed: every field the API returns.", "enum": [ "concise", "detailed" ], "type": "string" } }, "required": [ "account_id" ], "type": "object" }, "name": "get_account", "outputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "properties": { "account": { "additionalProperties": {}, "properties": { "environment": { "description": "demo, contest or live.", "type": [ "string", "null" ] }, "id": { "type": "string" }, "label": { "type": [ "string", "null" ] }, "login": { "type": [ "string", "null" ] }, "server": { "type": [ "string", "null" ] }, "state": { "description": "One of: created, provisioning, standby, starting, connecting, synchronizing, ready, executing, cooling, offline, degraded, reconnecting, invalid_credentials, trading_disabled, needs_2fa, needs_certificate, error. Only `ready` can trade.", "type": [ "string", "null" ] }, "tradingDisabled": { "type": [ "boolean", "null" ] } }, "required": [ "id" ], "type": "object" } }, "required": [ "account" ], "type": "object" } }, { "description": "Balance, equity, margin, free margin and margin level as decimal strings in the account currency, read every 15 s while online. Set fresh to ask the terminal now (the account must be `ready`). Example: {\"account_id\": \"<id>\", \"fresh\": true}", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "account_id": { "description": "The fxapis account id (a UUID) from list_accounts — not the MT5 login number.", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" }, "fresh": { "description": "True to ask the terminal now instead of using the last read.", "type": "boolean" }, "response_format": { "description": "concise (default): what a next step needs. detailed: every field the API returns.", "enum": [ "concise", "detailed" ], "type": "string" } }, "required": [ "account_id" ], "type": "object" }, "name": "get_account_figures", "outputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "properties": { "figures": { "additionalProperties": {}, "properties": { "balance": { "type": [ "string", "null" ] }, "currency": { "type": [ "string", "null" ] }, "equity": { "type": [ "string", "null" ] }, "freeMargin": { "type": [ "string", "null" ] }, "marginLevel": { "description": "Equity over margin, in percent. Absent while no margin is used.", "type": [ "string", "null" ] }, "observedAt": { "description": "When the terminal was read. Absent if never.", "type": [ "string", "null" ] }, "source": { "description": "live: the terminal was asked for this call. snapshot: the last read, taken every 15 s while online.", "type": [ "string", "null" ] } }, "type": "object" } }, "required": [ "figures" ], "type": "object" } }, { "description": "One account in one call: state, environment, balance and equity, and its largest open positions with their total P/L. Start here when asked how an account is doing. Example: {\"account_id\": \"<id>\"}", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "account_id": { "description": "The fxapis account id (a UUID) from list_accounts — not the MT5 login number.", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" }, "response_format": { "description": "concise (default): what a next step needs. detailed: every field the API returns.", "enum": [ "concise", "detailed" ], "type": "string" }, "top": { "description": "How many of the largest positions to list. Default 5.", "maximum": 20, "minimum": 1, "type": "integer" } }, "required": [ "account_id" ], "type": "object" }, "name": "get_account_overview", "outputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "properties": { "account": { "additionalProperties": {}, "properties": { "environment": { "description": "demo, contest or live.", "type": [ "string", "null" ] }, "id": { "type": "string" }, "label": { "type": [ "string", "null" ] }, "login": { "type": [ "string", "null" ] }, "server": { "type": [ "string", "null" ] }, "state": { "description": "One of: created, provisioning, standby, starting, connecting, synchronizing, ready, executing, cooling, offline, degraded, reconnecting, invalid_credentials, trading_disabled, needs_2fa, needs_certificate, error. Only `ready` can trade.", "type": [ "string", "null" ] }, "tradingDisabled": { "type": [ "boolean", "null" ] } }, "required": [ "id" ], "type": "object" }, "positions": { "anyOf": [ { "additionalProperties": {}, "properties": { "largest": { "items": { "additionalProperties": {}, "properties": { "brokerPositionId": { "description": "The position ticket. Pass this as position_id to close_position or modify_position.", "type": "string" }, "profit": { "type": [ "string", "null" ] }, "side": { "type": [ "string", "null" ] }, "symbol": { "type": [ "string", "null" ] }, "volume": { "type": [ "string", "null" ] } }, "required": [ "brokerPositionId" ], "type": "object" }, "type": "array" }, "open": { "type": "number" }, "profit": { "type": "string" } }, "required": [ "open", "profit", "largest" ], "type": "object" }, { "type": "null" } ] } }, "required": [ "account", "positions" ], "type": "object" } }, { "description": "Just an account's state, cheap enough to poll every few seconds after bring_accounts_online until `ready`. States invalid_credentials, needs_2fa, needs_certificate and trading_disabled need the user, so stop polling. Example: {\"account_id\": \"<id>\"}", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "account_id": { "description": "The fxapis account id (a UUID) from list_accounts — not the MT5 login number.", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" }, "response_format": { "description": "concise (default): what a next step needs. detailed: every field the API returns.", "enum": [ "concise", "detailed" ], "type": "string" } }, "required": [ "account_id" ], "type": "object" }, "name": "get_account_status", "outputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "properties": { "status": { "additionalProperties": {}, "properties": { "id": { "type": "string" }, "state": { "type": "string" } }, "required": [ "id", "state" ], "type": "object" } }, "required": [ "status" ], "type": "object" } }, { "description": "Whether a market is open now on this account's broker, and when it next opens or closes, in UTC. A broker holiday missing from its schedule still refuses orders. Example: {\"account_id\": \"<id>\", \"instrument\": \"XAUUSD\"}", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "account_id": { "description": "The fxapis account id (a UUID) from list_accounts — not the MT5 login number.", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" }, "instrument": { "description": "An instrument from list_instruments, e.g. XAUUSD.", "maxLength": 32, "minLength": 1, "type": "string" }, "response_format": { "description": "concise (default): what a next step needs. detailed: every field the API returns.", "enum": [ "concise", "detailed" ], "type": "string" }, "symbol": { "description": "Or the broker's own symbol.", "maxLength": 32, "minLength": 1, "type": "string" } }, "required": [ "account_id" ], "type": "object" }, "name": "get_market_hours", "outputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "properties": { "hours": { "additionalProperties": {}, "properties": {}, "type": "object" } }, "required": [ "hours" ], "type": "object" } }, { "description": "One multi-account order and each account's result; poll it after placing one. An account left `unresolved` must not be resent, so poll its order instead. Example: {\"multi_account_order_id\": \"<id>\"}", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "multi_account_order_id": { "description": "The id returned by place_multi_account_order.", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" }, "response_format": { "description": "concise (default): what a next step needs. detailed: every field the API returns.", "enum": [ "concise", "detailed" ], "type": "string" } }, "required": [ "multi_account_order_id" ], "type": "object" }, "name": "get_multi_account_order", "outputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "properties": { "multi_account_order": { "additionalProperties": {}, "properties": { "id": { "type": "string" }, "legs": { "anyOf": [ { "items": { "additionalProperties": {}, "properties": { "accountId": { "type": "string" }, "state": { "type": "string" } }, "required": [ "accountId", "state" ], "type": "object" }, "type": "array" }, { "type": "null" } ], "description": "Concise: only the accounts not filled." }, "side": { "type": [ "string", "null" ] }, "state": { "description": "planned → preparing → armed → releasing → settled; or cancelled / abandoned (nothing sent).", "type": [ "string", "null" ] }, "summary": { "anyOf": [ { "additionalProperties": {}, "properties": { "filled": { "type": "number" }, "rejected": { "type": "number" }, "skipped": { "type": "number" }, "total": { "type": "number" }, "unresolved": { "type": "number" } }, "required": [ "total", "filled", "rejected", "skipped", "unresolved" ], "type": "object" }, { "type": "null" } ] } }, "required": [ "id" ], "type": "object" } }, "required": [ "multi_account_order" ], "type": "object" } }, { "description": "The authoritative record of one order: what was asked, the broker's answer, fill volume and price. Poll it after ORDER_UNRESOLVED until it leaves `unknown`. Example: {\"order_id\": \"<id>\", \"include_deals\": true}", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "include_deals": { "description": "Also return the deals this order produced. Needs history:read.", "type": "boolean" }, "order_id": { "description": "The fxapis order id.", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" }, "response_format": { "description": "concise (default): what a next step needs. detailed: every field the API returns.", "enum": [ "concise", "detailed" ], "type": "string" } }, "required": [ "order_id" ], "type": "object" }, "name": "get_order", "outputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "properties": { "deals": { "items": { "additionalProperties": {}, "properties": { "brokerDealId": { "type": "string" }, "dealType": { "type": [ "string", "null" ] }, "dealtAt": { "type": [ "string", "null" ] }, "profit": { "type": [ "string", "null" ] }, "symbol": { "type": [ "string", "null" ] }, "volume": { "type": [ "string", "null" ] } }, "required": [ "brokerDealId" ], "type": "object" }, "type": "array" }, "order": { "additionalProperties": {}, "properties": { "accountId": { "type": [ "string", "null" ] }, "brokerPositionId": { "type": [ "string", "null" ] }, "filledPrice": { "type": [ "string", "null" ] }, "filledVolume": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "needsReconciliation": { "description": "True while fxapis is confirming the result with the broker. Never resend such an order; poll get_order.", "type": [ "boolean", "null" ] }, "retcodeText": { "type": [ "string", "null" ] }, "side": { "type": [ "string", "null" ] }, "state": { "description": "One of: accepted, validating, sending, working, completed, filled, partially_filled, rejected, failed, unknown, cancelled, expired.", "type": [ "string", "null" ] }, "symbol": { "type": [ "string", "null" ] } }, "required": [ "id" ], "type": "object" } }, "required": [ "order" ], "type": "object" } }, { "description": "Recent price bars (candles: open, high, low, close, tick volume, spread) for one symbol from this account's broker, oldest first with bar-open times in UTC, for technical analysis such as trend, support and resistance, volatility or moving averages; timeframes M1 to MN1, up to 500 bars, the last bar still forming, and tick volume counts price changes rather than traded lots. The account must be online, and until its terminal is updated at the next scheduled maintenance this answers CAPABILITY_UNAVAILABLE, so use get_quotes for the current price meanwhile. Example: {\"account_id\": \"<id>\", \"instrument\": \"XAUUSD\", \"timeframe\": \"H1\", \"count\": 100}", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "account_id": { "description": "The fxapis account id (a UUID) from list_accounts — not the MT5 login number.", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" }, "count": { "description": "Bars to return, counting back from the current one: 1–500, default 100. Ask for what the analysis needs.", "maximum": 500, "minimum": 1, "type": "integer" }, "instrument": { "description": "An instrument from list_instruments, e.g. XAUUSD; read as this account's own symbol for it.", "maxLength": 32, "minLength": 1, "type": "string" }, "symbol": { "description": "Or the broker's own symbol, exactly as this broker names it. Send instrument or symbol, not both.", "maxLength": 32, "minLength": 1, "type": "string" }, "timeframe": { "description": "Bar size: M1–M30 minutes, H1 or H4 hours, D1 a day, W1 a week, MN1 a month.", "enum": [ "M1", "M5", "M15", "M30", "H1", "H4", "D1", "W1", "MN1" ], "type": "string" } }, "required": [ "account_id", "timeframe" ], "type": "object" }, "name": "get_price_history", "outputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": {}, "properties": { "columns": { "description": "The order of each row's values: time_utc, open, high, low, close, tick_volume, spread (points).", "items": { "type": "string" }, "type": "array" }, "rows": { "description": "One bar per row, oldest first; the last is still forming.", "items": { "items": { "type": [ "string", "number" ] }, "type": "array" }, "type": "array" }, "symbol": { "type": "string" }, "timeframe": { "type": "string" } }, "required": [ "symbol", "timeframe", "columns", "rows" ], "type": "object" } }, { "description": "Live bid and ask for up to 20 symbols or instruments from this account's broker; a closed market answers its last price with marketOpen false. The account must be online. Example: {\"account_id\": \"<id>\", \"instruments\": [\"EURUSD\"]}", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "account_id": { "description": "The fxapis account id (a UUID) from list_accounts — not the MT5 login number.", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" }, "instruments": { "description": "Instruments; each is quoted as this account's own symbol for it.", "items": { "maxLength": 32, "minLength": 1, "type": "string" }, "maxItems": 20, "type": "array" }, "response_format": { "description": "concise (default): what a next step needs. detailed: every field the API returns.", "enum": [ "concise", "detailed" ], "type": "string" }, "symbols": { "description": "Broker symbols, exactly as this broker names them.", "items": { "description": "The symbol exactly as this broker names it, e.g. \"EURUSD\" — some brokers add a suffix such as \"EURUSD.r\".", "maxLength": 32, "minLength": 1, "type": "string" }, "maxItems": 20, "type": "array" } }, "required": [ "account_id" ], "type": "object" }, "name": "get_quotes", "outputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "properties": { "quotes": { "items": { "additionalProperties": {}, "properties": { "ask": { "type": [ "string", "null" ] }, "bid": { "type": [ "string", "null" ] }, "marketOpen": { "description": "False: the market is closed and the price is the last one.", "type": [ "boolean", "null" ] }, "stale": { "description": "True only while the market is open and the last tick is over 60 seconds old.", "type": [ "boolean", "null" ] }, "status": { "description": "ok, no_price, or unknown_symbol.", "type": "string" }, "symbol": { "type": "string" }, "time": { "description": "The last tick's time, in UTC.", "type": [ "string", "null" ] } }, "required": [ "symbol", "status" ], "type": "object" }, "type": "array" } }, "required": [ "quotes" ], "type": "object" } }, { "description": "One symbol on one account in one call: its specification, live quote, whether the market is open, and the margin for a volume. Use it before proposing a trade. Example: {\"account_id\": \"<id>\", \"instrument\": \"XAUUSD\", \"volume\": \"0.10\", \"side\": \"buy\"}", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "account_id": { "description": "The fxapis account id (a UUID) from list_accounts — not the MT5 login number.", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" }, "instrument": { "description": "Instead of symbol: an instrument from list_instruments, e.g. XAUUSD.", "maxLength": 32, "minLength": 1, "type": "string" }, "response_format": { "description": "concise (default): what a next step needs. detailed: every field the API returns.", "enum": [ "concise", "detailed" ], "type": "string" }, "side": { "description": "buy (default) or sell, for the margin.", "enum": [ "buy", "sell" ], "type": "string" }, "symbol": { "description": "The symbol exactly as this broker names it, e.g. \"EURUSD\" — some brokers add a suffix such as \"EURUSD.r\".", "maxLength": 32, "minLength": 1, "type": "string" }, "volume": { "anyOf": [ { "pattern": "^\\d+(\\.\\d{1,8})?$", "type": "string" }, { "minimum": 0, "type": "number" } ], "description": "Optional: the size to price the margin for. In lots, preferably as a string: \"0.01\" is a micro lot, \"1.00\" a standard lot." } }, "required": [ "account_id" ], "type": "object" }, "name": "get_symbol_snapshot", "outputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": {}, "properties": { "margin": { "anyOf": [ { "additionalProperties": {}, "properties": { "side": { "type": "string" }, "value": { "type": "string" }, "volume": { "type": [ "string", "null" ] } }, "required": [ "volume", "side", "value" ], "type": "object" }, { "type": "null" } ] }, "market": { "anyOf": [ { "additionalProperties": {}, "properties": {}, "type": "object" }, { "type": "null" } ] }, "quote": { "anyOf": [ { "additionalProperties": {}, "properties": { "ask": { "type": [ "string", "null" ] }, "bid": { "type": [ "string", "null" ] }, "marketOpen": { "description": "False: the market is closed and the price is the last one.", "type": [ "boolean", "null" ] }, "stale": { "description": "True only while the market is open and the last tick is over 60 seconds old.", "type": [ "boolean", "null" ] }, "status": { "description": "ok, no_price, or unknown_symbol.", "type": "string" }, "symbol": { "type": "string" }, "time": { "description": "The last tick's time, in UTC.", "type": [ "string", "null" ] } }, "required": [ "symbol", "status" ], "type": "object" }, { "type": "null" } ] }, "specification": { "anyOf": [ { "additionalProperties": {}, "properties": {}, "type": "object" }, { "type": "null" } ] }, "symbol": { "type": "string" }, "unavailable": { "items": { "type": "string" }, "type": "array" } }, "required": [ "symbol", "specification", "quote", "market", "margin", "unavailable" ], "type": "object" } }, { "description": "This month's usage against the plan, and its cost so far in minor units (9900 is $99.00). Over quota opening is refused, closing never is. Example: {}", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "response_format": { "description": "concise (default): what a next step needs. detailed: every field the API returns.", "enum": [ "concise", "detailed" ], "type": "string" } }, "type": "object" }, "name": "get_usage", "outputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": {}, "properties": { "plan": { "type": "string" }, "usage": { "additionalProperties": {}, "propertyNames": { "type": "string" }, "type": "object" } }, "required": [ "plan", "usage" ], "type": "object" } }, { "description": "This connection's workspace: its plan, the plan's limits and features, and whether trading is switched off. Call it first when unsure what the user can do. Example: {}", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "response_format": { "description": "concise (default): what a next step needs. detailed: every field the API returns.", "enum": [ "concise", "detailed" ], "type": "string" } }, "type": "object" }, "name": "get_workspace", "outputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "properties": { "entitlements": { "anyOf": [ { "additionalProperties": {}, "propertyNames": { "type": "string" }, "type": "object" }, { "type": "null" } ] }, "features": { "anyOf": [ { "additionalProperties": {}, "propertyNames": { "type": "string" }, "type": "object" }, { "type": "null" } ] }, "workspace": { "additionalProperties": {}, "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "plan": { "type": "string" }, "planName": { "type": "string" }, "tradingDisabled": { "type": "boolean" } }, "required": [ "id", "name", "plan", "planName", "tradingDisabled" ], "type": "object" } }, "required": [ "workspace", "entitlements", "features" ], "type": "object" } }, { "description": "Each instrument's symbol on this account's broker: mapped, ambiguous (with candidates) or missing. Trade the mapped symbol. Example: {\"account_id\": \"<id>\", \"query\": \"XAU\"}", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "account_id": { "description": "The fxapis account id (a UUID) from list_accounts — not the MT5 login number.", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" }, "cursor": { "description": "next_cursor from the previous page.", "maxLength": 200, "type": "string" }, "limit": { "description": "Items per page, 1–100. Default 25.", "maximum": 100, "minimum": 1, "type": "integer" }, "query": { "description": "Only instruments or symbols containing this, e.g. XAU.", "maxLength": 32, "minLength": 1, "type": "string" }, "response_format": { "description": "concise (default): what a next step needs. detailed: every field the API returns.", "enum": [ "concise", "detailed" ], "type": "string" } }, "required": [ "account_id" ], "type": "object" }, "name": "list_account_instruments", "outputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": {}, "properties": { "hint": { "type": "string" }, "items": { "items": { "additionalProperties": {}, "properties": { "instrument": { "type": "string" }, "status": { "type": "string" }, "symbol": { "type": [ "string", "null" ] } }, "required": [ "instrument", "status" ], "type": "object" }, "type": "array" }, "next_cursor": { "description": "Pass as cursor for the next page; null on the last.", "type": [ "string", "null" ] }, "total": { "type": [ "number", "null" ] }, "truncated": { "type": "boolean" } }, "required": [ "items", "next_cursor", "total" ], "type": "object" } }, { "description": "The workspace's MT5 accounts with id, login, server, state and environment (demo or live); use the id, not the login, everywhere else. Only `ready` accounts trade, so bring the others online first. Example: {\"limit\": 25}", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "cursor": { "description": "next_cursor from the previous page.", "maxLength": 200, "type": "string" }, "limit": { "description": "Items per page, 1–100. Default 25.", "maximum": 100, "minimum": 1, "type": "integer" }, "response_format": { "description": "concise (default): what a next step needs. detailed: every field the API returns.", "enum": [ "concise", "detailed" ], "type": "string" } }, "type": "object" }, "name": "list_accounts", "outputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": {}, "properties": { "hint": { "type": "string" }, "items": { "items": { "additionalProperties": {}, "properties": { "environment": { "description": "demo, contest or live.", "type": [ "string", "null" ] }, "id": { "type": "string" }, "label": { "type": [ "string", "null" ] }, "login": { "type": [ "string", "null" ] }, "server": { "type": [ "string", "null" ] }, "state": { "description": "One of: created, provisioning, standby, starting, connecting, synchronizing, ready, executing, cooling, offline, degraded, reconnecting, invalid_credentials, trading_disabled, needs_2fa, needs_certificate, error. Only `ready` can trade.", "type": [ "string", "null" ] }, "tradingDisabled": { "type": [ "boolean", "null" ] } }, "required": [ "id" ], "type": "object" }, "type": "array" }, "next_cursor": { "description": "Pass as cursor for the next page; null on the last.", "type": [ "string", "null" ] }, "total": { "type": [ "number", "null" ] }, "truncated": { "type": "boolean" } }, "required": [ "items", "next_cursor", "total" ], "type": "object" } }, { "description": "An account's deal history as the broker recorded it, newest first, including stops that fired, swaps and manual trades. Realised profit is here. Example: {\"account_id\": \"<id>\", \"since\": \"2026-10-01T00:00:00Z\"}", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "account_id": { "description": "The fxapis account id (a UUID) from list_accounts — not the MT5 login number.", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" }, "cursor": { "description": "`nextCursor` from the previous page.", "type": "string" }, "limit": { "description": "Rows per page, 1–200. Default 25.", "maximum": 200, "minimum": 1, "type": "integer" }, "response_format": { "description": "concise (default): what a next step needs. detailed: every field the API returns.", "enum": [ "concise", "detailed" ], "type": "string" }, "since": { "description": "ISO 8601 date-time; only rows at or after it.", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" }, "symbol": { "description": "The symbol exactly as this broker names it, e.g. \"EURUSD\" — some brokers add a suffix such as \"EURUSD.r\".", "maxLength": 32, "minLength": 1, "type": "string" }, "until": { "description": "ISO 8601 date-time; only rows at or before it.", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" } }, "required": [ "account_id" ], "type": "object" }, "name": "list_deals", "outputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": {}, "properties": { "hint": { "type": "string" }, "items": { "items": { "additionalProperties": {}, "properties": { "brokerDealId": { "type": "string" }, "dealType": { "type": [ "string", "null" ] }, "dealtAt": { "type": [ "string", "null" ] }, "profit": { "type": [ "string", "null" ] }, "symbol": { "type": [ "string", "null" ] }, "volume": { "type": [ "string", "null" ] } }, "required": [ "brokerDealId" ], "type": "object" }, "type": "array" }, "next_cursor": { "description": "Pass as cursor for the next page; null on the last.", "type": [ "string", "null" ] }, "total": { "type": [ "number", "null" ] }, "truncated": { "type": "boolean" } }, "required": [ "items", "next_cursor", "total" ], "type": "object" } }, { "description": "Markets named once (XAUUSD, US30, BTCUSD) whatever each broker calls them. list_account_instruments gives one account's own symbol for each. Example: {\"category\": \"metals\"}", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "category": { "description": "Only this category.", "enum": [ "forex", "metals", "indices", "energies", "crypto" ], "type": "string" }, "response_format": { "description": "concise (default): what a next step needs. detailed: every field the API returns.", "enum": [ "concise", "detailed" ], "type": "string" } }, "type": "object" }, "name": "list_instruments", "outputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "properties": { "instruments": { "items": { "additionalProperties": false, "properties": { "category": { "type": "string" }, "instrument": { "type": "string" }, "name": { "type": "string" } }, "required": [ "instrument", "name", "category" ], "type": "object" }, "type": "array" } }, "required": [ "instruments" ], "type": "object" } }, { "description": "Recent multi-account orders (one trade on many accounts), each with its per-account result. Pages with limit and cursor. Example: {}", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "cursor": { "description": "next_cursor from the previous page.", "maxLength": 200, "type": "string" }, "limit": { "description": "Items per page, 1–100. Default 25.", "maximum": 100, "minimum": 1, "type": "integer" }, "response_format": { "description": "concise (default): what a next step needs. detailed: every field the API returns.", "enum": [ "concise", "detailed" ], "type": "string" } }, "type": "object" }, "name": "list_multi_account_orders", "outputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": {}, "properties": { "hint": { "type": "string" }, "items": { "items": { "additionalProperties": {}, "properties": { "id": { "type": "string" }, "legs": { "anyOf": [ { "items": { "additionalProperties": {}, "properties": { "accountId": { "type": "string" }, "state": { "type": "string" } }, "required": [ "accountId", "state" ], "type": "object" }, "type": "array" }, { "type": "null" } ], "description": "Concise: only the accounts not filled." }, "side": { "type": [ "string", "null" ] }, "state": { "description": "planned → preparing → armed → releasing → settled; or cancelled / abandoned (nothing sent).", "type": [ "string", "null" ] }, "summary": { "anyOf": [ { "additionalProperties": {}, "properties": { "filled": { "type": "number" }, "rejected": { "type": "number" }, "skipped": { "type": "number" }, "total": { "type": "number" }, "unresolved": { "type": "number" } }, "required": [ "total", "filled", "rejected", "skipped", "unresolved" ], "type": "object" }, { "type": "null" } ] } }, "required": [ "id" ], "type": "object" }, "type": "array" }, "next_cursor": { "description": "Pass as cursor for the next page; null on the last.", "type": [ "string", "null" ] }, "total": { "type": [ "number", "null" ] }, "truncated": { "type": "boolean" } }, "required": [ "items", "next_cursor", "total" ], "type": "object" } }, { "description": "Orders placed through fxapis, newest first, for one account or all; state `unknown` means still being confirmed, so never resend those. Pages with cursor. Example: {\"state\": \"unknown\"}", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "account_id": { "description": "The fxapis account id (a UUID) from list_accounts — not the MT5 login number.", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" }, "cursor": { "description": "`nextCursor` from the previous page.", "type": "string" }, "limit": { "description": "Rows per page, 1–200. Default 25.", "maximum": 200, "minimum": 1, "type": "integer" }, "response_format": { "description": "concise (default): what a next step needs. detailed: every field the API returns.", "enum": [ "concise", "detailed" ], "type": "string" }, "since": { "description": "ISO 8601 date-time; only rows at or after it.", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" }, "state": { "description": "Only orders in this state.", "enum": [ "accepted", "validating", "sending", "working", "completed", "filled", "partially_filled", "rejected", "failed", "unknown", "cancelled", "expired" ], "type": "string" }, "symbol": { "description": "The symbol exactly as this broker names it, e.g. \"EURUSD\" — some brokers add a suffix such as \"EURUSD.r\".", "maxLength": 32, "minLength": 1, "type": "string" }, "until": { "description": "ISO 8601 date-time; only rows at or before it.", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" } }, "type": "object" }, "name": "list_orders", "outputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": {}, "properties": { "hint": { "type": "string" }, "items": { "items": { "additionalProperties": {}, "properties": { "accountId": { "type": [ "string", "null" ] }, "brokerPositionId": { "type": [ "string", "null" ] }, "filledPrice": { "type": [ "string", "null" ] }, "filledVolume": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "needsReconciliation": { "description": "True while fxapis is confirming the result with the broker. Never resend such an order; poll get_order.", "type": [ "boolean", "null" ] }, "retcodeText": { "type": [ "string", "null" ] }, "side": { "type": [ "string", "null" ] }, "state": { "description": "One of: accepted, validating, sending, working, completed, filled, partially_filled, rejected, failed, unknown, cancelled, expired.", "type": [ "string", "null" ] }, "symbol": { "type": [ "string", "null" ] } }, "required": [ "id" ], "type": "object" }, "type": "array" }, "next_cursor": { "description": "Pass as cursor for the next page; null on the last.", "type": [ "string", "null" ] }, "total": { "type": [ "number", "null" ] }, "truncated": { "type": "boolean" } }, "required": [ "items", "next_cursor", "total" ], "type": "object" } }, { "description": "Open positions on one account as last observed; brokerPositionId is what close_position and modify_position take. Pages with limit and cursor. Example: {\"account_id\": \"<id>\"}", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "account_id": { "description": "The fxapis account id (a UUID) from list_accounts — not the MT5 login number.", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" }, "cursor": { "description": "next_cursor from the previous page.", "maxLength": 200, "type": "string" }, "include_closed": { "description": "Also return positions that have closed. Default false.", "type": "boolean" }, "limit": { "description": "Items per page, 1–100. Default 25.", "maximum": 100, "minimum": 1, "type": "integer" }, "response_format": { "description": "concise (default): what a next step needs. detailed: every field the API returns.", "enum": [ "concise", "detailed" ], "type": "string" } }, "required": [ "account_id" ], "type": "object" }, "name": "list_positions", "outputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": {}, "properties": { "hint": { "type": "string" }, "items": { "items": { "additionalProperties": {}, "properties": { "brokerPositionId": { "description": "The position ticket. Pass this as position_id to close_position or modify_position.", "type": "string" }, "profit": { "type": [ "string", "null" ] }, "side": { "type": [ "string", "null" ] }, "symbol": { "type": [ "string", "null" ] }, "volume": { "type": [ "string", "null" ] } }, "required": [ "brokerPositionId" ], "type": "object" }, "type": "array" }, "next_cursor": { "description": "Pass as cursor for the next page; null on the last.", "type": [ "string", "null" ] }, "total": { "type": [ "number", "null" ] }, "truncated": { "type": "boolean" } }, "required": [ "items", "next_cursor", "total" ], "type": "object" } }, { "description": "Moves a position's stop loss or take profit on the user's real broker account (or demo); null removes a level. Remove a stop loss only when the user asks. Example: {\"account_id\": \"<id>\", \"position_id\": \"<brokerPositionId>\", \"stop_loss\": \"1.08000\", \"idempotency_key\": \"<new uuid>\"}", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "account_id": { "description": "The fxapis account id (a UUID) from list_accounts — not the MT5 login number.", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" }, "idempotency_key": { "description": "A unique string you generate for THIS action, e.g. a fresh UUID. If a call fails or times out and you retry the same action, send the SAME key: fxapis then returns the first result instead of acting twice. Use a new key only for a genuinely new action.", "maxLength": 200, "minLength": 8, "type": "string" }, "position_id": { "description": "The position ticket: `brokerPositionId` from list_positions.", "maxLength": 40, "minLength": 1, "type": "string" }, "stop_loss": { "anyOf": [ { "anyOf": [ { "pattern": "^\\d+(\\.\\d{1,8})?$", "type": "string" }, { "minimum": 0, "type": "number" } ], "description": "New stop loss; null removes it. An absolute price (e.g. \"1.08450\"), not a distance in pips or points." }, { "type": "null" } ] }, "take_profit": { "anyOf": [ { "anyOf": [ { "pattern": "^\\d+(\\.\\d{1,8})?$", "type": "string" }, { "minimum": 0, "type": "number" } ], "description": "New take profit; null removes it. An absolute price (e.g. \"1.08450\"), not a distance in pips or points." }, { "type": "null" } ] } }, "required": [ "account_id", "position_id", "idempotency_key" ], "type": "object" }, "name": "modify_position", "outputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "properties": { "order": { "additionalProperties": {}, "properties": { "accountId": { "type": [ "string", "null" ] }, "brokerPositionId": { "type": [ "string", "null" ] }, "filledPrice": { "type": [ "string", "null" ] }, "filledVolume": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "needsReconciliation": { "description": "True while fxapis is confirming the result with the broker. Never resend such an order; poll get_order.", "type": [ "boolean", "null" ] }, "retcodeText": { "type": [ "string", "null" ] }, "side": { "type": [ "string", "null" ] }, "state": { "description": "One of: accepted, validating, sending, working, completed, filled, partially_filled, rejected, failed, unknown, cancelled, expired.", "type": [ "string", "null" ] }, "symbol": { "type": [ "string", "null" ] } }, "required": [ "id" ], "type": "object" } }, "required": [ "order" ], "type": "object" } }, { "description": "Opens a position at market on the user's real broker account (or demo) and waits for the broker; confirm account, symbol, side and volume with the user first. On ORDER_UNRESOLVED never resend, poll get_order. Example: {\"account_id\": \"<id>\", \"symbol\": \"EURUSD\", \"side\": \"buy\", \"volume\": \"0.10\", \"idempotency_key\": \"<new uuid>\"}", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "account_id": { "description": "The fxapis account id (a UUID) from list_accounts — not the MT5 login number.", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" }, "client_order_id": { "description": "Optional reference of your own, echoed back on the order.", "maxLength": 120, "type": "string" }, "comment": { "description": "Optional note stored on the order. MT5 keeps the first 17 characters after our reference.", "maxLength": 120, "type": "string" }, "deviation_points": { "description": "Maximum slippage in points. Too small invites requotes.", "maximum": 10000, "minimum": 0, "type": "integer" }, "idempotency_key": { "description": "A unique string you generate for THIS action, e.g. a fresh UUID. If a call fails or times out and you retry the same action, send the SAME key: fxapis then returns the first result instead of acting twice. Use a new key only for a genuinely new action.", "maxLength": 200, "minLength": 8, "type": "string" }, "side": { "description": "buy or sell.", "enum": [ "buy", "sell" ], "type": "string" }, "stop_loss": { "anyOf": [ { "pattern": "^\\d+(\\.\\d{1,8})?$", "type": "string" }, { "minimum": 0, "type": "number" } ], "description": "Optional stop loss. Below entry for a buy, above for a sell. An absolute price (e.g. \"1.08450\"), not a distance in pips or points." }, "symbol": { "description": "The symbol exactly as this broker names it, e.g. \"EURUSD\" — some brokers add a suffix such as \"EURUSD.r\".", "maxLength": 32, "minLength": 1, "type": "string" }, "take_profit": { "anyOf": [ { "pattern": "^\\d+(\\.\\d{1,8})?$", "type": "string" }, { "minimum": 0, "type": "number" } ], "description": "Optional take profit. Above entry for a buy, below for a sell. An absolute price (e.g. \"1.08450\"), not a distance in pips or points." }, "volume": { "anyOf": [ { "pattern": "^\\d+(\\.\\d{1,8})?$", "type": "string" }, { "minimum": 0, "type": "number" } ], "description": "Order size. In lots, preferably as a string: \"0.01\" is a micro lot, \"1.00\" a standard lot." } }, "required": [ "account_id", "symbol", "side", "volume", "idempotency_key" ], "type": "object" }, "name": "place_market_order", "outputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "properties": { "order": { "additionalProperties": {}, "properties": { "accountId": { "type": [ "string", "null" ] }, "brokerPositionId": { "type": [ "string", "null" ] }, "filledPrice": { "type": [ "string", "null" ] }, "filledVolume": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "needsReconciliation": { "description": "True while fxapis is confirming the result with the broker. Never resend such an order; poll get_order.", "type": [ "boolean", "null" ] }, "retcodeText": { "type": [ "string", "null" ] }, "side": { "type": [ "string", "null" ] }, "state": { "description": "One of: accepted, validating, sending, working, completed, filled, partially_filled, rejected, failed, unknown, cancelled, expired.", "type": [ "string", "null" ] }, "symbol": { "type": [ "string", "null" ] } }, "required": [ "id" ], "type": "object" } }, "required": [ "order" ], "type": "object" } }, { "description": "Places the same market order on many of the user's real broker accounts (or demo) at once and returns at once; follow it with get_multi_account_order. Confirm the accounts, symbol, side and volume with the user first. Example: {\"account_ids\": [\"<id>\", \"<id>\"], \"instrument\": \"XAUUSD\", \"side\": \"buy\", \"volume\": \"0.01\", \"idempotency_key\": \"<new uuid>\"}", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "account_ids": { "description": "The accounts to trade on, one order each.", "items": { "description": "The fxapis account id (a UUID) from list_accounts — not the MT5 login number.", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" }, "maxItems": 1000, "minItems": 1, "type": "array" }, "barrier_policy": { "description": "When some accounts are not online in time: release-ready (default) trades on those that are; all-or-nothing trades on none unless all are; wait keeps waiting until expires_at.", "enum": [ "release-ready", "all-or-nothing", "wait" ], "type": "string" }, "comment": { "description": "Optional note stored on the order. MT5 keeps the first 17 characters after our reference.", "maxLength": 120, "type": "string" }, "execute_at": { "description": "When to send. Omit to send as soon as every account is online.", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" }, "expires_at": { "description": "Stop waiting for accounts after this.", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" }, "idempotency_key": { "description": "A unique string you generate for THIS action, e.g. a fresh UUID. If a call fails or times out and you retry the same action, send the SAME key: fxapis then returns the first result instead of acting twice. Use a new key only for a genuinely new action.", "maxLength": 200, "minLength": 8, "type": "string" }, "instrument": { "description": "Instead of symbol: an instrument from list_instruments, e.g. XAUUSD. Each account trades its own broker's symbol for it; the whole order is refused if any account's broker does not offer it.", "maxLength": 32, "minLength": 1, "type": "string" }, "label": { "description": "A name for this multi-account order.", "maxLength": 120, "type": "string" }, "side": { "description": "buy or sell.", "enum": [ "buy", "sell" ], "type": "string" }, "stop_loss": { "anyOf": [ { "pattern": "^\\d+(\\.\\d{1,8})?$", "type": "string" }, { "minimum": 0, "type": "number" } ], "description": "Optional stop loss for every account. An absolute price (e.g. \"1.08450\"), not a distance in pips or points." }, "symbol": { "description": "The symbol exactly as this broker names it, e.g. \"EURUSD\" — some brokers add a suffix such as \"EURUSD.r\".", "maxLength": 32, "minLength": 1, "type": "string" }, "take_profit": { "anyOf": [ { "pattern": "^\\d+(\\.\\d{1,8})?$", "type": "string" }, { "minimum": 0, "type": "number" } ], "description": "Optional take profit for every account. An absolute price (e.g. \"1.08450\"), not a distance in pips or points." }, "volume": { "anyOf": [ { "pattern": "^\\d+(\\.\\d{1,8})?$", "type": "string" }, { "minimum": 0, "type": "number" } ], "description": "Size per account, unless weights overrides it for an account. In lots, preferably as a string: \"0.01\" is a micro lot, \"1.00\" a standard lot." }, "weights": { "additionalProperties": { "anyOf": [ { "pattern": "^\\d+(\\.\\d{1,8})?$", "type": "string" }, { "minimum": 0, "type": "number" } ] }, "description": "Optional per-account size, keyed by account id, e.g. {\"<account id>\": \"0.05\"}.", "propertyNames": { "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" }, "type": "object" } }, "required": [ "account_ids", "side", "volume", "idempotency_key" ], "type": "object" }, "name": "place_multi_account_order", "outputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "properties": { "multi_account_order": { "additionalProperties": {}, "properties": { "id": { "type": "string" }, "legs": { "anyOf": [ { "items": { "additionalProperties": {}, "properties": { "accountId": { "type": "string" }, "state": { "type": "string" } }, "required": [ "accountId", "state" ], "type": "object" }, "type": "array" }, { "type": "null" } ], "description": "Concise: only the accounts not filled." }, "side": { "type": [ "string", "null" ] }, "state": { "description": "planned → preparing → armed → releasing → settled; or cancelled / abandoned (nothing sent).", "type": [ "string", "null" ] }, "summary": { "anyOf": [ { "additionalProperties": {}, "properties": { "filled": { "type": "number" }, "rejected": { "type": "number" }, "skipped": { "type": "number" }, "total": { "type": "number" }, "unresolved": { "type": "number" } }, "required": [ "total", "filled", "rejected", "skipped", "unresolved" ], "type": "object" }, { "type": "null" } ] } }, "required": [ "id" ], "type": "object" } }, "required": [ "multi_account_order" ], "type": "object" } }, { "description": "Places a limit or stop order on the user's real broker account (or demo) that waits at the broker; success means working, not filled. Confirm it with the user first. Example: {\"account_id\": \"<id>\", \"symbol\": \"EURUSD\", \"side\": \"buy\", \"kind\": \"limit\", \"volume\": \"0.10\", \"price\": \"1.08000\", \"idempotency_key\": \"<new uuid>\"}", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "account_id": { "description": "The fxapis account id (a UUID) from list_accounts — not the MT5 login number.", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" }, "client_order_id": { "description": "Optional reference of your own, echoed back on the order.", "maxLength": 120, "type": "string" }, "comment": { "description": "Optional note stored on the order. MT5 keeps the first 17 characters after our reference.", "maxLength": 120, "type": "string" }, "expires_at": { "description": "When the broker should drop it. Omit for good-till-cancelled.", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" }, "idempotency_key": { "description": "A unique string you generate for THIS action, e.g. a fresh UUID. If a call fails or times out and you retry the same action, send the SAME key: fxapis then returns the first result instead of acting twice. Use a new key only for a genuinely new action.", "maxLength": 200, "minLength": 8, "type": "string" }, "kind": { "description": "limit, stop or stop_limit.", "enum": [ "limit", "stop", "stop_limit" ], "type": "string" }, "price": { "anyOf": [ { "pattern": "^\\d+(\\.\\d{1,8})?$", "type": "string" }, { "minimum": 0, "type": "number" } ], "description": "The price the order waits at. An absolute price (e.g. \"1.08450\"), not a distance in pips or points." }, "side": { "description": "buy or sell.", "enum": [ "buy", "sell" ], "type": "string" }, "stop_limit_price": { "anyOf": [ { "pattern": "^\\d+(\\.\\d{1,8})?$", "type": "string" }, { "minimum": 0, "type": "number" } ], "description": "Required for stop_limit: the limit placed once the stop triggers. An absolute price (e.g. \"1.08450\"), not a distance in pips or points." }, "stop_loss": { "anyOf": [ { "pattern": "^\\d+(\\.\\d{1,8})?$", "type": "string" }, { "minimum": 0, "type": "number" } ], "description": "Optional stop loss. An absolute price (e.g. \"1.08450\"), not a distance in pips or points." }, "symbol": { "description": "The symbol exactly as this broker names it, e.g. \"EURUSD\" — some brokers add a suffix such as \"EURUSD.r\".", "maxLength": 32, "minLength": 1, "type": "string" }, "take_profit": { "anyOf": [ { "pattern": "^\\d+(\\.\\d{1,8})?$", "type": "string" }, { "minimum": 0, "type": "number" } ], "description": "Optional take profit. An absolute price (e.g. \"1.08450\"), not a distance in pips or points." }, "volume": { "anyOf": [ { "pattern": "^\\d+(\\.\\d{1,8})?$", "type": "string" }, { "minimum": 0, "type": "number" } ], "description": "Order size. In lots, preferably as a string: \"0.01\" is a micro lot, \"1.00\" a standard lot." } }, "required": [ "account_id", "symbol", "side", "kind", "volume", "price", "idempotency_key" ], "type": "object" }, "name": "place_pending_order", "outputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "properties": { "order": { "additionalProperties": {}, "properties": { "accountId": { "type": [ "string", "null" ] }, "brokerPositionId": { "type": [ "string", "null" ] }, "filledPrice": { "type": [ "string", "null" ] }, "filledVolume": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "needsReconciliation": { "description": "True while fxapis is confirming the result with the broker. Never resend such an order; poll get_order.", "type": [ "boolean", "null" ] }, "retcodeText": { "type": [ "string", "null" ] }, "side": { "type": [ "string", "null" ] }, "state": { "description": "One of: accepted, validating, sending, working, completed, filled, partially_filled, rejected, failed, unknown, cancelled, expired.", "type": [ "string", "null" ] }, "symbol": { "type": [ "string", "null" ] } }, "required": [ "id" ], "type": "object" } }, "required": [ "order" ], "type": "object" } }, { "description": "MT5 broker servers matching a broker or server name, servers seen working on fxapis first. A server not listed can still be used. Example: {\"query\": \"icmarkets\"}", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "query": { "description": "A broker's name or the start of a server name, e.g. 'justmarkets' or 'VantageInternational-Live'.", "maxLength": 64, "minLength": 2, "type": "string" }, "response_format": { "description": "concise (default): what a next step needs. detailed: every field the API returns.", "enum": [ "concise", "detailed" ], "type": "string" } }, "required": [ "query" ], "type": "object" }, "name": "search_broker_servers", "outputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "properties": { "servers": { "items": { "additionalProperties": false, "properties": { "company": { "type": [ "string", "null" ] }, "kind": { "type": "string" }, "name": { "type": "string" }, "proven": { "type": "boolean" } }, "required": [ "name", "company", "kind", "proven" ], "type": "object" }, "type": "array" } }, "required": [ "servers" ], "type": "object" } }, { "description": "Stops an account's terminal; open positions and their stops stay at the broker. Refused while an order is in flight. Example: {\"account_id\": \"<id>\"}", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "account_id": { "description": "The fxapis account id (a UUID) from list_accounts — not the MT5 login number.", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" } }, "required": [ "account_id" ], "type": "object" }, "name": "take_account_offline", "outputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "properties": { "result": { "additionalProperties": {}, "properties": { "accountId": { "type": "string" }, "state": { "type": "string" }, "stopped": { "type": "boolean" } }, "required": [ "accountId", "stopped", "state" ], "type": "object" } }, "required": [ "result" ], "type": "object" } } ] }
Verify it yourselfcurl -s https://api.teppi.xyz/v1/evidence/sha256:a2b09d2fa82898213e9ac7e616d8c236cf642ff7fcc5824347fee5ad67f537b9 | sha256sum