Account
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=. |
Get all price alerts for the current user, with optional filtering by symbol.
Request
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
symbol | string | Optional | Filter by security symbol, e.g. `TSLA.US` |
Response
Response properties
| Name | Type | Required | Description |
|---|---|---|---|
lists | object[] | Optional | Alert groups per security |
└ symbol | string | Optional | Security symbol |
└ chg | string | Optional | Day change amount |
└ price | string | Optional | Latest price |
└ p_chg | string | Optional | Day change percentage |
└ name | string | Optional | Security name. |
└ market | string | Optional | Market |
└ code | string | Optional | Ticker code |
└ indicators | object[] | Optional | Alert indicators |
└ ∟ id | string | Optional | Alert ID |
└ ∟ indicator_id | string | Optional | Condition: `1`=price_rise, `2`=price_fall, `3`=pct_rise, `4`=pct_fall |
└ ∟ frequency | integer | Optional | Frequency: `1`=daily, `2`=every_time, `3`=once |
└ ∟ enabled | boolean | Optional | Whether the alert is active |
└ ∟ text | string | Optional | Display text |
└ ∟ scope | integer | Optional | Scope |
└ ∟ value_map | object | Optional | Trigger value (e.g. `{"price":"400"}` or `{"chg":"5"}`) |
└ ∟ ∟ price | string | Optional | Latest price |
└ ∟ state | array | Optional | Trigger state flags |
└ product | string | Optional | Product type |
Response JSON example
{
"code": 0,
"message": "success",
"data": {
"lists": [
{
"symbol": "AAPL.US",
"code": "AAPL",
"market": "US",
"name": "Apple",
"price": "298.87",
"chg": "4.07",
"p_chg": "1.38",
"product": "stock",
"indicators": [
{
"id": "514050",
"indicator_id": "1",
"enabled": true,
"frequency": 2,
"scope": 0,
"text": "Price rises to 400",
"state": [
1
],
"value_map": {
"price": "400"
}
}
]
}
]
}
}Error code
See the Error Codes page for the full list of error codes.