Clearing - Instrument Information

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

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

filtersobject

Filters

Child attributes

filters.ledger_datestringrequired

Ledger Date. Defaults to today (rolling relative to the request date) when omitted.

filters.codestring

Stock Code

filters.namestring

Fallback Name

filters.counter_idstring

Counter ID

filters.statusstring

Status. Multi-select; submit as a comma-joined string. Allowed values are listed under enum.. Options: 0 = Active; 1 = Suspended; 2 = Delisted; 3 = Prelist; 8 = Unknown; 9 = Others; normal = Active

012389normal

filters.close_pricestring

Close Price

filters.stamp_duty_markstring

Stamp Duty Exemption. Options: 1 = Subject to stamp duty; 0 = Exempt from stamp duty

10

filters.has_holdingstring

Existing Position

filters.has_pending_ticketstring

Pending Approvals

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_stock_infos' \
  --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>",
        "code": "<string>",
        "counter_id": "<string>",
        "market": "<string>",
        "currency": "<string>",
        "name": "<string>",
        "name_en": "<string>",
        "name_cn": "<string>",
        "name_hk": "<string>",
        "isin": "<string>",
        "ipo_date": "<string>",
        "ipo_price": "<string>",
        "status": "<string>",
        "suspend_date": "<string>",
        "lot_size": "<string>",
        "stamp_duty_exemption": "<string>",
        "close_price": "<string>",
        "pre_close_price": "<string>",
        "settle_price": "<string>",
        "close_price_suspend": "<string>",
        "turnover": "<string>",
        "has_holding": "<string>",
        "updated_at": "<string>",
        "operator": "<string>"
      }
    ],
    "total": 0
  }
}