B2BROKERB2BROKER
MCP
B2COREB2CORE IBB2TRADERB2CONNECTB2TRANSLATEB2BROKER
Partner

Get Client NET Deposits

Deposits and withdrawals are client-centric: they cover all operations of the clients currently in the partner's structure, including those made before a client joined it. When a client is moved to another IB, its figures move with it; an IB above both the old and the new IB keeps them.

GET
/partner/client-net-deposits

Authorization

appToken read
AuthorizationBearer <token>

App 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

userId*string

Identifier of the partner user whose clients are reported

Formatuuid
startTime?string

Start of the reporting window (inclusive); omit for no lower bound

Formatdate-time
endTime?string

End of the reporting window (exclusive): operations at exactly this time are not counted; to include a whole day, pass the next day's 00:00. Omit for no upper bound

Formatdate-time
comparative?boolean

When true and both startTime and endTime are set, include the absolute change versus the previous equal-length window; clients active only in the previous window are listed too

Defaultfalse
sortBy?string

Ranking metric (current window)

Default"net"

Value in

  • "deposits"
  • "withdrawals"
  • "net"
sortOrder?string

Ranking direction

Default"desc"

Value in

  • "asc"
  • "desc"
clientExternalId?integer

Restrict the report to one b2core client id

limit?integer

Maximum number of clients to return; 0 returns only the aggregation and the total

Range0 <= value <= 100
Default50
offset?integer

Number of ranked clients to skip

Range0 <= value
Default0

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/partner/client-net-deposits?userId=497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "report": {    "aggregation": {      "deposits": {        "actualValue": "string",        "absoluteChange": "string",        "currency": "string"      },      "withdrawals": {        "actualValue": "string",        "absoluteChange": "string",        "currency": "string"      },      "net": {        "actualValue": "string",        "absoluteChange": "string",        "currency": "string"      }    },    "data": [      {        "clientExternalId": "string",        "deposits": {          "actualValue": "string",          "absoluteChange": "string"        },        "withdrawals": {          "actualValue": "string",          "absoluteChange": "string"        },        "net": {          "actualValue": "string",          "absoluteChange": "string"        }      }    ],    "total": 0  }}
{  "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"    }  ]}
PreviousGet Top Clients GETNextGet Dashboard Performance GET