Get Margin Quota
marginQuota
Request Parameter
| Parameter | Type | Meaning |
|---|---|---|
| account | Account | Account |
| stockNo | string | Symbol |
Result Response
| Parameter | Type | Meaning |
|---|---|---|
| isSuccess | bool | Interface result |
| data | Object | MarginShortQuota list is returned |
| message | string ? (optional) | isSuccess = False error description is returned |
MarginShortQuota Parameter
Return type : Object
| Parameter | Type | Meaning |
|---|---|---|
| stock_no | string | Symbol |
| date | string | Query Date (today) |
| shortsellOrigQuota | number ? | The Original Shortsell Quota |
| shortsellTradableQuota | number ? | Available Shortsell Quota |
| marginOrigQuota | number ? | The Original Margin Quota |
| marginTradableQuota | number ? | Available Margin Quota |
| marginRatio | number ? | Margin Ration |
| shortRatio | number ? | Short Sell Ration |
info
Explanation of Quota: If the marginRatio not return, it means margin is halted. If the shorRatio not return, it means short selling is halted. Explanation of Returned Quota: 0 - No quota / Greater than 0 - Quota available / Not return - No restrictions / Both of ratio of and quota not return 0 - margin or short selling halted.
Request Example
sdk.stock.marginQuota(account, "2330")
Response Example
{
isSuccess: true,
data:{
stockNo: '2330', // Stock symbol (string)
date: '2024/01/24', // Query date (string)
shortsellOrigQuota: 894, // The original short sell quota (number)
shortsellTradableQuota: 894, // Available short sell quota (number)
marginRatio: 60, // Margin ratio (number)
shortRatio: 90 // Short sell ratio (number)
}
}