CRM-API

Connect risk, reporting, sales and client-office tools to your Match-Trade CRM and the trading backend behind it, over REST and gRPC.

Read the docs

Contact sales

REST gRPC Webhooks AI skill

AI assistant

crm-api skill · sandbox

GET/v1/offers

Picks the USD offer: it sets currency and leverage

POST/v1/accounts

Creates the account and its trading account under that offer

GET/v1/payment-gateways

Finds a manual gateway in USD, matching the account currency

POST/v1/deposits/manual

Deposits 500 USD to the new login

Jane is registered and funded. Her first deposit also made her a client.

Example: an AI assistant with the CRM-API skill, on the sandbox.

What it covers

CRM data and trading operations through one access point. Your partner ID travels in the token, so you never pass it.

Accounts and leads

Create and update clients, read their timeline, add notes and tasks, send
inbox messages, track lead statuses

Trading accounts

Open accounts from your CRM offers, update them, change leverage

Payments

Gateways, deposit and withdrawal history, manual deposits and withdrawals, credit in and out

Trading

Open, edit, close and reopen positions; pending and correction orders

Trading data

Positions, order history, ledgers, groups, platform logs, balance snapshots
and candles, by login, group or ID

Prop trading

Challenges, prop accounts, evaluation requests,
competitions, add-ons and discounts

CRM events

Deposits, withdrawals, logins, manager assignments, notes, tasks
and account updates, as webhooks or gRPC streams

Single sign-on

Log your users into the Match-Trader platform
from your app with a one-time token

Real-time streams

Quotations, positions, orders, ledgers, equity, account info, symbols,
groups, trading events and prop-account changes over gRPC

Also

Social-trading leaderboard and statistics,
prediction-market bets and outcomes

Build the integration
by asking

Our CRM-API skill teaches AI assistants like Claude how this API works. Describe what you need in plain language, and the assistant writes and runs the calls or reviews your existing integration.

npx skills addhttps://github.com/match-trade/CRM-API-skill

Ships with a Python REST client, a smoke test, a gRPC template, TypeScript examples and an idempotent webhook handler.

View the skill on GitHub

What the assistant already knows

Offers decide currency, leverage and demo or real, so it reads them before creating anything.
Manual deposits need a manual gateway in the trading account’s currency.
Empty fields are left out rather than sent as null.
A 204 with no body means success.
An HTML error page means the request was blocked before
the API, usually an IP that isn’t whitelisted.
It works on the shared sandbox by default and only targets production when you confirm.

For tools that work alongside your CRM

Risk-management systems Client office and back-office portals Sales and retention tools Lead management and lead providers Reporting and analytics

Building or replacing a CRM?

CRM-API needs the Match-Trade CRM. If you deliver your own CRM, or connect to the platform without it, use Broker API v2.

Go to Broker API

From token to production

Four steps from your first test call on the shared sandbox
to a live, production-ready integration.

Step 01

Get a token

Request it from Match-Trade IT Support. It stays valid until revoked.

Step 02

Build on the sandbox

It’s shared between integrators, so use test data only.

Step 03

Conformance test

The integration guide lists
the tests for third-party tools.

Step 04

Go live

Switch to your production token, scoped to your brokerage.

Start with the docs

Endpoints, gRPC services, webhooks and the integration guide
are in the CRM-API reference.