Introduction

AI skill.md

Match-Trader has built a skill that makes integrating our API faster and easier. It lets you connect our API to your system - or check how your current integration is set up - just by describing what you need in plain language to an AI assistant. This skill teaches an AI assistant (like Claude) how to work with the CRM API. Instead of reading technical docs and writing code yourself, you simply say what you want to do, and the assistant handles the technical details for you. Link to GitHub.

To install it:

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

The CRM-API is a REST and gRPC API that exposes the data and operations of the Match-Trade CRM - and, additionally, of the Match-Trade trading backend - to external systems. It is the integration point for third-party tools that need to read from or act on a broker's CRM and trading data through a single access point.

Typical integrators include risk-management systems, custom client office and back-office portals, sales and retention tools, lead-management systems and lead providers, and reporting or analytics solutions. In short, any tool that works alongside a broker's existing Match-Trade CRM and needs access to its data can use this API.

The CRM-API is not intended for products that build or replace a CRM. If you are delivering your own CRM, or a system that connects directly to the Match-Trader platform without the Match-Trade CRM layer, use Broker-API v2 instead - it integrates with the platform directly and bypasses the CRM.

Through one access point, the CRM-API covers account management, offers, payments, trading accounts, positions, orders, market data, and CRM timeline events, over both REST and gRPC. This gives diverse client systems a consistent way to integrate with the Match-Trade CRM and backend.

In our system, each broker has a unique partnerID assigned. Every operation via this API is performed within that particular partnerID. Since we encode your partnerID in your Authorization token, you don't have to consider this parameter when sending requests, but you will see this parameter across multiple different endpoints. For the Sandbox environment, partnerID=0 and is shared between every account in the system. It means you will have access to test data added by other integrations.