Retrieve the List of Securities

Retrieve the List of Securities

SDK Links

Python	longport.openapi.QuoteContext.security_list
Rust	longport::quote::QuoteContext#security_list
Go	QuoteContext.SecurityList
Node.js	QuoteContext#securityList

Request

HTTP Method	GET
HTTP URL	/v1/quote/get_security_list

Parameters

Content-Type: application/json; charset=utf-8

Name	Type	Required	Description
market	string	YES	Market, currently only supports US
category	string	YES	Market subcategory, only supports Overnight

Request Example

from longport.openapi import QuoteContext, Config, Market, SecurityListCategory

config = Config.from_env()
ctx = QuoteContext(config)
resp = ctx.security_list(Market.US, SecurityListCategory.Overnight)
print(resp)

Response

Response Headers

• Content-Type: application/json

Response Example

{
  "code": 0,
  "data": {
    "list": [
      {
        "symbol": "BAC.US",
        "name_cn": "美国银行",
        "name_hk": "美國銀行",
        "name_en": "Bank of America"
      },
      {
        "symbol": "RDDT.US",
        "name_cn": "REDDIT INC",
        "name_hk": "REDDIT INC",
        "name_en": "REDDIT INC"
      },
      {
        "symbol": "GOOGL.US",
        "name_cn": "谷歌-A",
        "name_hk": "谷歌-A",
        "name_en": "Alphabet"
      }
    ]
  }
}

Response Status

Status	Description	Schema
200	Successful return	security_response
400	Parameter error	None

Schemas

security_response

Name	Type	Required	Description
list	object[]	false	List
∟ symbol	integer	true	Security code
∟ name_cn	string	true	Chinese name
∟ name_hk	string	true	Traditional Chinese name
∟ name_en	string	true	English name

Error Code

Business Error Code	Description	Troubleshooting Suggestion
310010	Invalid request	Check the request parameters
310011	Internal server error	Please retry or contact technical support