Skip to main content

PrimeXBT Partner API explained

The PrimeXBT Partner API gives partners more control over client data, reporting, and business automation. It can connect PrimeXBT with your CRM, internal dashboard, onboarding system, or other business tools.

You do not need to be a developer to understand its value. The API helps reduce manual work and gives your team faster access to important information about referred clients and commissions.

Find the technical documentation here: https://api.primexbt.com/docs/partner.html

What can the Partner API do?

  • Checking whether a specific client is assigned to your partner account

  • Receiving a list of your referred clients

  • Reviewing client registration and assignment dates

  • Checking available information about deposits, trading turnover, and KYC status

  • Creating commission reports for selected periods

  • Viewing revenue, turnover, and partner commission by client

  • Sending PrimeXBT data to your CRM, internal dashboard, or reporting system

For example, instead of manually checking every client in the Partners Area, your system can automatically confirm client attribution and update the relevant CRM record.

Another example is automated reporting. Your team can regularly receive updated figures for client activity and partner commissions without downloading and processing reports manually.

How to get access

To use the Partner API, request an API key from your Account Manager.

The API key is unique to your partner account. It identifies your business when your system requests data from PrimeXBT.

  • Do not share it with other partners or unauthorised third parties

  • Do not publish it on websites, social media, or public code repositories

  • Store it only in a secure system controlled by your business

  • Give access only to trusted developers or employees working on your integration

Technical documentation: https://api.primexbt.com/docs/partner.html
The documentation is intended for the developer who will build or maintain your integration.

Post-registration redirect

Post-registration redirect allows you to send a referred client back to your website or platform immediately after they complete registration with PrimeXBT.

  • Continue onboarding on your website

  • Open a course or educational platform

  • Access a partner dashboard

  • Complete the next step in your customer journey

  • Be matched with a record in your internal system

To use this feature, add the redirect_url parameter to the PrimeXBT registration link:
https://primexbt.com/my/id/sign-up?redirect_url=https%3A%2F%2Fpartner-example.test%2Fcallback

The source link example:
https://partner-example.test/callback?client_id={clientId}

The client_id value allows your system to identify the newly registered client and continue the required process.

For security reasons, your redirect domain must be added to the PrimeXBT whitelist before this feature can be used. Contact your Account Manager to request the setup.

Postbacks

Postbacks allow PrimeXBT to send information to a URL provided by the partner when a referred client completes a specific action. This gives your business access to important events almost in real time.

For example:

  1. A referred client registers or makes a deposit.

  2. The partner’s system receives the event almost in real time.

  3. The partner can automatically update the CRM, start an onboarding flow, notify a manager, or trigger another internal process.

Postbacks can help you respond to client activity faster and reduce the need for manual checks.

To discuss available events, transmitted data, and postback setup, contact your Account Manager.

Can I request additional API capabilities?

Yes. If your business requires additional methods, data fields, events, or an extension of the existing API capabilities, share your request with your Account Manager.

Explain the business task you want to automate and how the additional data would be used. The PrimeXBT team will review the request and discuss the available options with you.

Need help?

Contact your Account Manager to:

  • Request a Partner API key

  • Set up a post-registration redirect

  • Add your redirect domain to the whitelist

  • Configure postbacks

  • Discuss additional API methods or integration requirements

  • Get help with an existing integration

Did this answer your question?