API and integrations
What the PropExecutor API offers today and what is planned: keys and scopes, rate limits, account reports, trader assignment and integration patterns.
Does PropExecutor have an API?
Yes. Every plan includes API access. The REST API under `/v1` lets your systems list accounts, read live balance, equity and positions, pull trades, analytics, equity series and full account reports, assign and unassign traders, and read and rotate credentials. The documentation marks every endpoint as available or planned.
What can I do with the PropExecutor API?
With the API you can automate account delivery from your checkout by assigning pre-created accounts to buyers, build your own trader dashboards from account analytics and equity data, pull full reports for payout review, sync accounts into a CRM, export data, and rotate credentials from your support tools.
How do I create an API key?
Open the Developer page in the admin panel, create a key, give it a name and choose its scopes. The full token is shown once at creation; copy it into your system's secret store immediately. You can revoke a key at any time, which stops it working straight away.
Which API scopes are available?
There are four scopes: `accounts:read` to read accounts, trades, positions, analytics and reports; `accounts:write` to assign and unassign traders; `credentials:read` to read and rotate account credentials; and `trading:write`, reserved for trading endpoints that are planned. A key carries only the scopes you select.
Is there a rate limit on the API?
Yes. Each API key may make up to 1,200 read requests and 120 write requests per minute. Limits are counted per key, so one runaway script cannot starve your other integrations. Requests without a valid key are limited per IP address. A request over the limit receives a 429 response with retry information.
Can I pull a full account report through the API?
Yes. `GET /v1/accounts/{number}/report` returns one account's complete picture in a single response: identity, balance and equity history, monthly statement, indicators, streaks, long and short performance, results by instrument, every deal and position, and the frozen evaluation terms with any breaches.
Can I assign traders through the API?
Yes. `PUT /v1/accounts/{number}/trader` with a name and email assigns the account to that trader, creating the trader record if none exists for the email. `DELETE` on the same path unassigns it. Both revoke the account's live sessions when the holder actually changes.
Can I connect PropExecutor to my own website and checkout?
Yes, through the API. The usual pattern is to create unassigned accounts in bulk in the admin panel, then have your checkout's payment webhook assign the next account to the buyer with `PUT /v1/accounts/{number}/trader`, read its credentials, and email them. Your website and payments stay entirely yours.
Can I build my own trader dashboard on the API?
Yes. The API provides per-account analytics, equity series and full reports, so you can build a trader page on your own website. Many firms do not need to, because every PropExecutor account already includes a dashboard inside the terminal; a custom dashboard is for firms that want everything in their own portal.
Can I connect PropExecutor to my CRM?
Yes, through the API. A CRM integration typically syncs accounts and their status, assigns accounts to traders on purchase, and pulls reports for payout workflows. Most CRMs support webhooks or scheduled jobs that can call the PropExecutor API with a key scoped to what they need.
Does PropExecutor send webhooks to my systems?
Not yet. Outgoing webhooks, which would notify your systems of events such as passes and breaches, are documented in the API reference with a planned status. Today, integrations poll the API on a schedule, for example listing accounts every few minutes to pick up status changes.
Can I create trading accounts through the API?
Not yet. Account creation over the API is documented as planned. Today, accounts are created in the admin panel, in bulk of up to 100 per request, and your systems assign them to traders over the API. Pre-creating inventory this way gives instant delivery without API creation.
Where is the API documentation?
The API documentation is at /docs on the PropExecutor website. It covers authentication and scopes, errors, pagination, rate limits, each endpoint group, concepts and limits, and an availability page listing every endpoint as available or planned. Each page is also available as Markdown for AI tools.