Get Network Nodes
Network page: one page of the direct clients of `node` (the partner itself when omitted) as seen by the partner, sorted by an indicator. Every row carries branch figures: the client plus its whole downline, as paid to or seen by the partner over the window. Rewards, volume in lots and USD volume come from the partner's processed payments by trade time; rewards count the partner's payout currency only, other currencies are left out. Deposits, withdrawals and net deposits are in USD and follow each client's current tree, including operations from before the client joined it. A client whose direct parent is not in the partner's downline (a stale chain) is left out together with everything below it, and out of the rows; its payments, and those of clients outside the visible levels, come as `outsideNetwork` on the partner's own listing and still count in `totals`, which so match the Partner Dashboard. A client that reaches the partner through its IB record only is listed like any other. Figures come from a snapshot of the partner's downline for the window and `levels`, built on first use and kept for 10 minutes for any window; later requests with any `node`, `sort`, `dir`, `include`, `activeOnly` or page read it. Send stable bounds (day boundaries): every distinct `from`/`to` builds its own snapshot. The IB Room calls it through B2Core as `GET /api/ib/v3/partner/chain/nodes` with the same query; B2Core checks that `userId` is one of the client's IB users, forwards the query unchanged and passes the answer back as is, waiting at least 60 s so that ib-go's own `504` arrives.
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
uuidB2Core client ID whose direct clients are listed; omitted (or the partner's own client ID) lists the partner's own direct clients. A client outside the partner's visible downline is 404.
length <= 64Start 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 on first use.
date-timeEnd of the window (exclusive), RFC 3339 with an offset; must be after from
date-timepaid counts only the members within the partner's paid levels; all counts the whole downline, but only when the partner's IB type has showAllLevels — otherwise all returns the same as paid
"paid"Value in
- "paid"
- "all"
Indicator the rows are ordered by (its branch value) in dir; ties go to the larger downline first, then by client ID
"rewards"Value in
- "rewards"
- "volume"
- "volumeUsd"
- "deposits"
- "withdrawals"
- "netDeposits"
Sort direction
"desc"Value in
- "asc"
- "desc"
all lists every direct client (the table view); subIbs lists only direct clients with a downline of their own and adds clientsCard for the others and moreSubIbs for the sub-IBs after the page (the chart view)
"all"Value in
- "subIbs"
- "all"
Leave out clients whose branch is 0 on every indicator in the window, before paging. A sub-IB with any active client below stays. It narrows rows and total; node, clientsCard and the per-row counts keep the full direct counts.
falsePage size
1 <= value <= 20050nextCursor of the previous page (v<snapshot version in base 36>:<offset>; treat it as opaque). A cursor from an expired snapshot rebuilds the snapshot and returns the same offset; the order may have changed in between.
^v[0-9a-z]+:[0-9]+$Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/partner/chain/nodes?userId=497f6eca-6276-4993-bfeb-53cbbbba6f08&from=2026-10-01T00%3A00%3A00%2B02%3A00&to=2026-11-01T00%3A00%3A00%2B01%3A00"{ "report": { "asOf": "2026-11-05T10:12:00Z", "currency": "USD", "totals": { "rewards": "456.10", "volume": "1467.00", "volumeUsd": "146700000.00", "deposits": "25000.00", "withdrawals": "4000.00", "netDeposits": "21000.00" }, "node": { "clientId": "134", "clients": 4652, "subIbs": 13 }, "rows": [ { "clientId": "3836", "name": "John D.", "isSubIb": true, "clients": 163, "subIbs": 6, "values": { "rewards": "456.10", "volume": "1467.00", "volumeUsd": "146700000.00", "deposits": "25000.00", "withdrawals": "4000.00", "netDeposits": "21000.00" } } ], "clientsCard": { "count": 4652, "values": { "rewards": "456.10", "volume": "1467.00", "volumeUsd": "146700000.00", "deposits": "25000.00", "withdrawals": "4000.00", "netDeposits": "21000.00" } }, "moreSubIbs": { "count": 5, "values": { "rewards": "456.10", "volume": "1467.00", "volumeUsd": "146700000.00", "deposits": "25000.00", "withdrawals": "4000.00", "netDeposits": "21000.00" } }, "outsideNetwork": { "rewards": "456.10", "volume": "1467.00", "volumeUsd": "146700000.00", "deposits": "25000.00", "withdrawals": "4000.00", "netDeposits": "21000.00" }, "total": 13, "nextCursor": "vtoby3h:8" }}{ "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": "node is not in the partner's downline", "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" } ]}{ "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" }}