API documentation
get
/api/v1/Partners/me/instrumentsReturns 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 or Description (case-insensitive, substring). Results are capped at 500 to keep the modal responsive — the search box is the partner's escape hatch when the list is large.
Partners
Parameters
userGroupId
query · integer
Optional
search
query · string
Optional
types
query · array
Optional
version
path · string
Required
Responses
The OpenAPI specification does not include response body schemas for this endpoint. Use Try It with your credentials to see a live response.
- 200Success