B2CORE IB API

OpenAPI reference for the B2CORE Introducing Brokers HTTP API

Browse IB API operations in the sidebar. They are generated from the public OpenAPI specification synced into this repository.

Authentication

Every operation except POST /tokens and the signed CSV download operations (signatureAuth in the reference, authenticated by the signature and expires query parameters) requires a Bearer access token issued to an app registered in the Back Office (Introducing brokers > Preferences > Apps). To register an app and obtain a token, see How to access the API.

Access levels

Each app has an access level — Full access or Read-only — that is set in the Back Office. In the API, it is the accessLevel field (full or read_only) of the Clients operations (/clients). Apps created through the API without an accessLevel get full.

Every operation in this reference shows the scope it requires under the appToken security scheme:

  • read — available to every app. Every GET operation that uses the app token requires read, and so does POST /exports/async, so read-only apps can create export jobs.
  • write — available to Full-access apps only. Every POST, PUT, PATCH and DELETE operation that uses the app token requires write, except POST /exports/async, which requires read.

When a read-only app calls a write operation, the API responds with HTTP 403 and the body {"error":{"message":"This App is read-only and cannot perform this operation.","code":"insufficient_scope"}}. A change of the access level in the Back Office applies to the app's next request; existing tokens remain valid.

Bulk payment plan operations

The Bulk Edit page of the Back Office is built on the following operations, which are also available to API apps:

  • POST /payment-plans/bulk/coverage — calculates what a selection of IB types, trading groups and symbols covers: the number of matched IB types, trading groups and symbols and the resulting number of payment plan rows, together with the row cap.
  • POST /payment-plans/bulk — creates a bulk operation that sets or removes a payment plan for the selection; the operation runs in the background and a snapshot of the affected payment plans is saved before anything is changed.
  • GET /payment-plans/bulk — lists bulk operations, CSV imports of payment plans and support restores with their status, processed rows and errors; filters by source, status, platform, IB type and creation date.
  • GET /payment-plans/bulk/{operationId} — returns one operation with its parameters, error summary and snapshot details.
  • GET /platforms/{platformId}/symbols — searches the distinct symbols of a trading platform by name or path; used to fill the Symbols field of the form.

Trading groups and symbols in a selection are addressed either by ID or by a path prefix (a folder), the same way as folder entries ending in \* on the Bulk Edit page.

Last updated on

On this page