Stock Group Details · Whale Docs

GEThttps://b-api.longbridge.xyz/v1/datasets/stock_group_details

Dataset endpoints are available on the Test host only (https://b-api.longbridge.xyz); the Production host returns 404.

This Dataset query is read-only. Use GET by default. If the encoded query parameters are too large, send the same parameters as a JSON body with POST to the same path.

Authorization

AuthorizationstringheaderRequired

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

Permission

risk_config.stock_group_details_query

The Broker ACCESS_TOKEN must be granted the permission below, or the call will be rejected.

Query parameters

filtersobject

Child attributes

counter_idstring

pageinteger

page_sizeinteger

Responses

HTTP 200Paginated list result.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

Child attributes

counter_idstring

counter_id_valstring

Raw value behind field counter_id: counter_id returns the human-readable display value resolved via a dictionary/join mapping, while this field returns the underlying code/ID before that mapping.

stock_namestring

marketstring

market_valstring

Raw value behind field market: market returns the human-readable display value resolved via a dictionary/join mapping, while this field returns the underlying code/ID before that mapping.

stock_countstring

updated_atstring

operatorstring

totalintegerrequired

HTTP 400Bad request. Check the business error code in code and the error details in message.

Standard response envelopecodemessagedata

dataobjectdata structure

No nested fields

HTTP 401The user is not authenticated, or the login session has expired.

Standard response envelopecodemessagedata

dataobjectdata structure

No nested fields

HTTP 403The current account is not authorized to use this feature. Grant the required permission to the account in User Permission.

Standard response envelopecodemessagedata

dataobjectdata structure

No nested fields

HTTP 408The request timed out. Check the business error code in code and the error details in message.

Standard response envelopecodemessagedata

dataobjectdata structure

No nested fields

Request

curl --get \
  --url 'https://b-api.longbridge.xyz/v1/datasets/stock_group_details' \
  --header 'Authorization: Bearer <token>' \
  --data-urlencode 'filters={}' \
  --data-urlencode 'page=1' \
  --data-urlencode 'page_size=20'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "counter_id": "string",
        "counter_id_val": "string",
        "stock_name": "string",
        "market": "string",
        "market_val": "string",
        "stock_count": "string",
        "updated_at": "string",
        "operator": "string"
      }
    ],
    "total": 1
  }
}

Export

The export endpoint uses the same filters as this Dataset query.

POSThttps://b-api.longbridge.xyz/v1/datasets/stock_group_details/download

risk_config.stock_group_details_export

Export options Export records Download result