Clearing - Position Summary

POSThttps://b-api.longbridge.xyz/v1/datasets/clearing_custodian_position_summary

Authorization

AuthorizationstringheaderRequired

Send the Broker ACCESS_TOKEN as Authorization: Bearer <token>.

Request body application/json

filtersobject

Filters

Child attributes

filters.ledger_dateobject

Ledger Date. Range filter; both bounds are optional (omit a bound to leave that side unbounded). Defaults to the range [1 day(s) ago, today] when omitted (gte/lte roll with the request date).

Child attributes

filters.ledger_date.gtestring

Greater Than or Equal

filters.ledger_date.ltestring

Less Than or Equal

filters.marketstring

Market

filters.custodian_name_searchstring

Custodian

filters.sub_position_nostring

Stock Account

filters.counter_idstring

Counter ID

filters.codestring

Stock Code

pageinteger

Page

page_sizeinteger

Page Size

orderByarray<object>

Order By

Responses

HTTP 200Paginated list result.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

List

totalintegerrequired

Total

Request

curl --request POST \
  --url 'https://b-api.longbridge.xyz/v1/datasets/clearing_custodian_position_summary' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20,
  "orderBy": []
}'

Response

{
  "code": 0,
  "message": null,
  "data": {
    "list": [
      {
        "ledger_date": "<string>",
        "market": "<string>",
        "custodian_name": "<string>",
        "sub_position_no": "<string>",
        "counter_id": "<string>",
        "quantity": "<string>",
        "street_quantity": "<string>",
        "nominee_quantity": "<string>",
        "own_quantity": "<string>"
      }
    ],
    "total": 0
  }
}