Integration & API
From a 30-minute iframe drop-in to a fully custom build on REST + gRPC. The platform stays the source of truth — you control the UX, brand, and funnel.
Live demo · zero code
No backend changes, no migration, no redesign. Sign a short-lived JWT, embed the snippet below in your client portal — your investors land inside a fully themed B2COPY experience without a second login.
Copy the iframe snippet, paste into any page in your portal — leaderboard, master profile, subscribe-flow, all mobile-ready.
Issue an external JWT from your IdP, exchange via SideAuthenticate. Your clients never see a separate B2COPY sign-in.
Inherits your colors, typography, and language through query params and CSS tokens — out of the box.
One contract
Every public method is described in shared `.proto` files and exposed over both gRPC and REST. Pick the transport that matches your stack — request and response shapes are identical.
Versioned routes generated from the same .proto files. Use it for CRMs, web apps, mobile clients, and no-code scenarios — anywhere HTTPS is easier than gRPC.
Use Connect or gRPC-Web for microservices, internal gateways, and high-throughput integrations where latency and streaming matter. Type-safe, code-generated clients in any language.
API surfaces
Three lightweight layers, one protobuf contract. Use them independently or stack them — Broker for back office, Frontend for your own client app, Widget for embeds on your marketing site.
Server-to-server. Built for your CRM and back office — admin JWT, paginated account lists with embedded owner data, full subscription management for copier and PAMM links.
Server-to-serverOn behalf of the user. Powers your own web or mobile client: auth, accounts, subscriptions, deals, fees, transfers, leaderboard, charts, UI settings — everything from login to closing a position.
User-scopedPublic read-only surface. A trimmed layer for embeddable blocks — master cards, charts, leaderboards, and subscription-code checks on your marketing site, without a full client app.
Public · read-onlyAuthentication
EC-signed tokens scoped per tenant, rotated independently of user sessions. No password handling on either side of the integration.
Your back-office services authenticate to the Broker API with an admin JWT signed with your EC key. Tokens are tenant-scoped and can be rotated without touching user sessions.
Broker APIIssue an external JWT from your client portal, exchange it via SideAuthenticate or AuthUserWithExternalToken, then proceed with normal user-scoped calls. No second sign-in for your clients.
Frontend APIGetting started
One scenario takes a developer 1–3 days end-to-end. Two typical first integrations: a leaderboard on your website (Widget API), or CRM subscription sync (Broker API).
01
Get staging and production credentials — admin JWT for the Broker API, SSO setup for the Frontend API. Provisioned within one business day.
02
Choose gRPC (Connect or gRPC-Web) or REST. The OpenAPI spec is generated from the same .proto files — pick whichever matches your stack.
03
A leaderboard on your website (LeaderboardList + ChartService), or CRM subscription sync (Broker LinkService). One scenario takes 1–3 days.
04
Chain SideAuthenticate → Frontend API with the user JWT. Your clients move from your portal into the B2COPY-powered experience without re-authenticating.
Three integration paths
Every path is documented, supported, and used in production by other brokers. Start with the widget today, layer in deeper API later — nothing about your stack has to move.
Fastest path
Drop a pre-built widget (leaderboard, master profile, subscribe-flow) into your CRM, client area, or marketing page. SSO via a signed JWT — your investors land inside B2COPY already authenticated, themed to your brand.
Live in 30 minutes<!-- Add to your client portal -->
<iframe
src="https://widget.b2copy.com/copy"
data-sso-token="{{user.jwt}}"
data-theme="dark">
</iframe>
B2Core
+ IB Module
Nullpoint CRM
Ready
FX Back Office
ReadyZero dev
Already running B2Core, Nullpoint, or FX Back Office? B2COPY is ready — toggle the feature and copy trading appears in your client area the same day. B2Core integration also unlocks the IB Module for partner programs.
Full control
Build your own copy trading UX from scratch. REST for CRMs, web, mobile, and no-code; gRPC for high-performance real-time streaming. Generated from the same protobuf contracts — semantics are identical between transports. Sandbox + dedicated integration engineer included.
2–3 weeks · sandbox + engineer// REST APIGET/api/v1/copy/mastersPOST/api/v1/copy/subscriptionsGET/api/v1/copy/positionsPUT/api/v1/copy/subscriptions/{id}Coverage at a glance
Use it as a sizing reference: your CRM team works against the Broker API, your client app against the Frontend API, and your marketing site against the Widget API.
| Feature | Broker API Server-to-server | Frontend API On behalf of user | Widget API Public · read-only |
|---|---|---|---|
| Accounts & users | Reads · paginated lists | Full CRUD + leaderboard | Reads · subscription code |
| Copier / PAMM subscriptions | Full management | Full management | — |
| Trading & history | — | Positions · deals · stats | Positions · stats |
| Profitability & charts | — | ✓ | ✓ |
| Fees & promo codes | — | ✓ | Active plan |
| Transfers | — | ✓ | — |
| Challenges & contests | — | ✓ | — |
| Auth / SSO | — | ✓ | — |
| UI & platform settings | — | ✓ | Platform-level |
Broker API
Subscription management and CRM-friendly list reads with owner data embedded in responses. Authenticates with an admin JWT signed by your EC key.
Representative methods most CRMs need on day one — the full Broker API surface is broader and is extended on request to match your back-office model.
One call returns a paginated list of trading accounts with filters, sorting, and basic owner data (id, email, nickname, country) attached — built for CRM list views.
| Method | Purpose |
|---|---|
List | Paginated list of trading accounts with filters, sorting, and embedded owner data — for one-shot CRM rendering. |
| Method | Purpose |
|---|---|
Get | Retrieve a B2COPY user profile. |
List | Paginated list of users. |
Full management surface for copier and PAMM subscriptions — create, update, delete, restore, fetch details, and list with filters.
| Method | Purpose |
|---|---|
CreateCopierLink | Create a copy-trading subscription (investor → master). |
CreatePAMMLink | Create a PAMM subscription. |
UpdateCopierSettings | Update copying settings. |
UpdatePAMMSettings | Update PAMM settings. |
Delete | Disable a subscription. |
Restore | Restore a previously disabled subscription. |
GetCopierLink / GetPAMMLink | Details for a single subscription. |
ListCopier / ListPAMM | List subscriptions with filters and pagination. |
Typical scenarios: sync subscriptions to your CRM, run bulk operations from support tools, orchestrate master / investor onboarding on the broker side. Need a method that is not listed — bulk reassignment, custom owner-data shape, internal-tooling endpoint? Tell us during scoping; we add it on the next release.
Frontend API
Everything from login to closing a position and paying out fees. Use it to replace or complement the standard B2COPY client app — works for web and mobile, authenticates the user via SSO with a short-lived JWT.
A representative slice of the Frontend API — the actual surface covers many more services, fields, and edge cases. We extend it on request to match your client app UX.
| Method | Purpose |
|---|---|
Login | Sign in with platform username / password. |
AuthWithPlatformCredentials | Authenticate with trading-account credentials. |
RefreshToken | Refresh the active session. |
AuthUserWithExternalToken / AuthAccountWithExternalToken | SSO via external tokens — embed B2COPY into your client area without a second login. |
SideAuthenticate / SideLoginWithToken | Seamless side-login from your broker portal. |
The widest service in the API — covers account lifecycle, the public leaderboard, master profiles, finances, subscription codes, and account-type management.
| Method | Purpose |
|---|---|
Create | Create a B2COPY account on top of an existing MT or cTrader account. |
Get / Update | Read and edit account data. |
LeaderboardList | The public master leaderboard — filters, sorting, the top-N feed. |
ListMyAccounts | List accounts owned by the current user. |
ListAccountFinances | Financial metrics per account. |
SetIsInLeaderboard | Toggle whether a master appears in the leaderboard. |
CheckSubscriptionCode / GenerateSubscriptionCode / SetSubscriptionCode | Subscription codes for closed (invite-only) masters. |
GetMasterByLogin | Look up a master by login. |
GetAccountView / UpdateAccountView | The master's public profile view. |
SetMinimumDeposit | Minimum deposit required from subscribers. |
ResetPassword | Reset the account password. |
ListAvailableAccountTypes | Account types available on the platform. |
| Method | Purpose |
|---|---|
CreateCopierLink / CreatePAMMLink | Create a subscription on behalf of the user. |
UpdateCopierSettings | Update copying settings. |
Delete / Restore | Unsubscribe and restore. |
ListSubscribersCopier / ListSubscriptionsCopier | Copier subscribers and subscriptions. |
ListSubscribersPAMM / ListSubscriptionsPAMM | PAMM subscribers and subscriptions. |
GetOverviewMaster / GetOverviewInvestor | Summary view for the master or investor role. |
| Service · Method | Purpose |
|---|---|
PositionService.List / Close / Detach | Open positions, closing, and detaching from a master. |
DealService.List | Deal history. |
StatService.GetTradingStatistics | Aggregated trading statistics for dashboards and reports. |
| Service · Method | Purpose |
|---|---|
ReturnsService.List | Returns over time periods. |
ProfitabilityService.GetPnlsByLinks | P&L per subscription. |
ChartService.Get / List | Profitability charts for master cards. |
| Service · Method | Purpose |
|---|---|
PlanService | Create / get fee plans, get the active plan, get a plan by promo code. |
PromoCodeService | Create, update, delete, list promo codes. |
JobService | List fee jobs and paid fees per investor. |
CommissionSharingService | Revenue share with partners — save and read commission-sharing setup. |
| Method | Purpose |
|---|---|
Create | Transfer between accounts. |
ListTransfers | Transfer history. |
ListMasterFees / ListInvestorFees | Fees associated with transfers. |
Cancel | Cancel a transfer. |
CanTransfer | Check whether a transfer is possible. |
| Service · Method | Purpose |
|---|---|
SettingsService.GetSettings / SetSettings | PAMM account settings. |
RolloverService.Start | Trigger rollover. |
BalanceOperationService.List / SetCancelled (v2) | PAMM balance operations. |
| Service · Method | Purpose |
|---|---|
ChallengeService.List | List active challenges — base for promo campaigns and gamification. |
PersonalChallengeService | User participation and personal progress (create, get progress, list). |
StatisticsService.GetDailySummary | Daily summary for contest leaderboards. |
| Service · Method | Purpose |
|---|---|
RiskLimitService.SetLossLimit | Loss limit per subscription. |
RatioService.Get | Symbol ratios. |
TenantService.ListAllAvailable | Available environments and tenants. |
CommonSettingsService.GetPlatformSettings | Global platform settings. |
MenuSettingsService.GetMenus | App menu structure. |
AccountSettingsService.ListBatch | UI settings per account (including unauthenticated access). |
UserService.GetCurrentUser / Update | Current user profile. |
ProductService | Products and currencies for account creation. |
CountryService.List | Country reference. |
UploadService — GeneratePresignURL / ConfirmUpload / GetUpload | Avatars and media via S3 presign. |
Widget API
A trimmed public layer for cases where you don't need a full client application — display the leaderboard, render a master card, or check a subscription code from your marketing site. Same protobuf contract, less surface.
Outline of public read-only domains used by the embedded widget — actual method count is broader, and we open additional read endpoints on request for custom embeds.
| Domain · Methods | Purpose |
|---|---|
Accounts — Get, List, CheckSubscriptionCode | Master card, leaderboard list for the widget, subscription-code check. |
Profitability — ReturnsService.List, ChartService.Get / List | Mini charts and returns on the page. |
Statistics — StatService.GetTradingStatistics | Headline metrics in the widget. |
Positions — PositionService.List | Open trades (public read). |
Fees — PlanService.GetActive, GetByPromoCode | Active plan for the subscription widget. |
UI — CommonSettingsService.GetPlatformSettings | Branding and platform settings inside the widget. |
All three API surfaces are described in shared `.proto` files (proto/b2copy/broker, /frontend, /widget) and exposed over both gRPC and REST — generate clients for any language from the same contract. The full method list per surface is significantly larger than the samples above; the complete reference is in the API docs and is extended on request.
Hands-on integration support
The methods listed above are a selection — the real API is much broader, and we extend it on request to fit your CRM, client area, and reporting model. A dedicated B2COPY engineer rides along from the first sandbox call to first live copy, so the broker gets a clean, fitted integration instead of a `.proto` file and a wish of luck.
The tables on this page list a representative ~30% of the API surface — methods most brokers reach for in the first integration. The full proto contract is significantly larger across Broker, Frontend, and Widget. If the method you need is not on the page, it almost certainly already exists — and if it does not, we add it.
Assigned from kickoff to go-live. Reviews your data flow, recommends the cleanest method chains for your scenario, and stays available for follow-up integrations.
Need a method that isn't listed? A new field on an existing response? A bulk-mode for an internal-tooling endpoint? We add it on the next release — typically days, not quarters.
Full-fidelity staging environment with sample masters, investors, and subscriptions, plus a private Slack / Teams channel with the engineering team for fast back-and-forth during the build.
We walk through your endpoints, JWT setup, pagination, and rate handling together before you ship to production. Catches edge cases before they become support tickets.
Tell us about your CRM, client portal, and reporting model — we'll map the integration path and show which methods to use (and which to extend).
Frequently Asked
No. The tables above show a representative selection of methods — roughly the slice most brokers use in their first integration. The real API is significantly broader across all three surfaces (Broker / Frontend / Widget). The complete, up-to-date reference lives in the API docs at docs.b2copy.b2broker.com.
Yes. If the method, response field, filter, or bulk-mode you need is not in the current contract, we add it. Practically every broker we onboard gets at least one custom extension during integration — typical turnaround is days to a single release, not quarters. Tell us the scenario during scoping and it lands in the sandbox before you write client code against it.
You get a dedicated B2COPY integration engineer from kickoff to go-live, a full-fidelity sandbox with sample masters / investors / subscriptions, a private Slack or Teams channel with the engineering team for fast back-and-forth, and a joint pre-prod review of your endpoints, JWT setup, and pagination before you ship. The goal is an integration that fits your stack, not a generic copy-paste.
For the widget + SSO path — no. A back-office admin can copy the iframe snippet and sign JWTs through the admin panel. For pre-built CRM connectors (B2Core, Nullpoint, FXBO) it is a feature toggle. Deeper REST + gRPC integrations typically take a backend developer 1–3 days per scenario.
Embed the iframe widget in 30 minutes — same day with SSO. Pre-built CRM activation (B2Core / Nullpoint / FX Back Office) is also same-day. Full custom REST + gRPC builds run 2–3 weeks end-to-end with a sandbox and a dedicated B2COPY integration engineer.
Yes. Every public method is described in shared .proto files (proto/b2copy/broker, .../frontend, .../widget). REST routes and the OpenAPI spec are generated from the same files — request and response semantics are identical, you just pick the transport that fits your stack.
Two distinct flows. Server-to-server: an admin JWT signed with your EC key, scoped per tenant — used against the Broker API. User session: issue an external JWT from your client portal, exchange via SideAuthenticate (or AuthUserWithExternalToken), then call the Frontend API user-scoped. No password handling on either side.
150+ admin-panel settings cover most aspects of B2COPY before development is needed: leaderboard columns, statistics visibility, six fee types and their formulas, broker-controlled risk limits for masters, account visibility defaults, symbol mapping, and full custom branding (colors, logos, themes).
Explore more
Performance, management, subscription, volume, joining, and profit fees.
Learn moreDaily limits, max drawdown controls, and personal loss limits.
Learn moreSix allocation methods — proportional, ratio multiplier, or fixed lot.
Learn moreCopy trades across MT4, MT5, cTrader, and B2Trader servers.
Learn moreWidget SSO, CRM integrations, REST, and gRPC APIs.
Learn moreWe'll review your CRM, client area, and back office and propose the integration path that fits your engineering depth — widget today, full API in three weeks.
