Class: RestClient
Extends
default
Constructors
Constructor
new RestClient(options?: RestClientOptions, requestOptions?: AxiosRequestConfig): RestClient;Parameters
| Parameter | Type |
|---|---|
options? | RestClientOptions |
requestOptions? | AxiosRequestConfig |
Returns
RestClient
Inherited from
BaseRestClient.constructor
Methods
activateFeature()
activateFeature(params: ActivateFeatureRequest): Promise<Record<string, never>[]>;Activate USDC order book trading after place order returns error 54109. Shared by the master account and its sub-accounts; one successful call is enough. Error 51773 means this activation is not supported for the account.
Parameters
| Parameter | Type |
|---|---|
params | ActivateFeatureRequest |
Returns
Promise<Record<string, never>[]>
activateOption()
activateOption(): Promise<object[]>;Returns
Promise<object[]>
adjustCollateral()
adjustCollateral(params: AdjustCollateralRequest): Promise<[]>;Parameters
| Parameter | Type |
|---|---|
params | AdjustCollateralRequest |
Returns
Promise<[]>
adjustGridInvestment()
adjustGridInvestment(params: object): Promise<object[]>;Parameters
| Parameter | Type |
|---|---|
params | { algoId: string; amt: string; } |
params.algoId | string |
params.amt | string |
Returns
Promise<object[]>
adjustGridMarginBalance()
adjustGridMarginBalance(params: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | { algoId: string; amt?: string; percent?: string; type: "reduce" | "add"; } |
params.algoId | string |
params.amt? | string |
params.percent? | string |
params.type | "reduce" | "add" |
Returns
Promise<any[]>
amendAlgoOrder()
amendAlgoOrder(params: AmendAlgoOrderRequest): Promise<AmendAlgoOrderResult[]>;Parameters
| Parameter | Type |
|---|---|
params | AmendAlgoOrderRequest |
Returns
Promise<AmendAlgoOrderResult[]>
amendGridAlgoOrder()
amendGridAlgoOrder(params: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | { algoId: string; instId: string; slRatio?: string; slTriggerPx?: string; tpRatio?: string; tpTriggerPx?: string; triggerParams?: object[]; } |
params.algoId | string |
params.instId | string |
params.slRatio? | string |
params.slTriggerPx? | string |
params.tpRatio? | string |
params.tpTriggerPx? | string |
params.triggerParams? | object[] |
Returns
Promise<any[]>
amendLendingOrder()
amendLendingOrder(params: LendingOrder): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | LendingOrder |
Returns
Promise<any[]>
amendMultipleOrders()
amendMultipleOrders(params: AmendOrderRequest[]): Promise<AmendedOrder[]>;Parameters
| Parameter | Type |
|---|---|
params | AmendOrderRequest[] |
Returns
Promise<AmendedOrder[]>
amendOrder()
amendOrder(params: AmendOrderRequest): Promise<AmendedOrder[]>;Parameters
| Parameter | Type |
|---|---|
params | AmendOrderRequest |
Returns
Promise<AmendedOrder[]>
See
amendRecurringBuyOrder()
amendRecurringBuyOrder(params: AmendRecurringBuyOrderRequest): Promise<RecurringBuyOrderResult[]>;Parameters
| Parameter | Type |
|---|---|
params | AmendRecurringBuyOrderRequest |
Returns
Promise<RecurringBuyOrderResult[]>
applyCopytradingLeadTrading()
applyCopytradingLeadTrading(params: object): Promise<object[]>;Parameters
| Parameter | Type |
|---|---|
params | { profitSharingTs: string; totalUnrealizedProfitSharingAmt: string; } |
params.profitSharingTs | string |
params.totalUnrealizedProfitSharingAmt | string |
Returns
Promise<object[]>
applyForMonthlyStatement()
applyForMonthlyStatement(params?: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params? | { month?: string; } |
params.month? | string |
Returns
Promise<any[]>
borrowRepayVIPLoan()
borrowRepayVIPLoan(params: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | { amt: string; ccy: string; ordId?: string; side: "borrow" | "repay"; } |
params.amt | string |
params.ccy | string |
params.ordId? | string |
params.side | "borrow" | "repay" |
Returns
Promise<any[]>
cancelAdvanceAlgoOrder()
cancelAdvanceAlgoOrder(params: CancelAlgoOrderRequest[]): Promise<AlgoOrderResult[]>;Parameters
| Parameter | Type |
|---|---|
params | CancelAlgoOrderRequest[] |
Returns
Promise<AlgoOrderResult[]>
cancelAlgoOrder()
cancelAlgoOrder(params: CancelAlgoOrderRequest[]): Promise<AlgoOrderResult[]>;Parameters
| Parameter | Type |
|---|---|
params | CancelAlgoOrderRequest[] |
Returns
Promise<AlgoOrderResult[]>
cancelAllAfter()
cancelAllAfter(params: object): Promise<CancelAllAfterResponse[]>;Parameters
| Parameter | Type |
|---|---|
params | { tag?: string; timeOut: string; } |
params.tag? | string |
params.timeOut | string |
Returns
Promise<CancelAllAfterResponse[]>
cancelAllBlockAfter()
cancelAllBlockAfter(params: object): Promise<object[]>;Parameters
| Parameter | Type |
|---|---|
params | { timeOut: string; } |
params.timeOut | string |
Returns
Promise<object[]>
cancelAllBlockQuotes()
cancelAllBlockQuotes(): Promise<TimestampObject[]>;Returns
Promise<TimestampObject[]>
cancelAllRFQs()
cancelAllRFQs(): Promise<TimestampObject[]>;Returns
Promise<TimestampObject[]>
cancelAllSpreadOrders()
cancelAllSpreadOrders(params?: object): Promise<object[]>;Parameters
| Parameter | Type |
|---|---|
params? | { sprdId?: string; } |
params.sprdId? | string |
Returns
Promise<object[]>
cancelBlockQuote()
cancelBlockQuote(params: CancelBlockQuoteRequest): Promise<CancelBlockQuoteResult[]>;Parameters
| Parameter | Type |
|---|---|
params | CancelBlockQuoteRequest |
Returns
Promise<CancelBlockQuoteResult[]>
cancelBlockRFQ()
cancelBlockRFQ(params: CancelBlockRFQRequest): Promise<CancelBlockRFQResult[]>;Parameters
| Parameter | Type |
|---|---|
params | CancelBlockRFQRequest |
Returns
Promise<CancelBlockRFQResult[]>
cancelGridContractCloseOrder()
cancelGridContractCloseOrder(params: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | { algoId: string; ordId: string; } |
params.algoId | string |
params.ordId | string |
Returns
Promise<any[]>
cancelMassOrder()
cancelMassOrder(params: object): Promise<object[]>;Parameters
| Parameter | Type |
|---|---|
params | { instFamily: string; instType: string; lockInterval?: string; } |
params.instFamily | string |
params.instType | string |
params.lockInterval? | string |
Returns
Promise<object[]>
cancelMultipleBlockQuotes()
cancelMultipleBlockQuotes(params: CancelMultipleBlockQuoteRequest): Promise<CancelBlockQuoteResult[]>;Parameters
| Parameter | Type |
|---|---|
params | CancelMultipleBlockQuoteRequest |
Returns
Promise<CancelBlockQuoteResult[]>
cancelMultipleBlockRFQs()
cancelMultipleBlockRFQs(params: CancelMultipleBlockRFQRequest): Promise<CancelBlockRFQResult[]>;Parameters
| Parameter | Type |
|---|---|
params | CancelMultipleBlockRFQRequest |
Returns
Promise<CancelBlockRFQResult[]>
cancelMultipleOrders()
cancelMultipleOrders(params: OrderIdRequest[]): Promise<CancelledOrderResult[]>;Parameters
| Parameter | Type |
|---|---|
params | OrderIdRequest[] |
Returns
Promise<CancelledOrderResult[]>
cancelOrder()
cancelOrder(params: OrderIdRequest): Promise<CancelledOrderResult[]>;Parameters
| Parameter | Type |
|---|---|
params | OrderIdRequest |
Returns
Promise<CancelledOrderResult[]>
See
cancelRedeemETHStaking()
cancelRedeemETHStaking(params: object): Promise<object[]>;Parameters
| Parameter | Type |
|---|---|
params | { ordId: string; } |
params.ordId | string |
Returns
Promise<object[]>
cancelSignalBots()
cancelSignalBots(params: object): Promise<CancelSignalBotsResult[]>;Parameters
| Parameter | Type |
|---|---|
params | { algoId: string; } |
params.algoId | string |
Returns
Promise<CancelSignalBotsResult[]>
cancelSpreadAllAfter()
cancelSpreadAllAfter(params: object): Promise<object[]>;Parameters
| Parameter | Type |
|---|---|
params | { timeOut: string; } |
params.timeOut | string |
Returns
Promise<object[]>
cancelSpreadOrder()
cancelSpreadOrder(params?: object): Promise<CancelSpreadOrderResponse[]>;Parameters
| Parameter | Type |
|---|---|
params? | { clOrdId?: string; ordId?: string; } |
params.clOrdId? | string |
params.ordId? | string |
Returns
Promise<CancelSpreadOrderResponse[]>
cancelStakingRequest()
cancelStakingRequest(params: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | { ordId: string; protocolType: "staking" | "defi"; } |
params.ordId | string |
params.protocolType | "staking" | "defi" |
Returns
Promise<any[]>
cancelSubOrder()
cancelSubOrder(params: CancelSubOrderRequest): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | CancelSubOrderRequest |
Returns
Promise<any[]>
cancelWithdrawal()
cancelWithdrawal(params: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | { wdId: string; } |
params.wdId | string |
Returns
Promise<any[]>
changePositionMargin()
changePositionMargin(params: ChangePositionMarginRequest): Promise<AccountChangeMarginResult[]>;Parameters
| Parameter | Type |
|---|---|
params | ChangePositionMarginRequest |
Returns
Promise<AccountChangeMarginResult[]>
closeCopytradingSubposition()
closeCopytradingSubposition(params: CloseSubpositionRequest): Promise<object[]>;Parameters
| Parameter | Type |
|---|---|
params | CloseSubpositionRequest |
Returns
Promise<object[]>
closeGridContractPosition()
closeGridContractPosition(params: CloseContractGridPositionRequest): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | CloseContractGridPositionRequest |
Returns
Promise<any[]>
closePositions()
closePositions(params: ClosePositionRequest): Promise<ClosedPositions[]>;Parameters
| Parameter | Type |
|---|---|
params | ClosePositionRequest |
Returns
Promise<ClosedPositions[]>
closeSignalBotPosition()
closeSignalBotPosition(params: object): Promise<object[]>;Parameters
| Parameter | Type |
|---|---|
params | { algoId: string; instId: string; } |
params.algoId | string |
params.instId | string |
Returns
Promise<object[]>
computeGridMarginBalance()
computeGridMarginBalance(params: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | { algoId: string; amt?: string; type: "reduce" | "add"; } |
params.algoId | string |
params.amt? | string |
params.type | "reduce" | "add" |
Returns
Promise<any[]>
computeGridMinInvestment()
computeGridMinInvestment(params: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | { amt: string; ccy: string; } |
params.amt | string |
params.ccy | string |
Returns
Promise<any[]>
convertFixedLoanToMarketLoan()
convertFixedLoanToMarketLoan(params: object): Promise<object[]>;Parameters
| Parameter | Type |
|---|---|
params | { ordId: string; } |
params.ordId | string |
Returns
Promise<object[]>
convertTrade()
convertTrade(params: ConvertTradeRequest): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | ConvertTradeRequest |
Returns
Promise<any[]>
createBlockQuote()
createBlockQuote(params: CreateBlockQuoteRequest): Promise<CreateBlockQuoteResult[]>;Parameters
| Parameter | Type |
|---|---|
params | CreateBlockQuoteRequest |
Returns
Promise<CreateBlockQuoteResult[]>
createBlockRFQ()
createBlockRFQ(params: CreateBlockRFQRequest): Promise<CreateRFQResult[]>;Parameters
| Parameter | Type |
|---|---|
params | CreateBlockRFQRequest |
Returns
Promise<CreateRFQResult[]>
createSignal()
createSignal(params: CreateSignalRequest): Promise<CreateSignalResult[]>;Orderbook trading - Signal bot trading endpoints
Parameters
| Parameter | Type |
|---|---|
params | CreateSignalRequest |
Returns
Promise<CreateSignalResult[]>
createSignalBot()
createSignalBot(params: CreateSignalBotRequest): Promise<CreateSignalBotResult[]>;Parameters
| Parameter | Type |
|---|---|
params | CreateSignalBotRequest |
Returns
Promise<CreateSignalBotResult[]>
createSubAccount()
createSubAccount(params: object): Promise<any[]>;Broker endpoints (private)
Parameters
| Parameter | Type |
|---|---|
params | { clientIP?: string; label?: string; mainAcct: string; subAcct: string; } |
params.clientIP? | string |
params.label? | string |
params.mainAcct | string |
params.subAcct | string |
Returns
Promise<any[]>
createSubAccountAPIKey()
createSubAccountAPIKey(params: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | { ip?: string; label: string; passphrase: string; perm?: string; subAcct: string; } |
params.ip? | string |
params.label | string |
params.passphrase | string |
params.perm? | string |
params.subAcct | string |
Returns
Promise<any[]>
deletePrivate()
deletePrivate(endpoint: string, params?: any): Promise<any>;Parameters
| Parameter | Type |
|---|---|
endpoint | string |
params? | any |
Returns
Promise<any>
Inherited from
BaseRestClient.deletePrivate
deleteSubAccount()
deleteSubAccount(params: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | { subAcct: string; } |
params.subAcct | string |
Returns
Promise<any[]>
estimateConvertQuote()
estimateConvertQuote(params: ConvertQuoteEstimateRequest): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | ConvertQuoteEstimateRequest |
Returns
Promise<any[]>
executeBlockQuote()
executeBlockQuote(params: ExecuteBlockQuoteRequest): Promise<ExecuteBlockQuoteResult[]>;Parameters
| Parameter | Type |
|---|---|
params | ExecuteBlockQuoteRequest |
Returns
Promise<ExecuteBlockQuoteResult[]>
fetchLatencySummary()
fetchLatencySummary(): Promise<any>;Estimate request latency and the clock difference between the client and server. This SDK utility is intended for diagnostics, not an official exchange endpoint. Results are approximate and can vary between requests.
Returns
Promise<any>
fundsTransfer()
fundsTransfer(params: FundsTransferRequest): Promise<FundTransferResult[]>;Parameters
| Parameter | Type |
|---|---|
params | FundsTransferRequest |
Returns
Promise<FundTransferResult[]>
geCopytradingLeadPrivateStats()
geCopytradingLeadPrivateStats(params: GetLeadTraderStatsRequest): Promise<LeadTraderStats[]>;Parameters
| Parameter | Type |
|---|---|
params | GetLeadTraderStatsRequest |
Returns
Promise<LeadTraderStats[]>
get()
get(endpoint: string, params?: any): Promise<any>;Parameters
| Parameter | Type |
|---|---|
endpoint | string |
params? | any |
Returns
Promise<any>
Inherited from
BaseRestClient.get
get24hrTotalVolume()
get24hrTotalVolume(): Promise<any[]>;Returns
Promise<any[]>
getAccountAssetValuation()
getAccountAssetValuation(params?: object): Promise<AccountAssetValuation[]>;Parameters
| Parameter | Type |
|---|---|
params? | { ccy?: string; } |
params.ccy? | string |
Returns
Promise<AccountAssetValuation[]>
getAccountBillSubtypes()
getAccountBillSubtypes(params?: GetAccountBillSubtypesRequest): Promise<AccountBillTypeDefinition[]>;Bill type ids and subTypes (unified account bill CSV columns reference type / subType).
Parameters
| Parameter | Type |
|---|---|
params? | GetAccountBillSubtypesRequest |
Returns
Promise<AccountBillTypeDefinition[]>
See
GET /api/v5/account/subtypes
getAccountCollateralAssets()
getAccountCollateralAssets(params?: object): Promise<object[]>;Parameters
| Parameter | Type |
|---|---|
params? | { ccy?: string; collateralEnabled?: boolean; } |
params.ccy? | string |
params.collateralEnabled? | boolean |
Returns
Promise<object[]>
getAccountConfiguration()
getAccountConfiguration(): Promise<AccountConfiguration[]>;Returns
Promise<AccountConfiguration[]>
getAccountInstruments()
getAccountInstruments(params: GetInstrumentsRequest): Promise<AccountInstrument[]>;Trading account endpoints
Parameters
| Parameter | Type |
|---|---|
params | GetInstrumentsRequest |
Returns
Promise<AccountInstrument[]>
getAccountPositionRisk()
getAccountPositionRisk(params?: object): Promise<AccountPositionRisk[]>;Parameters
| Parameter | Type |
|---|---|
params? | { instType?: Omit<"SPOT", InstrumentType>; } |
params.instType? | Omit<"SPOT", InstrumentType> |
Returns
Promise<AccountPositionRisk[]>
getAccountRateLimit()
getAccountRateLimit(): Promise<any[]>;Returns
Promise<any[]>
getAccountRiskState()
getAccountRiskState(): Promise<AccountRiskState[]>;Returns
Promise<AccountRiskState[]>
getAccountSwitchPrecheck()
getAccountSwitchPrecheck(params: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | { acctLv: "1" | "2" | "3" | "4"; } |
params.acctLv | "1" | "2" | "3" | "4" |
Returns
Promise<any[]>
getAccruedInterest()
getAccruedInterest(params?: AccruedInterestRequest): Promise<AccruedInterestItem[]>;Parameters
| Parameter | Type |
|---|---|
params? | AccruedInterestRequest |
Returns
Promise<AccruedInterestItem[]>
getActiveSignalBot()
getActiveSignalBot(params: GetSignalBotRequest): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | GetSignalBotRequest |
Returns
Promise<any[]>
getActiveStakingOrders()
getActiveStakingOrders(params?: object): Promise<any[]>;Earn/staking get active orders
Parameters
| Parameter | Type |
|---|---|
params? | { ccy?: string; productId?: string; protocolType?: "staking" | "defi"; state?: "1" | "2" | "8" | "9" | "13"; } |
params.ccy? | string |
params.productId? | string |
params.protocolType? | "staking" | "defi" |
params.state? | "1" | "2" | "8" | "9" | "13" |
Returns
Promise<any[]>
getAlgoOrderDetails()
getAlgoOrderDetails(params: AlgoOrderDetailsRequest): Promise<AlgoOrderDetailsResult[]>;Parameters
| Parameter | Type |
|---|---|
params | AlgoOrderDetailsRequest |
Returns
Promise<AlgoOrderDetailsResult[]>
getAlgoOrderHistory()
getAlgoOrderHistory(params: AlgoLongHistoryRequest): Promise<HistoricAlgoOrder[]>;Parameters
| Parameter | Type |
|---|---|
params | AlgoLongHistoryRequest |
Returns
Promise<HistoricAlgoOrder[]>
getAlgoOrderList()
getAlgoOrderList(params: AlgoRecentHistoryRequest): Promise<AlgoOrderListItem[]>;Parameters
| Parameter | Type |
|---|---|
params | AlgoRecentHistoryRequest |
Returns
Promise<AlgoOrderListItem[]>
getAnnouncements()
getAnnouncements(params?: object): Promise<object[]>;Announcement endpoints
Parameters
| Parameter | Type |
|---|---|
params? | { annType?: string; page?: string; } |
params.annType? | string |
params.page? | string |
Returns
Promise<object[]>
getAnnouncementTypes()
getAnnouncementTypes(): Promise<object[]>;Returns
Promise<object[]>
getAPYHistory()
getAPYHistory(params: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | { days: string; } |
params.days | string |
Returns
Promise<any[]>
getAssetBillsDetails()
getAssetBillsDetails(params?: object): Promise<AssetBillDetails[]>;Query the billing record in the past month.
Parameters
| Parameter | Type | Description |
|---|---|---|
params? | { after?: string; before?: string; ccy?: string; clientId?: string; limit?: string; thirdPartyType?: "1" | "2" | "5" | "6"; type?: | "1" | "2" | "13" | "20" | "21" | "28" | "47" | "48" | "49" | "50" | "51" | "52" | "53" | "54" | "61" | "68" | "69" | "72" | "73" | "74" | "75" | "76" | "77" | "78" | "79" | "80" | "81" | "82" | "83" | "84" | "85" | "86" | "87" | "88" | "89" | "90" | "91" | "92" | "93" | "94" | "95" | "96" | "97" | "98" | "99" | "102" | "103" | "104" | "105" | "106" | "107" | "108" | "109" | "110" | "111" | "112" | "113" | "114" | "115" | "116" | "117" | "118" | "119" | "120" | "121" | "122" | "123" | "124" | "125" | "126" | "127" | "128" | "129" | "130" | "131" | "132" | "133" | "134" | "135" | "136" | "137" | "138" | "139" | "141" | "142" | "143" | "144" | "145" | "146" | "147" | "150" | "151" | "152" | "153" | "154" | "155" | "156" | "157" | "160" | "161" | "162" | "163" | "169" | "170" | "171" | "172" | "173" | "174" | "175" | "176" | "177" | "178" | "179" | "180" | "181" | "182" | "183" | "184" | "185" | "186" | "187" | "188" | "189" | "193" | "194" | "195" | "196" | "197" | "198" | "199" | "200" | "211"; } | - |
params.after? | string | - |
params.before? | string | - |
params.ccy? | string | - |
params.clientId? | string | - |
params.limit? | string | - |
params.thirdPartyType? | "1" | "2" | "5" | "6" | Third-party custody type. Defaults to 1 (Copper) if not specified. |
params.type? | | "1" | "2" | "13" | "20" | "21" | "28" | "47" | "48" | "49" | "50" | "51" | "52" | "53" | "54" | "61" | "68" | "69" | "72" | "73" | "74" | "75" | "76" | "77" | "78" | "79" | "80" | "81" | "82" | "83" | "84" | "85" | "86" | "87" | "88" | "89" | "90" | "91" | "92" | "93" | "94" | "95" | "96" | "97" | "98" | "99" | "102" | "103" | "104" | "105" | "106" | "107" | "108" | "109" | "110" | "111" | "112" | "113" | "114" | "115" | "116" | "117" | "118" | "119" | "120" | "121" | "122" | "123" | "124" | "125" | "126" | "127" | "128" | "129" | "130" | "131" | "132" | "133" | "134" | "135" | "136" | "137" | "138" | "139" | "141" | "142" | "143" | "144" | "145" | "146" | "147" | "150" | "151" | "152" | "153" | "154" | "155" | "156" | "157" | "160" | "161" | "162" | "163" | "169" | "170" | "171" | "172" | "173" | "174" | "175" | "176" | "177" | "178" | "179" | "180" | "181" | "182" | "183" | "184" | "185" | "186" | "187" | "188" | "189" | "193" | "194" | "195" | "196" | "197" | "198" | "199" | "200" | "211" | - |
Returns
Promise<AssetBillDetails[]>
getAssetBillsHistoric()
getAssetBillsHistoric(params?: object): Promise<AssetBillDetails[]>;Query the billing records of all time since 1 February, 2021.
⚠️ IMPORTANT: Data updates occur every 30 seconds. Update frequency may vary based on data volume - please be aware of potential delays during high-traffic periods.
Rate Limit: 1 Requests per second
Parameters
| Parameter | Type | Description |
|---|---|---|
params? | { after?: string; before?: string; ccy?: string; clientId?: string; limit?: string; pagingType?: "0" | "1"; thirdPartyType?: "1" | "2" | "5" | "6"; type?: | "1" | "2" | "13" | "20" | "21" | "28" | "47" | "48" | "49" | "50" | "51" | "52" | "53" | "54" | "61" | "68" | "69" | "72" | "73" | "74" | "75" | "76" | "77" | "78" | "79" | "80" | "81" | "82" | "83" | "84" | "85" | "86" | "87" | "88" | "89" | "90" | "91" | "92" | "93" | "94" | "95" | "96" | "97" | "98" | "99" | "102" | "103" | "104" | "105" | "106" | "107" | "108" | "109" | "110" | "111" | "112" | "113" | "114" | "115" | "116" | "117" | "118" | "119" | "120" | "121" | "122" | "123" | "124" | "125" | "126" | "127" | "128" | "129" | "130" | "131" | "132" | "133" | "134" | "135" | "136" | "137" | "138" | "139" | "141" | "142" | "143" | "144" | "145" | "146" | "147" | "150" | "151" | "152" | "153" | "154" | "155" | "156" | "157" | "160" | "161" | "162" | "163" | "169" | "170" | "171" | "172" | "173" | "174" | "175" | "176" | "177" | "178" | "179" | "180" | "181" | "182" | "183" | "184" | "185" | "186" | "187" | "188" | "189" | "193" | "194" | "195" | "196" | "197" | "198" | "199" | "200" | "211"; } | - |
params.after? | string | - |
params.before? | string | - |
params.ccy? | string | - |
params.clientId? | string | - |
params.limit? | string | - |
params.pagingType? | "0" | "1" | - |
params.thirdPartyType? | "1" | "2" | "5" | "6" | Third-party custody type. Defaults to 1 (Copper) if not specified. See 2026-06-05 changelog |
params.type? | | "1" | "2" | "13" | "20" | "21" | "28" | "47" | "48" | "49" | "50" | "51" | "52" | "53" | "54" | "61" | "68" | "69" | "72" | "73" | "74" | "75" | "76" | "77" | "78" | "79" | "80" | "81" | "82" | "83" | "84" | "85" | "86" | "87" | "88" | "89" | "90" | "91" | "92" | "93" | "94" | "95" | "96" | "97" | "98" | "99" | "102" | "103" | "104" | "105" | "106" | "107" | "108" | "109" | "110" | "111" | "112" | "113" | "114" | "115" | "116" | "117" | "118" | "119" | "120" | "121" | "122" | "123" | "124" | "125" | "126" | "127" | "128" | "129" | "130" | "131" | "132" | "133" | "134" | "135" | "136" | "137" | "138" | "139" | "141" | "142" | "143" | "144" | "145" | "146" | "147" | "150" | "151" | "152" | "153" | "154" | "155" | "156" | "157" | "160" | "161" | "162" | "163" | "169" | "170" | "171" | "172" | "173" | "174" | "175" | "176" | "177" | "178" | "179" | "180" | "181" | "182" | "183" | "184" | "185" | "186" | "187" | "188" | "189" | "193" | "194" | "195" | "196" | "197" | "198" | "199" | "200" | "211" | - |
Returns
Promise<AssetBillDetails[]>
getBalance()
getBalance(params?: object): Promise<AccountBalance[]>;Parameters
| Parameter | Type |
|---|---|
params? | { ccy?: string; } |
params.ccy? | string |
Returns
Promise<AccountBalance[]>
See
getBalances()
getBalances(params?: object): Promise<FundingBalance[]>;Parameters
| Parameter | Type |
|---|---|
params? | { ccy?: string; } |
params.ccy? | string |
Returns
Promise<FundingBalance[]>
getBills()
getBills(params?: any): Promise<AccountBill[]>;Up to last 7 days
Parameters
| Parameter | Type |
|---|---|
params? | any |
Returns
Promise<AccountBill[]>
getBillsArchive()
getBillsArchive(params?: any): Promise<AccountBill[]>;Last 3 months
Parameters
| Parameter | Type |
|---|---|
params? | any |
Returns
Promise<AccountBill[]>
getBlockCounterParties()
getBlockCounterParties(): Promise<BlockCounterParty[]>;Block trading - REST endpoints
Returns
Promise<BlockCounterParty[]>
getBlockMmpConfig()
getBlockMmpConfig(): Promise<BlockMMPConfig[]>;Returns
Promise<BlockMMPConfig[]>
getBlockPublicTrades()
getBlockPublicTrades(params: object): Promise<PublicBlockTrade[]>;Parameters
| Parameter | Type |
|---|---|
params | { instId: string; } |
params.instId | string |
Returns
Promise<PublicBlockTrade[]>
getBlockQuotes()
getBlockQuotes(params?: GetBlockQuoteParams): Promise<GetBlockQuoteResult[]>;Parameters
| Parameter | Type |
|---|---|
params? | GetBlockQuoteParams |
Returns
Promise<GetBlockQuoteResult[]>
getBlockRFQs()
getBlockRFQs(params?: GetBlockRFQSParams): Promise<BlockRFQResult[]>;Parameters
| Parameter | Type |
|---|---|
params? | GetBlockRFQSParams |
Returns
Promise<BlockRFQResult[]>
getBlockTicker()
getBlockTicker(params: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | { instId: string; } |
params.instId | string |
Returns
Promise<any[]>
getBlockTickers()
getBlockTickers(params: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | { instType: InstrumentType; uly?: string; } |
params.instType | InstrumentType |
params.uly? | string |
Returns
Promise<any[]>
getBlockTrades()
getBlockTrades(params?: any): Promise<BlockTradeResult[]>;Parameters
| Parameter | Type |
|---|---|
params? | any |
Returns
Promise<BlockTradeResult[]>
getBorrowableCurrencies()
getBorrowableCurrencies(): Promise<object[]>;Financial product - Flexible loan endpoints
Returns
Promise<object[]>
getBorrowInterestLimits()
getBorrowInterestLimits(params?: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params? | { ccy?: string; type?: "1" | "2"; } |
params.ccy? | string |
params.type? | "1" | "2" |
Returns
Promise<any[]>
getBorrowRepayHistory()
getBorrowRepayHistory(params?: GetBorrowRepayHistoryRequest): Promise<BorrowRepayHistoryItem[]>;Parameters
| Parameter | Type |
|---|---|
params? | GetBorrowRepayHistoryRequest |
Returns
Promise<BorrowRepayHistoryItem[]>
getCandles()
getCandles(params: CandleRequest): Promise<Candle[]>;Parameters
| Parameter | Type |
|---|---|
params | CandleRequest |
Returns
Promise<Candle[]>
getCollateralAssets()
getCollateralAssets(params?: GetFlexibleLoanCollateralAssetsRequest): Promise<CollateralAssetsResponse[]>;Parameters
| Parameter | Type |
|---|---|
params? | GetFlexibleLoanCollateralAssetsRequest |
Returns
Promise<CollateralAssetsResponse[]>
getContractsOpenInterestAndVolume()
getContractsOpenInterestAndVolume(params: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | { begin?: string; ccy: string; end?: string; period: "5m" | "1H" | "1D"; } |
params.begin? | string |
params.ccy | string |
params.end? | string |
params.period | "5m" | "1H" | "1D" |
Returns
Promise<any[]>
getContractTakerVolume()
getContractTakerVolume(params: GetContractTakerVolumeRequest): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | GetContractTakerVolumeRequest |
Returns
Promise<any[]>
getConvertCurrencies()
getConvertCurrencies(): Promise<any[]>;Returns
Promise<any[]>
getConvertCurrencyPair()
getConvertCurrencyPair(params: object): Promise<any[]>;Parameters
| Parameter | Type | Description |
|---|---|---|
params | { convertMode?: "0" | "1"; fromCcy: string; toCcy: string; } | - |
params.convertMode? | "0" | "1" | 0: standard convert (default), 1: large order convert for VIP |
params.fromCcy | string | - |
params.toCcy | string | - |
Returns
Promise<any[]>
getConvertHistory()
getConvertHistory(params?: any): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params? | any |
Returns
Promise<any[]>
getCopyTraders()
getCopyTraders(params: GetCopyTradersRequest): Promise<GetCopyTradersResult[]>;Parameters
| Parameter | Type |
|---|---|
params | GetCopyTradersRequest |
Returns
Promise<GetCopyTradersResult[]>
getCopyTradersPrivate()
getCopyTradersPrivate(params: GetCopyTradersRequest): Promise<GetCopyTradersResult[]>;Parameters
| Parameter | Type |
|---|---|
params | GetCopyTradersRequest |
Returns
Promise<GetCopyTradersResult[]>
getCopytradingAccount()
getCopytradingAccount(): Promise<GetAccountConfigurationResult[]>;Returns
Promise<GetAccountConfigurationResult[]>
getCopytradingBatchLeverageInfo()
getCopytradingBatchLeverageInfo(params: GetCTBatchLeverageInfoRequest): Promise<GetCTBatchLeverageInfoResult[]>;Parameters
| Parameter | Type |
|---|---|
params | GetCTBatchLeverageInfoRequest |
Returns
Promise<GetCTBatchLeverageInfoResult[]>
getCopytradingConfig()
getCopytradingConfig(params?: object): Promise<GetCopyTradingConfigResult[]>;Parameters
| Parameter | Type |
|---|---|
params? | { instType?: "SWAP"; } |
params.instType? | "SWAP" |
Returns
Promise<GetCopyTradingConfigResult[]>
getCopytradingCopySettings()
getCopytradingCopySettings(params: object): Promise<GetCopySettingsResult[]>;Parameters
| Parameter | Type |
|---|---|
params | { instType?: "SWAP"; uniqueCode: string; } |
params.instType? | "SWAP" |
params.uniqueCode | string |
Returns
Promise<GetCopySettingsResult[]>
getCopytradingInstruments()
getCopytradingInstruments(params?: object): Promise<object[]>;Parameters
| Parameter | Type |
|---|---|
params? | { instType?: "SPOT" | "SWAP"; } |
params.instType? | "SPOT" | "SWAP" |
Returns
Promise<object[]>
getCopytradingLeadDailyPnl()
getCopytradingLeadDailyPnl(params: GetLeadTraderStatsRequest): Promise<LeadTraderPnl[]>;Parameters
| Parameter | Type |
|---|---|
params | GetLeadTraderStatsRequest |
Returns
Promise<LeadTraderPnl[]>
getCopytradingLeadOpenPositions()
getCopytradingLeadOpenPositions(params: GetLeadTraderPositionsRequest): Promise<LeadTraderCurrentPosition[]>;Parameters
| Parameter | Type |
|---|---|
params | GetLeadTraderPositionsRequest |
Returns
Promise<LeadTraderCurrentPosition[]>
getCopytradingLeadPositionHistory()
getCopytradingLeadPositionHistory(params: GetLeadTraderPositionsRequest): Promise<LeadTraderPositionHistory[]>;Parameters
| Parameter | Type |
|---|---|
params | GetLeadTraderPositionsRequest |
Returns
Promise<LeadTraderPositionHistory[]>
getCopytradingLeadPreferences()
getCopytradingLeadPreferences(params: object): Promise<LeadTraderPreference[]>;Parameters
| Parameter | Type |
|---|---|
params | { instType?: "SWAP"; uniqueCode: string; } |
params.instType? | "SWAP" |
params.uniqueCode | string |
Returns
Promise<LeadTraderPreference[]>
getCopytradingLeadPrivateOpenPositions()
getCopytradingLeadPrivateOpenPositions(params: GetLeadTraderPositionsRequest): Promise<LeadTraderCurrentPosition[]>;Parameters
| Parameter | Type |
|---|---|
params | GetLeadTraderPositionsRequest |
Returns
Promise<LeadTraderCurrentPosition[]>
getCopytradingLeadPrivatePositionHistory()
getCopytradingLeadPrivatePositionHistory(params: GetLeadTraderPositionsRequest): Promise<LeadTraderPositionHistory[]>;Parameters
| Parameter | Type |
|---|---|
params | GetLeadTraderPositionsRequest |
Returns
Promise<LeadTraderPositionHistory[]>
getCopytradingLeadPrivatePreferences()
getCopytradingLeadPrivatePreferences(params: object): Promise<LeadTraderPreference[]>;Parameters
| Parameter | Type |
|---|---|
params | { instType?: "SWAP"; uniqueCode: string; } |
params.instType? | "SWAP" |
params.uniqueCode | string |
Returns
Promise<LeadTraderPreference[]>
getCopytradingLeadPrivateRanks()
getCopytradingLeadPrivateRanks(params?: GetPrivateLeadTraderRanksRequest): Promise<GetPrivateLeadTraderRanksResult[]>;Parameters
| Parameter | Type |
|---|---|
params? | GetPrivateLeadTraderRanksRequest |
Returns
Promise<GetPrivateLeadTraderRanksResult[]>
getCopytradingLeadPrivateWeeklyPnl()
getCopytradingLeadPrivateWeeklyPnl(params: object): Promise<LeadTraderPnl[]>;Parameters
| Parameter | Type |
|---|---|
params | { instType?: "SWAP"; uniqueCode: string; } |
params.instType? | "SWAP" |
params.uniqueCode | string |
Returns
Promise<LeadTraderPnl[]>
getCopytradingLeadRanks()
getCopytradingLeadRanks(params?: GetLeadTraderRanksRequest): Promise<GetLeadTraderRanksResult[]>;Parameters
| Parameter | Type |
|---|---|
params? | GetLeadTraderRanksRequest |
Returns
Promise<GetLeadTraderRanksResult[]>
getCopytradingLeadStats()
getCopytradingLeadStats(params: GetLeadTraderStatsRequest): Promise<LeadTraderStats[]>;Parameters
| Parameter | Type |
|---|---|
params | GetLeadTraderStatsRequest |
Returns
Promise<LeadTraderStats[]>
getCopytradingLeadTradersHistory()
getCopytradingLeadTradersHistory(params?: GetCTHistoryLeadTradersRequest): Promise<GetCTHistoryLeadTradersResult[]>;Parameters
| Parameter | Type |
|---|---|
params? | GetCTHistoryLeadTradersRequest |
Returns
Promise<GetCTHistoryLeadTradersResult[]>
getCopytradingLeadWeeklyPnl()
getCopytradingLeadWeeklyPnl(params: object): Promise<LeadTraderPnl[]>;Parameters
| Parameter | Type |
|---|---|
params | { instType?: "SWAP"; uniqueCode: string; } |
params.instType? | "SWAP" |
params.uniqueCode | string |
Returns
Promise<LeadTraderPnl[]>
getCopytradingMyLeadTraders()
getCopytradingMyLeadTraders(params?: object): Promise<GetCTMyLeadTradersResult[]>;Parameters
| Parameter | Type |
|---|---|
params? | { instType?: "SWAP"; } |
params.instType? | "SWAP" |
Returns
Promise<GetCTMyLeadTradersResult[]>
getCopytradingPLeadPrivateDailyPnl()
getCopytradingPLeadPrivateDailyPnl(params: GetLeadTraderStatsRequest): Promise<LeadTraderPnl[]>;Parameters
| Parameter | Type |
|---|---|
params | GetLeadTraderStatsRequest |
Returns
Promise<LeadTraderPnl[]>
getCopytradingProfitDetails()
getCopytradingProfitDetails(params?: GetCTProfitDetailsRequest): Promise<GetCTProfitDetailsResult[]>;Parameters
| Parameter | Type |
|---|---|
params? | GetCTProfitDetailsRequest |
Returns
Promise<GetCTProfitDetailsResult[]>
getCopytradingSubpositions()
getCopytradingSubpositions(params?: GetCurrentSubpositionsRequest): Promise<CurrentSubposition[]>;Orderbook trading - Copy trading endpoints
Parameters
| Parameter | Type |
|---|---|
params? | GetCurrentSubpositionsRequest |
Returns
Promise<CurrentSubposition[]>
getCopytradingSubpositionsHistory()
getCopytradingSubpositionsHistory(params?: GetSubpositionsHistoryRequest): Promise<SubpositionsHistory[]>;Parameters
| Parameter | Type |
|---|---|
params? | GetSubpositionsHistoryRequest |
Returns
Promise<SubpositionsHistory[]>
getCopytradingTotalProfit()
getCopytradingTotalProfit(params?: object): Promise<GetCTTotalProfitResult[]>;Parameters
| Parameter | Type |
|---|---|
params? | { instType?: "SPOT" | "SWAP"; } |
params.instType? | "SPOT" | "SWAP" |
Returns
Promise<GetCTTotalProfitResult[]>
getCopytradingTotalUnrealizedProfit()
getCopytradingTotalUnrealizedProfit(params?: object): Promise<object[]>;Parameters
| Parameter | Type |
|---|---|
params? | { instType?: "SWAP"; } |
params.instType? | "SWAP" |
Returns
Promise<object[]>
getCopytradingUnrealizedProfit()
getCopytradingUnrealizedProfit(params?: object): Promise<GetCTUnrealizedProfitResult[]>;Parameters
| Parameter | Type |
|---|---|
params? | { instType?: "SPOT" | "SWAP"; } |
params.instType? | "SPOT" | "SWAP" |
Returns
Promise<GetCTUnrealizedProfitResult[]>
getCurrencies()
getCurrencies(params?: object): Promise<FundingCurrency[]>;Funding account - REST endpoints
Parameters
| Parameter | Type |
|---|---|
params? | { ccy?: string; } |
params.ccy? | string |
Returns
Promise<FundingCurrency[]>
getDcdCurrencyPairs()
getDcdCurrencyPairs(): Promise<DcdCurrencyPair[]>;Financial product — dual investment (DCD) endpoints
Returns
Promise<DcdCurrencyPair[]>
See
https://www.okx.com/docs-v5/en/ (2026-03-13 release)
getDcdOrderHistory()
getDcdOrderHistory(params?: GetDcdOrderHistoryRequest): Promise<DcdOrderHistoryItem[]>;Parameters
| Parameter | Type |
|---|---|
params? | GetDcdOrderHistoryRequest |
Returns
Promise<DcdOrderHistoryItem[]>
getDcdOrderStatus()
getDcdOrderStatus(params: GetDcdOrderStatusRequest): Promise<DcdOrderStatus[]>;Parameters
| Parameter | Type |
|---|---|
params | GetDcdOrderStatusRequest |
Returns
Promise<DcdOrderStatus[]>
getDcdProducts()
getDcdProducts(params: GetDcdProductsRequest): Promise<DcdProduct[]>;Parameters
| Parameter | Type |
|---|---|
params | GetDcdProductsRequest |
Returns
Promise<DcdProduct[]>
getDeliveryExerciseHistory()
getDeliveryExerciseHistory(params: any): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | any |
Returns
Promise<any[]>
getDeltaHedgeCurrencies()
getDeltaHedgeCurrencies(params?: object): Promise<DeltaHedgeCurrency[]>;Parameters
| Parameter | Type |
|---|---|
params? | { ccy?: string; } |
params.ccy? | string |
Returns
Promise<DeltaHedgeCurrency[]>
getDepositAddress()
getDepositAddress(params: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | { ccy: string; } |
params.ccy | string |
Returns
Promise<any[]>
getDepositHistory()
getDepositHistory(params?: GetDepositHistoryRequest): Promise<DepositHistory[]>;Parameters
| Parameter | Type |
|---|---|
params? | GetDepositHistoryRequest |
Returns
Promise<DepositHistory[]>
getDepositWithdrawStatus()
getDepositWithdrawStatus(params: GetDepositWithdrawStatusRequest): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | GetDepositWithdrawStatusRequest |
Returns
Promise<any[]>
getDiscountRateAndInterestFreeQuota()
getDiscountRateAndInterestFreeQuota(params: any): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | any |
Returns
Promise<any[]>
getEasyConvertCurrencies()
getEasyConvertCurrencies(params?: object): Promise<any>;Get easy convert currency list
Parameters
| Parameter | Type |
|---|---|
params? | { source?: string; } |
params.source? | string |
Returns
Promise<any>
getEasyConvertHistory()
getEasyConvertHistory(params?: Pagination): Promise<APIResponse<any>>;Get easy convert history : Get the history and status of easy convert trades.
Parameters
| Parameter | Type |
|---|---|
params? | Pagination |
Returns
Promise<APIResponse<any>>
getEconomicCalendar()
getEconomicCalendar(params: EconomicCalendarRequest): Promise<EconomicCalendarData[]>;Parameters
| Parameter | Type |
|---|---|
params | EconomicCalendarRequest |
Returns
Promise<EconomicCalendarData[]>
getEstimatedDeliveryExercisePrice()
getEstimatedDeliveryExercisePrice(params: object): Promise<EstimatedDeliveryExercisePrice[]>;Estimated delivery or exercise price (FUTURES / OPTION / EVENTS; REST returns one row with settlePx). The value is only meaningful shortly before delivery/exercise. The window used for the index mean is 30 minutes (since 2026-03-18; 200ms sampling).
Parameters
| Parameter | Type |
|---|---|
params | { instId: string; } |
params.instId | string |
Returns
Promise<EstimatedDeliveryExercisePrice[]>
getETHStakingBalance()
getETHStakingBalance(): Promise<any[]>;Returns
Promise<any[]>
getETHStakingHistory()
getETHStakingHistory(params: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | { after?: string; before?: string; limit?: string; status?: "failed" | "pending" | "success" | "cancelled"; type?: "redeem" | "purchase"; } |
params.after? | string |
params.before? | string |
params.limit? | string |
params.status? | "failed" | "pending" | "success" | "cancelled" |
params.type? | "redeem" | "purchase" |
Returns
Promise<any[]>
getETHStakingProductInfo()
getETHStakingProductInfo(): Promise<EthStakingProductInfo[]>;Financial product - ETH staking endpoints
Returns
Promise<EthStakingProductInfo[]>
getEventContractEvents()
getEventContractEvents(params: GetEventContractEventsRequest): Promise<EventContractEvent[]>;Events for a series. Public (no auth required since 2026-05-19).
Parameters
| Parameter | Type |
|---|---|
params | GetEventContractEventsRequest |
Returns
Promise<EventContractEvent[]>
See
GET /api/v5/public/event-contract/events
getEventContractMarkets()
getEventContractMarkets(params: GetEventContractMarketsRequest): Promise<EventContractMarket[]>;Markets for events. Public (no auth required since 2026-05-19).
Parameters
| Parameter | Type |
|---|---|
params | GetEventContractMarketsRequest |
Returns
Promise<EventContractMarket[]>
See
GET /api/v5/public/event-contract/markets
getEventContractSeries()
getEventContractSeries(params?: GetEventContractSeriesRequest): Promise<EventContractSeries[]>;Prediction / event contract series. Public (no auth required since 2026-05-19).
Parameters
| Parameter | Type |
|---|---|
params? | GetEventContractSeriesRequest |
Returns
Promise<EventContractSeries[]>
See
GET /api/v5/public/event-contract/series
getExchangeRate()
getExchangeRate(): Promise<any[]>;Returns
Promise<any[]>
getExchanges()
getExchanges(): Promise<any[]>;Returns
Promise<any[]>
getFeeRates()
getFeeRates(params: object): Promise<AccountFeeRate[]>;Parameters
| Parameter | Type |
|---|---|
params | { groupId?: string; instFamily?: string; instId?: string; instType: InstrumentType; ruleType?: string; uly?: string; } |
params.groupId? | string |
params.instFamily? | string |
params.instId? | string |
params.instType | InstrumentType |
params.ruleType? | string |
params.uly? | string |
Returns
Promise<AccountFeeRate[]>
getFills()
getFills(params?: FillsHistoryRequest): Promise<OrderFill[]>;Get filled transaction details from the last 3 days.
Parameters
| Parameter | Type |
|---|---|
params? | FillsHistoryRequest |
Returns
Promise<OrderFill[]>
See
getFillsHistory()
getFillsHistory(params: FillsHistoryRequest): Promise<OrderFill[]>;Get history for last 3 months
Parameters
| Parameter | Type |
|---|---|
params | FillsHistoryRequest |
Returns
Promise<OrderFill[]>
getFixedLoanBorrowLimit()
getFixedLoanBorrowLimit(): Promise<FixedLoanBorrowingLimit[]>;Returns
Promise<FixedLoanBorrowingLimit[]>
getFixedLoanBorrowOrders()
getFixedLoanBorrowOrders(params: GetFixedLoanBorrowingOrdersListRequest): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | GetFixedLoanBorrowingOrdersListRequest |
Returns
Promise<any[]>
getFixedLoanBorrowQuote()
getFixedLoanBorrowQuote(params: GetFixedLoanBorrowQuoteRequest): Promise<FixedLoanBorrowQuote[]>;Parameters
| Parameter | Type |
|---|---|
params | GetFixedLoanBorrowQuoteRequest |
Returns
Promise<FixedLoanBorrowQuote[]>
getFullOrderBook()
getFullOrderBook(params: object): Promise<OrderBook[]>;Parameters
| Parameter | Type |
|---|---|
params | { instId: string; sz?: string; } |
params.instId | string |
params.sz? | string |
Returns
Promise<OrderBook[]>
getFundingRate()
getFundingRate(params: GetFundingRateRequest): Promise<PublicFundingRate[]>;Parameters
| Parameter | Type |
|---|---|
params | GetFundingRateRequest |
Returns
Promise<PublicFundingRate[]>
getFundingRateHistory()
getFundingRateHistory(params: FundingRateRequest): Promise<FundingRateHistory[]>;Parameters
| Parameter | Type |
|---|---|
params | FundingRateRequest |
Returns
Promise<FundingRateHistory[]>
getFundsTransferState()
getFundsTransferState(params?: object): Promise<FundTransferState[]>;Either parameter transId or clientId is required.
Parameters
| Parameter | Type |
|---|---|
params? | { clientId?: string; transId?: string; type?: "0" | "1" | "2"; } |
params.clientId? | string |
params.transId? | string |
params.type? | "0" | "1" | "2" |
Returns
Promise<FundTransferState[]>
getGlpHistoricalPerformance()
getGlpHistoricalPerformance(params: GetGlpHistoricalPerformanceRequest): Promise<GlpHistoricalPerformanceItem[]>;Parameters
| Parameter | Type |
|---|---|
params | GetGlpHistoricalPerformanceRequest |
Returns
Promise<GlpHistoricalPerformanceItem[]>
getGlpTodayPerformance()
getGlpTodayPerformance(): Promise<GlpTodayPerformance[]>;GLP performance endpoints (market makers)
Returns
Promise<GlpTodayPerformance[]>
getGlpV2AssessmentDetails()
getGlpV2AssessmentDetails(params: GetGlpV2AssessmentDetailsRequest): Promise<GlpV2AssessmentDetails[]>;Daily and week-to-date performance for one GLP product and trading side in the current assessment period. A sub-account API key returns the master account's GLP data.
Parameters
| Parameter | Type |
|---|---|
params | GetGlpV2AssessmentDetailsRequest |
Returns
Promise<GlpV2AssessmentDetails[]>
See
GET /api/v5/users/glp/v2/details
getGlpV2Overview()
getGlpV2Overview(): Promise<GlpV2Overview[]>;Active GLP enrollments, current and estimated tiers, tier requirements, and week-to-date performance. A sub-account API key returns the master account's GLP data. No request parameters.
Returns
Promise<GlpV2Overview[]>
See
GET /api/v5/users/glp/v2/overview
getGlpV2PerformanceHistory()
getGlpV2PerformanceHistory(params: GetGlpV2PerformanceHistoryRequest): Promise<GlpV2PerformanceHistory[]>;Weekly assessment results, tier outcomes, and performance for one GLP product and trading side. A sub-account API key returns the master account's GLP data.
Parameters
| Parameter | Type |
|---|---|
params | GetGlpV2PerformanceHistoryRequest |
Returns
Promise<GlpV2PerformanceHistory[]>
See
GET /api/v5/users/glp/v2/history/performance
getGreeks()
getGreeks(params?: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params? | { ccy?: string; } |
params.ccy? | string |
Returns
Promise<any[]>
getGridAIParameter()
getGridAIParameter(params: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | { algoOrdType: GridAlgoOrderType; direction: ContractGridDirection; duration?: "30D" | "7D" | "180D"; instId: string; } |
params.algoOrdType | GridAlgoOrderType |
params.direction | ContractGridDirection |
params.duration? | "30D" | "7D" | "180D" |
params.instId | string |
Returns
Promise<any[]>
getGridAlgoOrderDetails()
getGridAlgoOrderDetails(params: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | { algoId: string; algoOrdType: GridAlgoOrderType; } |
params.algoId | string |
params.algoOrdType | GridAlgoOrderType |
Returns
Promise<any[]>
getGridAlgoOrderHistory()
getGridAlgoOrderHistory(params: GetGridAlgoOrdersRequest): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | GetGridAlgoOrdersRequest |
Returns
Promise<any[]>
getGridAlgoOrderList()
getGridAlgoOrderList(params: GetGridAlgoOrdersRequest): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | GetGridAlgoOrdersRequest |
Returns
Promise<any[]>
getGridAlgoOrderPositions()
getGridAlgoOrderPositions(params: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | { algoId: string; algoOrdType: "contract_grid"; } |
params.algoId | string |
params.algoOrdType | "contract_grid" |
Returns
Promise<any[]>
getGridAlgoSubOrders()
getGridAlgoSubOrders(params: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | { after?: string; algoId: string; algoOrdType: GridAlgoOrderType; before?: string; groupId?: string; limit?: number; type: GridAlgoSubOrderType; } |
params.after? | string |
params.algoId | string |
params.algoOrdType | GridAlgoOrderType |
params.before? | string |
params.groupId? | string |
params.limit? | number |
params.type | GridAlgoSubOrderType |
Returns
Promise<any[]>
getHistoricalMarketData()
getHistoricalMarketData(params: GetHistoricalMarketDataRequest): Promise<MarketDataHistoryResult[]>;Parameters
| Parameter | Type |
|---|---|
params | GetHistoricalMarketDataRequest |
Returns
Promise<MarketDataHistoryResult[]>
getHistoricCandles()
getHistoricCandles(params: CandleRequest): Promise<Candle[]>;Parameters
| Parameter | Type |
|---|---|
params | CandleRequest |
Returns
Promise<Candle[]>
getHistoricIndexCandles()
getHistoricIndexCandles(params: CandleRequest): Promise<CandleNoVolume[]>;Parameters
| Parameter | Type |
|---|---|
params | CandleRequest |
Returns
Promise<CandleNoVolume[]>
getHistoricMarkPriceCandles()
getHistoricMarkPriceCandles(params: CandleRequest): Promise<CandleNoVolume[]>;Parameters
| Parameter | Type |
|---|---|
params | CandleRequest |
Returns
Promise<CandleNoVolume[]>
getHistoricTrades()
getHistoricTrades(params: object): Promise<Trade[]>;Parameters
| Parameter | Type |
|---|---|
params | { after?: string; before?: string; instId: string; limit?: string; type?: "1" | "2"; } |
params.after? | string |
params.before? | string |
params.instId | string |
params.limit? | string |
params.type? | "1" | "2" |
Returns
Promise<Trade[]>
getIndexCandles()
getIndexCandles(params: CandleRequest): Promise<CandleNoVolume[]>;Parameters
| Parameter | Type |
|---|---|
params | CandleRequest |
Returns
Promise<CandleNoVolume[]>
getIndexComponents()
getIndexComponents(params: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | { index: string; } |
params.index | string |
Returns
Promise<any[]>
getIndexTickers()
getIndexTickers(params?: object): Promise<IndexTicker[]>;Parameters
| Parameter | Type |
|---|---|
params? | { instId?: string; quoteCcy?: string; } |
params.instId? | string |
params.quoteCcy? | string |
Returns
Promise<IndexTicker[]>
getInstruments()
getInstruments(params: GetInstrumentsRequest): Promise<Instrument[]>;Public data - rest endpoints
Parameters
| Parameter | Type |
|---|---|
params | GetInstrumentsRequest |
Returns
Promise<Instrument[]>
getInsuranceFund()
getInsuranceFund(params?: GetInsuranceFundRequest): Promise<InsuranceFund[]>;Parameters
| Parameter | Type |
|---|---|
params? | GetInsuranceFundRequest |
Returns
Promise<InsuranceFund[]>
getInterestAccrued()
getInterestAccrued(params?: object): Promise<InterestAccrued[]>;Parameters
| Parameter | Type |
|---|---|
params? | { after?: string; before?: string; ccy?: string; instId?: string; limit?: string; mgnMode?: MarginMode; type?: "1" | "2"; } |
params.after? | string |
params.before? | string |
params.ccy? | string |
params.instId? | string |
params.limit? | string |
params.mgnMode? | MarginMode |
params.type? | "1" | "2" |
Returns
Promise<InterestAccrued[]>
getInterestRate()
getInterestRate(params?: object): Promise<InterestRate[]>;Parameters
| Parameter | Type |
|---|---|
params? | { ccy?: string; } |
params.ccy? | string |
Returns
Promise<InterestRate[]>
getInterestRateAndLoanQuota()
getInterestRateAndLoanQuota(): Promise<InterestRateAndLoanQuota[]>;Returns
Promise<InterestRateAndLoanQuota[]>
getLendingAPYHistory()
getLendingAPYHistory(params: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | { ccy: string; term: string; } |
params.ccy | string |
params.term | string |
Returns
Promise<any[]>
getLendingHistory()
getLendingHistory(params?: PaginatedSymbolRequest): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params? | PaginatedSymbolRequest |
Returns
Promise<any[]>
getLendingOffers()
getLendingOffers(params?: object): Promise<any[]>;Financial product - simple earn fixed endpoints
Parameters
| Parameter | Type |
|---|---|
params? | { ccy?: string; term?: string; } |
params.ccy? | string |
params.term? | string |
Returns
Promise<any[]>
getLendingOrders()
getLendingOrders(params: GetLendingOrderListRequest): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | GetLendingOrderListRequest |
Returns
Promise<any[]>
getLendingSubOrders()
getLendingSubOrders(params: GetLendingSubOrderListRequest): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | GetLendingSubOrderListRequest |
Returns
Promise<any[]>
getLendingVolume()
getLendingVolume(params: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | { ccy: string; term: string; } |
params.ccy | string |
params.term | string |
Returns
Promise<any[]>
getLeverage()
getLeverage(params: object): Promise<AccountLeverage[]>;Parameters
| Parameter | Type |
|---|---|
params | { ccy?: string; instId?: string; mgnMode: MarginMode; } |
params.ccy? | string |
params.instId? | string |
params.mgnMode | MarginMode |
Returns
Promise<AccountLeverage[]>
getLeverageEstimatedInfo()
getLeverageEstimatedInfo(params: object): Promise<AdjustLeverageInfo[]>;Parameters
| Parameter | Type |
|---|---|
params | { ccy?: string; instId?: string; instType: string; lever: string; mgnMode: MarginMode; posSide: PositionSide; } |
params.ccy? | string |
params.instId? | string |
params.instType | string |
params.lever | string |
params.mgnMode | MarginMode |
params.posSide | PositionSide |
Returns
Promise<AdjustLeverageInfo[]>
getLeverageV2()
getLeverageV2(params: object): Promise<AccountLeverage[]>;Parameters
| Parameter | Type |
|---|---|
params | { ccy?: string; instId?: string; mgnMode: MarginMode; } |
params.ccy? | string |
params.instId? | string |
params.mgnMode | MarginMode |
Returns
Promise<AccountLeverage[]>
Deprecated
Use getLeverage() instead. Both methods call the same leverage-info endpoint in SDK 3.2.9.
getLightningDeposits()
getLightningDeposits(params: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | { amt: string; ccy: string; to?: "6" | "18"; } |
params.amt | string |
params.ccy | string |
params.to? | "6" | "18" |
Returns
Promise<any[]>
getLoanHistory()
getLoanHistory(params?: LoanHistoryRequest): Promise<LoanHistoryItem[]>;Parameters
| Parameter | Type |
|---|---|
params? | LoanHistoryRequest |
Returns
Promise<LoanHistoryItem[]>
getLoanInfo()
getLoanInfo(params?: GetLoanInfoRequest): Promise<LoanInfo[]>;Parameters
| Parameter | Type |
|---|---|
params? | GetLoanInfoRequest |
Returns
Promise<LoanInfo[]>
getLongShortContractRatio()
getLongShortContractRatio(params: GetTopTradersContractLongShortRatioRequest): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | GetTopTradersContractLongShortRatioRequest |
Returns
Promise<any[]>
getLongShortRatio()
getLongShortRatio(params: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | { begin?: string; ccy: string; end?: string; period: "5m" | "1H" | "1D"; } |
params.begin? | string |
params.ccy | string |
params.end? | string |
params.period | "5m" | "1H" | "1D" |
Returns
Promise<any[]>
getManagedSubAccountTransferHistory()
getManagedSubAccountTransferHistory(params: GetManagedSubAccountTransferHistoryRequest): Promise<ManagedSubAccountTransfer[]>;Parameters
| Parameter | Type |
|---|---|
params | GetManagedSubAccountTransferHistoryRequest |
Returns
Promise<ManagedSubAccountTransfer[]>
getMarginLendingRatio()
getMarginLendingRatio(params: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | { begin?: string; ccy: string; end?: string; period: "5m" | "1H" | "1D"; } |
params.begin? | string |
params.ccy | string |
params.end? | string |
params.period | "5m" | "1H" | "1D" |
Returns
Promise<any[]>
getMarkPrice()
getMarkPrice(params: any): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | any |
Returns
Promise<any[]>
getMarkPriceCandles()
getMarkPriceCandles(params: CandleRequest): Promise<CandleNoVolume[]>;Parameters
| Parameter | Type |
|---|---|
params | CandleRequest |
Returns
Promise<CandleNoVolume[]>
getMaxAvailableTradableAmount()
getMaxAvailableTradableAmount(params: object): Promise<AccountMaxTradableAmount[]>;Parameters
| Parameter | Type |
|---|---|
params | { ccy?: string; instId: string; reduceOnly?: boolean; tdMode: "cross" | "isolated" | "cash"; unSpotOffset?: boolean; } |
params.ccy? | string |
params.instId | string |
params.reduceOnly? | boolean |
params.tdMode | "cross" | "isolated" | "cash" |
params.unSpotOffset? | boolean |
Returns
Promise<AccountMaxTradableAmount[]>
getMaxBuySellAmount()
getMaxBuySellAmount(params: object): Promise<AccountMaxOrderAmount[]>;Max buy/sell amount or open amount
Parameters
| Parameter | Type | Description |
|---|---|---|
params | { ccy?: string; instId: string; leverage?: string; outcome?: string; px?: string; tdMode: "cross" | "isolated" | "cash"; unSpotOffset?: boolean; } | - |
params.ccy? | string | - |
params.instId | string | - |
params.leverage? | string | - |
params.outcome? | string | Market outcome for EVENTS: yes or no. Optional; defaults to yes. |
params.px? | string | - |
params.tdMode | "cross" | "isolated" | "cash" | - |
params.unSpotOffset? | boolean | - |
Returns
Promise<AccountMaxOrderAmount[]>
getMaxGridQuantity()
getMaxGridQuantity(params: MaxGridQuantityRequest): Promise<object[]>;Parameters
| Parameter | Type |
|---|---|
params | MaxGridQuantityRequest |
Returns
Promise<object[]>
getMaxLoan()
getMaxLoan(params: object): Promise<AccountMaxLoan[]>;Parameters
| Parameter | Type |
|---|---|
params | { ccy?: string; instId: string; mgnCcy?: string; mgnMode: MarginMode; } |
params.ccy? | string |
params.instId | string |
params.mgnCcy? | string |
params.mgnMode | MarginMode |
Returns
Promise<AccountMaxLoan[]>
getMaxLoanAmount()
getMaxLoanAmount(params: MaxLoanRequest): Promise<MaxLoanResponse[]>;Parameters
| Parameter | Type |
|---|---|
params | MaxLoanRequest |
Returns
Promise<MaxLoanResponse[]>
getMaxWithdrawals()
getMaxWithdrawals(params?: object): Promise<MaxWithdrawal[]>;Parameters
| Parameter | Type |
|---|---|
params? | { ccy?: string; } |
params.ccy? | string |
Returns
Promise<MaxWithdrawal[]>
getMinMaxLimitPrice()
getMinMaxLimitPrice(params: any): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | any |
Returns
Promise<any[]>
getMmInstrumentTypes()
getMmInstrumentTypes(params?: object): Promise<MmInstrumentType[]>;Parameters
| Parameter | Type |
|---|---|
params? | { instId?: string; instType?: "SPOT" | "SWAP"; } |
params.instId? | string |
params.instType? | "SPOT" | "SWAP" |
Returns
Promise<MmInstrumentType[]>
getMMPConfig()
getMMPConfig(params?: object): Promise<MMPConfig[]>;Parameters
| Parameter | Type |
|---|---|
params? | { instFamily?: string; } |
params.instFamily? | string |
Returns
Promise<MMPConfig[]>
getMonthlyStatement()
getMonthlyStatement(params: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | { month: string; } |
params.month | string |
Returns
Promise<any[]>
getMovePositionsHistory()
getMovePositionsHistory(params?: GetMovePositionsHistoryRequest): Promise<MovePositionsResult[]>;Move position history for the last 3 days (VIP6+).
Parameters
| Parameter | Type |
|---|---|
params? | GetMovePositionsHistoryRequest |
Returns
Promise<MovePositionsResult[]>
See
GET /api/v5/account/move-positions-history
getNonTradableAssets()
getNonTradableAssets(params?: object): Promise<NonTradableAsset[]>;Parameters
| Parameter | Type |
|---|---|
params? | { ccy?: string; } |
params.ccy? | string |
Returns
Promise<NonTradableAsset[]>
getOkusdLimits()
getOkusdLimits(): Promise<OkusdLimits[]>;Financial product — OKUSD endpoints
Returns
Promise<OkusdLimits[]>
getOneClickRepayCurrencyList()
getOneClickRepayCurrencyList(params?: object): Promise<APIResponse<any>>;Get one-click repay currency list : Get list of debt currency data and repay currencies. Debt currencies include both cross and isolated debts.
Parameters
| Parameter | Type |
|---|---|
params? | { debtType?: "cross" | "isolated"; } |
params.debtType? | "cross" | "isolated" |
Returns
Promise<APIResponse<any>>
getOneClickRepayHistory()
getOneClickRepayHistory(params?: Pagination): Promise<APIResponse<any>>;Get the history and status of one-click repay trades.
Parameters
| Parameter | Type |
|---|---|
params? | Pagination |
Returns
Promise<APIResponse<any>>
getOpenInterest()
getOpenInterest(params: any): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | any |
Returns
Promise<any[]>
getOpenInterestAndVolumeExpiry()
getOpenInterestAndVolumeExpiry(params: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | { ccy: string; period: "1D" | "8H"; } |
params.ccy | string |
params.period | "1D" | "8H" |
Returns
Promise<any[]>
getOpenInterestAndVolumeStrike()
getOpenInterestAndVolumeStrike(params: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | { ccy: string; expTime: string; period?: "1D" | "8H"; } |
params.ccy | string |
params.expTime | string |
params.period? | "1D" | "8H" |
Returns
Promise<any[]>
getOpenInterestHistory()
getOpenInterestHistory(params: GetContractOpenInterestHistoryRequest): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | GetContractOpenInterestHistoryRequest |
Returns
Promise<any[]>
getOptionMarketData()
getOptionMarketData(params: any): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | any |
Returns
Promise<any[]>
getOptionsOpenInterestAndVolume()
getOptionsOpenInterestAndVolume(params: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | { ccy: string; period: "1D" | "8H"; } |
params.ccy | string |
params.period | "1D" | "8H" |
Returns
Promise<any[]>
getOptionTickBands()
getOptionTickBands(params: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | { instFamily?: string; instType: string; } |
params.instFamily? | string |
params.instType | string |
Returns
Promise<any[]>
getOptionTrades()
getOptionTrades(params: GetOptionTradesRequest): Promise<OptionTrades[]>;Parameters
| Parameter | Type |
|---|---|
params | GetOptionTradesRequest |
Returns
Promise<OptionTrades[]>
getOptionTradesByInstrument()
getOptionTradesByInstrument(params: object): Promise<OptionTrade[]>;Parameters
| Parameter | Type |
|---|---|
params | { instFamily: string; } |
params.instFamily | string |
Returns
Promise<OptionTrade[]>
getOracle()
getOracle(): Promise<any[]>;Returns
Promise<any[]>
getOrderBook()
getOrderBook(params: object): Promise<OrderBook[]>;Parameters
| Parameter | Type |
|---|---|
params | { instId: string; sz?: string; } |
params.instId | string |
params.sz? | string |
Returns
Promise<OrderBook[]>
See
getOrderDetails()
getOrderDetails(params: OrderIdRequest): Promise<OrderDetails[]>;Parameters
| Parameter | Type |
|---|---|
params | OrderIdRequest |
Returns
Promise<OrderDetails[]>
See
getOrderHistory()
getOrderHistory(params: OrderHistoryRequest): Promise<HistoricOrder[]>;Get history for last 7 days
Parameters
| Parameter | Type |
|---|---|
params | OrderHistoryRequest |
Returns
Promise<HistoricOrder[]>
See
getOrderHistoryArchive()
getOrderHistoryArchive(params: OrderHistoryRequest): Promise<HistoricOrder[]>;Get history for last 3 months
Parameters
| Parameter | Type |
|---|---|
params | OrderHistoryRequest |
Returns
Promise<HistoricOrder[]>
getOrderList()
getOrderList(params?: OrderHistoryRequest): Promise<OrderListItem[]>;Parameters
| Parameter | Type |
|---|---|
params? | OrderHistoryRequest |
Returns
Promise<OrderListItem[]>
See
getPMLimitation()
getPMLimitation(params: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | { instFamily?: string; instType: "SWAP" | "FUTURES" | "OPTION"; uly?: string; } |
params.instFamily? | string |
params.instType | "SWAP" | "FUTURES" | "OPTION" |
params.uly? | string |
Returns
Promise<any[]>
getPositions()
getPositions(params?: GetPositionsParams): Promise<AccountPosition[]>;Parameters
| Parameter | Type |
|---|---|
params? | GetPositionsParams |
Returns
Promise<AccountPosition[]>
getPositionsHistory()
getPositionsHistory(params?: GetHistoricPositionParams): Promise<HistoricAccountPosition[]>;Parameters
| Parameter | Type |
|---|---|
params? | GetHistoricPositionParams |
Returns
Promise<HistoricAccountPosition[]>
getPositionTiers()
getPositionTiers(params: any): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | any |
Returns
Promise<any[]>
getPremiumHistory()
getPremiumHistory(params: GetPremiumHistoryRequest): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | GetPremiumHistoryRequest |
Returns
Promise<any[]>
getPrivate()
getPrivate(endpoint: string, params?: any): Promise<any>;Parameters
| Parameter | Type |
|---|---|
endpoint | string |
params? | any |
Returns
Promise<any>
Inherited from
BaseRestClient.getPrivate
getPublicBlockTrades()
getPublicBlockTrades(params: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | { instId: string; } |
params.instId | string |
Returns
Promise<any[]>
getPublicBorrowHistory()
getPublicBorrowHistory(params?: PaginatedSymbolRequest): Promise<PublicBorrowHistoryRecord[]>;Parameters
| Parameter | Type |
|---|---|
params? | PaginatedSymbolRequest |
Returns
Promise<PublicBorrowHistoryRecord[]>
getPublicBorrowInfo()
getPublicBorrowInfo(params?: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params? | { ccy?: string; } |
params.ccy? | string |
Returns
Promise<any[]>
getPublicRFQBlockTrades()
getPublicRFQBlockTrades(params?: any): Promise<PublicBlockTrade[]>;Parameters
| Parameter | Type |
|---|---|
params? | any |
Returns
Promise<PublicBlockTrade[]>
getPutCallRatio()
getPutCallRatio(params: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | { ccy: string; period: "1D" | "8H"; } |
params.ccy | string |
params.period | "1D" | "8H" |
Returns
Promise<any[]>
getQuickMarginBorrowRepayHistory()
getQuickMarginBorrowRepayHistory(params: GetQuickMarginBorrowRepayHistoryRequest): Promise<QuickMarginBorrowRepayRecord[]>;Parameters
| Parameter | Type |
|---|---|
params | GetQuickMarginBorrowRepayHistoryRequest |
Returns
Promise<QuickMarginBorrowRepayRecord[]>
getQuoteProducts()
getQuoteProducts(): Promise<BlockMakerInstrumentSettings[]>;Returns
Promise<BlockMakerInstrumentSettings[]>
getRecurringBuyOrderDetails()
getRecurringBuyOrderDetails(params: object): Promise<RecurringBuyOrder[]>;Parameters
| Parameter | Type |
|---|---|
params | { algoId: string; } |
params.algoId | string |
Returns
Promise<RecurringBuyOrder[]>
getRecurringBuyOrderHistory()
getRecurringBuyOrderHistory(params: GetRecurringBuyOrderListRequest): Promise<RecurringBuyOrder[]>;Parameters
| Parameter | Type |
|---|---|
params | GetRecurringBuyOrderListRequest |
Returns
Promise<RecurringBuyOrder[]>
getRecurringBuyOrders()
getRecurringBuyOrders(params: GetRecurringBuyOrderListRequest): Promise<RecurringBuyOrder[]>;Parameters
| Parameter | Type |
|---|---|
params | GetRecurringBuyOrderListRequest |
Returns
Promise<RecurringBuyOrder[]>
getRecurringBuySubOrders()
getRecurringBuySubOrders(params: GetRecurringBuyOrderListRequest): Promise<RecurringBuySubOrder[]>;Parameters
| Parameter | Type |
|---|---|
params | GetRecurringBuyOrderListRequest |
Returns
Promise<RecurringBuySubOrder[]>
getRequestedBillsHistoryLink()
getRequestedBillsHistoryLink(params: BillsHistoryArchiveRequest): Promise<AccountHistoryBill[]>;This endpoint returns the link to the bill data which you can request using requestBillsHistoryDownloadLink.
Parameters
| Parameter | Type |
|---|---|
params | BillsHistoryArchiveRequest |
Returns
Promise<AccountHistoryBill[]>
getRpiOrderBook()
getRpiOrderBook(params: object): Promise<OrderBookRpi[]>;Parameters
| Parameter | Type |
|---|---|
params | { instId: string; sz?: string; } |
params.instId | string |
params.sz? | string |
Returns
Promise<OrderBookRpi[]>
getRSIBackTesting()
getRSIBackTesting(params: GetRSIBackTestingRequest): Promise<object[]>;Parameters
| Parameter | Type |
|---|---|
params | GetRSIBackTestingRequest |
Returns
Promise<object[]>
getSavingBalance()
getSavingBalance(params?: object): Promise<any[]>;Financial product - simple earn flexible endpoints
Parameters
| Parameter | Type |
|---|---|
params? | { ccy?: string; } |
params.ccy? | string |
Returns
Promise<any[]>
getServerTime()
getServerTime(): Promise<number>;OKX misc endpoints
Returns
Promise<number>
getSignalBotEventHistory()
getSignalBotEventHistory(params: GetSignalBotEventHistoryRequest): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | GetSignalBotEventHistoryRequest |
Returns
Promise<any[]>
getSignalBotHistory()
getSignalBotHistory(params: GetSignalBotRequest): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | GetSignalBotRequest |
Returns
Promise<any[]>
getSignalBotOrder()
getSignalBotOrder(params: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | { algoId: string; algoOrdType: string; } |
params.algoId | string |
params.algoOrdType | string |
Returns
Promise<any[]>
getSignalBotPositionHistory()
getSignalBotPositionHistory(params: GetSignalBotPositionHistoryRequest): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | GetSignalBotPositionHistoryRequest |
Returns
Promise<any[]>
getSignalBotPositions()
getSignalBotPositions(params: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | { algoId: string; algoOrdType: string; } |
params.algoId | string |
params.algoOrdType | string |
Returns
Promise<any[]>
getSignalBotSubOrders()
getSignalBotSubOrders(params: GetSignalBotSubOrdersRequest): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | GetSignalBotSubOrdersRequest |
Returns
Promise<any[]>
getSignals()
getSignals(params: GetSignalsRequest): Promise<GetSignalsResult[]>;Parameters
| Parameter | Type |
|---|---|
params | GetSignalsRequest |
Returns
Promise<GetSignalsResult[]>
getSOLStakingProductInfo()
getSOLStakingProductInfo(): Promise<SolStakingProductInfo>;Returns
Promise<SolStakingProductInfo>
getSpreadActiveOrders()
getSpreadActiveOrders(params?: GetActiveSpreadOrdersRequest): Promise<SpreadOrder[]>;Parameters
| Parameter | Type |
|---|---|
params? | GetActiveSpreadOrdersRequest |
Returns
Promise<SpreadOrder[]>
getSpreadCandles()
getSpreadCandles(params: GetSpreadCandlesRequest): Promise<SpreadCandle[]>;Parameters
| Parameter | Type |
|---|---|
params | GetSpreadCandlesRequest |
Returns
Promise<SpreadCandle[]>
getSpreadHistoryCandles()
getSpreadHistoryCandles(params: GetSpreadCandlesRequest): Promise<SpreadCandle[]>;Parameters
| Parameter | Type |
|---|---|
params | GetSpreadCandlesRequest |
Returns
Promise<SpreadCandle[]>
getSpreadOrder()
getSpreadOrder(params: object): Promise<SpreadOrder[]>;Parameters
| Parameter | Type |
|---|---|
params | { clOrdId?: string; ordId?: string; } |
params.clOrdId? | string |
params.ordId? | string |
Returns
Promise<SpreadOrder[]>
getSpreadOrderBook()
getSpreadOrderBook(params: object): Promise<SpreadOrderBook[]>;Parameters
| Parameter | Type |
|---|---|
params | { sprdId: string; sz?: string; } |
params.sprdId | string |
params.sz? | string |
Returns
Promise<SpreadOrderBook[]>
getSpreadOrdersArchive()
getSpreadOrdersArchive(params?: GetSpreadOrderHistoryArchiveRequest): Promise<SpreadOrder[]>;Parameters
| Parameter | Type |
|---|---|
params? | GetSpreadOrderHistoryArchiveRequest |
Returns
Promise<SpreadOrder[]>
getSpreadOrdersRecent()
getSpreadOrdersRecent(params?: GetSpreadOrderHistoryRequest): Promise<SpreadOrder[]>;Parameters
| Parameter | Type |
|---|---|
params? | GetSpreadOrderHistoryRequest |
Returns
Promise<SpreadOrder[]>
getSpreadPublicTrades()
getSpreadPublicTrades(params?: object): Promise<PublicSpreadTrade[]>;Parameters
| Parameter | Type |
|---|---|
params? | { sprdId?: string; } |
params.sprdId? | string |
Returns
Promise<PublicSpreadTrade[]>
getSpreads()
getSpreads(params?: GetSpreadsRequest): Promise<SpreadDetails[]>;Parameters
| Parameter | Type |
|---|---|
params? | GetSpreadsRequest |
Returns
Promise<SpreadDetails[]>
getSpreadTicker()
getSpreadTicker(params: object): Promise<SpreadTicker[]>;Parameters
| Parameter | Type |
|---|---|
params | { sprdId: string; } |
params.sprdId | string |
Returns
Promise<SpreadTicker[]>
getSpreadTrades()
getSpreadTrades(params?: GetSpreadTradesRequest): Promise<SpreadTrade[]>;Parameters
| Parameter | Type |
|---|---|
params? | GetSpreadTradesRequest |
Returns
Promise<SpreadTrade[]>
getStableRewardsApyHistory()
getStableRewardsApyHistory(params: GetStableRewardsApyHistoryRequest): Promise<StableRewardsApyHistoryItem[]>;Parameters
| Parameter | Type |
|---|---|
params | GetStableRewardsApyHistoryRequest |
Returns
Promise<StableRewardsApyHistoryItem[]>
getStableRewardsBalance()
getStableRewardsBalance(params?: GetStableRewardsBalanceRequest): Promise<StableRewardsBalance[]>;Parameters
| Parameter | Type |
|---|---|
params? | GetStableRewardsBalanceRequest |
Returns
Promise<StableRewardsBalance[]>
getStableRewardsProductInfo()
getStableRewardsProductInfo(params: GetStableRewardsProductInfoRequest): Promise<StableRewardsProductInfo[]>;Financial product — stable rewards endpoints
Parameters
| Parameter | Type |
|---|---|
params | GetStableRewardsProductInfoRequest |
Returns
Promise<StableRewardsProductInfo[]>
See
https://www.okx.com/docs-v5/en/ (2026-04-24 release)
getStableRewardsSubscribeRedeemHistory()
getStableRewardsSubscribeRedeemHistory(params: GetStableRewardsSubscribeRedeemHistoryRequest): Promise<StableRewardsSubscribeRedeemHistoryItem[]>;Parameters
| Parameter | Type |
|---|---|
params | GetStableRewardsSubscribeRedeemHistoryRequest |
Returns
Promise<StableRewardsSubscribeRedeemHistoryItem[]>
Deprecated
Decommissioned 2026-07-14. Use order book trading APIs.
getStakingOffers()
getStakingOffers(params?: object): Promise<any[]>;Get earn offers
Parameters
| Parameter | Type |
|---|---|
params? | { ccy?: string; productId?: string; protocolType?: "staking" | "defi"; } |
params.ccy? | string |
params.productId? | string |
params.protocolType? | "staking" | "defi" |
Returns
Promise<any[]>
getStakingOrderHistory()
getStakingOrderHistory(params?: object): Promise<any[]>;Earn/staking get order history
Parameters
| Parameter | Type |
|---|---|
params? | { after?: string; before?: string; ccy?: string; limit?: string; productId?: string; protocolType?: string; } |
params.after? | string |
params.before? | string |
params.ccy? | string |
params.limit? | string |
params.productId? | string |
params.protocolType? | string |
Returns
Promise<any[]>
getSubAccountBalances()
getSubAccountBalances(params: object): Promise<SubAccountBalances[]>;Parameters
| Parameter | Type |
|---|---|
params | { subAcct: string; } |
params.subAcct | string |
Returns
Promise<SubAccountBalances[]>
getSubAccountBorrowInterestAndLimit()
getSubAccountBorrowInterestAndLimit(params: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | { ccy?: string; subAcct: string; } |
params.ccy? | string |
params.subAcct | string |
Returns
Promise<any[]>
getSubAccountCustodyTradingList()
getSubAccountCustodyTradingList(params?: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params? | { subAcct?: string; } |
params.subAcct? | string |
Returns
Promise<any[]>
getSubAccountFundingBalances()
getSubAccountFundingBalances(params: object): Promise<FundingBalance[]>;Parameters
| Parameter | Type |
|---|---|
params | { ccy?: string; subAcct: string; } |
params.ccy? | string |
params.subAcct | string |
Returns
Promise<FundingBalance[]>
getSubAccountList()
getSubAccountList(params?: any): Promise<SubAccount[]>;View sub-account list
Parameters
| Parameter | Type |
|---|---|
params? | any |
Returns
Promise<SubAccount[]>
getSubAccountMaxWithdrawal()
getSubAccountMaxWithdrawal(params: GetSubAccountMaxWithdrawalsRequest): Promise<SubAccountMaxWithdrawal[]>;Parameters
| Parameter | Type |
|---|---|
params | GetSubAccountMaxWithdrawalsRequest |
Returns
Promise<SubAccountMaxWithdrawal[]>
getSubAccountTransferHistory()
getSubAccountTransferHistory(params?: object): Promise<any[]>;History of sub-account transfer
Parameters
| Parameter | Type |
|---|---|
params? | { after?: string; before?: string; ccy?: string; limit?: string; subAcct?: string; type?: "0" | "1"; } |
params.after? | string |
params.before? | string |
params.ccy? | string |
params.limit? | string |
params.subAcct? | string |
params.type? | "0" | "1" |
Returns
Promise<any[]>
getSupportCoin()
getSupportCoin(): Promise<any[]>;Trading statistics - REST endpoints
Returns
Promise<any[]>
getSystemStatus()
getSystemStatus(params: object): Promise<any[]>;Status endpoints (public)
Parameters
| Parameter | Type |
|---|---|
params | { state?: "completed" | "canceled" | "ongoing" | "scheduled" | "pre_open"; } |
params.state? | "completed" | "canceled" | "ongoing" | "scheduled" | "pre_open" |
Returns
Promise<any[]>
getSystemTime()
getSystemTime(params: any): Promise<SystemTime[]>;Parameters
| Parameter | Type |
|---|---|
params | any |
Returns
Promise<SystemTime[]>
getTakerFlow()
getTakerFlow(params: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | { ccy: string; period: "1D" | "8H"; } |
params.ccy | string |
params.period | "1D" | "8H" |
Returns
Promise<any[]>
getTakerVolume()
getTakerVolume(params: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | { begin?: string; ccy: string; end?: string; instType: string; period?: string; } |
params.begin? | string |
params.ccy | string |
params.end? | string |
params.instType | string |
params.period? | string |
Returns
Promise<any[]>
getTicker()
getTicker(params: object): Promise<Ticker[]>;Parameters
| Parameter | Type |
|---|---|
params | { instId: string; } |
params.instId | string |
Returns
Promise<Ticker[]>
See
getTickers()
getTickers(params: object): Promise<Ticker[]>;Orderbook trading - Market data endpoints
Parameters
| Parameter | Type |
|---|---|
params | { instFamily?: string; instType: InstrumentType; uly?: string; } |
params.instFamily? | string |
params.instType | InstrumentType |
params.uly? | string |
Returns
Promise<Ticker[]>
getTopTradersAccountRatio()
getTopTradersAccountRatio(params: GetTopTradersContractLongShortRatioRequest): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | GetTopTradersContractLongShortRatioRequest |
Returns
Promise<any[]>
getTopTradersContractPositionRatio()
getTopTradersContractPositionRatio(params: GetTopTradersContractLongShortRatioRequest): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | GetTopTradersContractLongShortRatioRequest |
Returns
Promise<any[]>
getTrades()
getTrades(params: object): Promise<Trade[]>;Parameters
| Parameter | Type |
|---|---|
params | { instId: string; limit?: number; } |
params.instId | string |
params.limit? | number |
Returns
Promise<Trade[]>
getUnderlying()
getUnderlying(params: any): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | any |
Returns
Promise<any[]>
getUnitConvert()
getUnitConvert(params: UnitConvertRequest): Promise<UnitConvertData[]>;Parameters
| Parameter | Type |
|---|---|
params | UnitConvertRequest |
Returns
Promise<UnitConvertData[]>
getVIPInterestAccrued()
getVIPInterestAccrued(params: GetVIPInterestRequest): Promise<VIPInterest[]>;Parameters
| Parameter | Type |
|---|---|
params | GetVIPInterestRequest |
Returns
Promise<VIPInterest[]>
getVIPInterestDeducted()
getVIPInterestDeducted(params: GetVIPInterestRequest): Promise<VIPInterest[]>;Parameters
| Parameter | Type |
|---|---|
params | GetVIPInterestRequest |
Returns
Promise<VIPInterest[]>
getVIPInterestRateAndLoanQuota()
getVIPInterestRateAndLoanQuota(params: any): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | any |
Returns
Promise<any[]>
getVIPLoanBorrowRepayHistory()
getVIPLoanBorrowRepayHistory(params?: any): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params? | any |
Returns
Promise<any[]>
getVIPLoanOrder()
getVIPLoanOrder(params: GetVIPLoanOrderDetailRequest): Promise<VIPLoanOrderDetail[]>;Parameters
| Parameter | Type |
|---|---|
params | GetVIPLoanOrderDetailRequest |
Returns
Promise<VIPLoanOrderDetail[]>
getVIPLoanOrders()
getVIPLoanOrders(params: GetVIPLoanOrderListRequest): Promise<VIPLoanOrder[]>;Parameters
| Parameter | Type |
|---|---|
params | GetVIPLoanOrderListRequest |
Returns
Promise<VIPLoanOrder[]>
getWithdrawalHistory()
getWithdrawalHistory(params?: WithdrawalHistoryRequest): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params? | WithdrawalHistoryRequest |
Returns
Promise<any[]>
instantTriggerGridAlgoOrder()
instantTriggerGridAlgoOrder(params: object): Promise<object[]>;Parameters
| Parameter | Type |
|---|---|
params | { algoId: string; } |
params.algoId | string |
Returns
Promise<object[]>
manualBorrowRepay()
manualBorrowRepay(params: object): Promise<object[]>;Parameters
| Parameter | Type |
|---|---|
params | { amt: string; ccy: string; side: "borrow" | "repay"; } |
params.amt | string |
params.ccy | string |
params.side | "borrow" | "repay" |
Returns
Promise<object[]>
manualRenewFixedLoanBorrowOrder()
manualRenewFixedLoanBorrowOrder(params: object): Promise<object[]>;Parameters
| Parameter | Type |
|---|---|
params | { maxRate: string; ordId: string; } |
params.maxRate | string |
params.ordId | string |
Returns
Promise<object[]>
movePositions()
movePositions(params: MovePositionsRequest): Promise<MovePositionsResult[]>;Move positions between accounts under the same master account (VIP6+). TradeFi positions are not supported (error 70004).
Parameters
| Parameter | Type |
|---|---|
params | MovePositionsRequest |
Returns
Promise<MovePositionsResult[]>
See
POST /api/v5/account/move-positions — 2026-05-15 changelog
placeAlgoOrder()
placeAlgoOrder(params: AlgoOrderRequest): Promise<AlgoOrderResult[]>;Orderbook trading - Algo trading endpoints
Parameters
| Parameter | Type |
|---|---|
params | AlgoOrderRequest |
Returns
Promise<AlgoOrderResult[]>
placeGridAlgoOrder()
placeGridAlgoOrder(params: GridAlgoOrderRequest): Promise<any[]>;Orderbook trading - Grid trading endpoints
Parameters
| Parameter | Type |
|---|---|
params | GridAlgoOrderRequest |
Returns
Promise<any[]>
placeLendingOrder()
placeLendingOrder(params: LendingOrder): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | LendingOrder |
Returns
Promise<any[]>
placeSignalBotSubOrder()
placeSignalBotSubOrder(params: PlaceSubOrderRequest): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | PlaceSubOrderRequest |
Returns
Promise<any[]>
positionBuilder()
positionBuilder(params: PositionBuilderRequest): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | PositionBuilderRequest |
Returns
Promise<any[]>
post()
post(endpoint: string, params?: any): Promise<any>;Parameters
| Parameter | Type |
|---|---|
endpoint | string |
params? | any |
Returns
Promise<any>
Inherited from
BaseRestClient.post
postPrivate()
postPrivate(endpoint: string, params?: any): Promise<any>;Parameters
| Parameter | Type |
|---|---|
endpoint | string |
params? | any |
Returns
Promise<any>
Inherited from
BaseRestClient.postPrivate
precheckSetDeltaNeutral()
precheckSetDeltaNeutral(params: PrecheckSetDeltaNeutralRequest): Promise<PrecheckSetDeltaNeutralResult[]>;Parameters
| Parameter | Type |
|---|---|
params | PrecheckSetDeltaNeutralRequest |
Returns
Promise<PrecheckSetDeltaNeutralResult[]>
presetAccountLevelSwitch()
presetAccountLevelSwitch(params: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | { acctLv: "2" | "3" | "4"; lever?: string; riskOffsetType?: "1" | "2" | "3" | "4"; } |
params.acctLv | "2" | "3" | "4" |
params.lever? | string |
params.riskOffsetType? | "1" | "2" | "3" | "4" |
Returns
Promise<any[]>
purchaseETHStaking()
purchaseETHStaking(params: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | { amt: string; } |
params.amt | string |
Returns
Promise<any[]>
redeemETHStaking()
redeemETHStaking(params: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | { amt: string; } |
params.amt | string |
Returns
Promise<any[]>
redeemOkusd()
redeemOkusd(params: RedeemOkusdRequest): Promise<OkusdRedeemResult[]>;Parameters
| Parameter | Type |
|---|---|
params | RedeemOkusdRequest |
Returns
Promise<OkusdRedeemResult[]>
redeemStake()
redeemStake(params: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | { allowEarlyRedeem?: boolean; ordId: string; protocolType: "staking" | "defi"; } |
params.allowEarlyRedeem? | boolean |
params.ordId | string |
params.protocolType | "staking" | "defi" |
Returns
Promise<any[]>
reduceFixedLoanLiabilities()
reduceFixedLoanLiabilities(params: object): Promise<object[]>;Parameters
| Parameter | Type |
|---|---|
params | { ordId: string; pendingRepay: boolean; } |
params.ordId | string |
params.pendingRepay | boolean |
Returns
Promise<object[]>
repayFixedLoanBorrowOrder()
repayFixedLoanBorrowOrder(params: object): Promise<object[]>;Parameters
| Parameter | Type |
|---|---|
params | { ordId: string; } |
params.ordId | string |
Returns
Promise<object[]>
requestBillsHistoryDownloadLink()
requestBillsHistoryDownloadLink(params: BillsHistoryArchiveRequest): Promise<AccountHistoryBill[]>;Apply for bill data since 1 February, 2021 except for the current quarter. Check the "Get bills details (since 2021)" endpoint in about 2 hours for the download link; in peak load it may take longer, and if still missing after 3 hours contact support. It is only applicable to the data from the unified account.
This endpoint submits a request for bill data. You can then use getRequestedBillsHistoryLink to get the link to the bill data. It may take some time to generate the data.
Parameters
| Parameter | Type |
|---|---|
params | BillsHistoryArchiveRequest |
Returns
Promise<AccountHistoryBill[]>
requestDcdQuote()
requestDcdQuote(params: RequestDcdQuoteRequest): Promise<DcdQuote[]>;Parameters
| Parameter | Type |
|---|---|
params | RequestDcdQuoteRequest |
Returns
Promise<DcdQuote[]>
requestDcdRedeemQuote()
requestDcdRedeemQuote(params: RequestDcdRedeemQuoteRequest): Promise<DcdRedeemQuote[]>;Parameters
| Parameter | Type |
|---|---|
params | RequestDcdRedeemQuoteRequest |
Returns
Promise<DcdRedeemQuote[]>
requestStableRewardsQuote()
requestStableRewardsQuote(params: RequestStableRewardsQuoteRequest): Promise<StableRewardsQuote[]>;Parameters
| Parameter | Type |
|---|---|
params | RequestStableRewardsQuoteRequest |
Returns
Promise<StableRewardsQuote[]>
Deprecated
Decommissioned 2026-07-14. Use order book trading APIs.
resetBlockMmp()
resetBlockMmp(): Promise<object[]>;Returns
Promise<object[]>
resetMMPStatus()
resetMMPStatus(params: object): Promise<object[]>;Parameters
| Parameter | Type |
|---|---|
params | { instFamily: string; instType?: "OPTION"; } |
params.instFamily | string |
params.instType? | "OPTION" |
Returns
Promise<object[]>
resetSubAccountAPIKey()
resetSubAccountAPIKey(params: object): Promise<SubAccountAPIReset[]>;Parameters
| Parameter | Type |
|---|---|
params | { apiKey: string; ip?: string; label?: string; perm?: string; subAcct: string; } |
params.apiKey | string |
params.ip? | string |
params.label? | string |
params.perm? | string |
params.subAcct | string |
Returns
Promise<SubAccountAPIReset[]>
savingsPurchaseRedemption()
savingsPurchaseRedemption(params: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | { amt: string; ccy: string; rate: string; side: "purchase" | "redempt"; } |
params.amt | string |
params.ccy | string |
params.rate | string |
params.side | "purchase" | "redempt" |
Returns
Promise<any[]>
setAccountCollateralAssets()
setAccountCollateralAssets(params: object): Promise<object[]>;Parameters
| Parameter | Type |
|---|---|
params | { ccyList?: string[]; collateralEnabled: boolean; type: "all" | "custom"; } |
params.ccyList? | string[] |
params.collateralEnabled | boolean |
params.type | "all" | "custom" |
Returns
Promise<object[]>
setAccountMode()
setAccountMode(params: object): Promise<AccountModeResult[]>;Parameters
| Parameter | Type |
|---|---|
params | { acctLv: AccountLevel; } |
params.acctLv | AccountLevel |
Returns
Promise<AccountModeResult[]>
setAutoLoan()
setAutoLoan(params: object): Promise<AutoLoanResult[]>;Parameters
| Parameter | Type |
|---|---|
params | { autoLoan: boolean; } |
params.autoLoan | boolean |
Returns
Promise<AutoLoanResult[]>
setAutoRepay()
setAutoRepay(params: object): Promise<object[]>;Parameters
| Parameter | Type |
|---|---|
params | { autoRepay: boolean; } |
params.autoRepay | boolean |
Returns
Promise<object[]>
setCopytradingBatchLeverage()
setCopytradingBatchLeverage(params: SetCTBatchLeverageRequest): Promise<SetCTBatchLeverageResult[]>;Parameters
| Parameter | Type |
|---|---|
params | SetCTBatchLeverageRequest |
Returns
Promise<SetCTBatchLeverageResult[]>
setCopytradingFirstCopy()
setCopytradingFirstCopy(params: CopySettingsRequest): Promise<object[]>;Parameters
| Parameter | Type |
|---|---|
params | CopySettingsRequest |
Returns
Promise<object[]>
setCopytradingInstruments()
setCopytradingInstruments(params: object): Promise<object[]>;Parameters
| Parameter | Type |
|---|---|
params | { instId: string; instType?: "SPOT" | "SWAP"; } |
params.instId | string |
params.instType? | "SPOT" | "SWAP" |
Returns
Promise<object[]>
setFeeType()
setFeeType(params: SetFeeTypeRequest): Promise<SetFeeTypeResult[]>;Parameters
| Parameter | Type |
|---|---|
params | SetFeeTypeRequest |
Returns
Promise<SetFeeTypeResult[]>
setGreeksDisplayType()
setGreeksDisplayType(params: object): Promise<Greeks[]>;Parameters
| Parameter | Type |
|---|---|
params | { greeksType: "BS" | "PA"; } |
params.greeksType | "BS" | "PA" |
Returns
Promise<Greeks[]>
setIsolatedMode()
setIsolatedMode(params: object): Promise<AccountIsolatedMode[]>;Parameters
| Parameter | Type |
|---|---|
params | { isoMode: "autonomy" | "automatic"; type: "MARGIN" | "CONTRACTS"; } |
params.isoMode | "autonomy" | "automatic" |
params.type | "MARGIN" | "CONTRACTS" |
Returns
Promise<AccountIsolatedMode[]>
setLendingRate()
setLendingRate(params: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | { ccy: string; rate: string; } |
params.ccy | string |
params.rate | string |
Returns
Promise<any[]>
setLeverage()
setLeverage(params: SetLeverageRequest): Promise<AccountLeverageResult[]>;Parameters
| Parameter | Type |
|---|---|
params | SetLeverageRequest |
Returns
Promise<AccountLeverageResult[]>
setMMPConfig()
setMMPConfig(params: SetMMPConfigRequest): Promise<SetMMPConfigResult[]>;Parameters
| Parameter | Type |
|---|---|
params | SetMMPConfigRequest |
Returns
Promise<SetMMPConfigResult[]>
setPositionMode()
setPositionMode(params: object): Promise<AccountPositionModeResult[]>;Parameters
| Parameter | Type |
|---|---|
params | { posMode: PosMode; } |
params.posMode | PosMode |
Returns
Promise<AccountPositionModeResult[]>
setSettleCurrency()
setSettleCurrency(params: SetSettleCurrencyRequest): Promise<SetSettleCurrencyResult[]>;Parameters
| Parameter | Type |
|---|---|
params | SetSettleCurrencyRequest |
Returns
Promise<SetSettleCurrencyResult[]>
setSignalInstruments()
setSignalInstruments(params: SetSignalInstrumentsRequest): Promise<object[]>;Parameters
| Parameter | Type |
|---|---|
params | SetSignalInstrumentsRequest |
Returns
Promise<object[]>
setSubAccountLoanAllocation()
setSubAccountLoanAllocation(params: SetSubAccountLoanAllocationRequest): Promise<object[]>;Parameters
| Parameter | Type |
|---|---|
params | SetSubAccountLoanAllocationRequest |
Returns
Promise<object[]>
setSubAccountTransferOutPermission()
setSubAccountTransferOutPermission(params: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | { canTransOut: boolean; subAcct: string; } |
params.canTransOut | boolean |
params.subAcct | string |
Returns
Promise<any[]>
setTradingConfig()
setTradingConfig(params: SetTradingConfigRequest): Promise<SetTradingConfigResult[]>;Parameters
| Parameter | Type |
|---|---|
params | SetTradingConfigRequest |
Returns
Promise<SetTradingConfigResult[]>
spotGridWithdrawIncome()
spotGridWithdrawIncome(params: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | { algoId: string; } |
params.algoId | string |
Returns
Promise<any[]>
stopCopytradingCopy()
stopCopytradingCopy(params: object): Promise<object[]>;Parameters
| Parameter | Type |
|---|---|
params | { instType?: "SWAP"; subPosCloseType: "market_close" | "copy_close" | "manual_close"; uniqueCode: string; } |
params.instType? | "SWAP" |
params.subPosCloseType | "market_close" | "copy_close" | "manual_close" |
params.uniqueCode | string |
Returns
Promise<object[]>
stopCopytradingLeadTrading()
stopCopytradingLeadTrading(params?: object): Promise<object[]>;Parameters
| Parameter | Type |
|---|---|
params? | { instType?: "SWAP"; } |
params.instType? | "SWAP" |
Returns
Promise<object[]>
stopGridAlgoOrder()
stopGridAlgoOrder(orders: StopGridAlgoOrderRequest[]): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
orders | StopGridAlgoOrderRequest[] |
Returns
Promise<any[]>
stopRecurringBuyOrder()
stopRecurringBuyOrder(params: object): Promise<RecurringBuyOrderResult[]>;Parameters
| Parameter | Type |
|---|---|
params | { algoId: string; } |
params.algoId | string |
Returns
Promise<RecurringBuyOrderResult[]>
submitCopytradingAlgoOrder()
submitCopytradingAlgoOrder(params: PlaceCTAlgoOrderRequest): Promise<PlaceCTAlgoOrderResult[]>;Parameters
| Parameter | Type |
|---|---|
params | PlaceCTAlgoOrderRequest |
Returns
Promise<PlaceCTAlgoOrderResult[]>
submitDcdRedeem()
submitDcdRedeem(params: SubmitDcdRedeemRequest): Promise<DcdRedeemResult[]>;Parameters
| Parameter | Type |
|---|---|
params | SubmitDcdRedeemRequest |
Returns
Promise<DcdRedeemResult[]>
submitDcdTrade()
submitDcdTrade(params: SubmitDcdTradeRequest): Promise<DcdTradeResult[]>;Parameters
| Parameter | Type |
|---|---|
params | SubmitDcdTradeRequest |
Returns
Promise<DcdTradeResult[]>
submitEasyConvert()
submitEasyConvert(params: object): Promise<APIResponse<any>>;Convert small balances to a supported receiving currency, with up to five source currencies per request.
Parameters
| Parameter | Type |
|---|---|
params | { fromCcys: string[]; source?: string; toCcy: string; } |
params.fromCcys | string[] |
params.source? | string |
params.toCcy | string |
Returns
Promise<APIResponse<any>>
submitFixedLoanBorrowOrder()
submitFixedLoanBorrowOrder(params: SubmitFixedLoanBorrowingOrderRequest): Promise<object[]>;Parameters
| Parameter | Type |
|---|---|
params | SubmitFixedLoanBorrowingOrderRequest |
Returns
Promise<object[]>
submitMultipleOrders()
submitMultipleOrders(params: OrderRequest[]): Promise<OrderResult[]>;Parameters
| Parameter | Type |
|---|---|
params | OrderRequest[] |
Returns
Promise<OrderResult[]>
submitOneClickRepay()
submitOneClickRepay(params: object): Promise<APIResponse<any>>;Repay cross-margin debt using available funding and trading balances. Isolated debt is not supported.
Parameters
| Parameter | Type |
|---|---|
params | { debtCcys: string[]; repayCcy: string; } |
params.debtCcys | string[] |
params.repayCcy | string |
Returns
Promise<APIResponse<any>>
submitOrder()
submitOrder(params: OrderRequest): Promise<OrderResult[]>;Orderbook trading - trade endpoints
Parameters
| Parameter | Type |
|---|---|
params | OrderRequest |
Returns
Promise<OrderResult[]>
See
submitOrderPrecheck()
submitOrderPrecheck(params: OrderPrecheckRequest): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | OrderPrecheckRequest |
Returns
Promise<any[]>
submitQuickMarginBorrowRepay()
submitQuickMarginBorrowRepay(params: QuickMarginBorrowRepayRequest): Promise<QuickMarginBorrowRepayResult[]>;Parameters
| Parameter | Type |
|---|---|
params | QuickMarginBorrowRepayRequest |
Returns
Promise<QuickMarginBorrowRepayResult[]>
submitRecurringBuyOrder()
submitRecurringBuyOrder(params: PlaceRecurringBuyOrderRequest): Promise<RecurringBuyOrderResult[]>;Orderbook trading - Recurring buy endpoints
Parameters
| Parameter | Type |
|---|---|
params | PlaceRecurringBuyOrderRequest |
Returns
Promise<RecurringBuyOrderResult[]>
submitSpreadOrder()
submitSpreadOrder(params: PlaceSpreadOrderRequest): Promise<PlaceSpreadOrderResponse[]>;Spread trading - REST endpoints
Parameters
| Parameter | Type |
|---|---|
params | PlaceSpreadOrderRequest |
Returns
Promise<PlaceSpreadOrderResponse[]>
submitStableRewardsTrade()
submitStableRewardsTrade(params: SubmitStableRewardsTradeRequest): Promise<StableRewardsTradeResult[]>;Parameters
| Parameter | Type |
|---|---|
params | SubmitStableRewardsTradeRequest |
Returns
Promise<StableRewardsTradeResult[]>
Deprecated
Decommissioned 2026-07-14. Use order book trading APIs.
submitStake()
submitStake(params: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | { investData: object[]; productId: string; term?: string; } |
params.investData | object[] |
params.productId | string |
params.term? | string |
Returns
Promise<any[]>
submitWithdraw()
submitWithdraw(params: WithdrawRequest): Promise<WithdrawResponse[]>;Parameters
| Parameter | Type |
|---|---|
params | WithdrawRequest |
Returns
Promise<WithdrawResponse[]>
submitWithdrawLightning()
submitWithdrawLightning(params: object): Promise<any[]>;Parameters
| Parameter | Type |
|---|---|
params | { ccy: string; invoice: string; memo?: string; } |
params.ccy | string |
params.invoice | string |
params.memo? | string |
Returns
Promise<any[]>
subscribeOkusd()
subscribeOkusd(params: SubscribeOkusdRequest): Promise<OkusdSubscribeResult[]>;Parameters
| Parameter | Type |
|---|---|
params | SubscribeOkusdRequest |
Returns
Promise<OkusdSubscribeResult[]>
transferSubAccountBalance()
transferSubAccountBalance(params: SubAccountTransferRequest): Promise<SubAccountTransferResult[]>;Master accounts manage the transfers between sub-accounts
Parameters
| Parameter | Type |
|---|---|
params | SubAccountTransferRequest |
Returns
Promise<SubAccountTransferResult[]>
updateBlockMmpConfig()
updateBlockMmpConfig(params: SetMmpConfigRequest): Promise<SetMmpConfigResult[]>;Parameters
| Parameter | Type |
|---|---|
params | SetMmpConfigRequest |
Returns
Promise<SetMmpConfigResult[]>
updateBlockQuoteProducts()
updateBlockQuoteProducts(params: SetQuoteProductsRequest): Promise<object[]>;Parameters
| Parameter | Type |
|---|---|
params | SetQuoteProductsRequest |
Returns
Promise<object[]>
updateCopytradingCopySettings()
updateCopytradingCopySettings(params: CopySettingsRequest): Promise<object[]>;Parameters
| Parameter | Type |
|---|---|
params | CopySettingsRequest |
Returns
Promise<object[]>
updateCopytradingProfitSharing()
updateCopytradingProfitSharing(params: object): Promise<object[]>;Parameters
| Parameter | Type |
|---|---|
params | { instType?: "SWAP"; profitSharingRatio: string; } |
params.instType? | "SWAP" |
params.profitSharingRatio | string |
Returns
Promise<object[]>
updateFixedLoanBorrowOrder()
updateFixedLoanBorrowOrder(params: UpdateFixedLoanBorrowingOrderRequest): Promise<object[]>;Parameters
| Parameter | Type |
|---|---|
params | UpdateFixedLoanBorrowingOrderRequest |
Returns
Promise<object[]>
updateRiskOffsetAmount()
updateRiskOffsetAmount(params: object): Promise<object[]>;Parameters
| Parameter | Type |
|---|---|
params | { ccy: string; clSpotInUseAmt: string; } |
params.ccy | string |
params.clSpotInUseAmt | string |
Returns
Promise<object[]>
updateRiskOffsetType()
updateRiskOffsetType(params: object): Promise<object[]>;Parameters
| Parameter | Type |
|---|---|
params | { type: "1" | "2" | "3" | "4"; } |
params.type | "1" | "2" | "3" | "4" |
Returns
Promise<object[]>
updateSignalMargin()
updateSignalMargin(params: AdjustMarginBalanceRequest): Promise<object[]>;Parameters
| Parameter | Type |
|---|---|
params | AdjustMarginBalanceRequest |
Returns
Promise<object[]>
updateSignalTPSL()
updateSignalTPSL(params: AmendTPSLRequest): Promise<object[]>;Parameters
| Parameter | Type |
|---|---|
params | AmendTPSLRequest |
Returns
Promise<object[]>
updateSpreadOrder()
updateSpreadOrder(params: UpdateSpreadOrderRequest): Promise<UpdateSpreadOrderResponse[]>;Parameters
| Parameter | Type |
|---|---|
params | UpdateSpreadOrderRequest |
Returns
Promise<UpdateSpreadOrderResponse[]>