mirror of
https://github.com/longbridge/developers.git
synced 2026-09-19 03:34:09 +08:00
3db9fde5ed
<img width="903" alt="image" src="https://github.com/longportapp/openapi-website/assets/5518/c26d8c42-ae93-4acb-9550-286a52bf210a">
112 lines
2.7 KiB
Markdown
112 lines
2.7 KiB
Markdown
---
|
|
slug: security_list
|
|
title: 获取标的列表
|
|
language_tabs: false
|
|
toc_footers: []
|
|
includes: []
|
|
search: true
|
|
highlight_theme: ''
|
|
headingLevel: 2
|
|
---
|
|
|
|
获取标的列表
|
|
|
|
<SDKLinks module="quote" klass="QuoteContext" method="security_list" />
|
|
|
|
## Request
|
|
|
|
<table className="http-basic">
|
|
<tbody>
|
|
<tr><td className="http-basic-key">HTTP Method</td><td>GET</td></tr>
|
|
<tr><td className="http-basic-key">HTTP URL</td><td>/v1/quote/get_security_list
|
|
</td></tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
### Parameters
|
|
|
|
> Content-Type: application/json; charset=utf-8
|
|
|
|
| Name | Type | Required | Description |
|
|
| -------- | ------ | -------- | -------------------------------- |
|
|
| market | string | YES | 市场,目前只支持 US |
|
|
| category | string | YES | 市场下分类,目前只支持 Overnight |
|
|
|
|
### Request Example
|
|
|
|
```python
|
|
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
|
|
|
|
```json
|
|
{
|
|
"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 | 返回成功 | [security_response](#get_security_list_rsp) |
|
|
| 400 | 参数错误 | None |
|
|
|
|
<aside className="success">
|
|
</aside>
|
|
|
|
## Schemas
|
|
|
|
### security_response
|
|
|
|
<a id="get_security_list_rsp"></a>
|
|
|
|
| Name | Type | Required | Description |
|
|
| --------- | -------- | -------- | ----------- |
|
|
| list | object[] | false | 列表 |
|
|
| ∟ symbol | integer | true | 标的代码 |
|
|
| ∟ name_cn | string | true | 中文名称 |
|
|
| ∟ name_hk | string | true | 繁体名称 |
|
|
| ∟ name_en | string | true | 英文名称 |
|
|
|
|
## 错误码
|
|
|
|
| 业务错误码 | 描述 | 排查建议 |
|
|
| ---------- | -------------- | ------------------------ |
|
|
| 310010 | 无效的请求 | 请求参数有误 |
|
|
| 310011 | 服务端内部错误 | 请重试或联系技术人员处理 |
|