okx-api
Version:
Complete Node.js SDK for OKX's REST APIs and WebSockets, with TypeScript & end-to-end tests
69 lines (68 loc) • 1.78 kB
TypeScript
export interface FundsTransferRequest {
ccy: string;
amt: string;
from: '6' | '18';
to: '6' | '18';
subAcct?: string;
type?: '0' | '1' | '2' | '3' | '4';
loanTrans?: boolean;
clientId?: string;
omitPosRisk?: string;
}
export interface WithdrawRequest {
ccy: string;
amt: string;
dest: '3' | '4';
toAddr: string;
/**
* Address type:
* - 1: wallet address, email, phone, or login account name
* - 2: UID (only for whitelisted users; applicable only when dest=3)
*/
toAddrType?: '1' | '2';
chain?: string;
areaCode?: string;
clientId?: string;
rcvrInfo?: {
walletType: 'exchange' | 'private';
exchId?: string;
rcvrFirstName?: string;
rcvrLastName?: string;
rcvrCountry?: string;
rcvrCountrySubDivision?: string;
rcvrTownName?: string;
rcvrStreetName?: string;
};
}
/**
* @see GET /api/v5/public/funding-rate
* `instId` may be a specific instrument, or the literal `ANY` for all perpetuals and X-Perp (FUTURES) contracts.
*/
export interface GetFundingRateRequest {
instId: string;
}
export interface FundingRateRequest {
/** Perpetual or X-Perp FUTURES instrument id (not `ANY` on this route). */
instId: string;
before?: string;
after?: string;
limit?: string;
}
export interface GetDepositWithdrawStatusRequest {
wdId?: string;
txId?: string;
ccy?: string;
to?: string;
chain?: string;
}
export interface GetDepositHistoryRequest {
ccy?: string;
depId?: string;
fromWdId?: string;
txId?: string;
type?: '3' | '4';
state?: '0' | '1' | '2' | '8' | '11' | '12' | '13' | '14' | '17';
after?: string;
before?: string;
limit?: string;
}