Developer API

Prop Firm REST API
Documentation

FXPropTech's REST API gives developers full programmatic access to your prop firm's data — trader accounts, evaluations, trades, payouts, risk rules, and more. Automate, integrate, and extend without limits.

100+
API Endpoints
REST
+ WebSocket
99.9%
Uptime SLA
OAuth2
Auth Standard
API Endpoint Status
GET /v1/traders 200 OK
POST /v1/accounts 201 Created
PUT /v1/rules/{id} 200 Updated
WS /v1/trades/stream ● Live
GET /v1/payouts 200 OK
100+
Endpoints
REST
+ WebSocket
99.9%
Uptime SLA

Endpoints

Core API Endpoints

Full CRUD access across every resource in your prop firm — traders, evaluations, trades, payouts, risk, and more.

Traders
GET/v1/traders

List all trader accounts with pagination, filtering by status, plan, or date range.

GET/v1/traders/{id}

Retrieve a single trader's full profile including KYC status, balance, P&L, and evaluation state.

POST/v1/traders

Create a new trader account, trigger evaluation provisioning, and send onboarding notifications.

PATCH/v1/traders/{id}

Update trader details, change account status, adjust funding tier, or override risk limits.

Evaluations
GET/v1/evaluations/{id}

Get real-time evaluation progress — phase, P&L, drawdown, days remaining, rule status.

POST/v1/evaluations

Programmatically provision a new evaluation account for a trader after payment confirmation.

POST/v1/evaluations/{id}/pass

Manually advance a trader to the next phase or funded status (admin-only endpoint).

DELETE/v1/evaluations/{id}

Terminate and archive an evaluation account (e.g., after rule breach or trader request).

Payouts
GET/v1/payouts

List all payout requests — pending, processed, and failed — with amounts and destination details.

POST/v1/payouts/approve

Approve and trigger a payout to a funded trader's wallet, bank, or payment method.


Webhooks

Real-Time Event Webhooks

Subscribe to any event in your prop firm's lifecycle. Webhooks are delivered via HTTPS POST with HMAC-SHA256 signatures — retry logic and failure alerts included.

Webhook Payload
{
  "event":  "evaluation.passed",
  "id":     "evt_9f3bc1a4",
  "ts":     "2025-04-25T09:12:00Z",
  "data": {
    "trader_id":  "TR-8842",
    "phase":      "1",
    "next_phase": "funded",
    "profit_pct": 8.4
  }
}
Available Events

trader.created

A new trader account has been registered and provisioned.

trader.kyc_passed

KYC verification completed successfully — trader is cleared to trade.

evaluation.started

A new evaluation account has been activated and the challenge clock started.

evaluation.passed

Trader has successfully passed an evaluation phase — advance to next phase or funded.

evaluation.failed

Trader breached a rule (drawdown, loss limit, etc.) — account has been deactivated.

payout.requested

A funded trader has submitted a profit withdrawal request — pending approval.

payout.completed

Payout has been successfully processed and funds dispatched to the trader.

payment.confirmed

Challenge fee payment received — automatically triggers evaluation provisioning.

risk.violation_flagged

Risk engine detected a rule violation (scalping, news trading, grid, etc.).

Developer Tools

SDKs, Tools & Authentication

Everything you need to integrate quickly — from API keys to client libraries and Postman collections.

OAuth 2.0 Auth

Bearer token authentication with scoped API keys. Generate keys per integration with read-only or full-access scopes from your admin panel.

Client Libraries

Official SDKs for Node.js, Python, PHP, and Go. Community libraries available for Ruby, Java, and more. Full type definitions included.

Postman Collection

Pre-built Postman collection with all 100+ endpoints, sample request bodies, and environment variables. Import and test in minutes.

Sandbox Environment

Fully isolated sandbox with mock data. Test the complete trader lifecycle — registration, evaluation, payout — without touching production.

Interactive API Explorer

OpenAPI 3.0 spec with Swagger UI. Browse, filter, and test every endpoint directly in the browser with your live API credentials.

Developer Support

Dedicated integration support via Slack, email, and scheduled calls. Our dev team helps you go from API key to live integration.


Frequently Asked Questions

API Documentation FAQs

Everything developers and prop firm operators need to know about integrating with the FXPropTech REST API.

The FXPropTech REST API gives you full programmatic access to your prop firm's data and workflows. You can automate trader onboarding, provision evaluation accounts on payment confirmation, retrieve real-time P&L and drawdown data, approve payouts, update risk rules, and stream live trade data via WebSocket — all without any manual steps in the admin panel.

FXPropTech uses OAuth 2.0 with Bearer token authentication. API keys are generated from your admin panel and can be scoped to read-only or full-access permissions per integration. Keys can be rotated or revoked at any time without disrupting other integrations.

FXPropTech supports webhooks for all major lifecycle events including: trader.created, trader.kyc_passed, evaluation.started, evaluation.passed, evaluation.failed, payout.requested, payout.completed, payment.confirmed, and risk.violation_flagged. Webhooks are delivered via HTTPS POST with HMAC-SHA256 signatures, retry logic, and failure alerts.

Yes. FXPropTech provides a fully isolated sandbox environment with mock data. You can test the complete trader lifecycle — registration, evaluation, payouts — without touching your production platform. A pre-built Postman collection with all 100+ endpoints is available for instant setup.

FXPropTech provides official SDKs for Node.js, Python, PHP, and Go with full type definitions. Community libraries are available for Ruby and Java. An OpenAPI 3.0 specification with Swagger UI is also provided so you can browse, filter, and test every endpoint directly in the browser.

Yes. In addition to the REST API, FXPropTech provides a WebSocket endpoint at /v1/trades/stream for real-time trade event streaming. This allows you to build live dashboards, trigger instant enforcement actions, or push live P&L data to custom trader-facing interfaces as trades occur.

Yes. The POST /v1/evaluations endpoint allows you to programmatically provision a new evaluation account the moment a trader's payment is confirmed. Combined with the payment.confirmed webhook, you can build a fully automated flow where a trader pays, receives MT4/MT5 credentials, and starts trading — with zero manual admin intervention.

FXPropTech provides dedicated integration support via Slack, email, and scheduled calls. The developer team helps you go from API key to live integration — including reviewing your architecture, debugging webhook delivery, and advising on automation best practices.

Start Building

Ready to Integrate?

Request your API credentials, access the sandbox, and start building your custom prop firm integration today.