API documentação

List Partner Instruments

get/api/v1/Partners/me/instruments

Returns the list of tradeable instruments that have a non-zero per-instrument markup or a non-zero per-instrument commission override — the same fields the rebate runner stacks on top of the group-level UserGroupItem markup when computing each partner's Spread basis. The customer Configs panel renders this list inside the Instruments modal so a Partner can see WHY their effective rebate per fill differs across symbols (e.g. tighter on EURUSD, wider on exotic CFDs). Filtering: only instruments with at least one of (MarkupBid > 0, MarkupAsk > 0, Commissions > 0) are returned. The optional search matches symbol, description, or exchange (case-insensitive substring). exchanges limits the list to those exchange names. Results are capped at 500.

Partners

Parâmetros

userGroupId

query · integer

Opcional

search

query · string

Obrigatório

types

query · array

Obrigatório

exchanges

query · array

Opcional

version

path · string

Obrigatório

RESPOSTAS

A especificação OpenAPI não inclui esquemas de corpo de resposta para este endpoint. Utilize a opção "Experimentar" com as suas credenciais para ver uma resposta em tempo real.

  • 200Success
Alipay
Stripe
Eurex
AWS
Azure
Google Cloud
Currenex
Velocity Trade
Bitcoin
CME
Interactive Brokers
Kraken
FIX API
XTX
Bloomberg
Binance

Lance a sua plataforma.