Trade
Authorization
Signed mode: every request is signed with your App Key/Secret. Header set:
| Name | Type | Required | Description |
|---|---|---|---|
Authorization | string · header | Required | The account Access Token from the OpenAPI dashboard — passed as the raw token (no Bearer prefix) and included in the signature calculation. |
X-Api-Key | string · header | Required | Your App Key. |
X-Timestamp | string · header | Required | Request timestamp in seconds (Unix epoch). |
X-Api-Signature | string · header | Required | HMAC-SHA256 signature. Format: HMAC-SHA256 SignedHeaders=authorization;x-api-key;x-timestamp, Signature=. |
The API is used to obtain stock position information including account, stock code, number of shares held, number of available shares, average position price (calculated according to account settings), and currency.
Request
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
symbol | array | Optional | Stock code, use `ticker.region` format, E.g:`AAPL.US` |
Response
Response properties
| Name | Type | Required | Description |
|---|---|---|---|
list | object[] | Optional | Stock holding information |
└ account_channel | string | Optional | Account type |
└ stock_info | object[] | Optional | Stock list |
└ ∟ symbol | string | Optional | Stock code |
└ ∟ symbol_name | string | Optional | Stock name |
└ ∟ currency | string | Optional | Currency |
└ ∟ quantity | string | Optional | The number of holdings |
└ ∟ available_quantity | string | Optional | Available quantity |
└ ∟ cost_price | string | Optional | Cost Price(According to the client's choice of average purchase or diluted cost) |
└ ∟ market | string | Optional | market |
└ ∟ init_quantity | string | Optional | Initial position before market opening |
Response JSON example
{
"code": 0,
"data": {
"list": [
{
"account_channel": "lb",
"stock_info": [
{
"symbol": "700.HK",
"symbol_name": "TENCENT",
"currency": "HKD",
"quantity": "650",
"market": "HK",
"available_quantity": "-450",
"cost_price": "457.53",
"init_quantity": "214"
},
{
"symbol": "9991.HK",
"symbol_name": "BAOZUN-SW",
"currency": "HKD",
"market": "HK",
"quantity": "200",
"available_quantity": "0",
"cost_price": "32.25",
"init_quantity": "214"
},
{
"symbol": "TCEHY.US",
"symbol_name": "Tencent (ADR)",
"currency": "USD",
"market": "US",
"quantity": "10",
"available_quantity": "10",
"init_quantity": "18"
},
{
"symbol": "2628.HK",
"symbol_name": "CHINA LIFE",
"currency": "HKD",
"market": "HK",
"quantity": "9000",
"available_quantity": "0",
"init_quantity": "8000"
},
{
"symbol": "5.HK",
"symbol_name": "HSBC HOLDINGS",
"currency": "HKD",
"market": "HK",
"quantity": "2400",
"available_quantity": "2000",
"init_quantity": "2000"
},
{
"symbol": "BABA.US",
"symbol_name": "Alibaba",
"currency": "USD",
"market": "US",
"quantity": "2000209",
"available_quantity": "2000209",
"init_quantity": "214"
},
{
"symbol": "2.HK",
"symbol_name": "CLP HOLDINGS",
"currency": "HKD",
"market": "HK",
"quantity": "2000",
"available_quantity": "2000",
"init_quantity": "2000"
},
{
"symbol": "NOK.US",
"symbol_name": "Nokia",
"currency": "USD",
"market": "US",
"quantity": "1",
"available_quantity": "0",
"init_quantity": "1"
}
]
}
]
}
}Error code
See the Error Codes page for the full list of error codes.