B2CORE IB API

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

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.