bitget-api
Version:
Complete Node.js & JavaScript SDK for Bitget V1-V3 REST APIs & WebSockets, with TypeScript & end-to-end tests.
218 lines (217 loc) • 4.69 kB
TypeScript
export interface AccountSymbolConfigV3 {
category: string;
symbol: string;
marginMode: string;
leverage: string;
}
export interface AccountCoinConfigV3 {
coin: string;
leverage: string;
}
export interface AccountSettingsV3 {
assetMode: string;
holdMode: string;
symbolConfigList: AccountSymbolConfigV3[];
coinConfigList: AccountCoinConfigV3[];
}
export interface AccountAssetV3 {
coin: string;
equity: string;
usdValue: string;
balance: string;
available: string;
debt: string;
locked: string;
}
export interface AccountAssetsV3 {
accountEquity: string;
usdtEquity: string;
btcEquity: string;
unrealisedPnl: string;
usdtUnrealisedPnl: string;
btcUnrealizedPnl: string;
effEquity: string;
mmr: string;
imr: string;
mgnRatio: string;
positionMgnRatio: string;
assets: AccountAssetV3[];
}
export interface ConvertRecordV3 {
fromCoin: string;
fromCoinSize: string;
toCoin: string;
toCoinSize: string;
price: string;
ts: string;
}
export interface FinancialRecordV3 {
category: string;
id: string;
symbol: string;
coin: string;
type: string;
amount: string;
fee: string;
balance: string;
ts: string;
}
export interface PaymentCoinV3 {
coin: string;
size: string;
amount: string;
}
export interface RepayableCoinV3 {
coin: string;
size: string;
amount: string;
}
export interface RepayResponseV3 {
result: string;
repayAmount: string;
}
export interface CreateSubAccountApiKeyResponseV3 {
note: string;
apiKey: string;
secret: string;
type: string;
permissions: string[];
ips: string[];
}
export interface SubAccountApiKeyV3 {
apiKey: string;
note: string;
type: string;
permissions: string[];
ips: string[];
ts?: string;
}
export interface UpdateSubAccountApiKeyResponseV3 {
note: string;
apiKey: string;
type: string;
permissions: string[];
ips: string[];
}
export interface CreateSubAccountResponseV3 {
username: string;
subUid: string;
status: string;
note: string;
createdTime: string;
updatedTime: string;
}
export interface SubAccountV3 {
subUid: string;
username: string;
status: string;
accountMode: string;
type: string;
note: string;
createdTime: string;
updatedTime: string;
}
export interface TransferResponseV3 {
transferId: string;
}
export interface SubTransferRecordV3 {
transferId: string;
oldTransferId?: string;
fromType: string;
toType: string;
amount: string;
coin: string;
fromUserId: string;
toUserId: string;
status: string;
clientOid: string;
createdTime: string;
updatedTime: string;
}
export interface SubUnifiedAssetV3 {
coin: string;
equity: string;
usdValue: string;
balance: string;
available: string;
debt: string;
locked: string;
}
export interface SubUnifiedAssetV3 {
subUid: string;
cursor: string;
assets: SubUnifiedAssetV3[];
}
export interface GetFeeRateResponseV3 {
makerFeeRate: string;
takerFeeRate: string;
}
export interface FundingAssetV3 {
coin: string;
available: string;
frozen: string;
balance: string;
}
export interface DepositAddressV3 {
address: string;
chain: string;
coin: string;
tag: string;
url: string;
}
export interface DepositRecordV3 {
orderId: string;
recordId: string;
coin: string;
type: 'deposit';
dest: 'on_chain' | 'internal_transfer';
size: string;
status: 'pending' | 'success' | 'fail';
fromAddress: string;
toAddress: string;
chain: string;
createdTime: string;
updatedTime: string;
}
export interface WithdrawResponseV3 {
orderId: string;
clientOid: string;
}
export interface WithdrawRecordV3 {
orderId: string;
clientOid: string;
recordId: string;
coin: string;
type: 'withdraw';
dest: 'on_chain' | 'internal_transfer';
size: string;
status: 'pending' | 'success' | 'fail';
fromAddress: string;
toAddress: string;
chain: string;
fee: string;
confirm: string;
tag: string;
createdTime: string;
updatedTime: string;
}
export interface MaxTransferableV3 {
coin: string;
maxTransfer: string;
borrowMaxTransfer: string;
}
export interface OpenInterestLimitV3 {
symbol: string;
singleUserLimit: string;
masterSubLimit: string;
marketMakerLimit: string;
}
export interface TaxRecordV3 {
id: string;
coin: string;
type: string;
amount: string;
fee: string;
balance: string;
ts: string;
}