EventWe're exhibiting at Forex Expo Dubai 🇦🇪Meet us at Forex Expo Dubai 🇦🇪At Forex Expo Dubai 🇦🇪22–23 Sep 202622–23 SepSee the schedule
Book a Demo
Build

Every object, over REST.

If you can see it in the platform, you can read and write it over the API. Versioned endpoints, webhooks on every state change, and a sandbox tenant so you build against real behaviour before touching live traders.

Book a Demo Read the Guides
curl · traders.get200 · 38ms
$ curl api.ypf.io/v2/traders/88410
{
"name": "Daniela Reyes",
"status": "funded",
"accounts": 3,
"lifetime_payouts": 18420
}
Reference

Core endpoints.

The most-used surface. Full schemas, parameters and examples live in the developer guides.

Traders

Identity, contact and KYC state
GET/tradersList traders with filtering and cursor pagination
POST/tradersCreate a trader record
GET/traders/{id}Retrieve a trader with linked accounts
PATCH/traders/{id}Update trader fields, subject to role scope
GET/traders/{id}/kycVerification state and evidence references

Accounts

Trading accounts across every platform
GET/accountsList accounts, filterable by program, phase and state
POST/accountsProvision an account on a connected platform
GET/accounts/{id}/metricsLive equity, drawdown and target progress
POST/accounts/{id}/disableDisable trading and optionally flatten positions

Programs & challenges

Evaluation design and lifecycle
GET/programsList published programs and their current versions
POST/programsCreate a program version
GET/challenges/{id}Challenge state, phase and rule version in force
POST/challenges/{id}/resetIssue a reset against a challenge

Payouts

Requests, approvals and settlement
GET/payoutsList payout requests by state
POST/payoutsCreate a payout request
POST/payouts/{id}/approveRecord an approval in the chain
GET/payouts/{id}/eventsFull pipeline history for one payout

Webhooks

Push notification of state changes
GET/webhooksList configured endpoints and subscribed events
POST/webhooksRegister an endpoint with an event filter
DELETE/webhooks/{id}Remove an endpoint
What the API gives you

Built for teams who ship.

Capability06 included

Every object over REST

Traders, accounts, challenges, payouts, rules and KYC state — anything you can do in the UI you can do over the API.

Webhooks on state changes

Subscribe to the events you care about with signed payloads, automatic retries and a replay window for missed deliveries.

Sandbox per firm

A full environment with seeded data, so you can build and test against real flows without touching production.

Versioned with a deprecation policy

Breaking changes ship behind a new version with a published sunset date. Nothing changes under you without notice.

Rate limits you can see

Current usage and remaining quota returned on every response, with burst headroom for migrations and bulk jobs.

SDKs and examples

Typed clients for TypeScript, Python and PHP, plus copy-paste curl for every endpoint in the reference.

Server-side enforcement41 ms median latencyEvery change audit-loggedIncluded on every plan
Base URL

What's included

Standard on every firm running on the platform. No add-on tier, no per-seat unlock.

06capabilities
included by default
  • 01https://api.yourpropfirm.com/v2
  • 02Bearer token authentication
  • 03Cursor pagination on all collections
  • 04Idempotency keys on writes
  • 051,000 req/min default rate limit
  • 06Signed webhooks with replay window
Keep exploring

Related in this family

System Status

Live uptime across every service

Explore

Help Center

Searchable answers for you and your traders

Explore

Contact

One form, routed to whoever can answer

Explore

Implementation

A named lead from kickoff to cutover

Explore
Questions

Questions operators ask

Generate scoped keys from Admin Controls. Each key carries its own permission scope and appears in the audit log, so machine access is attributable in the same way as a human user.
1,000 requests per minute by default, per key. Limits are raised on request for bulk work such as migration, and responses carry standard rate-limit headers so you can back off cleanly.
Endpoints are versioned and breaking changes carry a minimum twelve-month deprecation notice, with both versions running in parallel through the transition.
Let's talk

Get sandbox access.

A sandbox tenant with seeded data and full API surface, so you can build before you commit.

Book a Demo