B2BROKER
B2CORE
B2CORE IB
B2TRADER
B2CONNECT
B2TRANSLATE
B2BROKERGet Dashboard Top Symbols
Rewards by Symbol: the rebate credited to the partner in its payout currency over the window, per traded symbol, ranked by `sortBy`. Credited amounts are stored at the payout currency's precision, so the rows plus `other` add up to the payout-currency rebate of `GET /partner/dashboard/performance` for the same window. There is no comparison.
Authorization
appToken readApp access token issued by POST /tokens (client credentials). Full-access Apps hold the read and write scopes, read-only Apps hold read only. Send it as Authorization: Bearer <token>.
In: header
Scope: read
Query Parameters
Identifier of the partner user (the IB record) whose dashboard is requested
uuidStart of the window (inclusive), RFC 3339 with an offset. Encode + as %2B: a raw + in a query string reads as a space. Any window length is accepted; long windows take longer.
date-timeEnd of the window (exclusive), RFC 3339 with an offset; must be after startTime. Operations at exactly this time are not counted; to include a whole day, pass the next day's 00:00.
date-timeRanking metric; ties are ordered by symbol name
"rebate"Value in
- "rebate"
- "volumeLots"
- "numberOfTrades"
Maximum number of ranked rows to return
1 <= value <= 10050Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/partner/dashboard/top-symbols?userId=497f6eca-6276-4993-bfeb-53cbbbba6f08&startTime=2026-10-01T00%3A00%3A00%2B02%3A00&endTime=2026-11-01T00%3A00%3A00%2B01%3A00"{ "report": { "currency": "EUR", "data": [ { "symbolName": "XAUUSD", "rebate": "520.00", "volumeLots": "130.50", "numberOfTrades": 412, "rebatePerLot": "3.98" } ], "other": { "rebate": "80.00", "volumeLots": "40.00", "numberOfTrades": 95 } }}{ "error": { "message": "validation failed", "code": "validation_error", "details": [ { "field": "startTime", "issue": "the window has more than 5000 hour buckets" } ] }}{ "message": "string", "code": "string", "errors": { "property1": [ "string" ], "property2": [ "string" ] }, "details": [ { "field": "string", "issue": "string" } ]}{ "error": { "message": "partner user not found", "code": "not_found" }}{ "message": "string", "code": "string", "errors": { "property1": [ "string" ], "property2": [ "string" ] }, "details": [ { "field": "string", "issue": "string" } ]}{ "message": "string", "code": "string", "errors": { "property1": [ "string" ], "property2": [ "string" ] }, "details": [ { "field": "string", "issue": "string" } ]}{ "error": { "message": "the report took too long to build", "code": "gateway_timeout" }}