{ "info": { "name": "Tickwire API", "description": "Generated from the Tickwire OpenAPI document (version 0.1.0). Set apiKey to a sandbox key (twsk_…) and baseUrl to the sandbox URL to experiment safely; set accountId to one of your accounts.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "variable": [ { "key": "baseUrl", "value": "https://api.tickwire.io" }, { "key": "apiKey", "value": "YOUR_API_KEY" }, { "key": "agentKey", "value": "YOUR_AGENT_KEY" }, { "key": "accountId", "value": "YOUR_ACCOUNT_ID" } ], "item": [ { "name": "Account REST API (/users/current)", "item": [ { "name": "Accounts and provisioning", "item": [ { "name": "List Accounts (GET /users/current/accounts)", "request": { "method": "GET", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/current/accounts", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "accounts" ], "query": [ { "key": "offset", "value": "0", "disabled": true }, { "key": "limit", "value": "1000", "disabled": true }, { "key": "version", "value": "1", "disabled": true }, { "key": "type", "value": "string", "disabled": true }, { "key": "state", "value": "string", "disabled": true }, { "key": "connectionStatus", "value": "string", "disabled": true }, { "key": "deploymentStatus", "value": "deployed", "disabled": true }, { "key": "query", "value": "string", "disabled": true }, { "key": "provisioningProfileId", "value": "YOUR_ACCOUNT_ID", "disabled": true }, { "key": "region", "value": "eu", "disabled": true }, { "key": "tags", "value": "string", "disabled": true }, { "key": "sortOrder", "value": "asc", "disabled": true } ] }, "description": "Reference: /docs/reference/provisioning/#get-users-current-accounts" } }, { "name": "Create Account (POST /users/current/accounts)", "request": { "method": "POST", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/current/accounts", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "accounts" ] }, "description": "Reference: /docs/reference/provisioning/#post-users-current-accounts", "body": { "mode": "raw", "raw": "{\n \"name\": \"example\",\n \"server\": \"Tickwire-Sandbox\",\n \"magic\": 0,\n \"manualTrades\": false,\n \"quoteStreamingIntervalInSeconds\": 2.5,\n \"reliability\": \"regular\",\n \"resourceSlots\": 1,\n \"copyFactoryResourceSlots\": 1,\n \"type\": \"cloud-g2\",\n \"riskManagementApiEnabled\": false,\n \"metastatsApiEnabled\": false\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Account (GET /users/current/accounts/{account_id})", "request": { "method": "GET", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/current/accounts/{{accountId}}", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "accounts", "{{accountId}}" ] }, "description": "Reference: /docs/reference/provisioning/#get-users-current-accounts-account-id" } }, { "name": "Update Account (PUT /users/current/accounts/{account_id})", "request": { "method": "PUT", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/current/accounts/{{accountId}}", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "accounts", "{{accountId}}" ] }, "description": "Reference: /docs/reference/provisioning/#put-users-current-accounts-account-id", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Account (DELETE /users/current/accounts/{account_id})", "request": { "method": "DELETE", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" } ], "url": { "raw": "{{baseUrl}}/users/current/accounts/{{accountId}}", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "accounts", "{{accountId}}" ], "query": [ { "key": "executeForAllReplicas", "value": "false", "disabled": true } ] }, "description": "Reference: /docs/reference/provisioning/#delete-users-current-accounts-account-id" } }, { "name": "Set Credentials (PUT /users/current/accounts/{account_id}/credentials)", "request": { "method": "PUT", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/current/accounts/{{accountId}}/credentials", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "accounts", "{{accountId}}", "credentials" ] }, "description": "Reference: /docs/reference/provisioning/#put-users-current-accounts-account-id-credentials", "body": { "mode": "raw", "raw": "{\n \"password\": \"YOUR_PASSWORD\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Deploy (POST /users/current/accounts/{account_id}/deploy)", "request": { "method": "POST", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" } ], "url": { "raw": "{{baseUrl}}/users/current/accounts/{{accountId}}/deploy", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "accounts", "{{accountId}}", "deploy" ], "query": [ { "key": "executeForAllReplicas", "value": "true", "disabled": true } ] }, "description": "Reference: /docs/reference/provisioning/#post-users-current-accounts-account-id-deploy" } }, { "name": "Enable Account Features (POST /users/current/accounts/{account_id}/enable-account-features)", "request": { "method": "POST", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/current/accounts/{{accountId}}/enable-account-features", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "accounts", "{{accountId}}", "enable-account-features" ] }, "description": "Reference: /docs/reference/provisioning/#post-users-current-accounts-account-id-enable-account-features", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Enable the copy trading API (POST /users/current/accounts/{account_id}/enable-copy-factory-api)", "request": { "method": "POST", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/current/accounts/{{accountId}}/enable-copy-factory-api", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "accounts", "{{accountId}}", "enable-copy-factory-api" ] }, "description": "Reference: /docs/reference/provisioning/#post-users-current-accounts-account-id-enable-copy-factory-api", "body": { "mode": "raw", "raw": "{\n \"copyFactoryRoles\": [\n \"PROVIDER\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Enable the trading statistics API (POST /users/current/accounts/{account_id}/enable-metastats-api)", "request": { "method": "POST", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" } ], "url": { "raw": "{{baseUrl}}/users/current/accounts/{{accountId}}/enable-metastats-api", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "accounts", "{{accountId}}", "enable-metastats-api" ] }, "description": "Reference: /docs/reference/provisioning/#post-users-current-accounts-account-id-enable-metastats-api" } }, { "name": "Enable Risk Management (POST /users/current/accounts/{account_id}/enable-risk-management-api)", "request": { "method": "POST", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" } ], "url": { "raw": "{{baseUrl}}/users/current/accounts/{{accountId}}/enable-risk-management-api", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "accounts", "{{accountId}}", "enable-risk-management-api" ] }, "description": "Reference: /docs/reference/provisioning/#post-users-current-accounts-account-id-enable-risk-management-api" } }, { "name": "Increase Reliability (POST /users/current/accounts/{account_id}/increase-reliability)", "request": { "method": "POST", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" } ], "url": { "raw": "{{baseUrl}}/users/current/accounts/{{accountId}}/increase-reliability", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "accounts", "{{accountId}}", "increase-reliability" ] }, "description": "Reference: /docs/reference/provisioning/#post-users-current-accounts-account-id-increase-reliability" } }, { "name": "Redeploy (POST /users/current/accounts/{account_id}/redeploy)", "request": { "method": "POST", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" } ], "url": { "raw": "{{baseUrl}}/users/current/accounts/{{accountId}}/redeploy", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "accounts", "{{accountId}}", "redeploy" ], "query": [ { "key": "executeForAllReplicas", "value": "true", "disabled": true } ] }, "description": "Reference: /docs/reference/provisioning/#post-users-current-accounts-account-id-redeploy" } }, { "name": "Undeploy (POST /users/current/accounts/{account_id}/undeploy)", "request": { "method": "POST", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" } ], "url": { "raw": "{{baseUrl}}/users/current/accounts/{{accountId}}/undeploy", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "accounts", "{{accountId}}", "undeploy" ], "query": [ { "key": "executeForAllReplicas", "value": "true", "disabled": true } ] }, "description": "Reference: /docs/reference/provisioning/#post-users-current-accounts-account-id-undeploy" } }, { "name": "List Profiles (GET /users/current/provisioning-profiles)", "request": { "method": "GET", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/current/provisioning-profiles", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "provisioning-profiles" ], "query": [ { "key": "version", "value": "1", "disabled": true }, { "key": "status", "value": "new", "disabled": true }, { "key": "type", "value": "mtTerminal", "disabled": true }, { "key": "query", "value": "string", "disabled": true }, { "key": "offset", "value": "0", "disabled": true }, { "key": "limit", "value": "1000", "disabled": true } ] }, "description": "Reference: /docs/reference/provisioning/#get-users-current-provisioning-profiles" } }, { "name": "Create Profile (POST /users/current/provisioning-profiles)", "request": { "method": "POST", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/current/provisioning-profiles", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "provisioning-profiles" ] }, "description": "Reference: /docs/reference/provisioning/#post-users-current-provisioning-profiles", "body": { "mode": "raw", "raw": "{\n \"name\": \"example\",\n \"version\": 4,\n \"brokerTimezone\": \"2026-09-01T00:00:00.000\",\n \"brokerDSTSwitchTimezone\": \"2026-09-01T00:00:00.000\",\n \"type\": \"mtTerminal\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Profile (GET /users/current/provisioning-profiles/{profile_id})", "request": { "method": "GET", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/current/provisioning-profiles/:profile_id", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "provisioning-profiles", ":profile_id" ], "variable": [ { "key": "profile_id", "value": "PROFILE_ID" } ] }, "description": "Reference: /docs/reference/provisioning/#get-users-current-provisioning-profiles-profile-id" } }, { "name": "Update Profile (PUT /users/current/provisioning-profiles/{profile_id})", "request": { "method": "PUT", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/current/provisioning-profiles/:profile_id", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "provisioning-profiles", ":profile_id" ], "variable": [ { "key": "profile_id", "value": "PROFILE_ID" } ] }, "description": "Reference: /docs/reference/provisioning/#put-users-current-provisioning-profiles-profile-id", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Profile (DELETE /users/current/provisioning-profiles/{profile_id})", "request": { "method": "DELETE", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" } ], "url": { "raw": "{{baseUrl}}/users/current/provisioning-profiles/:profile_id", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "provisioning-profiles", ":profile_id" ], "variable": [ { "key": "profile_id", "value": "PROFILE_ID" } ] }, "description": "Reference: /docs/reference/provisioning/#delete-users-current-provisioning-profiles-profile-id" } }, { "name": "Upload File (PUT /users/current/provisioning-profiles/{profile_id}/{file_name})", "request": { "method": "PUT", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" } ], "url": { "raw": "{{baseUrl}}/users/current/provisioning-profiles/:profile_id/:file_name", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "provisioning-profiles", ":profile_id", ":file_name" ], "variable": [ { "key": "profile_id", "value": "PROFILE_ID" }, { "key": "file_name", "value": "FILE_NAME" } ] }, "description": "Reference: /docs/reference/provisioning/#put-users-current-provisioning-profiles-profile-id-file-name" } } ] }, { "name": "Account state", "item": [ { "name": "Account Information (GET /users/current/accounts/{account_id}/account-information)", "request": { "method": "GET", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/current/accounts/{{accountId}}/account-information", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "accounts", "{{accountId}}", "account-information" ], "query": [ { "key": "refreshTerminalState", "value": "string", "disabled": true } ] }, "description": "Reference: /docs/reference/account-state/#get-users-current-accounts-account-id-account-information" } }, { "name": "Capabilities (GET /users/current/accounts/{account_id}/capabilities)", "request": { "method": "GET", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/current/accounts/{{accountId}}/capabilities", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "accounts", "{{accountId}}", "capabilities" ] }, "description": "Reference: /docs/reference/account-state/#get-users-current-accounts-account-id-capabilities" } }, { "name": "Orders (GET /users/current/accounts/{account_id}/orders)", "request": { "method": "GET", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/current/accounts/{{accountId}}/orders", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "accounts", "{{accountId}}", "orders" ], "query": [ { "key": "refreshTerminalState", "value": "string", "disabled": true } ] }, "description": "Reference: /docs/reference/account-state/#get-users-current-accounts-account-id-orders" } }, { "name": "Order (GET /users/current/accounts/{account_id}/orders/{order_id})", "request": { "method": "GET", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/current/accounts/{{accountId}}/orders/:order_id", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "accounts", "{{accountId}}", "orders", ":order_id" ], "query": [ { "key": "refreshTerminalState", "value": "string", "disabled": true } ], "variable": [ { "key": "order_id", "value": "ORDER_ID" } ] }, "description": "Reference: /docs/reference/account-state/#get-users-current-accounts-account-id-orders-order-id" } }, { "name": "Positions (GET /users/current/accounts/{account_id}/positions)", "request": { "method": "GET", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/current/accounts/{{accountId}}/positions", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "accounts", "{{accountId}}", "positions" ], "query": [ { "key": "refreshTerminalState", "value": "string", "disabled": true } ] }, "description": "Reference: /docs/reference/account-state/#get-users-current-accounts-account-id-positions" } }, { "name": "Position (GET /users/current/accounts/{account_id}/positions/{position_id})", "request": { "method": "GET", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/current/accounts/{{accountId}}/positions/:position_id", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "accounts", "{{accountId}}", "positions", ":position_id" ], "query": [ { "key": "refreshTerminalState", "value": "string", "disabled": true } ], "variable": [ { "key": "position_id", "value": "POSITION_ID" } ] }, "description": "Reference: /docs/reference/account-state/#get-users-current-accounts-account-id-positions-position-id" } }, { "name": "Server Time (GET /users/current/accounts/{account_id}/server-time)", "request": { "method": "GET", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/current/accounts/{{accountId}}/server-time", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "accounts", "{{accountId}}", "server-time" ], "query": [ { "key": "refresh", "value": "string", "disabled": true } ] }, "description": "Reference: /docs/reference/account-state/#get-users-current-accounts-account-id-server-time" } } ] }, { "name": "Market data", "item": [ { "name": "Historical Ticks (GET /users/current/accounts/{account_id}/historical-market-data/symbols/{symbol}/ticks)", "request": { "method": "GET", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/current/accounts/{{accountId}}/historical-market-data/symbols/:symbol/ticks", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "accounts", "{{accountId}}", "historical-market-data", "symbols", ":symbol", "ticks" ], "query": [ { "key": "startTime", "value": "2026-09-01T00:00:00.000", "disabled": true }, { "key": "offset", "value": "string", "disabled": true }, { "key": "limit", "value": "string", "disabled": true } ], "variable": [ { "key": "symbol", "value": "EURUSD" } ] }, "description": "Reference: /docs/reference/market-data/#get-users-current-accounts-account-id-historical-market-data-symbols-symbol-ticks" } }, { "name": "Historical Candles (GET /users/current/accounts/{account_id}/historical-market-data/symbols/{symbol}/timeframes/{timeframe}/candles)", "request": { "method": "GET", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/current/accounts/{{accountId}}/historical-market-data/symbols/:symbol/timeframes/:timeframe/candles", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "accounts", "{{accountId}}", "historical-market-data", "symbols", ":symbol", "timeframes", ":timeframe", "candles" ], "query": [ { "key": "startTime", "value": "2026-09-01T00:00:00.000", "disabled": true }, { "key": "limit", "value": "string", "disabled": true } ], "variable": [ { "key": "symbol", "value": "EURUSD" }, { "key": "timeframe", "value": "1h" } ] }, "description": "Reference: /docs/reference/market-data/#get-users-current-accounts-account-id-historical-market-data-symbols-symbol-timeframes-timeframe-candles" } }, { "name": "Symbols (GET /users/current/accounts/{account_id}/symbols)", "request": { "method": "GET", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/current/accounts/{{accountId}}/symbols", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "accounts", "{{accountId}}", "symbols" ] }, "description": "Reference: /docs/reference/market-data/#get-users-current-accounts-account-id-symbols" } }, { "name": "Current Book (GET /users/current/accounts/{account_id}/symbols/{symbol}/current-book)", "request": { "method": "GET", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/current/accounts/{{accountId}}/symbols/:symbol/current-book", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "accounts", "{{accountId}}", "symbols", ":symbol", "current-book" ], "query": [ { "key": "keepSubscription", "value": "string", "disabled": true } ], "variable": [ { "key": "symbol", "value": "EURUSD" } ] }, "description": "Reference: /docs/reference/market-data/#get-users-current-accounts-account-id-symbols-symbol-current-book" } }, { "name": "Current Candle (GET /users/current/accounts/{account_id}/symbols/{symbol}/current-candles/{timeframe})", "request": { "method": "GET", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/current/accounts/{{accountId}}/symbols/:symbol/current-candles/:timeframe", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "accounts", "{{accountId}}", "symbols", ":symbol", "current-candles", ":timeframe" ], "query": [ { "key": "keepSubscription", "value": "string", "disabled": true } ], "variable": [ { "key": "symbol", "value": "EURUSD" }, { "key": "timeframe", "value": "1h" } ] }, "description": "Reference: /docs/reference/market-data/#get-users-current-accounts-account-id-symbols-symbol-current-candles-timeframe" } }, { "name": "Current Price (GET /users/current/accounts/{account_id}/symbols/{symbol}/current-price)", "request": { "method": "GET", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/current/accounts/{{accountId}}/symbols/:symbol/current-price", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "accounts", "{{accountId}}", "symbols", ":symbol", "current-price" ], "query": [ { "key": "keepSubscription", "value": "string", "disabled": true } ], "variable": [ { "key": "symbol", "value": "EURUSD" } ] }, "description": "Reference: /docs/reference/market-data/#get-users-current-accounts-account-id-symbols-symbol-current-price" } }, { "name": "Current Tick (GET /users/current/accounts/{account_id}/symbols/{symbol}/current-tick)", "request": { "method": "GET", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/current/accounts/{{accountId}}/symbols/:symbol/current-tick", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "accounts", "{{accountId}}", "symbols", ":symbol", "current-tick" ], "query": [ { "key": "keepSubscription", "value": "string", "disabled": true } ], "variable": [ { "key": "symbol", "value": "EURUSD" } ] }, "description": "Reference: /docs/reference/market-data/#get-users-current-accounts-account-id-symbols-symbol-current-tick" } }, { "name": "Specification (GET /users/current/accounts/{account_id}/symbols/{symbol}/specification)", "request": { "method": "GET", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/current/accounts/{{accountId}}/symbols/:symbol/specification", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "accounts", "{{accountId}}", "symbols", ":symbol", "specification" ], "variable": [ { "key": "symbol", "value": "EURUSD" } ] }, "description": "Reference: /docs/reference/market-data/#get-users-current-accounts-account-id-symbols-symbol-specification" } }, { "name": "Unsubscribe (POST /users/current/accounts/{account_id}/symbols/{symbol}/unsubscribe)", "request": { "method": "POST", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" } ], "url": { "raw": "{{baseUrl}}/users/current/accounts/{{accountId}}/symbols/:symbol/unsubscribe", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "accounts", "{{accountId}}", "symbols", ":symbol", "unsubscribe" ], "variable": [ { "key": "symbol", "value": "EURUSD" } ] }, "description": "Reference: /docs/reference/market-data/#post-users-current-accounts-account-id-symbols-symbol-unsubscribe" } } ] }, { "name": "History", "item": [ { "name": "History Deals By Position (GET /users/current/accounts/{account_id}/history-deals/position/{position_id})", "request": { "method": "GET", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/current/accounts/{{accountId}}/history-deals/position/:position_id", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "accounts", "{{accountId}}", "history-deals", "position", ":position_id" ], "variable": [ { "key": "position_id", "value": "POSITION_ID" } ] }, "description": "Reference: /docs/reference/history/#get-users-current-accounts-account-id-history-deals-position-position-id" } }, { "name": "History Deals By Ticket (GET /users/current/accounts/{account_id}/history-deals/ticket/{ticket})", "request": { "method": "GET", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/current/accounts/{{accountId}}/history-deals/ticket/:ticket", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "accounts", "{{accountId}}", "history-deals", "ticket", ":ticket" ], "variable": [ { "key": "ticket", "value": "TICKET" } ] }, "description": "Reference: /docs/reference/history/#get-users-current-accounts-account-id-history-deals-ticket-ticket" } }, { "name": "History Deals By Time (GET /users/current/accounts/{account_id}/history-deals/time/{start_time}/{end_time})", "request": { "method": "GET", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/current/accounts/{{accountId}}/history-deals/time/:start_time/:end_time", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "accounts", "{{accountId}}", "history-deals", "time", ":start_time", ":end_time" ], "query": [ { "key": "offset", "value": "string", "disabled": true }, { "key": "limit", "value": "string", "disabled": true } ], "variable": [ { "key": "start_time", "value": "2026-09-01T00:00:00.000" }, { "key": "end_time", "value": "2026-09-02T00:00:00.000" } ] }, "description": "Reference: /docs/reference/history/#get-users-current-accounts-account-id-history-deals-time-start-time-end-time" } }, { "name": "History Orders By Position (GET /users/current/accounts/{account_id}/history-orders/position/{position_id})", "request": { "method": "GET", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/current/accounts/{{accountId}}/history-orders/position/:position_id", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "accounts", "{{accountId}}", "history-orders", "position", ":position_id" ], "variable": [ { "key": "position_id", "value": "POSITION_ID" } ] }, "description": "Reference: /docs/reference/history/#get-users-current-accounts-account-id-history-orders-position-position-id" } }, { "name": "History Orders By Ticket (GET /users/current/accounts/{account_id}/history-orders/ticket/{ticket})", "request": { "method": "GET", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/current/accounts/{{accountId}}/history-orders/ticket/:ticket", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "accounts", "{{accountId}}", "history-orders", "ticket", ":ticket" ], "variable": [ { "key": "ticket", "value": "TICKET" } ] }, "description": "Reference: /docs/reference/history/#get-users-current-accounts-account-id-history-orders-ticket-ticket" } }, { "name": "History Orders By Time (GET /users/current/accounts/{account_id}/history-orders/time/{start_time}/{end_time})", "request": { "method": "GET", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/current/accounts/{{accountId}}/history-orders/time/:start_time/:end_time", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "accounts", "{{accountId}}", "history-orders", "time", ":start_time", ":end_time" ], "query": [ { "key": "offset", "value": "string", "disabled": true }, { "key": "limit", "value": "string", "disabled": true } ], "variable": [ { "key": "start_time", "value": "2026-09-01T00:00:00.000" }, { "key": "end_time", "value": "2026-09-02T00:00:00.000" } ] }, "description": "Reference: /docs/reference/history/#get-users-current-accounts-account-id-history-orders-time-start-time-end-time" } } ] }, { "name": "Trading", "item": [ { "name": "Calculate Margin (POST /users/current/accounts/{account_id}/calculate-margin)", "request": { "method": "POST", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/current/accounts/{{accountId}}/calculate-margin", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "accounts", "{{accountId}}", "calculate-margin" ] }, "description": "Margin for an order: `{margin}`, or `{}` if not calculable.\n\nReference: /docs/reference/trading/#post-users-current-accounts-account-id-calculate-margin", "body": { "mode": "raw", "raw": "{\n \"symbol\": \"EURUSD\",\n \"type\": \"ORDER_TYPE_BUY\",\n \"volume\": 0.01,\n \"openPrice\": 1.1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Trade (POST /users/current/accounts/{account_id}/trade)", "request": { "method": "POST", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/current/accounts/{{accountId}}/trade", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "accounts", "{{accountId}}", "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`.\n\nReference: /docs/reference/trading/#post-users-current-accounts-account-id-trade", "body": { "mode": "raw", "raw": "{\n \"actionType\": \"ORDER_TYPE_BUY\",\n \"symbol\": \"EURUSD\",\n \"volume\": 0.01\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Trade Check (POST /users/current/accounts/{account_id}/trade/check)", "request": { "method": "POST", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/current/accounts/{{accountId}}/trade/check", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "accounts", "{{accountId}}", "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.\n\nReference: /docs/reference/trading/#post-users-current-accounts-account-id-trade-check", "body": { "mode": "raw", "raw": "{\n \"actionType\": \"ORDER_TYPE_BUY\",\n \"symbol\": \"EURUSD\",\n \"volume\": 0.01\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Trailing (GET /users/current/accounts/{account_id}/trailing-stop-losses)", "request": { "method": "GET", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/current/accounts/{{accountId}}/trailing-stop-losses", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "accounts", "{{accountId}}", "trailing-stop-losses" ] }, "description": "Trailing stop rules Tickwire runs for this account (`state`:\n`active` | `pending`; `pending` waits for its pending order to fill).\n\nReference: /docs/reference/trading/#get-users-current-accounts-account-id-trailing-stop-losses" } }, { "name": "Delete Trailing (DELETE /users/current/accounts/{account_id}/trailing-stop-losses/{position_id})", "request": { "method": "DELETE", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" } ], "url": { "raw": "{{baseUrl}}/users/current/accounts/{{accountId}}/trailing-stop-losses/:position_id", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "accounts", "{{accountId}}", "trailing-stop-losses", ":position_id" ], "variable": [ { "key": "position_id", "value": "POSITION_ID" } ] }, "description": "Stop trailing a position (the current SL stays where it is).\n\nReference: /docs/reference/trading/#delete-users-current-accounts-account-id-trailing-stop-losses-position-id" } } ] }, { "name": "Health, snapshot and audit trail", "item": [ { "name": "Account Audit (GET /users/current/accounts/{account_id}/audit)", "request": { "method": "GET", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/current/accounts/{{accountId}}/audit", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "accounts", "{{accountId}}", "audit" ], "query": [ { "key": "limit", "value": "100", "disabled": true } ] }, "description": "Reference: /docs/reference/account-health-audit/#get-users-current-accounts-account-id-audit" } }, { "name": "Account Health (GET /users/current/accounts/{account_id}/health)", "request": { "method": "GET", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/current/accounts/{{accountId}}/health", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "accounts", "{{accountId}}", "health" ] }, "description": "Reference: /docs/reference/account-health-audit/#get-users-current-accounts-account-id-health" } }, { "name": "Account Snapshot (GET /users/current/accounts/{account_id}/snapshot)", "request": { "method": "GET", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/current/accounts/{{accountId}}/snapshot", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "accounts", "{{accountId}}", "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.\n\nReference: /docs/reference/account-health-audit/#get-users-current-accounts-account-id-snapshot" } } ] }, { "name": "Tokens and discovery", "item": [ { "name": "Narrow Down (POST /users/current/narrow-down-auth-token)", "request": { "method": "POST", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" } ], "url": { "raw": "{{baseUrl}}/users/current/narrow-down-auth-token", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "narrow-down-auth-token" ], "query": [ { "key": "validity-in-hours", "value": "24", "disabled": true } ] }, "description": "Reference: /docs/reference/tokens-discovery/#post-users-current-narrow-down-auth-token" } }, { "name": "Regions (GET /users/current/regions)", "request": { "method": "GET", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/current/regions", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "regions" ] }, "description": "Reference: /docs/reference/tokens-discovery/#get-users-current-regions" } }, { "name": "Client Api Domain (GET /users/current/servers/mt-client-api)", "request": { "method": "GET", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/current/servers/mt-client-api", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "servers", "mt-client-api" ] }, "description": "Reference: /docs/reference/tokens-discovery/#get-users-current-servers-mt-client-api" } }, { "name": "List Tokens (GET /users/current/tokens)", "request": { "method": "GET", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/current/tokens", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "tokens" ] }, "description": "Reference: /docs/reference/tokens-discovery/#get-users-current-tokens" } }, { "name": "Create Token (POST /users/current/tokens)", "request": { "method": "POST", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/current/tokens", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "tokens" ] }, "description": "Reference: /docs/reference/tokens-discovery/#post-users-current-tokens", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"kind\": \"api\",\n \"readOnly\": false\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Token (GET /users/current/tokens/{token_id})", "request": { "method": "GET", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/current/tokens/:token_id", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "tokens", ":token_id" ], "variable": [ { "key": "token_id", "value": "TOKEN_ID" } ] }, "description": "Reference: /docs/reference/tokens-discovery/#get-users-current-tokens-token-id" } }, { "name": "Patch Token (PATCH /users/current/tokens/{token_id})", "request": { "method": "PATCH", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/current/tokens/:token_id", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "tokens", ":token_id" ], "variable": [ { "key": "token_id", "value": "TOKEN_ID" } ] }, "description": "Reference: /docs/reference/tokens-discovery/#patch-users-current-tokens-token-id", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Revoke Token (DELETE /users/current/tokens/{token_id})", "request": { "method": "DELETE", "header": [ { "key": "auth-token", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" } ], "url": { "raw": "{{baseUrl}}/users/current/tokens/:token_id", "host": [ "{{baseUrl}}" ], "path": [ "users", "current", "tokens", ":token_id" ], "variable": [ { "key": "token_id", "value": "TOKEN_ID" } ] }, "description": "Reference: /docs/reference/tokens-discovery/#delete-users-current-tokens-token-id" } }, { "name": "Access Rule Manifest (GET /v1/access-rule-manifest)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/access-rule-manifest", "host": [ "{{baseUrl}}" ], "path": [ "v1", "access-rule-manifest" ] }, "description": "Reference: /docs/reference/tokens-discovery/#get-v1-access-rule-manifest" } }, { "name": "Search Servers (GET /v1/known-mt-servers/{version}/search)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/known-mt-servers/:version/search", "host": [ "{{baseUrl}}" ], "path": [ "v1", "known-mt-servers", ":version", "search" ], "query": [ { "key": "query", "value": "", "disabled": true } ], "variable": [ { "key": "version", "value": "5" } ] }, "description": "Reference: /docs/reference/tokens-discovery/#get-v1-known-mt-servers-version-search" } } ] } ] }, { "name": "Terminal routes and batch orders", "item": [ { "name": "MT5 terminal", "item": [ { "name": "GET /mt5/{account_id}/AccountInfo (GET /mt5/{account_id}/AccountInfo)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/mt5/{{accountId}}/AccountInfo", "host": [ "{{baseUrl}}" ], "path": [ "mt5", "{{accountId}}", "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.\n\nReference: /docs/reference/mt5-terminal/#get-mt5-account-id-accountinfo" } }, { "name": "GET /mt5/{account_id}/AccountSummary (GET /mt5/{account_id}/AccountSummary)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/mt5/{{accountId}}/AccountSummary", "host": [ "{{baseUrl}}" ], "path": [ "mt5", "{{accountId}}", "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).\n\nReference: /docs/reference/mt5-terminal/#get-mt5-account-id-accountsummary" } }, { "name": "POST /mt5/{account_id}/CloseAll (POST /mt5/{account_id}/CloseAll)", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" } ], "url": { "raw": "{{baseUrl}}/mt5/{{accountId}}/CloseAll", "host": [ "{{baseUrl}}" ], "path": [ "mt5", "{{accountId}}", "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.\n\nReference: /docs/reference/mt5-terminal/#post-mt5-account-id-closeall" } }, { "name": "GET /mt5/{account_id}/OpenedOrders (GET /mt5/{account_id}/OpenedOrders)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/mt5/{{accountId}}/OpenedOrders", "host": [ "{{baseUrl}}" ], "path": [ "mt5", "{{accountId}}", "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.\n\nReference: /docs/reference/mt5-terminal/#get-mt5-account-id-openedorders" } }, { "name": "GET /mt5/{account_id}/OrderCalcMargin (GET /mt5/{account_id}/OrderCalcMargin)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/mt5/{{accountId}}/OrderCalcMargin", "host": [ "{{baseUrl}}" ], "path": [ "mt5", "{{accountId}}", "OrderCalcMargin" ] }, "description": "Margin (account currency) needed to open `volume` lots of `operation`\non `symbol` at `price`. Places nothing.\n\nReference: /docs/reference/mt5-terminal/#get-mt5-account-id-ordercalcmargin" } }, { "name": "GET /mt5/{account_id}/OrderCalcProfit (GET /mt5/{account_id}/OrderCalcProfit)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/mt5/{{accountId}}/OrderCalcProfit", "host": [ "{{baseUrl}}" ], "path": [ "mt5", "{{accountId}}", "OrderCalcProfit" ] }, "description": "Projected P/L (account currency) of `volume` lots from `priceOpen` to\n`priceClose`; pending operations count by direction only. Places nothing.\n\nReference: /docs/reference/mt5-terminal/#get-mt5-account-id-ordercalcprofit" } }, { "name": "POST /mt5/{account_id}/OrderClose (POST /mt5/{account_id}/OrderClose)", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" } ], "url": { "raw": "{{baseUrl}}/mt5/{{accountId}}/OrderClose", "host": [ "{{baseUrl}}" ], "path": [ "mt5", "{{accountId}}", "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.\n\nReference: /docs/reference/mt5-terminal/#post-mt5-account-id-orderclose" } }, { "name": "GET /mt5/{account_id}/OrderHistory (GET /mt5/{account_id}/OrderHistory)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/mt5/{{accountId}}/OrderHistory", "host": [ "{{baseUrl}}" ], "path": [ "mt5", "{{accountId}}", "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).\n\nReference: /docs/reference/mt5-terminal/#get-mt5-account-id-orderhistory" } }, { "name": "POST /mt5/{account_id}/OrderModify (POST /mt5/{account_id}/OrderModify)", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" } ], "url": { "raw": "{{baseUrl}}/mt5/{{accountId}}/OrderModify", "host": [ "{{baseUrl}}" ], "path": [ "mt5", "{{accountId}}", "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.\n\nReference: /docs/reference/mt5-terminal/#post-mt5-account-id-ordermodify" } }, { "name": "POST /mt5/{account_id}/OrderSend (POST /mt5/{account_id}/OrderSend)", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" } ], "url": { "raw": "{{baseUrl}}/mt5/{{accountId}}/OrderSend", "host": [ "{{baseUrl}}" ], "path": [ "mt5", "{{accountId}}", "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`.\n\nReference: /docs/reference/mt5-terminal/#post-mt5-account-id-ordersend" } }, { "name": "GET /mt5/{account_id}/PositionHistory (GET /mt5/{account_id}/PositionHistory)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/mt5/{{accountId}}/PositionHistory", "host": [ "{{baseUrl}}" ], "path": [ "mt5", "{{accountId}}", "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.\n\nReference: /docs/reference/mt5-terminal/#get-mt5-account-id-positionhistory" } }, { "name": "GET /mt5/{account_id}/PriceHistory (GET /mt5/{account_id}/PriceHistory)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/mt5/{{accountId}}/PriceHistory", "host": [ "{{baseUrl}}" ], "path": [ "mt5", "{{accountId}}", "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`.\n\nReference: /docs/reference/mt5-terminal/#get-mt5-account-id-pricehistory" } }, { "name": "GET /mt5/{account_id}/ServerTimezone (GET /mt5/{account_id}/ServerTimezone)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/mt5/{{accountId}}/ServerTimezone", "host": [ "{{baseUrl}}" ], "path": [ "mt5", "{{accountId}}", "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.\n\nReference: /docs/reference/mt5-terminal/#get-mt5-account-id-servertimezone" } }, { "name": "GET /mt5/{account_id}/SymbolInfo (GET /mt5/{account_id}/SymbolInfo)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/mt5/{{accountId}}/SymbolInfo", "host": [ "{{baseUrl}}" ], "path": [ "mt5", "{{accountId}}", "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.\n\nReference: /docs/reference/mt5-terminal/#get-mt5-account-id-symbolinfo" } }, { "name": "GET /mt5/{account_id}/getQuote (GET /mt5/{account_id}/getQuote)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/mt5/{{accountId}}/getQuote", "host": [ "{{baseUrl}}" ], "path": [ "mt5", "{{accountId}}", "getQuote" ] }, "description": "Latest tick for `symbol`: bid, ask, last, volume and broker time.\n\nReference: /docs/reference/mt5-terminal/#get-mt5-account-id-getquote" } }, { "name": "GET /mt5/{account_id}/healthz (GET /mt5/{account_id}/healthz)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/mt5/{{accountId}}/healthz", "host": [ "{{baseUrl}}" ], "path": [ "mt5", "{{accountId}}", "healthz" ] }, "description": "Readiness check: 200 once the terminal is `ready`, otherwise 503. The\nbody holds no personal data: `{status, terminal, broker, account}`.\n\nReference: /docs/reference/mt5-terminal/#get-mt5-account-id-healthz" } }, { "name": "GET /mt5/{account_id}/livez (GET /mt5/{account_id}/livez)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/mt5/{{accountId}}/livez", "host": [ "{{baseUrl}}" ], "path": [ "mt5", "{{accountId}}", "livez" ] }, "description": "Liveness check: 200 while the terminal answers (whatever the broker\nlink), otherwise 503.\n\nReference: /docs/reference/mt5-terminal/#get-mt5-account-id-livez" } }, { "name": "GET /mt5/{account_id}/status (GET /mt5/{account_id}/status)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/mt5/{{accountId}}/status", "host": [ "{{baseUrl}}" ], "path": [ "mt5", "{{accountId}}", "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.\n\nReference: /docs/reference/mt5-terminal/#get-mt5-account-id-status" } }, { "name": "GET /mt5/{account_id}/symbols (GET /mt5/{account_id}/symbols)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/mt5/{{accountId}}/symbols", "host": [ "{{baseUrl}}" ], "path": [ "mt5", "{{accountId}}", "symbols" ] }, "description": "Names of all symbols available on this terminal. Use them verbatim:\nbrokers suffix symbols (EURUSD.sd, XAUUSDm).\n\nReference: /docs/reference/mt5-terminal/#get-mt5-account-id-symbols" } } ] }, { "name": "MT4 terminal", "item": [ { "name": "GET /mt4/{account_id}/AccountInfo (GET /mt4/{account_id}/AccountInfo)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/mt4/{{accountId}}/AccountInfo", "host": [ "{{baseUrl}}" ], "path": [ "mt4", "{{accountId}}", "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.\n\nReference: /docs/reference/mt4-terminal/#get-mt4-account-id-accountinfo" } }, { "name": "GET /mt4/{account_id}/AccountSummary (GET /mt4/{account_id}/AccountSummary)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/mt4/{{accountId}}/AccountSummary", "host": [ "{{baseUrl}}" ], "path": [ "mt4", "{{accountId}}", "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).\n\nReference: /docs/reference/mt4-terminal/#get-mt4-account-id-accountsummary" } }, { "name": "POST /mt4/{account_id}/CloseAll (POST /mt4/{account_id}/CloseAll)", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" } ], "url": { "raw": "{{baseUrl}}/mt4/{{accountId}}/CloseAll", "host": [ "{{baseUrl}}" ], "path": [ "mt4", "{{accountId}}", "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.\n\nReference: /docs/reference/mt4-terminal/#post-mt4-account-id-closeall" } }, { "name": "GET /mt4/{account_id}/OpenedOrders (GET /mt4/{account_id}/OpenedOrders)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/mt4/{{accountId}}/OpenedOrders", "host": [ "{{baseUrl}}" ], "path": [ "mt4", "{{accountId}}", "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.\n\nReference: /docs/reference/mt4-terminal/#get-mt4-account-id-openedorders" } }, { "name": "GET /mt4/{account_id}/OrderCalcMargin (GET /mt4/{account_id}/OrderCalcMargin)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/mt4/{{accountId}}/OrderCalcMargin", "host": [ "{{baseUrl}}" ], "path": [ "mt4", "{{accountId}}", "OrderCalcMargin" ] }, "description": "Margin (account currency) needed to open `volume` lots of `operation`\non `symbol` at `price`. Places nothing.\n\nReference: /docs/reference/mt4-terminal/#get-mt4-account-id-ordercalcmargin" } }, { "name": "GET /mt4/{account_id}/OrderCalcProfit (GET /mt4/{account_id}/OrderCalcProfit)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/mt4/{{accountId}}/OrderCalcProfit", "host": [ "{{baseUrl}}" ], "path": [ "mt4", "{{accountId}}", "OrderCalcProfit" ] }, "description": "Projected P/L (account currency) of `volume` lots from `priceOpen` to\n`priceClose`; pending operations count by direction only. Places nothing.\n\nReference: /docs/reference/mt4-terminal/#get-mt4-account-id-ordercalcprofit" } }, { "name": "POST /mt4/{account_id}/OrderClose (POST /mt4/{account_id}/OrderClose)", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" } ], "url": { "raw": "{{baseUrl}}/mt4/{{accountId}}/OrderClose", "host": [ "{{baseUrl}}" ], "path": [ "mt4", "{{accountId}}", "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.\n\nReference: /docs/reference/mt4-terminal/#post-mt4-account-id-orderclose" } }, { "name": "GET /mt4/{account_id}/OrderHistory (GET /mt4/{account_id}/OrderHistory)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/mt4/{{accountId}}/OrderHistory", "host": [ "{{baseUrl}}" ], "path": [ "mt4", "{{accountId}}", "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).\n\nReference: /docs/reference/mt4-terminal/#get-mt4-account-id-orderhistory" } }, { "name": "POST /mt4/{account_id}/OrderModify (POST /mt4/{account_id}/OrderModify)", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" } ], "url": { "raw": "{{baseUrl}}/mt4/{{accountId}}/OrderModify", "host": [ "{{baseUrl}}" ], "path": [ "mt4", "{{accountId}}", "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.\n\nReference: /docs/reference/mt4-terminal/#post-mt4-account-id-ordermodify" } }, { "name": "POST /mt4/{account_id}/OrderSend (POST /mt4/{account_id}/OrderSend)", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" } ], "url": { "raw": "{{baseUrl}}/mt4/{{accountId}}/OrderSend", "host": [ "{{baseUrl}}" ], "path": [ "mt4", "{{accountId}}", "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`.\n\nReference: /docs/reference/mt4-terminal/#post-mt4-account-id-ordersend" } }, { "name": "GET /mt4/{account_id}/PositionHistory (GET /mt4/{account_id}/PositionHistory)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/mt4/{{accountId}}/PositionHistory", "host": [ "{{baseUrl}}" ], "path": [ "mt4", "{{accountId}}", "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.\n\nReference: /docs/reference/mt4-terminal/#get-mt4-account-id-positionhistory" } }, { "name": "GET /mt4/{account_id}/PriceHistory (GET /mt4/{account_id}/PriceHistory)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/mt4/{{accountId}}/PriceHistory", "host": [ "{{baseUrl}}" ], "path": [ "mt4", "{{accountId}}", "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`.\n\nReference: /docs/reference/mt4-terminal/#get-mt4-account-id-pricehistory" } }, { "name": "GET /mt4/{account_id}/ServerTimezone (GET /mt4/{account_id}/ServerTimezone)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/mt4/{{accountId}}/ServerTimezone", "host": [ "{{baseUrl}}" ], "path": [ "mt4", "{{accountId}}", "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.\n\nReference: /docs/reference/mt4-terminal/#get-mt4-account-id-servertimezone" } }, { "name": "GET /mt4/{account_id}/SymbolInfo (GET /mt4/{account_id}/SymbolInfo)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/mt4/{{accountId}}/SymbolInfo", "host": [ "{{baseUrl}}" ], "path": [ "mt4", "{{accountId}}", "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.\n\nReference: /docs/reference/mt4-terminal/#get-mt4-account-id-symbolinfo" } }, { "name": "GET /mt4/{account_id}/getQuote (GET /mt4/{account_id}/getQuote)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/mt4/{{accountId}}/getQuote", "host": [ "{{baseUrl}}" ], "path": [ "mt4", "{{accountId}}", "getQuote" ] }, "description": "Latest tick for `symbol`: bid, ask, last, volume and broker time.\n\nReference: /docs/reference/mt4-terminal/#get-mt4-account-id-getquote" } }, { "name": "GET /mt4/{account_id}/healthz (GET /mt4/{account_id}/healthz)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/mt4/{{accountId}}/healthz", "host": [ "{{baseUrl}}" ], "path": [ "mt4", "{{accountId}}", "healthz" ] }, "description": "Readiness check: 200 once the terminal is `ready`, otherwise 503. The\nbody holds no personal data: `{status, terminal, broker, account}`.\n\nReference: /docs/reference/mt4-terminal/#get-mt4-account-id-healthz" } }, { "name": "GET /mt4/{account_id}/livez (GET /mt4/{account_id}/livez)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/mt4/{{accountId}}/livez", "host": [ "{{baseUrl}}" ], "path": [ "mt4", "{{accountId}}", "livez" ] }, "description": "Liveness check: 200 while the terminal answers (whatever the broker\nlink), otherwise 503.\n\nReference: /docs/reference/mt4-terminal/#get-mt4-account-id-livez" } }, { "name": "GET /mt4/{account_id}/status (GET /mt4/{account_id}/status)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/mt4/{{accountId}}/status", "host": [ "{{baseUrl}}" ], "path": [ "mt4", "{{accountId}}", "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.\n\nReference: /docs/reference/mt4-terminal/#get-mt4-account-id-status" } }, { "name": "GET /mt4/{account_id}/symbols (GET /mt4/{account_id}/symbols)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/mt4/{{accountId}}/symbols", "host": [ "{{baseUrl}}" ], "path": [ "mt4", "{{accountId}}", "symbols" ] }, "description": "Names of all symbols available on this terminal. Use them verbatim:\nbrokers suffix symbols (EURUSD.sd, XAUUSDm).\n\nReference: /docs/reference/mt4-terminal/#get-mt4-account-id-symbols" } } ] }, { "name": "Batch orders", "item": [ { "name": "Batch orders (POST /v1/orders)", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" } ], "url": { "raw": "{{baseUrl}}/v1/orders", "host": [ "{{baseUrl}}" ], "path": [ "v1", "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.\n\nReference: /docs/reference/batch-orders/#post-v1-orders" } }, { "name": "Batch close (POST /v1/orders/close)", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" } ], "url": { "raw": "{{baseUrl}}/v1/orders/close", "host": [ "{{baseUrl}}" ], "path": [ "v1", "orders", "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`.\n\nReference: /docs/reference/batch-orders/#post-v1-orders-close" } } ] } ] }, { "name": "Native /v1", "item": [ { "name": "Sandbox", "item": [ { "name": "Sandbox Info (GET /v1/sandbox)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/sandbox", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox" ] }, "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).\n\nReference: /docs/reference/sandbox/#get-v1-sandbox" } }, { "name": "Create Key (POST /v1/sandbox/keys)", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/keys", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "keys" ] }, "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`.\n\nReference: /docs/reference/sandbox/#post-v1-sandbox-keys", "body": { "mode": "raw", "raw": "{\n \"name\": \"sandbox\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Signup (POST /v1/sandbox/signup)", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/signup", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "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.\n\nReference: /docs/reference/sandbox/#post-v1-sandbox-signup", "body": { "mode": "raw", "raw": "{\n \"platform\": \"mt5\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Accounts", "item": [ { "name": "List Accounts (GET /v1/accounts)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/accounts", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts" ] }, "description": "Reference: /docs/reference/accounts/#get-v1-accounts" } }, { "name": "Link Account (POST /v1/accounts)", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/accounts", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts" ] }, "description": "Reference: /docs/reference/accounts/#post-v1-accounts", "body": { "mode": "raw", "raw": "{\n \"platform\": \"mt5\",\n \"server\": \"Tickwire-Sandbox\",\n \"login\": 1,\n \"password\": \"YOUR_PASSWORD\",\n \"nickname\": \"\",\n \"trade_ea_symbol\": \"\",\n \"proxy_address\": \"\",\n \"proxy_type\": \"\",\n \"proxy_auth\": \"\",\n \"proxy_local_port\": 0\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Account (GET /v1/accounts/{account_id})", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/{{accountId}}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", "{{accountId}}" ] }, "description": "Reference: /docs/reference/accounts/#get-v1-accounts-account-id" } }, { "name": "Patch Account (PATCH /v1/accounts/{account_id})", "request": { "method": "PATCH", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/{{accountId}}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", "{{accountId}}" ] }, "description": "Reference: /docs/reference/accounts/#patch-v1-accounts-account-id", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Unlink Account (DELETE /v1/accounts/{account_id})", "request": { "method": "DELETE", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/{{accountId}}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", "{{accountId}}" ] }, "description": "Reference: /docs/reference/accounts/#delete-v1-accounts-account-id" } } ] }, { "name": "Webhooks and events", "item": [ { "name": "Resend Event (POST /v1/events/{event_id}/resend)", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" } ], "url": { "raw": "{{baseUrl}}/v1/events/:event_id/resend", "host": [ "{{baseUrl}}" ], "path": [ "v1", "events", ":event_id", "resend" ], "query": [ { "key": "webhookId", "value": "YOUR_ACCOUNT_ID", "disabled": true } ], "variable": [ { "key": "event_id", "value": "EVENT_ID" } ] }, "description": "Queue an event again to every endpoint that received it (or `webhookId`).\n\nReference: /docs/reference/webhooks/#post-v1-events-event-id-resend" } }, { "name": "Event Types (GET /v1/webhook-event-types)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/webhook-event-types", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhook-event-types" ] }, "description": "Every webhook event type, with a description, its source and an example envelope.\n\nReference: /docs/reference/webhooks/#get-v1-webhook-event-types" } }, { "name": "Trigger (POST /v1/webhook-events/trigger)", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/webhook-events/trigger", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhook-events", "trigger" ] }, "description": "Publish one test event of a catalog type (any type in the sandbox; live: `webhook.test`).\n\nReference: /docs/reference/webhooks/#post-v1-webhook-events-trigger", "body": { "mode": "raw", "raw": "{\n \"type\": \"string\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create Listener (POST /v1/webhook-listeners)", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" } ], "url": { "raw": "{{baseUrl}}/v1/webhook-listeners", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhook-listeners" ] }, "description": "Start a local-forwarding listener: its signing secret and the current cursor.\n\nReference: /docs/reference/webhooks/#post-v1-webhook-listeners" } }, { "name": "Listener Events (GET /v1/webhook-listeners/{listener_id}/events)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/webhook-listeners/:listener_id/events", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhook-listeners", ":listener_id", "events" ], "query": [ { "key": "after", "value": "", "disabled": true }, { "key": "types", "value": "string", "disabled": true }, { "key": "limit", "value": "100", "disabled": true } ], "variable": [ { "key": "listener_id", "value": "LISTENER_ID" } ] }, "description": "The tenant's events after the `after` cursor, each signed with the listener secret.\n\nReference: /docs/reference/webhooks/#get-v1-webhook-listeners-listener-id-events" } }, { "name": "List Webhooks (GET /v1/webhooks)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks" ] }, "description": "Reference: /docs/reference/webhooks/#get-v1-webhooks" } }, { "name": "Create Webhook (POST /v1/webhooks)", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks" ] }, "description": "Reference: /docs/reference/webhooks/#post-v1-webhooks", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://example.com/hook\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Webhook (GET /v1/webhooks/{webhook_id})", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/:webhook_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", ":webhook_id" ], "variable": [ { "key": "webhook_id", "value": "WEBHOOK_ID" } ] }, "description": "Reference: /docs/reference/webhooks/#get-v1-webhooks-webhook-id" } }, { "name": "Patch Endpoint (PATCH /v1/webhooks/{webhook_id})", "request": { "method": "PATCH", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/:webhook_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", ":webhook_id" ], "variable": [ { "key": "webhook_id", "value": "WEBHOOK_ID" } ] }, "description": "Change the event filter (`enabledEvents`), URL or description.\n\nReference: /docs/reference/webhooks/#patch-v1-webhooks-webhook-id", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Webhook (DELETE /v1/webhooks/{webhook_id})", "request": { "method": "DELETE", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/:webhook_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", ":webhook_id" ], "variable": [ { "key": "webhook_id", "value": "WEBHOOK_ID" } ] }, "description": "Reference: /docs/reference/webhooks/#delete-v1-webhooks-webhook-id" } }, { "name": "List Deliveries (GET /v1/webhooks/{webhook_id}/deliveries)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/:webhook_id/deliveries", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", ":webhook_id", "deliveries" ], "query": [ { "key": "status", "value": "string", "disabled": true }, { "key": "eventType", "value": "string", "disabled": true }, { "key": "eventId", "value": "YOUR_ACCOUNT_ID", "disabled": true }, { "key": "since", "value": "string", "disabled": true }, { "key": "until", "value": "string", "disabled": true }, { "key": "cursor", "value": "string", "disabled": true }, { "key": "limit", "value": "50", "disabled": true } ], "variable": [ { "key": "webhook_id", "value": "WEBHOOK_ID" } ] }, "description": "The endpoint's deliveries, newest first (`{data, hasMore, nextCursor}`).\n\nReference: /docs/reference/webhooks/#get-v1-webhooks-webhook-id-deliveries" } }, { "name": "Get Delivery (GET /v1/webhooks/{webhook_id}/deliveries/{delivery_id})", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/:webhook_id/deliveries/:delivery_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", ":webhook_id", "deliveries", ":delivery_id" ], "variable": [ { "key": "webhook_id", "value": "WEBHOOK_ID" }, { "key": "delivery_id", "value": "DELIVERY_ID" } ] }, "description": "One delivery with every attempt, the signed payload and the last response body.\n\nReference: /docs/reference/webhooks/#get-v1-webhooks-webhook-id-deliveries-delivery-id" } }, { "name": "Resend Delivery (POST /v1/webhooks/{webhook_id}/deliveries/{delivery_id}/resend)", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/:webhook_id/deliveries/:delivery_id/resend", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", ":webhook_id", "deliveries", ":delivery_id", "resend" ], "variable": [ { "key": "webhook_id", "value": "WEBHOOK_ID" }, { "key": "delivery_id", "value": "DELIVERY_ID" } ] }, "description": "Queue this delivery's event again to the endpoint. Returns the new delivery (202).\n\nReference: /docs/reference/webhooks/#post-v1-webhooks-webhook-id-deliveries-delivery-id-resend" } }, { "name": "Disable Endpoint (POST /v1/webhooks/{webhook_id}/disable)", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/:webhook_id/disable", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", ":webhook_id", "disable" ], "variable": [ { "key": "webhook_id", "value": "WEBHOOK_ID" } ] }, "description": "Stop deliveries to an endpoint; unfinished deliveries are closed as failed.\n\nReference: /docs/reference/webhooks/#post-v1-webhooks-webhook-id-disable" } }, { "name": "Enable Endpoint (POST /v1/webhooks/{webhook_id}/enable)", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/:webhook_id/enable", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", ":webhook_id", "enable" ], "variable": [ { "key": "webhook_id", "value": "WEBHOOK_ID" } ] }, "description": "Re-enable an endpoint (after an automatic disable, or your own).\n\nReference: /docs/reference/webhooks/#post-v1-webhooks-webhook-id-enable" } }, { "name": "Reveal Secret (POST /v1/webhooks/{webhook_id}/reveal-secret)", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/:webhook_id/reveal-secret", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", ":webhook_id", "reveal-secret" ], "variable": [ { "key": "webhook_id", "value": "WEBHOOK_ID" } ] }, "description": "The current signing secret (and the previous one during a rotation overlap).\n\nReference: /docs/reference/webhooks/#post-v1-webhooks-webhook-id-reveal-secret" } }, { "name": "Rotate Secret (POST /v1/webhooks/{webhook_id}/rotate-secret)", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/:webhook_id/rotate-secret", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", ":webhook_id", "rotate-secret" ], "variable": [ { "key": "webhook_id", "value": "WEBHOOK_ID" } ] }, "description": "New signing secret; the old one stays valid for `overlapHours` (default 24).\n\nReference: /docs/reference/webhooks/#post-v1-webhooks-webhook-id-rotate-secret", "body": { "mode": "raw", "raw": "{\n \"overlapHours\": 24\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Endpoint Settings (GET /v1/webhooks/{webhook_id}/settings)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/:webhook_id/settings", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", ":webhook_id", "settings" ], "variable": [ { "key": "webhook_id", "value": "WEBHOOK_ID" } ] }, "description": "Endpoint status, failure streak, event filter and secret-rotation state.\n\nReference: /docs/reference/webhooks/#get-v1-webhooks-webhook-id-settings" } } ] }, { "name": "Read-only keys", "item": [ { "name": "List Ro Keys (GET /v1/readonly-keys)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/readonly-keys", "host": [ "{{baseUrl}}" ], "path": [ "v1", "readonly-keys" ] }, "description": "Reference: /docs/reference/keys/#get-v1-readonly-keys" } }, { "name": "Create Ro Key (POST /v1/readonly-keys)", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/readonly-keys", "host": [ "{{baseUrl}}" ], "path": [ "v1", "readonly-keys" ] }, "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.\n\nReference: /docs/reference/keys/#post-v1-readonly-keys", "body": { "mode": "raw", "raw": "{\n \"name\": \"example\",\n \"scope\": \"all\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Ro Key (GET /v1/readonly-keys/{key_id})", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/readonly-keys/:key_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "readonly-keys", ":key_id" ], "variable": [ { "key": "key_id", "value": "KEY_ID" } ] }, "description": "Reference: /docs/reference/keys/#get-v1-readonly-keys-key-id" } }, { "name": "Patch Ro Key (PATCH /v1/readonly-keys/{key_id})", "request": { "method": "PATCH", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/readonly-keys/:key_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "readonly-keys", ":key_id" ], "variable": [ { "key": "key_id", "value": "KEY_ID" } ] }, "description": "Reference: /docs/reference/keys/#patch-v1-readonly-keys-key-id", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Ro Key (DELETE /v1/readonly-keys/{key_id})", "request": { "method": "DELETE", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" } ], "url": { "raw": "{{baseUrl}}/v1/readonly-keys/:key_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "readonly-keys", ":key_id" ], "variable": [ { "key": "key_id", "value": "KEY_ID" } ] }, "description": "Reference: /docs/reference/keys/#delete-v1-readonly-keys-key-id" } }, { "name": "Rotate Ro Key (POST /v1/readonly-keys/{key_id}/rotate)", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" } ], "url": { "raw": "{{baseUrl}}/v1/readonly-keys/:key_id/rotate", "host": [ "{{baseUrl}}" ], "path": [ "v1", "readonly-keys", ":key_id", "rotate" ], "variable": [ { "key": "key_id", "value": "KEY_ID" } ] }, "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`.\n\nReference: /docs/reference/keys/#post-v1-readonly-keys-key-id-rotate" } } ] }, { "name": "Private servers", "item": [ { "name": "List Servers (GET /v1/private-servers)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/private-servers", "host": [ "{{baseUrl}}" ], "path": [ "v1", "private-servers" ] }, "description": "Reference: /docs/reference/private-servers/#get-v1-private-servers" } }, { "name": "Buy Server (POST /v1/private-servers)", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/private-servers", "host": [ "{{baseUrl}}" ], "path": [ "v1", "private-servers" ] }, "description": "Reference: /docs/reference/private-servers/#post-v1-private-servers", "body": { "mode": "raw", "raw": "{\n \"slots\": 1,\n \"region\": \"eu\",\n \"name\": \"example\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Regions (GET /v1/private-servers/regions)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/private-servers/regions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "private-servers", "regions" ] }, "description": "Reference: /docs/reference/private-servers/#get-v1-private-servers-regions" } }, { "name": "Get Server (GET /v1/private-servers/{server_id})", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/private-servers/:server_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "private-servers", ":server_id" ], "variable": [ { "key": "server_id", "value": "SERVER_ID" } ] }, "description": "Reference: /docs/reference/private-servers/#get-v1-private-servers-server-id" } }, { "name": "Resize Server (PATCH /v1/private-servers/{server_id})", "request": { "method": "PATCH", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/private-servers/:server_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "private-servers", ":server_id" ], "variable": [ { "key": "server_id", "value": "SERVER_ID" } ] }, "description": "Reference: /docs/reference/private-servers/#patch-v1-private-servers-server-id", "body": { "mode": "raw", "raw": "{\n \"slots\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Cancel Server (DELETE /v1/private-servers/{server_id})", "request": { "method": "DELETE", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" } ], "url": { "raw": "{{baseUrl}}/v1/private-servers/:server_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "private-servers", ":server_id" ], "variable": [ { "key": "server_id", "value": "SERVER_ID" } ] }, "description": "Reference: /docs/reference/private-servers/#delete-v1-private-servers-server-id" } }, { "name": "Add Server Account (POST /v1/private-servers/{server_id}/accounts)", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/private-servers/:server_id/accounts", "host": [ "{{baseUrl}}" ], "path": [ "v1", "private-servers", ":server_id", "accounts" ], "variable": [ { "key": "server_id", "value": "SERVER_ID" } ] }, "description": "Reference: /docs/reference/private-servers/#post-v1-private-servers-server-id-accounts", "body": { "mode": "raw", "raw": "{\n \"platform\": \"mt5\",\n \"server\": \"Tickwire-Sandbox\",\n \"login\": 1,\n \"password\": \"YOUR_PASSWORD\",\n \"nickname\": \"\",\n \"trade_ea_symbol\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Remove Server Account (DELETE /v1/private-servers/{server_id}/accounts/{account_id})", "request": { "method": "DELETE", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" } ], "url": { "raw": "{{baseUrl}}/v1/private-servers/:server_id/accounts/{{accountId}}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "private-servers", ":server_id", "accounts", "{{accountId}}" ], "variable": [ { "key": "server_id", "value": "SERVER_ID" } ] }, "description": "Reference: /docs/reference/private-servers/#delete-v1-private-servers-server-id-accounts-account-id" } } ] }, { "name": "Dedicated IPs and billing", "item": [ { "name": "Billing (GET /v1/billing)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/billing", "host": [ "{{baseUrl}}" ], "path": [ "v1", "billing" ] }, "description": "Reference: /docs/reference/billing/#get-v1-billing" } }, { "name": "Upgrade (POST /v1/billing/upgrade)", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/billing/upgrade", "host": [ "{{baseUrl}}" ], "path": [ "v1", "billing", "upgrade" ] }, "description": "Reference: /docs/reference/billing/#post-v1-billing-upgrade", "body": { "mode": "raw", "raw": "{\n \"accounts\": 1,\n \"own_address\": false\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Upgrade Quote (GET /v1/billing/upgrade/quote)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/billing/upgrade/quote?accounts=1", "host": [ "{{baseUrl}}" ], "path": [ "v1", "billing", "upgrade", "quote" ], "query": [ { "key": "accounts", "value": "1", "disabled": false }, { "key": "own_address", "value": "false", "disabled": true } ] }, "description": "Reference: /docs/reference/billing/#get-v1-billing-upgrade-quote" } }, { "name": "My Dedicated Ips (GET /v1/dedicated-ips)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/dedicated-ips", "host": [ "{{baseUrl}}" ], "path": [ "v1", "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`.\n\nReference: /docs/reference/billing/#get-v1-dedicated-ips" } }, { "name": "My Move Accounts (POST /v1/dedicated-ips/move-accounts)", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/dedicated-ips/move-accounts", "host": [ "{{baseUrl}}" ], "path": [ "v1", "dedicated-ips", "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.\n\nReference: /docs/reference/billing/#post-v1-dedicated-ips-move-accounts", "body": { "mode": "raw", "raw": "{\n \"account_ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Subscription (GET /v1/subscription)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/subscription", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscription" ] }, "description": "Reference: /docs/reference/billing/#get-v1-subscription" } }, { "name": "Wallet (GET /v1/wallet)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/wallet", "host": [ "{{baseUrl}}" ], "path": [ "v1", "wallet" ] }, "description": "Reference: /docs/reference/billing/#get-v1-wallet" } }, { "name": "Wallet Assets (GET /v1/wallet/assets)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/wallet/assets", "host": [ "{{baseUrl}}" ], "path": [ "v1", "wallet", "assets" ] }, "description": "Reference: /docs/reference/billing/#get-v1-wallet-assets" } }, { "name": "Create Topup (POST /v1/wallet/topup)", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/wallet/topup", "host": [ "{{baseUrl}}" ], "path": [ "v1", "wallet", "topup" ] }, "description": "Reference: /docs/reference/billing/#post-v1-wallet-topup", "body": { "mode": "raw", "raw": "{\n \"amount_eur_cents\": 1000,\n \"method\": \"crypto\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Topup (GET /v1/wallet/topup/{topup_id})", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/wallet/topup/:topup_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "wallet", "topup", ":topup_id" ], "variable": [ { "key": "topup_id", "value": "TOPUP_ID" } ] }, "description": "Reference: /docs/reference/billing/#get-v1-wallet-topup-topup-id" } }, { "name": "Confirm Topup (POST /v1/wallet/topup/{topup_id}/confirm)", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" } ], "url": { "raw": "{{baseUrl}}/v1/wallet/topup/:topup_id/confirm", "host": [ "{{baseUrl}}" ], "path": [ "v1", "wallet", "topup", ":topup_id", "confirm" ], "variable": [ { "key": "topup_id", "value": "TOPUP_ID" } ] }, "description": "Reference: /docs/reference/billing/#post-v1-wallet-topup-topup-id-confirm" } }, { "name": "List Topups (GET /v1/wallet/topups)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/wallet/topups", "host": [ "{{baseUrl}}" ], "path": [ "v1", "wallet", "topups" ] }, "description": "Reference: /docs/reference/billing/#get-v1-wallet-topups" } } ] }, { "name": "Identity and other routes", "item": [ { "name": "Get Api Version (GET /v1/api-version)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/api-version", "host": [ "{{baseUrl}}" ], "path": [ "v1", "api-version" ] }, "description": "The organisation's pinned API version, the latest one and every supported one.\n\nReference: /docs/reference/native-other/#get-v1-api-version" } }, { "name": "Set Api Version (POST /v1/api-version)", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/api-version", "host": [ "{{baseUrl}}" ], "path": [ "v1", "api-version" ] }, "description": "Pin the organisation to `apiVersion` (owner or admin credential; audited).\n\nReference: /docs/reference/native-other/#post-v1-api-version", "body": { "mode": "raw", "raw": "{\n \"apiVersion\": \"string\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Whoami (GET /v1/meta/whoami)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/meta/whoami", "host": [ "{{baseUrl}}" ], "path": [ "v1", "meta", "whoami" ] }, "description": "Reference: /docs/reference/native-other/#get-v1-meta-whoami" } }, { "name": "List Request Logs (GET /v1/request-logs)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/request-logs", "host": [ "{{baseUrl}}" ], "path": [ "v1", "request-logs" ], "query": [ { "key": "status", "value": "string", "disabled": true }, { "key": "method", "value": "string", "disabled": true }, { "key": "route", "value": "string", "disabled": true }, { "key": "errorCode", "value": "string", "disabled": true }, { "key": "keyId", "value": "YOUR_ACCOUNT_ID", "disabled": true }, { "key": "accountId", "value": "YOUR_ACCOUNT_ID", "disabled": true }, { "key": "requestId", "value": "YOUR_ACCOUNT_ID", "disabled": true }, { "key": "since", "value": "string", "disabled": true }, { "key": "until", "value": "string", "disabled": true }, { "key": "cursor", "value": "string", "disabled": true }, { "key": "limit", "value": "50", "disabled": true } ] }, "description": "The organisation's request log, newest first (metadata only).\n\nReference: /docs/reference/native-other/#get-v1-request-logs" } }, { "name": "Request Log Summary (GET /v1/request-logs/summary)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/request-logs/summary", "host": [ "{{baseUrl}}" ], "path": [ "v1", "request-logs", "summary" ], "query": [ { "key": "hours", "value": "24", "disabled": true } ] }, "description": "Totals, error rate and the top error codes and routes over the last `hours`.\n\nReference: /docs/reference/native-other/#get-v1-request-logs-summary" } }, { "name": "Get Request Log (GET /v1/request-logs/{log_id})", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/request-logs/:log_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "request-logs", ":log_id" ], "variable": [ { "key": "log_id", "value": "LOG_ID" } ] }, "description": "One call; body excerpts only for a full-access key with the writer role.\n\nReference: /docs/reference/native-other/#get-v1-request-logs-log-id" } } ] } ] }, { "name": "AI agents", "item": [ { "name": "Agent API", "item": [ { "name": "Agent Accounts (GET /v1/agent/accounts)", "request": { "method": "GET", "header": [ { "key": "X-Tickwire-Agent-Key", "value": "{{agentKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/agent/accounts", "host": [ "{{baseUrl}}" ], "path": [ "v1", "agent", "accounts" ], "query": [ { "key": "limit", "value": "100", "disabled": true, "description": "Page size, 1..500 (default 100)." }, { "key": "cursor", "value": "string", "disabled": true, "description": "The next_cursor of the previous page, unchanged." } ] }, "description": "Accounts this key may use, by account id. Cursor-paginated:\n`{accounts, has_more, next_cursor}`.\n\nReference: /docs/reference/agent-api/#get-v1-agent-accounts" } }, { "name": "Agent Account Info (GET /v1/agent/accounts/{account_id}/account-information)", "request": { "method": "GET", "header": [ { "key": "X-Tickwire-Agent-Key", "value": "{{agentKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/agent/accounts/{{accountId}}/account-information", "host": [ "{{baseUrl}}" ], "path": [ "v1", "agent", "accounts", "{{accountId}}", "account-information" ] }, "description": "Balance, equity, margin… as reported by the broker (same shape as `/users/current/…`).\n\nReference: /docs/reference/agent-api/#get-v1-agent-accounts-account-id-account-information" } }, { "name": "Agent Health (GET /v1/agent/accounts/{account_id}/health)", "request": { "method": "GET", "header": [ { "key": "X-Tickwire-Agent-Key", "value": "{{agentKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/agent/accounts/{{accountId}}/health", "host": [ "{{baseUrl}}" ], "path": [ "v1", "agent", "accounts", "{{accountId}}", "health" ] }, "description": "Truthful health with evidence (connected / disconnected / unknown).\n\nReference: /docs/reference/agent-api/#get-v1-agent-accounts-account-id-health" } }, { "name": "Agent Deals (GET /v1/agent/accounts/{account_id}/history-deals)", "request": { "method": "GET", "header": [ { "key": "X-Tickwire-Agent-Key", "value": "{{agentKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/agent/accounts/{{accountId}}/history-deals", "host": [ "{{baseUrl}}" ], "path": [ "v1", "agent", "accounts", "{{accountId}}", "history-deals" ], "query": [ { "key": "start_time", "value": "2026-09-01T00:00:00.000", "disabled": true }, { "key": "end_time", "value": "2026-09-01T00:00:00.000", "disabled": true }, { "key": "limit", "value": "100", "disabled": true } ] }, "description": "Deals in a bounded window (default last 24 h, max 31 days).\n\nReference: /docs/reference/agent-api/#get-v1-agent-accounts-account-id-history-deals" } }, { "name": "Agent Orders (GET /v1/agent/accounts/{account_id}/orders)", "request": { "method": "GET", "header": [ { "key": "X-Tickwire-Agent-Key", "value": "{{agentKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/agent/accounts/{{accountId}}/orders", "host": [ "{{baseUrl}}" ], "path": [ "v1", "agent", "accounts", "{{accountId}}", "orders" ] }, "description": "Pending orders (same shape as `/users/current/accounts/{id}/orders`).\n\nReference: /docs/reference/agent-api/#get-v1-agent-accounts-account-id-orders" } }, { "name": "Agent Positions (GET /v1/agent/accounts/{account_id}/positions)", "request": { "method": "GET", "header": [ { "key": "X-Tickwire-Agent-Key", "value": "{{agentKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/agent/accounts/{{accountId}}/positions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "agent", "accounts", "{{accountId}}", "positions" ] }, "description": "Open positions (same shape as `/users/current/accounts/{id}/positions`).\n\nReference: /docs/reference/agent-api/#get-v1-agent-accounts-account-id-positions" } }, { "name": "Agent Snapshot (GET /v1/agent/accounts/{account_id}/snapshot)", "request": { "method": "GET", "header": [ { "key": "X-Tickwire-Agent-Key", "value": "{{agentKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/agent/accounts/{{accountId}}/snapshot", "host": [ "{{baseUrl}}" ], "path": [ "v1", "agent", "accounts", "{{accountId}}", "snapshot" ] }, "description": "Account information, positions, orders, health and server time in one\nread, with `as_of` and per-section freshness.\n\nReference: /docs/reference/agent-api/#get-v1-agent-accounts-account-id-snapshot" } }, { "name": "Agent Price (GET /v1/agent/accounts/{account_id}/symbols/{symbol}/current-price)", "request": { "method": "GET", "header": [ { "key": "X-Tickwire-Agent-Key", "value": "{{agentKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/agent/accounts/{{accountId}}/symbols/:symbol/current-price", "host": [ "{{baseUrl}}" ], "path": [ "v1", "agent", "accounts", "{{accountId}}", "symbols", ":symbol", "current-price" ], "variable": [ { "key": "symbol", "value": "EURUSD" } ] }, "description": "Current bid/ask with broker time.\n\nReference: /docs/reference/agent-api/#get-v1-agent-accounts-account-id-symbols-symbol-current-price" } }, { "name": "Agent Spec (GET /v1/agent/accounts/{account_id}/symbols/{symbol}/specification)", "request": { "method": "GET", "header": [ { "key": "X-Tickwire-Agent-Key", "value": "{{agentKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/agent/accounts/{{accountId}}/symbols/:symbol/specification", "host": [ "{{baseUrl}}" ], "path": [ "v1", "agent", "accounts", "{{accountId}}", "symbols", ":symbol", "specification" ], "variable": [ { "key": "symbol", "value": "EURUSD" } ] }, "description": "Symbol specification: volume limits and step, digits, contract size…\n\nReference: /docs/reference/agent-api/#get-v1-agent-accounts-account-id-symbols-symbol-specification" } }, { "name": "Agent Trade (POST /v1/agent/accounts/{account_id}/trade)", "request": { "method": "POST", "header": [ { "key": "X-Tickwire-Agent-Key", "value": "{{agentKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/agent/accounts/{{accountId}}/trade", "host": [ "{{baseUrl}}" ], "path": [ "v1", "agent", "accounts", "{{accountId}}", "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.\n\nReference: /docs/reference/agent-api/#post-v1-agent-accounts-account-id-trade", "body": { "mode": "raw", "raw": "{\n \"actionType\": \"ORDER_TYPE_BUY\",\n \"symbol\": \"EURUSD\",\n \"volume\": 0.01\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Agent Own Audit (GET /v1/agent/audit)", "request": { "method": "GET", "header": [ { "key": "X-Tickwire-Agent-Key", "value": "{{agentKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/agent/audit", "host": [ "{{baseUrl}}" ], "path": [ "v1", "agent", "audit" ], "query": [ { "key": "limit", "value": "50", "disabled": true, "description": "Page size, 1..500 (default 50)." }, { "key": "before", "value": "1", "disabled": true }, { "key": "cursor", "value": "string", "disabled": true, "description": "The next_cursor of the previous page, unchanged." } ] }, "description": "This key's own audit entries, newest first. Cursor-paginated:\n`{entries, has_more, next_cursor}`.\n\nReference: /docs/reference/agent-api/#get-v1-agent-audit" } }, { "name": "Agent Me (GET /v1/agent/me)", "request": { "method": "GET", "header": [ { "key": "X-Tickwire-Agent-Key", "value": "{{agentKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/agent/me", "host": [ "{{baseUrl}}" ], "path": [ "v1", "agent", "me" ] }, "description": "This key's permissions, kill switches and applicable hooks.\n\nReference: /docs/reference/agent-api/#get-v1-agent-me" } }, { "name": "Agent Request Status (GET /v1/agent/requests/{idempotency_key})", "request": { "method": "GET", "header": [ { "key": "X-Tickwire-Agent-Key", "value": "{{agentKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/agent/requests/:idempotency_key", "host": [ "{{baseUrl}}" ], "path": [ "v1", "agent", "requests", ":idempotency_key" ], "variable": [ { "key": "idempotency_key", "value": "IDEMPOTENCY_KEY" } ] }, "description": "What happened to the trade sent with this idempotency key.\n\nReference: /docs/reference/agent-api/#get-v1-agent-requests-idempotency-key" } } ] }, { "name": "Agent keys and kill switches", "item": [ { "name": "Agent Audit (GET /v1/agent-audit)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/agent-audit", "host": [ "{{baseUrl}}" ], "path": [ "v1", "agent-audit" ], "query": [ { "key": "agent_key_id", "value": "YOUR_ACCOUNT_ID", "disabled": true }, { "key": "account_id", "value": "YOUR_ACCOUNT_ID", "disabled": true }, { "key": "before", "value": "1", "disabled": true }, { "key": "limit", "value": "100", "disabled": true, "description": "Page size, 1..500 (default 100)." }, { "key": "cursor", "value": "string", "disabled": true, "description": "The next_cursor of the previous page, unchanged." } ] }, "description": "The agent audit log, newest first (by `seq`). Cursor-paginated:\n`{entries, has_more, next_cursor}`; `before` (a `seq`) still works.\n\nReference: /docs/reference/agent-admin/#get-v1-agent-audit" } }, { "name": "List Agent Keys (GET /v1/agent-keys)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/agent-keys", "host": [ "{{baseUrl}}" ], "path": [ "v1", "agent-keys" ], "query": [ { "key": "limit", "value": "100", "disabled": true, "description": "Page size, 1..500 (default 100)." }, { "key": "cursor", "value": "string", "disabled": true, "description": "The next_cursor of the previous page, unchanged." } ] }, "description": "Agent keys of this tenant (never the key values), oldest first.\nCursor-paginated: `{data, has_more, next_cursor}`.\n\nReference: /docs/reference/agent-admin/#get-v1-agent-keys" } }, { "name": "Create Agent Key (POST /v1/agent-keys)", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/agent-keys", "host": [ "{{baseUrl}}" ], "path": [ "v1", "agent-keys" ] }, "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.\n\nReference: /docs/reference/agent-admin/#post-v1-agent-keys", "body": { "mode": "raw", "raw": "{\n \"name\": \"my-agent\",\n \"account_ids\": [\n \"YOUR_ACCOUNT_ID\"\n ],\n \"read_only\": false\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Agent Key (GET /v1/agent-keys/{key_id})", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/agent-keys/:key_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "agent-keys", ":key_id" ], "variable": [ { "key": "key_id", "value": "KEY_ID" } ] }, "description": "One agent key record.\n\nReference: /docs/reference/agent-admin/#get-v1-agent-keys-key-id" } }, { "name": "Patch Agent Key (PATCH /v1/agent-keys/{key_id})", "request": { "method": "PATCH", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/agent-keys/:key_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "agent-keys", ":key_id" ], "variable": [ { "key": "key_id", "value": "KEY_ID" } ] }, "description": "Rename, re-scope or flip read-only.\n\nReference: /docs/reference/agent-admin/#patch-v1-agent-keys-key-id", "body": { "mode": "raw", "raw": "{\n \"name\": \"my-agent\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Revoke Agent Key (DELETE /v1/agent-keys/{key_id})", "request": { "method": "DELETE", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" } ], "url": { "raw": "{{baseUrl}}/v1/agent-keys/:key_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "agent-keys", ":key_id" ], "variable": [ { "key": "key_id", "value": "KEY_ID" } ] }, "description": "Revoke an agent key (irreversible).\n\nReference: /docs/reference/agent-admin/#delete-v1-agent-keys-key-id" } }, { "name": "Set Key Kill Switch (PUT /v1/agent-keys/{key_id}/kill-switch)", "request": { "method": "PUT", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/agent-keys/:key_id/kill-switch", "host": [ "{{baseUrl}}" ], "path": [ "v1", "agent-keys", ":key_id", "kill-switch" ], "variable": [ { "key": "key_id", "value": "KEY_ID" } ] }, "description": "Engage or release the kill switch of one agent key.\n\nReference: /docs/reference/agent-admin/#put-v1-agent-keys-key-id-kill-switch", "body": { "mode": "raw", "raw": "{\n \"engaged\": true,\n \"reason\": \"stop this agent\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Kill Switches (GET /v1/agent-kill-switches)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/agent-kill-switches", "host": [ "{{baseUrl}}" ], "path": [ "v1", "agent-kill-switches" ], "query": [ { "key": "limit", "value": "100", "disabled": true, "description": "Page size, 1..500 (default 100)." }, { "key": "cursor", "value": "string", "disabled": true, "description": "The next_cursor of the previous page, unchanged." } ] }, "description": "Engaged account kill switches (agent-key switches are on each key), by\naccount id. Cursor-paginated: `{accounts, has_more, next_cursor}`.\n\nReference: /docs/reference/agent-admin/#get-v1-agent-kill-switches" } }, { "name": "Set Account Kill Switch (PUT /v1/agent-kill-switches/accounts/{account_id})", "request": { "method": "PUT", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/agent-kill-switches/accounts/{{accountId}}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "agent-kill-switches", "accounts", "{{accountId}}" ] }, "description": "Engage or release the agent kill switch of one account.\n\nReference: /docs/reference/agent-admin/#put-v1-agent-kill-switches-accounts-account-id", "body": { "mode": "raw", "raw": "{\n \"engaged\": true,\n \"reason\": \"stop all agents\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Pre-trade hooks and holds", "item": [ { "name": "List Holds (GET /v1/pretrade-holds)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/pretrade-holds", "host": [ "{{baseUrl}}" ], "path": [ "v1", "pretrade-holds" ], "query": [ { "key": "status", "value": "string", "disabled": true }, { "key": "account_id", "value": "YOUR_ACCOUNT_ID", "disabled": true }, { "key": "limit", "value": "100", "disabled": true, "description": "Page size, 1..500 (default 100)." }, { "key": "cursor", "value": "string", "disabled": true, "description": "The next_cursor of the previous page, unchanged." } ] }, "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`.\n\nReference: /docs/reference/pretrade/#get-v1-pretrade-holds" } }, { "name": "Get Hold (GET /v1/pretrade-holds/{hold_id})", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/pretrade-holds/:hold_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "pretrade-holds", ":hold_id" ], "variable": [ { "key": "hold_id", "value": "HOLD_ID" } ] }, "description": "One hold.\n\nReference: /docs/reference/pretrade/#get-v1-pretrade-holds-hold-id" } }, { "name": "Cancel Hold (POST /v1/pretrade-holds/{hold_id}/cancel)", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" } ], "url": { "raw": "{{baseUrl}}/v1/pretrade-holds/:hold_id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "v1", "pretrade-holds", ":hold_id", "cancel" ], "variable": [ { "key": "hold_id", "value": "HOLD_ID" } ] }, "description": "Owner override: reject a pending hold. Nothing is sent.\n\nReference: /docs/reference/pretrade/#post-v1-pretrade-holds-hold-id-cancel" } }, { "name": "Release Hold (POST /v1/pretrade-holds/{hold_id}/release)", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" } ], "url": { "raw": "{{baseUrl}}/v1/pretrade-holds/:hold_id/release", "host": [ "{{baseUrl}}" ], "path": [ "v1", "pretrade-holds", ":hold_id", "release" ], "variable": [ { "key": "hold_id", "value": "HOLD_ID" } ] }, "description": "Approve or reject a hold; signed with the holding hook's secret.\n\nReference: /docs/reference/pretrade/#post-v1-pretrade-holds-hold-id-release" } }, { "name": "List Hooks (GET /v1/pretrade-hooks)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/pretrade-hooks", "host": [ "{{baseUrl}}" ], "path": [ "v1", "pretrade-hooks" ], "query": [ { "key": "limit", "value": "100", "disabled": true, "description": "Page size, 1..500 (default 100)." }, { "key": "cursor", "value": "string", "disabled": true, "description": "The next_cursor of the previous page, unchanged." } ] }, "description": "This tenant's hooks (never the secrets), oldest first.\nCursor-paginated: `{data, has_more, next_cursor}`.\n\nReference: /docs/reference/pretrade/#get-v1-pretrade-hooks" } }, { "name": "Create Hook (POST /v1/pretrade-hooks)", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/pretrade-hooks", "host": [ "{{baseUrl}}" ], "path": [ "v1", "pretrade-hooks" ] }, "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`.\n\nReference: /docs/reference/pretrade/#post-v1-pretrade-hooks", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://example.com/pretrade\",\n \"account_id\": \"YOUR_ACCOUNT_ID\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Hook (GET /v1/pretrade-hooks/{hook_id})", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/pretrade-hooks/:hook_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "pretrade-hooks", ":hook_id" ], "variable": [ { "key": "hook_id", "value": "HOOK_ID" } ] }, "description": "One hook.\n\nReference: /docs/reference/pretrade/#get-v1-pretrade-hooks-hook-id" } }, { "name": "Patch Hook (PATCH /v1/pretrade-hooks/{hook_id})", "request": { "method": "PATCH", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/pretrade-hooks/:hook_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "pretrade-hooks", ":hook_id" ], "variable": [ { "key": "hook_id", "value": "HOOK_ID" } ] }, "description": "Change url, applies_to, fail_mode, timeout, hold TTL or enabled.\n\nReference: /docs/reference/pretrade/#patch-v1-pretrade-hooks-hook-id", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://example.com/pretrade\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Hook (DELETE /v1/pretrade-hooks/{hook_id})", "request": { "method": "DELETE", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" } ], "url": { "raw": "{{baseUrl}}/v1/pretrade-hooks/:hook_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "pretrade-hooks", ":hook_id" ], "variable": [ { "key": "hook_id", "value": "HOOK_ID" } ] }, "description": "Remove a hook. Its pending holds stay pending until they expire.\n\nReference: /docs/reference/pretrade/#delete-v1-pretrade-hooks-hook-id" } }, { "name": "Rotate Hook Secret (POST /v1/pretrade-hooks/{hook_id}/rotate-secret)", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" } ], "url": { "raw": "{{baseUrl}}/v1/pretrade-hooks/:hook_id/rotate-secret", "host": [ "{{baseUrl}}" ], "path": [ "v1", "pretrade-hooks", ":hook_id", "rotate-secret" ], "variable": [ { "key": "hook_id", "value": "HOOK_ID" } ] }, "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`.\n\nReference: /docs/reference/pretrade/#post-v1-pretrade-hooks-hook-id-rotate-secret" } } ] }, { "name": "Sign in with Tickwire (OAuth) and connected apps", "item": [ { "name": "As Metadata (GET /.well-known/oauth-authorization-server)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/.well-known/oauth-authorization-server", "host": [ "{{baseUrl}}" ], "path": [ ".well-known", "oauth-authorization-server" ] }, "description": "RFC 8414 Authorization Server Metadata.\n\nReference: /docs/reference/oauth/#get-well-known-oauth-authorization-server" } }, { "name": "Authorize (GET /oauth/authorize)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/oauth/authorize", "host": [ "{{baseUrl}}" ], "path": [ "oauth", "authorize" ] }, "description": "Validate the request, then send the browser to the consent page.\n\nReference: /docs/reference/oauth/#get-oauth-authorize" } }, { "name": "Consent Decide (POST /oauth/consent/decide)", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/oauth/consent/decide", "host": [ "{{baseUrl}}" ], "path": [ "oauth", "consent", "decide" ] }, "description": "Approve or deny; answers where to send the browser next.\n\nReference: /docs/reference/oauth/#post-oauth-consent-decide", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Consent View (POST /oauth/consent/view)", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/oauth/consent/view", "host": [ "{{baseUrl}}" ], "path": [ "oauth", "consent", "view" ] }, "description": "What the consent page shows, plus a consent token bound to this session.\n\nReference: /docs/reference/oauth/#post-oauth-consent-view", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Register (POST /oauth/register)", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" } ], "url": { "raw": "{{baseUrl}}/oauth/register", "host": [ "{{baseUrl}}" ], "path": [ "oauth", "register" ] }, "description": "RFC 7591 Dynamic Client Registration.\n\nReference: /docs/reference/oauth/#post-oauth-register" } }, { "name": "Revoke (POST /oauth/revoke)", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" } ], "url": { "raw": "{{baseUrl}}/oauth/revoke", "host": [ "{{baseUrl}}" ], "path": [ "oauth", "revoke" ] }, "description": "RFC 7009 token revocation.\n\nReference: /docs/reference/oauth/#post-oauth-revoke" } }, { "name": "Token (POST /oauth/token)", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" } ], "url": { "raw": "{{baseUrl}}/oauth/token", "host": [ "{{baseUrl}}" ], "path": [ "oauth", "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.\n\nReference: /docs/reference/oauth/#post-oauth-token" } }, { "name": "List Apps (GET /v1/connected-apps)", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/connected-apps", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connected-apps" ], "query": [ { "key": "include_ended", "value": "false", "disabled": true }, { "key": "limit", "value": "100", "disabled": true, "description": "Page size, 1..500 (default 100)." }, { "key": "cursor", "value": "string", "disabled": true, "description": "The next_cursor of the previous page, unchanged." } ] }, "description": "Apps connected to this tenant through Sign in with Tickwire, oldest\nfirst. Cursor-paginated: `{apps, has_more, next_cursor}`.\n\nReference: /docs/reference/oauth/#get-v1-connected-apps" } }, { "name": "Disconnect App (DELETE /v1/connected-apps/{grant_id})", "request": { "method": "DELETE", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" } ], "url": { "raw": "{{baseUrl}}/v1/connected-apps/:grant_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "connected-apps", ":grant_id" ], "variable": [ { "key": "grant_id", "value": "GRANT_ID" } ] }, "description": "Disconnect: revoke the app's agent key and all of its tokens.\n\nReference: /docs/reference/oauth/#delete-v1-connected-apps-grant-id" } } ] } ] }, { "name": "Guarded execution", "item": [ { "name": "Guarded trades", "item": [ { "name": "Guarded Trade (POST /v1/execution/accounts/{account_id}/trade)", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "X-Actor", "value": "postman" }, { "key": "X-Reason", "value": "why you are doing this" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/execution/accounts/{{accountId}}/trade", "host": [ "{{baseUrl}}" ], "path": [ "v1", "execution", "accounts", "{{accountId}}", "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.\n\nReference: /docs/reference/execution/#post-v1-execution-accounts-account-id-trade", "body": { "mode": "raw", "raw": "{\n \"actionType\": \"ORDER_TYPE_BUY\",\n \"symbol\": \"EURUSD\",\n \"volume\": 0.01\n}", "options": { "raw": { "language": "json" } } } } } ] } ] } ] }