Search Stock · Whale Docs

POSThttps://b-api.longbridge.xyz/v1/whaleapi/search/stock

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

keywordstringrequired

keyword

Responses

HTTP 200Fields are taken from the real responses definition for this operation in the published Whale OpenAPI spec (whale-openapi/Whale-openapi.json).

Standard response envelopecodemessagedata

dataobjectdata structure

stock_listarray<object>required

stock_list

Child attributes

namestringrequired

Stock Name. Stock Name

symbolstringrequired

Stock Symbol eg: BABA.US. Stock Symbol eg: BABA.US

marketstringrequired

Stock Market eg: US. Stock Market eg: US

productstringrequired

Stock Product eg: ST、ETF. Stock Product eg: ST、ETF

codestringrequired

Sotck Code eg: BABA. Sotck Code eg: BABA

name_cnstringrequired

Stock Chinese Name. Stock Chinese Name

name_enstringrequired

Stock English Name. Stock English Name

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 --request POST \
  --url 'https://b-api.longbridge.xyz/v1/whaleapi/search/stock' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "keyword": "<string>"
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "stock_list": [
      {
        "name": "string",
        "symbol": "string",
        "market": "string",
        "product": "string",
        "code": "string",
        "name_cn": "string",
        "name_en": "string"
      }
    ]
  }
}