Per address, every API
All requests toapi.hyperprop.com from one client address count toward
one limit: 30,000 requests in any 5 minutes (about 100 a second).
Exits never count toward that limit. POST requests to
/trade/order/cancel, /trade/orders/cancel-all, /trade/position/close,
/trade/close-all and /trade/flatten have their own allowance, five times
higher: 150,000 in any 5 minutes. A server that reaches the general limit can
still cancel orders and close positions for its traders.
Over either limit, requests from that address answer 429 until its count
for the last 5 minutes drops below the limit:
Platform API
Apart from the per-address limit above, the Platform API has no global request-rate limit, but the endpoints below are limited per organization (all API keys and portal users of your firm count together). Endpoints not listed here have no fixed limit. Treat the numbers as the rate to stay under: they are approximate, so don’t rely on getting more. Over a limit, the endpoint answers 429 with codeRATE_LIMITED and a
Retry-After header (whole seconds). Some endpoints also put
retryAfterSeconds in the body; the header is always there. Wait at least
Retry-After before retrying. These answers carry no X-RateLimit-*
headers or rate_limit block.
Accounts and account operations
To provision many accounts, use
POST /trading-accounts/bulk: one call
creates many accounts and counts once. To refresh many accounts, use the
many-accounts read (up to 200 accounts per call) rather than one call per
account.
Reports and insights
The heavier reports also run at most 6 at a time per organization:
GET /analytics, /analytics/hourly, /analytics/top-traders,
/analytics/revenue, /risk/pnl, /risk/plan-economics, /risk/behavior,
/risk/linked-traders, /risk/trading-patterns, /insights/top-traders,
/insights/sentiment, /insights/watchlist/activity and
/trading-accounts/active-traders. A seventh request while six are still
running answers 429 RATE_LIMITED with Retry-After: 5. A report that
runs out of time answers 503 REPORT_TIMEOUT with a Retry-After
header; wait at least that long before asking again.
Webhooks, billing, support and team
See Billing and invoices for the billing
endpoints.
Per trader: journal reads
The two journal reads are limited per trader, however the trader is signed in (app, personal API key or partner app):
One partner app can also make at most 600 journal requests a minute
across all its traders together. Over any of these limits the endpoint answers
429
RATE_LIMITED with a Retry-After header.
Sign-in and invalid keys
Trader sign-in limits repeated failed attempts, and resending the verification email is limited too. Both answer 429 with codeTOO_MANY_ATTEMPTS and a Retry-After header (seconds). Sign-in requests
(/platform/v1/auth/*, except me and refresh) from one address are also
limited to 300 in any 5 minutes, answered like the
per-address limit.
Repeated failed sign-ins on the journal with a personal API key or with
partner app headers (wrong key, wrong app secret) answer 429 with
Retry-After: 60; fix the credentials instead of retrying. Other invalid API
keys are also refused with 429 for a short time.
Design for these limits cheaply: respect
Idempotency-Key on writes, back
off on ENGINE_UNREACHABLE / IDEMPOTENCY_KEY_IN_PROGRESS (see
Idempotency), and always honour Retry-After.Trade API
The Trade API rate-limits per account, per action category using token buckets: each category has a burst (“at once”) and a steady refill rate. Short bursts up to the burst are fine; sustained throughput is the refill rate.Exits have their own allowance per holder
Order submissions and modifications share one bucket per account, whoever sends them. Exits (cancellations, closes and flattens) are counted separately for each holder on the account:- the trader’s own Hyperprop session (web terminal and mobile app),
- the trader’s personal API keys, together,
- each partner app.
Partner apps and personal API keys
These apply on top of the per-account limits above.
New sessions are limited too.
POST /trade/partner/session and
POST /trade/api-keys/session allow at most 30 successful exchanges a
minute per trader key, and one partner app at most 3,000 a minute
across all its traders. A session lasts 15 minutes, so reuse it instead of
exchanging the key for every request. Over the limit the exchange answers
429 RATE_LIMITED with a Retry-After header and the rate_limit
block below. Repeated failed exchanges answer 429 too; wait a minute
before trying again.
Open trade event connections (/trade/ws) are capped per holder: a personal
API key user can keep up to 5 open, and a partner app up to 8 per trader. The
trader’s own terminal sessions keep their own connections. An extra
connection is refused with 429.
429 responses
Exceeding a bucket returns 429 with codeRATE_LIMITED and full retry
guidance in the body:
rate_limit block only appears on 429 responses; successful
responses do not include it, so pace with the per-bucket rates above. Sleep
rate_limit.retry_after seconds and retry — that value is exact, not an
estimate.
The 429 response also includes standard HTTP headers:
The personal API key read limit is the exception: its 429 carries code
RATE_LIMITED and a Retry-After header, without the rate_limit block.