API documentation

Limits & quotas

Every limit you can run into, with its value and the answer you get when you reach it. Plan-dependent values are always in GET /v1/me.

Updated

Your limits and usage

GET /v1/me returns your plan, its end date and how much of each limit you use. Every response also carries the end of your paid period in the x-subscription-expires-at header.

bash
curl -i https://api.propmetaapi.com/v1/me -H "Authorization: Bearer $GW_KEY"

HTTP/1.1 200 OK
x-subscription-expires-at: 2026-11-04T00:00:00.000Z

{
  "subscription": { "expiresAt": "2026-11-04T00:00:00.000Z", "active": true, "daysLeft": 30 },
  "limits": {
    "activeAccounts": { "used": 12, "max": 100 },
    "accounts": { "used": 31, "max": 300 },
    "requestsPerMin": 6000,
    "tradesPerMin": 600
  }
}
GET /v1/me keeps answering after the plan ends or when access is suspended — use it as your health check.

Plan limits

LimitValueWhen reached
ACTIVE accounts (permanently connected)your plan403 QUOTA_EXCEEDED on activate
Registered accounts (ACTIVE + STANDBY)your plan (by default 3 × the ACTIVE limit)403 QUOTA_EXCEEDED on create
Requests per minute (reads)6000 by default — yours is limits.requestsPerMin in GET /v1/me429 RATE_LIMITED + Retry-After
Trade requests per minute600 by default — yours is limits.tradesPerMin in GET /v1/me429 RATE_LIMITED + Retry-After
Trade requests per minute on one account300429 RATE_LIMITED + Retry-After
Credential changes on one account20 an hour429 RATE_LIMITED + Retry-After
POST …/check on one account120 an hour429 RATE_LIMITED + Retry-After
Webhook test deliveries10 a minute429 RATE_LIMITED + Retry-After
Broker file uploads (POST /v1/brokers, PUT …/files)20 an hour; at most 10 brokers waiting for approval and 200 MB of stored files429 RATE_LIMITED / 403 QUOTA_EXCEEDED
Working API keys20403 QUOTA_EXCEEDED
Webhooks10403 QUOTA_EXCEEDED
Risk trackers per account10 (+ one daily drawdown limit)403 QUOTA_EXCEEDED
Accounts in one scoped key1000400 VALIDATION
IP allowlist rules200 (IPs or CIDRs, IPv4 or IPv6)403 FORBIDDEN_IP for other addresses

Request rate

  • Limits are per client: all your keys share them.
  • Reads and trade calls (orders, modifications, closes, cancels) are counted separately.
  • The window is the calendar minute (UTC); it resets at the start of every minute.
  • Over the limit you get 429 RATE_LIMITED with a Retry-After header and details.retryAfter — the seconds until the minute ends. There are no other rate-limit headers.
http
HTTP/1.1 429 Too Many Requests
Retry-After: 17

{ "code": "RATE_LIMITED", "message": "rate limit exceeded", "retryable": true, "details": { "retryAfter": 17 } }

Retry with the Retry-After value, never in a tight loop: retrying safely

Request limits

LimitValueWhen reached
Request body256 KB (broker file uploads: 23 MB)400 VALIDATION
?wait on any route0 – 60 seconds400 VALIDATION
Market data ?timeout2 – 120 seconds (default 30)504 QUERY_TIMEOUT when the terminal is slower
Parallel reads on one account4 at a time429 RATE_LIMITED, retry after 1 s
Idempotency-Key1 – 128 characters400 VALIDATION
Order comment / symbol27 / 32 characters400 VALIDATION
deviationPoints0 – 10 000400 VALIDATION
symbols= list4000 characters; items beyond the route's cap are dropped silently (quotes, market-watch, tick-values, trade-rights 500 · symbols 1000 · sessions/status 100 · rates 20 · WebSocket 200)400 VALIDATION above 4000 characters
Failed authentications per IP30 per minute (an IPv6 /64 together: 120)429 RATE_LIMITED
Numbers in a request bodymust be finite (1e400 and similar are refused)400 VALIDATION
POST /v1/tools/ping-host port80, 443 or 1024 – 65535, except well-known database and remote-desktop ports400 VALIDATION

Page sizes

List routes take ?limit; larger values are refused with 400. Page through the rest with the route's cursor (after / cursor / pageNumber).

RouteMax limitDefault
GET /v1/accounts500100
GET /v1/events500500
GET …/deals1000500
GET …/closed-orders1000100
GET …/equity-bars1000500
GET …/logs1000200
GET …/risk-trackers/{id}/periods50030
GET …/daily-drawdown/days50030
GET /v1/webhooks/{id}/deliveries20050
GET …/symbols10 00010 000
GET …/ticks (MT5)100 00010 000
GET …/rates (count)100 000—

How long commands may take

A trade call answers 202 with a command at once. With ?wait=N (up to 60 s) it answers 200 with the final command when it finishes in time; otherwise read GET /v1/commands/{id}?wait=60 until it is final.

LimitValueWhen reached
CHECK (one-off login and read)150 s504 DEADLINE_EXCEEDED
Close all120 s504 DEADLINE_EXCEEDED
Every other trade command60 s504 DEADLINE_EXCEEDED
Terminal read (quotes, symbols, rates …)?timeout, default 30 s504 QUERY_TIMEOUT
A STANDBY account after a read with ?waitstays logged in 60 s; a check younger than 60 s is reused—
Keep every ?wait at 60 s or less and set your HTTP client timeout above it (for example 75 s). Never resend a trade with a new Idempotency-Key after a timeout — ask for the command first; resending with the same key is always safe.

WebSocket limits

LimitValueWhen reached
Open sockets per key50HTTP 429 at the handshake (details.retryAfter 10 s)
Subscriptions per socket500error RATE_LIMITED
Symbols in one subscribe200error VALIDATION
Incoming message size1 MBsocket closed
Messages you send20 a second on average, bursts up to 600error RATE_LIMITED with the message's id; 5 seconds in a row over it: closed (1008)
Server pingevery 20 s — a socket that missed the previous ping is closedreconnect
Slow readerover 4 MB queued: only the latest value per stream; over 16 MB: closed (1013)read faster or subscribe to less
Key checked againevery 10 s — revoked, expired or suspended keys are closed (4401)—

WebSocket guide →

Webhook limits

LimitValueWhen reached
Webhooks per client10403 QUOTA_EXCEEDED
Target URLhttps only, a public address, no redirects followed400 VALIDATION
Your endpoint must answer2xx within 10 sretried
Events per deliveryup to 50, in order—
Retries10 s, 20 s, 40 s … doubling up to 1 hour—
Failing for 72 hoursthe webhook is switched offevent WEBHOOK_DISABLED

Webhooks and signature checks →

Data retention

DataKept for
Event feed (GET /v1/events)14 days — an older cursor answers 410 CURSOR_EXPIRED
Equity bars (one per minute)14 days — an older cursor answers 410 CURSOR_EXPIRED
Account logs14 days
Webhook delivery records7 days
Copy trading log90 days
Deals, closed positions, orders history, commandsas long as the account exists
A removed account and all its datadeleted 90 days after removal

When your plan ends

  • You get the events SUBSCRIPTION_EXPIRING 3 days and 1 day before the end, then SUBSCRIPTION_EXPIRED.
  • After the end, requests answer 402 SUBSCRIPTION_EXPIRED and WebSockets close.
  • These keep working so you can always reduce risk: GET /v1/me, open positions and pending orders, closing a position, cancelling an order, close-all, and billing (invoices, one invoice, usage). Command polling (GET /v1/commands/{id}), the event feed, the WebSocket and webhooks stop — send those close calls with ?wait, or repeat them with the same Idempotency-Key, to read the result.
  • 24 hours after the end, ACTIVE accounts go back to STANDBY. Renewing keeps the same keys and accounts.
A suspended client gets 403 CLIENT_SUSPENDED everywhere except GET /v1/me; contact support.

Billing & usage

Your invoices and your day-by-day usage are readable through the API. All three /v1/billing routes need a key with the manage permission that is not limited to some accounts (otherwise 403 FORBIDDEN with details.permission). There is no separate plan or quota route: the plan label, the paid period and the quotas are in GET /v1/me above.

RouteAnswer
GET /v1/billing/invoicesYour invoices, newest first, at most 200.
GET /v1/billing/invoices/{id}One invoice. An unknown id or another customer's invoice answers 404 NOT_FOUND.
GET /v1/billing/usageOne row per UTC day, oldest first. ?from and ?to are days (YYYY-MM-DD), to inclusive; default: the last 30 days. A date that is not a real calendar day answers 400 VALIDATION.
GET /v1/mePlan label (client.plan), paid period (subscription) and the quotas with their use (limits; max null = no limit) — see Your limits and usage above.
GET /v1/metrics/meRequests, errors and trade calls of the calling key per minute (?minutes 1–10080, default 60) and its open sockets; read permission.
bash
curl https://api.propmetaapi.com/v1/billing/invoices -H "Authorization: Bearer $GW_KEY"
{
  "items": [
    { "id": "9b2f…", "number": "INV-2026-000042", "clientId": "c7a1…", "plan": "pro-100", "description": "…",
      "periodStart": "2026-10-04T00:00:00.000Z", "periodEnd": "2026-11-04T00:00:00.000Z", "maxActiveAccounts": 100,
      "amount": 199, "currency": "USD", "status": "PAID", "paidAt": "2026-10-04T08:12:00.000Z", "paymentRef": "…", "note": null,
      "createdAt": "2026-10-04T08:11:40.000Z" }
  ]
}

curl https://api.propmetaapi.com/v1/billing/invoices/$INVOICE_ID -H "Authorization: Bearer $GW_KEY"     # one invoice (404 NOT_FOUND otherwise)

# 403 FORBIDDEN without the manage permission, or with a key limited to some accounts:
# { "code": "FORBIDDEN", "message": "billing needs the \"manage\" permission", "details": { "permission": "manage" } }

Invoice fields

FieldMeaning
numberInvoice number <prefix>-<year>-<6 digits>, e.g. INV-2026-000042; no two invoices share one.
planCode of the plan sold, or null.
descriptionWhat the invoice is for.
periodStart, periodEndThe paid period this invoice sells (ISO 8601).
maxActiveAccountsACTIVE-account quota sold with that period.
amount, currencyPrice as a number and its 3-letter currency.
statusPENDING (unpaid), PAID (then paidAt and paymentRef are set) or VOID (cancelled by the operator).
noteThe operator's note, or null.
id, clientId, createdAtInvoice id (for GET /v1/billing/invoices/{id}), your client id, creation time.

Usage per day

bash
curl "https://api.propmetaapi.com/v1/billing/usage?from=2026-10-01&to=2026-10-03" -H "Authorization: Bearer $GW_KEY"
{
  "items": [
    { "day": "2026-10-01", "peakActiveAccounts": 12, "activeAccountHours": 281.5, "accounts": 31, "requests": 48210, "tradeRequests": 913 },
    { "day": "2026-10-02", "peakActiveAccounts": 14, "activeAccountHours": 318.25, "accounts": 33, "requests": 51077, "tradeRequests": 1204 },
    { "day": "2026-10-03", "peakActiveAccounts": 14, "activeAccountHours": 336, "accounts": 33, "requests": 20311, "tradeRequests": 388 }
  ]
}
FieldMeaning
dayUTC day, YYYY-MM-DD.
peakActiveAccountsHighest number of ACTIVE accounts that day.
activeAccountHoursHours your ACTIVE accounts were running that day, summed (two decimals).
accountsRegistered accounts that day.
requestsRequests counted that day, over all your keys.
tradeRequestsTrade calls counted that day.
Billing reads keep working after your plan ends — a PENDING invoice is what renews it — while commands, the event feed, the WebSocket and webhooks answer 402 SUBSCRIPTION_EXPIRED. Payment is not collected through the API: the operator marks an invoice PAID; a VOID invoice takes back the period it sold. When your plan ends · Error codes

Accounts and platforms

  • STANDBY accounts have no connection: reads need ?wait (a short login), otherwise 409 ACCOUNT_NOT_CONNECTED. Accounts you read or trade often should be ACTIVE.
  • Connecting (activate) usually takes 15–60 s. Logins are paced to protect your broker connections, so activating many accounts at once is spread over a few minutes — this is expected.
  • Trailing stops, live risk-tracker figures and equity watches need an ACTIVE account.
  • MT5 only: order book (book channel), tick history, STOP_LIMIT orders, the extra timeframes (M2, M3 …) and certificates. On MT4 these answer 422 NOT_SUPPORTED_ON_PLATFORM.
  • Accounts can only be registered on servers of a broker the gateway knows (GET /v1/brokers; for a missing one send POST /v1/broker-requests), and the broker must be verified by one successful check before accounts on it can be activated (409 BROKER_NOT_VERIFIED).

Account lifecycle in the integration guide →