API documentation

API reference

Every endpoint with its parameters, request body and a ready-to-run curl example. Generated from the live OpenAPI document.

Version 1.0.0 · https://api.propmetaapi.com

Every endpoint except /v1/health and /v1/docs needs Authorization: Bearer <key> and may also answer 400 VALIDATION, 401 UNAUTHORIZED, 402 SUBSCRIPTION_EXPIRED, 403 FORBIDDEN / FORBIDDEN_IP / CLIENT_SUSPENDED, 429 RATE_LIMITED and 5xx (INTERNAL, UNAVAILABLE) — see Errors & limits. Trade calls also need an Idempotency-Key header.

131 endpoints

Plan & keys

GET/v1/meYour plan: paid period, limits and usage, and the calling key (answers after expiry and while suspended too)
GET/v1/keysYour keys this key may manage
POST/v1/keysA key with at most this key's permissions and accounts (shown once)
DELETE/v1/keys/{id}Revoke a key this key could have made, and the keys it made (its sockets close within 10 s)

Accounts

GET/v1/accountsList accounts (oldest first, cursor paging)
POST/v1/accountsRegister an account (repeat-safe: same id for the same server+login; 200 when it existed)
GET/v1/accounts/{id}Account state (with its daily drawdown limit)
DELETE/v1/accounts/{id}Remove (no way back)
PATCH/v1/accounts/{id}/credentialsReplace passwords (auth of a changed password back to UNKNOWN; ACTIVE restarts)
POST/v1/accounts/{id}/activatePermanent connection; ?wait: until connected (200) or a failure
POST/v1/accounts/{id}/deactivateBack to STANDBY (the permanent terminal stops)
POST/v1/accounts/{id}/checkOne-off login, read and history sync (verifies the credentials and the broker files)
GET/v1/accounts/{id}/summaryAccount information (balance, equity, margin …) + connected / stale / asOf
GET/v1/accounts/{id}/logsTerminal / EA / lifecycle log lines (14 days), oldest first after a cursor
PATCH/v1/accounts/{id}/connectionProxy and / or MT5 certificate of the terminal (null removes; ACTIVE restarts)
POST/v1/accounts/{id}/reconnectRestart the terminal of an ACTIVE account that lost its connection (DISCONNECTED / CRASHED / ERROR); a start in progress is left alone, at most once per 30 s
POST/v1/accounts/deactivate-allYour ACTIVE accounts (all, or accountIds) back to STANDBY
POST/v1/accounts/orphansYour ACTIVE accounts not in keepAccountIds back to STANDBY (dryRun only reports)
GET/v1/accounts/{id}/detailsEverything the terminal reports about the account (name, stop-out levels, limits, server time...)
GET/v1/accounts/{id}/mailsTerminal mailbox
POST/v1/accounts/{id}/refreshFresh snapshot from the terminal (profits)
GET/v1/accounts/{id}/rawAccount, server, summary, positions, orders and symbols in one answer

Trading

GET/v1/accounts/{id}/positionsOpen positions (409 ACCOUNT_NOT_CONNECTED when not current); sort / filter
GET/v1/accounts/{id}/positions/{positionId}One open position
PATCH/v1/accounts/{id}/positions/{positionId}Change SL/TP of a position (prices, or distances from the open price)
GET/v1/accounts/{id}/ordersPending orders (409 ACCOUNT_NOT_CONNECTED when not current); sort / filter
POST/v1/accounts/{id}/ordersMarket or pending order (LIMIT, STOP, STOP_LIMIT with expiration)
GET/v1/accounts/{id}/orders/{orderId}One pending order
PATCH/v1/accounts/{id}/orders/{orderId}Change a pending order (price, SL/TP, stop-limit price, expiration)
DELETE/v1/accounts/{id}/orders/{orderId}Cancel a pending order
GET/v1/accounts/{id}/ticketsIds of open positions and pending orders
POST/v1/accounts/{id}/positions/{positionId}/closeClose (part of) a position
POST/v1/accounts/{id}/positions/{positionId}/close-byClose a position by an opposite one of the same symbol
POST/v1/accounts/{id}/close-allDelete pendings, close every position (or only those of `symbol`)
PUT/v1/accounts/{id}/positions/{positionId}/trailing-stopServer-side trailing stop of an open position (ACTIVE accounts)
DELETE/v1/accounts/{id}/positions/{positionId}/trailing-stopStop trailing a position (the current stop loss stays)
DELETE/v1/accounts/{id}/trailing-stops/{trailingId}Cancel a trailing stop by its id (also one still waiting for its pending order to fill)
GET/v1/accounts/{id}/trailing-stopsTrailing stops of the account (newest first)

Market data

GET/v1/accounts/{id}/symbolsSymbols (names, or full specs with details=true; filter with * and ?)
GET/v1/accounts/{id}/symbols/{symbol}Full specification of one symbol
GET/v1/accounts/{id}/symbols/{symbol}/sessionsQuote and trade sessions per weekday (broker clock)
GET/v1/accounts/{id}/symbol-groupsSymbol groups (from the symbols' paths)
GET/v1/accounts/{id}/trade-rightsTrade rights of symbols (direction, close-only, close-by, order kinds)
GET/v1/accounts/{id}/quotesLatest quotes
GET/v1/accounts/{id}/market-watchMarket watch rows: bid/ask, day high/low, open, previous close, change
GET/v1/accounts/{id}/tick-valuesTick values (format=array: [symbol, tickValue, tickSize])
GET/v1/accounts/{id}/margin-requiredMargin needed for an order
GET/v1/accounts/{id}/sessions/statusIs the trade / quote session open now
GET/v1/accounts/{id}/ratesPrice bars in [from,to), or `count` bars back from `from`; symbols= for several
GET/v1/accounts/{id}/rates/todayBars of today (broker day)
GET/v1/accounts/{id}/rates/monthBars of 30 days from a date
GET/v1/accounts/{id}/rates/high-lowHighest and lowest price in a range, with their times
POST/v1/accounts/{id}/rates/requestsAsynchronous bars: the answer comes on the WebSocket channel quoteHistory
GET/v1/accounts/{id}/rates/requests/{requestId}Result of an asynchronous bars request (kept one hour)
GET/v1/accounts/{id}/ticksTick history (MT5)
POST/v1/accounts/{id}/tick-historyStream the tick history from `from` to now on the WebSocket channel tickHistory (MT5)
DELETE/v1/accounts/{id}/tick-history/{symbol}Stop a tick-history stream
GET/v1/accounts/{id}/server-timeBroker clock, offset and DST of the server
GET/v1/accounts/{id}/subscriptionsLive data subscriptions of this key
POST/v1/accounts/{id}/subscriptionsLive data for this key, kept 10 minutes after the last use. Read it on /v1/ws with a listening subscription: {op:"subscribe", channel, accountId, passive:true} (all symbols the account streams)
DELETE/v1/accounts/{id}/subscriptionsRemove live data subscriptions

History & statistics

GET/v1/accounts/{id}/dealsClosed deal legs in [from,to), ordered by (time, id) — 409 HISTORY_NOT_SYNCED, never a short list
GET/v1/accounts/{id}/positions/{positionId}/dealsAll legs of one position (paged)
GET/v1/accounts/{id}/history/positionsClosed positions (legs aggregated) in [from,to) or by ids — same completeness rule as /deals
GET/v1/accounts/{id}/history/ordersOrders that left the terminal: filled, cancelled, expired (read from the terminal)
GET/v1/accounts/{id}/history/statusHistory sync status
GET/v1/accounts/{id}/closed-ordersLast closed positions, newest first (stored history, no sync wait)
GET/v1/accounts/{id}/statsTrading statistics (win rate, profit factor, drawdown …)
GET/v1/accounts/{id}/equity-historyBalance / equity series (deals, equity bars; reconstruct=true fills older periods from price history)
GET/v1/accounts/{id}/stats/equityStatistics plus the equity series
GET/v1/accounts/{id}/stats/unrealizedFloating profit over time and of the open positions (open positions from the live figures; totalUnrealized = equity - balance - credit; stale: true when the account is not connected)
GET/v1/accounts/{id}/equity-barsClosed one-minute equity bars after a cursor (410 CURSOR_EXPIRED past retention)

Risk management

GET/v1/accounts/{id}/risk-trackersRisk trackers with the current period's figures
POST/v1/accounts/{id}/risk-trackersDrawdown / profit limits per DAY, WEEK, MONTH (broker-time midnight) or LIFETIME
GET/v1/accounts/{id}/risk-trackers/{trackerId}One risk tracker
PATCH/v1/accounts/{id}/risk-trackers/{trackerId}Change limits / action / enabled (applies to the running period)
DELETE/v1/accounts/{id}/risk-trackers/{trackerId}Remove a risk tracker
GET/v1/accounts/{id}/risk-trackers/{trackerId}/periodsStatistics per period, newest first
GET/v1/accounts/{id}/daily-drawdownThe account's daily drawdown limit with today's figures
PUT/v1/accounts/{id}/daily-drawdownSet the daily drawdown limit (the whole setting; the same body again changes nothing)
PATCH/v1/accounts/{id}/daily-drawdownSwitch on / off, or change limits, action, confirmSec, balanceAdjust (applies to the running day)
DELETE/v1/accounts/{id}/daily-drawdownRemove the daily drawdown limit and its days (a block ends with it)
GET/v1/accounts/{id}/daily-drawdown/daysThe days, newest first (a day closed by a restart ends at the restart)

Events & streaming

PUT/v1/accounts/{id}/watchesReplace equity watches (event WATCH_TRIGGERED)
GET/v1/commands/{id}Command status
GET/v1/eventsYour event feed, oldest first after a cursor (410 CURSOR_EXPIRED past the 14-day retention)
GET/v1/wsWebSocket (upgrade): live data and the event feed

Webhooks

GET/v1/webhooksYour webhooks (delivery state)
POST/v1/webhooksDeliver events to a URL (the answer shows the signing secret once)
GET/v1/webhooks/{id}One webhook (delivery state)
PATCH/v1/webhooks/{id}Change url / filters / enabled (enabled: true clears a failure state)
DELETE/v1/webhooks/{id}Remove a webhook
POST/v1/webhooks/{id}/rotate-secretA new signing secret (shown once; the old one stops signing at once)
POST/v1/webhooks/{id}/testSend one WEBHOOK_TEST event now and answer with the URL's answer
GET/v1/webhooks/{id}/deliveriesRecent delivery attempts (7 days), newest first

Billing & usage

GET/v1/billing/invoicesYour invoices, newest first (answers after expiry too)
GET/v1/billing/invoices/{id}One invoice
GET/v1/billing/usageUsage per UTC day (peak ACTIVE accounts, account hours, requests; answers after expiry too)
GET/v1/metrics/meRequests, errors and trade calls of the calling key per minute

Brokers & servers

GET/v1/serversBroker servers your accounts can use
GET/v1/brokersBrokers you can use: approved ones and your own uploads (file metadata, status)
POST/v1/brokersUpload a broker's server files (MT5 servers.dat, MT4 .srv or servers.ini) — repeat-safe; 409 when the broker has other files
GET/v1/brokers/{id}One broker
DELETE/v1/brokers/{id}Remove your own broker no registered account uses
PUT/v1/brokers/{id}/filesReplace the files of your own broker (back to PENDING; running terminals keep theirs until their next start)
GET/v1/broker-requestsYour requests to add a broker (newest first)
POST/v1/broker-requestsAsk the operator to add a broker you have no files for — repeat-safe for an open request
DELETE/v1/broker-requests/{id}Withdraw an open broker request
GET/v1/servers/{name}/access-pointsAddresses of a server with their TCP connect time from the gateway

Copy trading

GET/v1/copy/masters/{accountId}One copy master
PUT/v1/copy/masters/{accountId}Register / change a copy master (only the fields sent change)
GET/v1/copy/allocations/{externalId}One allocation with copy counters
PUT/v1/copy/allocations/{externalId}Upsert an allocation (versioned; leader != master, no cycles)
DELETE/v1/copy/allocations/{externalId}Remove an allocation without open copies (409 STATE_CONFLICT with openLinks otherwise)
POST/v1/copy/allocations/{externalId}/modeACTIVE, CLOSE_ONLY or PAUSED (only positions opened after activation are copied)
PUT/v1/copy/symbol-mapsSymbol mapping between servers (per client)
GET/v1/copy/mastersCopy masters with their account and copy counters
GET/v1/copy/allocationsAllocations (filter by leader, master, mode) with copy counters
GET/v1/copy/logsCopy log: oldest first after a cursor (default) or newest first with order=desc, limit ≤ 500

mtapi compatibility

GET/compat/{platform}/{method}mtapi.io-compatible methods (same names and parameters; id = account id)

Tools & status

GET/v1/audit-logYour security history: keys, accounts, credentials, webhooks, IP allowlist, copy and risk settings, and operator changes on your data (newest first; needs a key not limited to some accounts)
GET/v1/statusFree capacity and your ACTIVE accounts that are not connected
GET/v1/openapi.jsonThis document (without operator routes)
GET/v1/debug/headersHeaders and client address as the gateway sees them (secrets redacted) — for IP allowlist problems
POST/v1/tools/ping-hostTCP connect time from the gateway to broker addresses
GET/v1/versionVersions of the API and protocol
GET/v1/healthLiveness, no auth
GET/v1/readyReadiness, no auth: Postgres and Redis answer and the api is not shutting down (503 otherwise)
GET/v1/docsSwagger UI (no auth for the page; it asks for the key)