Query Voucher Spec
HTTP Request
POST /v5/broker/award/info
Request Parameters
Parameter | Required | Type | Comments |
---|---|---|---|
id | true | string | Voucher ID |
Response Parameters
Parameter | Type | Comments |
---|---|---|
id | string | Voucher ID |
coin | string | Coin |
amountUnit | string | AWARD_AMOUNT_UNIT_USD AWARD_AMOUNT_UNIT_COIN |
productLine | string | Product line |
subProductLine | string | Sub product line |
totalAmount | Object | Total amount of voucher |
usedAmount | string | Used amount of voucher |
Request Example
- HTTP
- Python
- Node.js
POST /v5/broker/award/info HTTP/1.1
Host: api.bybit.com
X-BAPI-SIGN: XXXXXX
X-BAPI-API-KEY: XXXXXX
X-BAPI-TIMESTAMP: 1726107086048
X-BAPI-RECV-WINDOW: 5000
Content-Type: application/json
Content-Length: 22
{
"id": "80209"
}
const { RestClientV5 } = require('bybit-api');
const client = new RestClientV5({
testnet: true,
key: 'apikey',
secret: 'apisecret',
});
client
.getBrokerVoucherSpec({
accountId: '5714139',
awardId: '189528',
specCode: 'demo000',
withUsedAmount: false,
})
.then((response) => {
console.log(response);
})
.catch((error) => {
console.error(error);
});
Response Example
{
"retCode": 0,
"retMsg": "",
"result": {
"id": "80209",
"coin": "USDT",
"amountUnit": "AWARD_AMOUNT_UNIT_USD",
"productLine": "PRODUCT_LINE_CONTRACT",
"subProductLine": "SUB_PRODUCT_LINE_CONTRACT_DEFAULT",
"totalAmount": "10000",
"usedAmount": "100"
},
"retExtInfo": {},
"time": 1726107086313
}