Skip to content

Class: RestClient ​

Extends ​

  • default

Constructors ​

Constructor ​

ts
new RestClient(options?: RestClientOptions, requestOptions?: AxiosRequestConfig): RestClient;

Parameters ​

ParameterType
options?RestClientOptions
requestOptions?AxiosRequestConfig

Returns ​

RestClient

Inherited from ​

BaseRestClient.constructor

Methods ​

activateFeature() ​

ts
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 ​

ParameterType
paramsActivateFeatureRequest

Returns ​

Promise<Record<string, never>[]>


activateOption() ​

ts
activateOption(): Promise<object[]>;

Returns ​

Promise<object[]>


adjustCollateral() ​

ts
adjustCollateral(params: AdjustCollateralRequest): Promise<[]>;

Parameters ​

ParameterType
paramsAdjustCollateralRequest

Returns ​

Promise<[]>


adjustGridInvestment() ​

ts
adjustGridInvestment(params: object): Promise<object[]>;

Parameters ​

ParameterType
params{ algoId: string; amt: string; }
params.algoIdstring
params.amtstring

Returns ​

Promise<object[]>


adjustGridMarginBalance() ​

ts
adjustGridMarginBalance(params: object): Promise<any[]>;

Parameters ​

ParameterType
params{ algoId: string; amt?: string; percent?: string; type: "reduce" | "add"; }
params.algoIdstring
params.amt?string
params.percent?string
params.type"reduce" | "add"

Returns ​

Promise<any[]>


amendAlgoOrder() ​

ts
amendAlgoOrder(params: AmendAlgoOrderRequest): Promise<AmendAlgoOrderResult[]>;

Parameters ​

ParameterType
paramsAmendAlgoOrderRequest

Returns ​

Promise<AmendAlgoOrderResult[]>


amendGridAlgoOrder() ​

ts
amendGridAlgoOrder(params: object): Promise<any[]>;

Parameters ​

ParameterType
params{ algoId: string; instId: string; slRatio?: string; slTriggerPx?: string; tpRatio?: string; tpTriggerPx?: string; triggerParams?: object[]; }
params.algoIdstring
params.instIdstring
params.slRatio?string
params.slTriggerPx?string
params.tpRatio?string
params.tpTriggerPx?string
params.triggerParams?object[]

Returns ​

Promise<any[]>


amendLendingOrder() ​

ts
amendLendingOrder(params: LendingOrder): Promise<any[]>;

Parameters ​

ParameterType
paramsLendingOrder

Returns ​

Promise<any[]>


amendMultipleOrders() ​

ts
amendMultipleOrders(params: AmendOrderRequest[]): Promise<AmendedOrder[]>;

Parameters ​

ParameterType
paramsAmendOrderRequest[]

Returns ​

Promise<AmendedOrder[]>


amendOrder() ​

ts
amendOrder(params: AmendOrderRequest): Promise<AmendedOrder[]>;

Parameters ​

ParameterType
paramsAmendOrderRequest

Returns ​

Promise<AmendedOrder[]>

See ​

Order management


amendRecurringBuyOrder() ​

ts
amendRecurringBuyOrder(params: AmendRecurringBuyOrderRequest): Promise<RecurringBuyOrderResult[]>;

Parameters ​

ParameterType
paramsAmendRecurringBuyOrderRequest

Returns ​

Promise<RecurringBuyOrderResult[]>


applyCopytradingLeadTrading() ​

ts
applyCopytradingLeadTrading(params: object): Promise<object[]>;

Parameters ​

ParameterType
params{ profitSharingTs: string; totalUnrealizedProfitSharingAmt: string; }
params.profitSharingTsstring
params.totalUnrealizedProfitSharingAmtstring

Returns ​

Promise<object[]>


applyForMonthlyStatement() ​

ts
applyForMonthlyStatement(params?: object): Promise<any[]>;

Parameters ​

ParameterType
params?{ month?: string; }
params.month?string

Returns ​

Promise<any[]>


borrowRepayVIPLoan() ​

ts
borrowRepayVIPLoan(params: object): Promise<any[]>;

Parameters ​

ParameterType
params{ amt: string; ccy: string; ordId?: string; side: "borrow" | "repay"; }
params.amtstring
params.ccystring
params.ordId?string
params.side"borrow" | "repay"

Returns ​

Promise<any[]>


cancelAdvanceAlgoOrder() ​

ts
cancelAdvanceAlgoOrder(params: CancelAlgoOrderRequest[]): Promise<AlgoOrderResult[]>;

Parameters ​

ParameterType
paramsCancelAlgoOrderRequest[]

Returns ​

Promise<AlgoOrderResult[]>


cancelAlgoOrder() ​

ts
cancelAlgoOrder(params: CancelAlgoOrderRequest[]): Promise<AlgoOrderResult[]>;

Parameters ​

ParameterType
paramsCancelAlgoOrderRequest[]

Returns ​

Promise<AlgoOrderResult[]>


cancelAllAfter() ​

ts
cancelAllAfter(params: object): Promise<CancelAllAfterResponse[]>;

Parameters ​

ParameterType
params{ tag?: string; timeOut: string; }
params.tag?string
params.timeOutstring

Returns ​

Promise<CancelAllAfterResponse[]>


cancelAllBlockAfter() ​

ts
cancelAllBlockAfter(params: object): Promise<object[]>;

Parameters ​

ParameterType
params{ timeOut: string; }
params.timeOutstring

Returns ​

Promise<object[]>


cancelAllBlockQuotes() ​

ts
cancelAllBlockQuotes(): Promise<TimestampObject[]>;

Returns ​

Promise<TimestampObject[]>


cancelAllRFQs() ​

ts
cancelAllRFQs(): Promise<TimestampObject[]>;

Returns ​

Promise<TimestampObject[]>


cancelAllSpreadOrders() ​

ts
cancelAllSpreadOrders(params?: object): Promise<object[]>;

Parameters ​

ParameterType
params?{ sprdId?: string; }
params.sprdId?string

Returns ​

Promise<object[]>


cancelBlockQuote() ​

ts
cancelBlockQuote(params: CancelBlockQuoteRequest): Promise<CancelBlockQuoteResult[]>;

Parameters ​

ParameterType
paramsCancelBlockQuoteRequest

Returns ​

Promise<CancelBlockQuoteResult[]>


cancelBlockRFQ() ​

ts
cancelBlockRFQ(params: CancelBlockRFQRequest): Promise<CancelBlockRFQResult[]>;

Parameters ​

ParameterType
paramsCancelBlockRFQRequest

Returns ​

Promise<CancelBlockRFQResult[]>


cancelGridContractCloseOrder() ​

ts
cancelGridContractCloseOrder(params: object): Promise<any[]>;

Parameters ​

ParameterType
params{ algoId: string; ordId: string; }
params.algoIdstring
params.ordIdstring

Returns ​

Promise<any[]>


cancelMassOrder() ​

ts
cancelMassOrder(params: object): Promise<object[]>;

Parameters ​

ParameterType
params{ instFamily: string; instType: string; lockInterval?: string; }
params.instFamilystring
params.instTypestring
params.lockInterval?string

Returns ​

Promise<object[]>


cancelMultipleBlockQuotes() ​

ts
cancelMultipleBlockQuotes(params: CancelMultipleBlockQuoteRequest): Promise<CancelBlockQuoteResult[]>;

Parameters ​

ParameterType
paramsCancelMultipleBlockQuoteRequest

Returns ​

Promise<CancelBlockQuoteResult[]>


cancelMultipleBlockRFQs() ​

ts
cancelMultipleBlockRFQs(params: CancelMultipleBlockRFQRequest): Promise<CancelBlockRFQResult[]>;

Parameters ​

ParameterType
paramsCancelMultipleBlockRFQRequest

Returns ​

Promise<CancelBlockRFQResult[]>


cancelMultipleOrders() ​

ts
cancelMultipleOrders(params: OrderIdRequest[]): Promise<CancelledOrderResult[]>;

Parameters ​

ParameterType
paramsOrderIdRequest[]

Returns ​

Promise<CancelledOrderResult[]>


cancelOrder() ​

ts
cancelOrder(params: OrderIdRequest): Promise<CancelledOrderResult[]>;

Parameters ​

ParameterType
paramsOrderIdRequest

Returns ​

Promise<CancelledOrderResult[]>

See ​

Order management


cancelRedeemETHStaking() ​

ts
cancelRedeemETHStaking(params: object): Promise<object[]>;

Parameters ​

ParameterType
params{ ordId: string; }
params.ordIdstring

Returns ​

Promise<object[]>


cancelSignalBots() ​

ts
cancelSignalBots(params: object): Promise<CancelSignalBotsResult[]>;

Parameters ​

ParameterType
params{ algoId: string; }
params.algoIdstring

Returns ​

Promise<CancelSignalBotsResult[]>


cancelSpreadAllAfter() ​

ts
cancelSpreadAllAfter(params: object): Promise<object[]>;

Parameters ​

ParameterType
params{ timeOut: string; }
params.timeOutstring

Returns ​

Promise<object[]>


cancelSpreadOrder() ​

ts
cancelSpreadOrder(params?: object): Promise<CancelSpreadOrderResponse[]>;

Parameters ​

ParameterType
params?{ clOrdId?: string; ordId?: string; }
params.clOrdId?string
params.ordId?string

Returns ​

Promise<CancelSpreadOrderResponse[]>


cancelStakingRequest() ​

ts
cancelStakingRequest(params: object): Promise<any[]>;

Parameters ​

ParameterType
params{ ordId: string; protocolType: "staking" | "defi"; }
params.ordIdstring
params.protocolType"staking" | "defi"

Returns ​

Promise<any[]>


cancelSubOrder() ​

ts
cancelSubOrder(params: CancelSubOrderRequest): Promise<any[]>;

Parameters ​

ParameterType
paramsCancelSubOrderRequest

Returns ​

Promise<any[]>


cancelWithdrawal() ​

ts
cancelWithdrawal(params: object): Promise<any[]>;

Parameters ​

ParameterType
params{ wdId: string; }
params.wdIdstring

Returns ​

Promise<any[]>


changePositionMargin() ​

ts
changePositionMargin(params: ChangePositionMarginRequest): Promise<AccountChangeMarginResult[]>;

Parameters ​

ParameterType
paramsChangePositionMarginRequest

Returns ​

Promise<AccountChangeMarginResult[]>


closeCopytradingSubposition() ​

ts
closeCopytradingSubposition(params: CloseSubpositionRequest): Promise<object[]>;

Parameters ​

ParameterType
paramsCloseSubpositionRequest

Returns ​

Promise<object[]>


closeGridContractPosition() ​

ts
closeGridContractPosition(params: CloseContractGridPositionRequest): Promise<any[]>;

Parameters ​

ParameterType
paramsCloseContractGridPositionRequest

Returns ​

Promise<any[]>


closePositions() ​

ts
closePositions(params: ClosePositionRequest): Promise<ClosedPositions[]>;

Parameters ​

ParameterType
paramsClosePositionRequest

Returns ​

Promise<ClosedPositions[]>


closeSignalBotPosition() ​

ts
closeSignalBotPosition(params: object): Promise<object[]>;

Parameters ​

ParameterType
params{ algoId: string; instId: string; }
params.algoIdstring
params.instIdstring

Returns ​

Promise<object[]>


computeGridMarginBalance() ​

ts
computeGridMarginBalance(params: object): Promise<any[]>;

Parameters ​

ParameterType
params{ algoId: string; amt?: string; type: "reduce" | "add"; }
params.algoIdstring
params.amt?string
params.type"reduce" | "add"

Returns ​

Promise<any[]>


computeGridMinInvestment() ​

ts
computeGridMinInvestment(params: object): Promise<any[]>;

Parameters ​

ParameterType
params{ amt: string; ccy: string; }
params.amtstring
params.ccystring

Returns ​

Promise<any[]>


convertFixedLoanToMarketLoan() ​

ts
convertFixedLoanToMarketLoan(params: object): Promise<object[]>;

Parameters ​

ParameterType
params{ ordId: string; }
params.ordIdstring

Returns ​

Promise<object[]>


convertTrade() ​

ts
convertTrade(params: ConvertTradeRequest): Promise<any[]>;

Parameters ​

ParameterType
paramsConvertTradeRequest

Returns ​

Promise<any[]>


createBlockQuote() ​

ts
createBlockQuote(params: CreateBlockQuoteRequest): Promise<CreateBlockQuoteResult[]>;

Parameters ​

ParameterType
paramsCreateBlockQuoteRequest

Returns ​

Promise<CreateBlockQuoteResult[]>


createBlockRFQ() ​

ts
createBlockRFQ(params: CreateBlockRFQRequest): Promise<CreateRFQResult[]>;

Parameters ​

ParameterType
paramsCreateBlockRFQRequest

Returns ​

Promise<CreateRFQResult[]>


createSignal() ​

ts
createSignal(params: CreateSignalRequest): Promise<CreateSignalResult[]>;

Orderbook trading - Signal bot trading endpoints

Parameters ​

ParameterType
paramsCreateSignalRequest

Returns ​

Promise<CreateSignalResult[]>


createSignalBot() ​

ts
createSignalBot(params: CreateSignalBotRequest): Promise<CreateSignalBotResult[]>;

Parameters ​

ParameterType
paramsCreateSignalBotRequest

Returns ​

Promise<CreateSignalBotResult[]>


createSubAccount() ​

ts
createSubAccount(params: object): Promise<any[]>;

Broker endpoints (private)

Parameters ​

ParameterType
params{ clientIP?: string; label?: string; mainAcct: string; subAcct: string; }
params.clientIP?string
params.label?string
params.mainAcctstring
params.subAcctstring

Returns ​

Promise<any[]>


createSubAccountAPIKey() ​

ts
createSubAccountAPIKey(params: object): Promise<any[]>;

Parameters ​

ParameterType
params{ ip?: string; label: string; passphrase: string; perm?: string; subAcct: string; }
params.ip?string
params.labelstring
params.passphrasestring
params.perm?string
params.subAcctstring

Returns ​

Promise<any[]>


deletePrivate() ​

ts
deletePrivate(endpoint: string, params?: any): Promise<any>;

Parameters ​

ParameterType
endpointstring
params?any

Returns ​

Promise<any>

Inherited from ​

BaseRestClient.deletePrivate


deleteSubAccount() ​

ts
deleteSubAccount(params: object): Promise<any[]>;

Parameters ​

ParameterType
params{ subAcct: string; }
params.subAcctstring

Returns ​

Promise<any[]>


estimateConvertQuote() ​

ts
estimateConvertQuote(params: ConvertQuoteEstimateRequest): Promise<any[]>;

Parameters ​

ParameterType
paramsConvertQuoteEstimateRequest

Returns ​

Promise<any[]>


executeBlockQuote() ​

ts
executeBlockQuote(params: ExecuteBlockQuoteRequest): Promise<ExecuteBlockQuoteResult[]>;

Parameters ​

ParameterType
paramsExecuteBlockQuoteRequest

Returns ​

Promise<ExecuteBlockQuoteResult[]>


fetchLatencySummary() ​

ts
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() ​

ts
fundsTransfer(params: FundsTransferRequest): Promise<FundTransferResult[]>;

Parameters ​

ParameterType
paramsFundsTransferRequest

Returns ​

Promise<FundTransferResult[]>


geCopytradingLeadPrivateStats() ​

ts
geCopytradingLeadPrivateStats(params: GetLeadTraderStatsRequest): Promise<LeadTraderStats[]>;

Parameters ​

ParameterType
paramsGetLeadTraderStatsRequest

Returns ​

Promise<LeadTraderStats[]>


get() ​

ts
get(endpoint: string, params?: any): Promise<any>;

Parameters ​

ParameterType
endpointstring
params?any

Returns ​

Promise<any>

Inherited from ​

BaseRestClient.get


get24hrTotalVolume() ​

ts
get24hrTotalVolume(): Promise<any[]>;

Returns ​

Promise<any[]>


getAccountAssetValuation() ​

ts
getAccountAssetValuation(params?: object): Promise<AccountAssetValuation[]>;

Parameters ​

ParameterType
params?{ ccy?: string; }
params.ccy?string

Returns ​

Promise<AccountAssetValuation[]>


getAccountBillSubtypes() ​

ts
getAccountBillSubtypes(params?: GetAccountBillSubtypesRequest): Promise<AccountBillTypeDefinition[]>;

Bill type ids and subTypes (unified account bill CSV columns reference type / subType).

Parameters ​

ParameterType
params?GetAccountBillSubtypesRequest

Returns ​

Promise<AccountBillTypeDefinition[]>

See ​

GET /api/v5/account/subtypes


getAccountCollateralAssets() ​

ts
getAccountCollateralAssets(params?: object): Promise<object[]>;

Parameters ​

ParameterType
params?{ ccy?: string; collateralEnabled?: boolean; }
params.ccy?string
params.collateralEnabled?boolean

Returns ​

Promise<object[]>


getAccountConfiguration() ​

ts
getAccountConfiguration(): Promise<AccountConfiguration[]>;

Returns ​

Promise<AccountConfiguration[]>


getAccountInstruments() ​

ts
getAccountInstruments(params: GetInstrumentsRequest): Promise<AccountInstrument[]>;

Trading account endpoints

Parameters ​

ParameterType
paramsGetInstrumentsRequest

Returns ​

Promise<AccountInstrument[]>


getAccountPositionRisk() ​

ts
getAccountPositionRisk(params?: object): Promise<AccountPositionRisk[]>;

Parameters ​

ParameterType
params?{ instType?: Omit<"SPOT", InstrumentType>; }
params.instType?Omit<"SPOT", InstrumentType>

Returns ​

Promise<AccountPositionRisk[]>


getAccountRateLimit() ​

ts
getAccountRateLimit(): Promise<any[]>;

Returns ​

Promise<any[]>


getAccountRiskState() ​

ts
getAccountRiskState(): Promise<AccountRiskState[]>;

Returns ​

Promise<AccountRiskState[]>


getAccountSwitchPrecheck() ​

ts
getAccountSwitchPrecheck(params: object): Promise<any[]>;

Parameters ​

ParameterType
params{ acctLv: "1" | "2" | "3" | "4"; }
params.acctLv"1" | "2" | "3" | "4"

Returns ​

Promise<any[]>


getAccruedInterest() ​

ts
getAccruedInterest(params?: AccruedInterestRequest): Promise<AccruedInterestItem[]>;

Parameters ​

ParameterType
params?AccruedInterestRequest

Returns ​

Promise<AccruedInterestItem[]>


getActiveSignalBot() ​

ts
getActiveSignalBot(params: GetSignalBotRequest): Promise<any[]>;

Parameters ​

ParameterType
paramsGetSignalBotRequest

Returns ​

Promise<any[]>


getActiveStakingOrders() ​

ts
getActiveStakingOrders(params?: object): Promise<any[]>;

Earn/staking get active orders

Parameters ​

ParameterType
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() ​

ts
getAlgoOrderDetails(params: AlgoOrderDetailsRequest): Promise<AlgoOrderDetailsResult[]>;

Parameters ​

ParameterType
paramsAlgoOrderDetailsRequest

Returns ​

Promise<AlgoOrderDetailsResult[]>


getAlgoOrderHistory() ​

ts
getAlgoOrderHistory(params: AlgoLongHistoryRequest): Promise<HistoricAlgoOrder[]>;

Parameters ​

ParameterType
paramsAlgoLongHistoryRequest

Returns ​

Promise<HistoricAlgoOrder[]>


getAlgoOrderList() ​

ts
getAlgoOrderList(params: AlgoRecentHistoryRequest): Promise<AlgoOrderListItem[]>;

Parameters ​

ParameterType
paramsAlgoRecentHistoryRequest

Returns ​

Promise<AlgoOrderListItem[]>


getAnnouncements() ​

ts
getAnnouncements(params?: object): Promise<object[]>;

Announcement endpoints

Parameters ​

ParameterType
params?{ annType?: string; page?: string; }
params.annType?string
params.page?string

Returns ​

Promise<object[]>


getAnnouncementTypes() ​

ts
getAnnouncementTypes(): Promise<object[]>;

Returns ​

Promise<object[]>


getAPYHistory() ​

ts
getAPYHistory(params: object): Promise<any[]>;

Parameters ​

ParameterType
params{ days: string; }
params.daysstring

Returns ​

Promise<any[]>


getAssetBillsDetails() ​

ts
getAssetBillsDetails(params?: object): Promise<AssetBillDetails[]>;

Query the billing record in the past month.

Parameters ​

ParameterTypeDescription
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() ​

ts
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 ​

ParameterTypeDescription
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() ​

ts
getBalance(params?: object): Promise<AccountBalance[]>;

Parameters ​

ParameterType
params?{ ccy?: string; }
params.ccy?string

Returns ​

Promise<AccountBalance[]>

See ​

Read trading account balances


getBalances() ​

ts
getBalances(params?: object): Promise<FundingBalance[]>;

Parameters ​

ParameterType
params?{ ccy?: string; }
params.ccy?string

Returns ​

Promise<FundingBalance[]>


getBills() ​

ts
getBills(params?: any): Promise<AccountBill[]>;

Up to last 7 days

Parameters ​

ParameterType
params?any

Returns ​

Promise<AccountBill[]>


getBillsArchive() ​

ts
getBillsArchive(params?: any): Promise<AccountBill[]>;

Last 3 months

Parameters ​

ParameterType
params?any

Returns ​

Promise<AccountBill[]>


getBlockCounterParties() ​

ts
getBlockCounterParties(): Promise<BlockCounterParty[]>;

Block trading - REST endpoints

Returns ​

Promise<BlockCounterParty[]>


getBlockMmpConfig() ​

ts
getBlockMmpConfig(): Promise<BlockMMPConfig[]>;

Returns ​

Promise<BlockMMPConfig[]>


getBlockPublicTrades() ​

ts
getBlockPublicTrades(params: object): Promise<PublicBlockTrade[]>;

Parameters ​

ParameterType
params{ instId: string; }
params.instIdstring

Returns ​

Promise<PublicBlockTrade[]>


getBlockQuotes() ​

ts
getBlockQuotes(params?: GetBlockQuoteParams): Promise<GetBlockQuoteResult[]>;

Parameters ​

ParameterType
params?GetBlockQuoteParams

Returns ​

Promise<GetBlockQuoteResult[]>


getBlockRFQs() ​

ts
getBlockRFQs(params?: GetBlockRFQSParams): Promise<BlockRFQResult[]>;

Parameters ​

ParameterType
params?GetBlockRFQSParams

Returns ​

Promise<BlockRFQResult[]>


getBlockTicker() ​

ts
getBlockTicker(params: object): Promise<any[]>;

Parameters ​

ParameterType
params{ instId: string; }
params.instIdstring

Returns ​

Promise<any[]>


getBlockTickers() ​

ts
getBlockTickers(params: object): Promise<any[]>;

Parameters ​

ParameterType
params{ instType: InstrumentType; uly?: string; }
params.instTypeInstrumentType
params.uly?string

Returns ​

Promise<any[]>


getBlockTrades() ​

ts
getBlockTrades(params?: any): Promise<BlockTradeResult[]>;

Parameters ​

ParameterType
params?any

Returns ​

Promise<BlockTradeResult[]>


getBorrowableCurrencies() ​

ts
getBorrowableCurrencies(): Promise<object[]>;

Financial product - Flexible loan endpoints

Returns ​

Promise<object[]>


getBorrowInterestLimits() ​

ts
getBorrowInterestLimits(params?: object): Promise<any[]>;

Parameters ​

ParameterType
params?{ ccy?: string; type?: "1" | "2"; }
params.ccy?string
params.type?"1" | "2"

Returns ​

Promise<any[]>


getBorrowRepayHistory() ​

ts
getBorrowRepayHistory(params?: GetBorrowRepayHistoryRequest): Promise<BorrowRepayHistoryItem[]>;

Parameters ​

ParameterType
params?GetBorrowRepayHistoryRequest

Returns ​

Promise<BorrowRepayHistoryItem[]>


getCandles() ​

ts
getCandles(params: CandleRequest): Promise<Candle[]>;

Parameters ​

ParameterType
paramsCandleRequest

Returns ​

Promise<Candle[]>


getCollateralAssets() ​

ts
getCollateralAssets(params?: GetFlexibleLoanCollateralAssetsRequest): Promise<CollateralAssetsResponse[]>;

Parameters ​

ParameterType
params?GetFlexibleLoanCollateralAssetsRequest

Returns ​

Promise<CollateralAssetsResponse[]>


getContractsOpenInterestAndVolume() ​

ts
getContractsOpenInterestAndVolume(params: object): Promise<any[]>;

Parameters ​

ParameterType
params{ begin?: string; ccy: string; end?: string; period: "5m" | "1H" | "1D"; }
params.begin?string
params.ccystring
params.end?string
params.period"5m" | "1H" | "1D"

Returns ​

Promise<any[]>


getContractTakerVolume() ​

ts
getContractTakerVolume(params: GetContractTakerVolumeRequest): Promise<any[]>;

Parameters ​

ParameterType
paramsGetContractTakerVolumeRequest

Returns ​

Promise<any[]>


getConvertCurrencies() ​

ts
getConvertCurrencies(): Promise<any[]>;

Returns ​

Promise<any[]>


getConvertCurrencyPair() ​

ts
getConvertCurrencyPair(params: object): Promise<any[]>;

Parameters ​

ParameterTypeDescription
params{ convertMode?: "0" | "1"; fromCcy: string; toCcy: string; }-
params.convertMode?"0" | "1"0: standard convert (default), 1: large order convert for VIP
params.fromCcystring-
params.toCcystring-

Returns ​

Promise<any[]>


getConvertHistory() ​

ts
getConvertHistory(params?: any): Promise<any[]>;

Parameters ​

ParameterType
params?any

Returns ​

Promise<any[]>


getCopyTraders() ​

ts
getCopyTraders(params: GetCopyTradersRequest): Promise<GetCopyTradersResult[]>;

Parameters ​

ParameterType
paramsGetCopyTradersRequest

Returns ​

Promise<GetCopyTradersResult[]>


getCopyTradersPrivate() ​

ts
getCopyTradersPrivate(params: GetCopyTradersRequest): Promise<GetCopyTradersResult[]>;

Parameters ​

ParameterType
paramsGetCopyTradersRequest

Returns ​

Promise<GetCopyTradersResult[]>


getCopytradingAccount() ​

ts
getCopytradingAccount(): Promise<GetAccountConfigurationResult[]>;

Returns ​

Promise<GetAccountConfigurationResult[]>


getCopytradingBatchLeverageInfo() ​

ts
getCopytradingBatchLeverageInfo(params: GetCTBatchLeverageInfoRequest): Promise<GetCTBatchLeverageInfoResult[]>;

Parameters ​

ParameterType
paramsGetCTBatchLeverageInfoRequest

Returns ​

Promise<GetCTBatchLeverageInfoResult[]>


getCopytradingConfig() ​

ts
getCopytradingConfig(params?: object): Promise<GetCopyTradingConfigResult[]>;

Parameters ​

ParameterType
params?{ instType?: "SWAP"; }
params.instType?"SWAP"

Returns ​

Promise<GetCopyTradingConfigResult[]>


getCopytradingCopySettings() ​

ts
getCopytradingCopySettings(params: object): Promise<GetCopySettingsResult[]>;

Parameters ​

ParameterType
params{ instType?: "SWAP"; uniqueCode: string; }
params.instType?"SWAP"
params.uniqueCodestring

Returns ​

Promise<GetCopySettingsResult[]>


getCopytradingInstruments() ​

ts
getCopytradingInstruments(params?: object): Promise<object[]>;

Parameters ​

ParameterType
params?{ instType?: "SPOT" | "SWAP"; }
params.instType?"SPOT" | "SWAP"

Returns ​

Promise<object[]>


getCopytradingLeadDailyPnl() ​

ts
getCopytradingLeadDailyPnl(params: GetLeadTraderStatsRequest): Promise<LeadTraderPnl[]>;

Parameters ​

ParameterType
paramsGetLeadTraderStatsRequest

Returns ​

Promise<LeadTraderPnl[]>


getCopytradingLeadOpenPositions() ​

ts
getCopytradingLeadOpenPositions(params: GetLeadTraderPositionsRequest): Promise<LeadTraderCurrentPosition[]>;

Parameters ​

ParameterType
paramsGetLeadTraderPositionsRequest

Returns ​

Promise<LeadTraderCurrentPosition[]>


getCopytradingLeadPositionHistory() ​

ts
getCopytradingLeadPositionHistory(params: GetLeadTraderPositionsRequest): Promise<LeadTraderPositionHistory[]>;

Parameters ​

ParameterType
paramsGetLeadTraderPositionsRequest

Returns ​

Promise<LeadTraderPositionHistory[]>


getCopytradingLeadPreferences() ​

ts
getCopytradingLeadPreferences(params: object): Promise<LeadTraderPreference[]>;

Parameters ​

ParameterType
params{ instType?: "SWAP"; uniqueCode: string; }
params.instType?"SWAP"
params.uniqueCodestring

Returns ​

Promise<LeadTraderPreference[]>


getCopytradingLeadPrivateOpenPositions() ​

ts
getCopytradingLeadPrivateOpenPositions(params: GetLeadTraderPositionsRequest): Promise<LeadTraderCurrentPosition[]>;

Parameters ​

ParameterType
paramsGetLeadTraderPositionsRequest

Returns ​

Promise<LeadTraderCurrentPosition[]>


getCopytradingLeadPrivatePositionHistory() ​

ts
getCopytradingLeadPrivatePositionHistory(params: GetLeadTraderPositionsRequest): Promise<LeadTraderPositionHistory[]>;

Parameters ​

ParameterType
paramsGetLeadTraderPositionsRequest

Returns ​

Promise<LeadTraderPositionHistory[]>


getCopytradingLeadPrivatePreferences() ​

ts
getCopytradingLeadPrivatePreferences(params: object): Promise<LeadTraderPreference[]>;

Parameters ​

ParameterType
params{ instType?: "SWAP"; uniqueCode: string; }
params.instType?"SWAP"
params.uniqueCodestring

Returns ​

Promise<LeadTraderPreference[]>


getCopytradingLeadPrivateRanks() ​

ts
getCopytradingLeadPrivateRanks(params?: GetPrivateLeadTraderRanksRequest): Promise<GetPrivateLeadTraderRanksResult[]>;

Parameters ​

ParameterType
params?GetPrivateLeadTraderRanksRequest

Returns ​

Promise<GetPrivateLeadTraderRanksResult[]>


getCopytradingLeadPrivateWeeklyPnl() ​

ts
getCopytradingLeadPrivateWeeklyPnl(params: object): Promise<LeadTraderPnl[]>;

Parameters ​

ParameterType
params{ instType?: "SWAP"; uniqueCode: string; }
params.instType?"SWAP"
params.uniqueCodestring

Returns ​

Promise<LeadTraderPnl[]>


getCopytradingLeadRanks() ​

ts
getCopytradingLeadRanks(params?: GetLeadTraderRanksRequest): Promise<GetLeadTraderRanksResult[]>;

Parameters ​

ParameterType
params?GetLeadTraderRanksRequest

Returns ​

Promise<GetLeadTraderRanksResult[]>


getCopytradingLeadStats() ​

ts
getCopytradingLeadStats(params: GetLeadTraderStatsRequest): Promise<LeadTraderStats[]>;

Parameters ​

ParameterType
paramsGetLeadTraderStatsRequest

Returns ​

Promise<LeadTraderStats[]>


getCopytradingLeadTradersHistory() ​

ts
getCopytradingLeadTradersHistory(params?: GetCTHistoryLeadTradersRequest): Promise<GetCTHistoryLeadTradersResult[]>;

Parameters ​

ParameterType
params?GetCTHistoryLeadTradersRequest

Returns ​

Promise<GetCTHistoryLeadTradersResult[]>


getCopytradingLeadWeeklyPnl() ​

ts
getCopytradingLeadWeeklyPnl(params: object): Promise<LeadTraderPnl[]>;

Parameters ​

ParameterType
params{ instType?: "SWAP"; uniqueCode: string; }
params.instType?"SWAP"
params.uniqueCodestring

Returns ​

Promise<LeadTraderPnl[]>


getCopytradingMyLeadTraders() ​

ts
getCopytradingMyLeadTraders(params?: object): Promise<GetCTMyLeadTradersResult[]>;

Parameters ​

ParameterType
params?{ instType?: "SWAP"; }
params.instType?"SWAP"

Returns ​

Promise<GetCTMyLeadTradersResult[]>


getCopytradingPLeadPrivateDailyPnl() ​

ts
getCopytradingPLeadPrivateDailyPnl(params: GetLeadTraderStatsRequest): Promise<LeadTraderPnl[]>;

Parameters ​

ParameterType
paramsGetLeadTraderStatsRequest

Returns ​

Promise<LeadTraderPnl[]>


getCopytradingProfitDetails() ​

ts
getCopytradingProfitDetails(params?: GetCTProfitDetailsRequest): Promise<GetCTProfitDetailsResult[]>;

Parameters ​

ParameterType
params?GetCTProfitDetailsRequest

Returns ​

Promise<GetCTProfitDetailsResult[]>


getCopytradingSubpositions() ​

ts
getCopytradingSubpositions(params?: GetCurrentSubpositionsRequest): Promise<CurrentSubposition[]>;

Orderbook trading - Copy trading endpoints

Parameters ​

ParameterType
params?GetCurrentSubpositionsRequest

Returns ​

Promise<CurrentSubposition[]>


getCopytradingSubpositionsHistory() ​

ts
getCopytradingSubpositionsHistory(params?: GetSubpositionsHistoryRequest): Promise<SubpositionsHistory[]>;

Parameters ​

ParameterType
params?GetSubpositionsHistoryRequest

Returns ​

Promise<SubpositionsHistory[]>


getCopytradingTotalProfit() ​

ts
getCopytradingTotalProfit(params?: object): Promise<GetCTTotalProfitResult[]>;

Parameters ​

ParameterType
params?{ instType?: "SPOT" | "SWAP"; }
params.instType?"SPOT" | "SWAP"

Returns ​

Promise<GetCTTotalProfitResult[]>


getCopytradingTotalUnrealizedProfit() ​

ts
getCopytradingTotalUnrealizedProfit(params?: object): Promise<object[]>;

Parameters ​

ParameterType
params?{ instType?: "SWAP"; }
params.instType?"SWAP"

Returns ​

Promise<object[]>


getCopytradingUnrealizedProfit() ​

ts
getCopytradingUnrealizedProfit(params?: object): Promise<GetCTUnrealizedProfitResult[]>;

Parameters ​

ParameterType
params?{ instType?: "SPOT" | "SWAP"; }
params.instType?"SPOT" | "SWAP"

Returns ​

Promise<GetCTUnrealizedProfitResult[]>


getCurrencies() ​

ts
getCurrencies(params?: object): Promise<FundingCurrency[]>;

Funding account - REST endpoints

Parameters ​

ParameterType
params?{ ccy?: string; }
params.ccy?string

Returns ​

Promise<FundingCurrency[]>


getDcdCurrencyPairs() ​

ts
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() ​

ts
getDcdOrderHistory(params?: GetDcdOrderHistoryRequest): Promise<DcdOrderHistoryItem[]>;

Parameters ​

ParameterType
params?GetDcdOrderHistoryRequest

Returns ​

Promise<DcdOrderHistoryItem[]>


getDcdOrderStatus() ​

ts
getDcdOrderStatus(params: GetDcdOrderStatusRequest): Promise<DcdOrderStatus[]>;

Parameters ​

ParameterType
paramsGetDcdOrderStatusRequest

Returns ​

Promise<DcdOrderStatus[]>


getDcdProducts() ​

ts
getDcdProducts(params: GetDcdProductsRequest): Promise<DcdProduct[]>;

Parameters ​

ParameterType
paramsGetDcdProductsRequest

Returns ​

Promise<DcdProduct[]>


getDeliveryExerciseHistory() ​

ts
getDeliveryExerciseHistory(params: any): Promise<any[]>;

Parameters ​

ParameterType
paramsany

Returns ​

Promise<any[]>


getDeltaHedgeCurrencies() ​

ts
getDeltaHedgeCurrencies(params?: object): Promise<DeltaHedgeCurrency[]>;

Parameters ​

ParameterType
params?{ ccy?: string; }
params.ccy?string

Returns ​

Promise<DeltaHedgeCurrency[]>


getDepositAddress() ​

ts
getDepositAddress(params: object): Promise<any[]>;

Parameters ​

ParameterType
params{ ccy: string; }
params.ccystring

Returns ​

Promise<any[]>


getDepositHistory() ​

ts
getDepositHistory(params?: GetDepositHistoryRequest): Promise<DepositHistory[]>;

Parameters ​

ParameterType
params?GetDepositHistoryRequest

Returns ​

Promise<DepositHistory[]>


getDepositWithdrawStatus() ​

ts
getDepositWithdrawStatus(params: GetDepositWithdrawStatusRequest): Promise<any[]>;

Parameters ​

ParameterType
paramsGetDepositWithdrawStatusRequest

Returns ​

Promise<any[]>


getDiscountRateAndInterestFreeQuota() ​

ts
getDiscountRateAndInterestFreeQuota(params: any): Promise<any[]>;

Parameters ​

ParameterType
paramsany

Returns ​

Promise<any[]>


getEasyConvertCurrencies() ​

ts
getEasyConvertCurrencies(params?: object): Promise<any>;

Get easy convert currency list

Parameters ​

ParameterType
params?{ source?: string; }
params.source?string

Returns ​

Promise<any>


getEasyConvertHistory() ​

ts
getEasyConvertHistory(params?: Pagination): Promise<APIResponse<any>>;

Get easy convert history : Get the history and status of easy convert trades.

Parameters ​

ParameterType
params?Pagination

Returns ​

Promise<APIResponse<any>>


getEconomicCalendar() ​

ts
getEconomicCalendar(params: EconomicCalendarRequest): Promise<EconomicCalendarData[]>;

Parameters ​

ParameterType
paramsEconomicCalendarRequest

Returns ​

Promise<EconomicCalendarData[]>


getEstimatedDeliveryExercisePrice() ​

ts
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 ​

ParameterType
params{ instId: string; }
params.instIdstring

Returns ​

Promise<EstimatedDeliveryExercisePrice[]>


getETHStakingBalance() ​

ts
getETHStakingBalance(): Promise<any[]>;

Returns ​

Promise<any[]>


getETHStakingHistory() ​

ts
getETHStakingHistory(params: object): Promise<any[]>;

Parameters ​

ParameterType
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() ​

ts
getETHStakingProductInfo(): Promise<EthStakingProductInfo[]>;

Financial product - ETH staking endpoints

Returns ​

Promise<EthStakingProductInfo[]>


getEventContractEvents() ​

ts
getEventContractEvents(params: GetEventContractEventsRequest): Promise<EventContractEvent[]>;

Events for a series. Public (no auth required since 2026-05-19).

Parameters ​

ParameterType
paramsGetEventContractEventsRequest

Returns ​

Promise<EventContractEvent[]>

See ​

GET /api/v5/public/event-contract/events


getEventContractMarkets() ​

ts
getEventContractMarkets(params: GetEventContractMarketsRequest): Promise<EventContractMarket[]>;

Markets for events. Public (no auth required since 2026-05-19).

Parameters ​

ParameterType
paramsGetEventContractMarketsRequest

Returns ​

Promise<EventContractMarket[]>

See ​

GET /api/v5/public/event-contract/markets


getEventContractSeries() ​

ts
getEventContractSeries(params?: GetEventContractSeriesRequest): Promise<EventContractSeries[]>;

Prediction / event contract series. Public (no auth required since 2026-05-19).

Parameters ​

ParameterType
params?GetEventContractSeriesRequest

Returns ​

Promise<EventContractSeries[]>

See ​

GET /api/v5/public/event-contract/series


getExchangeRate() ​

ts
getExchangeRate(): Promise<any[]>;

Returns ​

Promise<any[]>


getExchanges() ​

ts
getExchanges(): Promise<any[]>;

Returns ​

Promise<any[]>


getFeeRates() ​

ts
getFeeRates(params: object): Promise<AccountFeeRate[]>;

Parameters ​

ParameterType
params{ groupId?: string; instFamily?: string; instId?: string; instType: InstrumentType; ruleType?: string; uly?: string; }
params.groupId?string
params.instFamily?string
params.instId?string
params.instTypeInstrumentType
params.ruleType?string
params.uly?string

Returns ​

Promise<AccountFeeRate[]>


getFills() ​

ts
getFills(params?: FillsHistoryRequest): Promise<OrderFill[]>;

Get filled transaction details from the last 3 days.

Parameters ​

ParameterType
params?FillsHistoryRequest

Returns ​

Promise<OrderFill[]>

See ​

Order management


getFillsHistory() ​

ts
getFillsHistory(params: FillsHistoryRequest): Promise<OrderFill[]>;

Get history for last 3 months

Parameters ​

ParameterType
paramsFillsHistoryRequest

Returns ​

Promise<OrderFill[]>


getFixedLoanBorrowLimit() ​

ts
getFixedLoanBorrowLimit(): Promise<FixedLoanBorrowingLimit[]>;

Returns ​

Promise<FixedLoanBorrowingLimit[]>


getFixedLoanBorrowOrders() ​

ts
getFixedLoanBorrowOrders(params: GetFixedLoanBorrowingOrdersListRequest): Promise<any[]>;

Parameters ​

ParameterType
paramsGetFixedLoanBorrowingOrdersListRequest

Returns ​

Promise<any[]>


getFixedLoanBorrowQuote() ​

ts
getFixedLoanBorrowQuote(params: GetFixedLoanBorrowQuoteRequest): Promise<FixedLoanBorrowQuote[]>;

Parameters ​

ParameterType
paramsGetFixedLoanBorrowQuoteRequest

Returns ​

Promise<FixedLoanBorrowQuote[]>


getFullOrderBook() ​

ts
getFullOrderBook(params: object): Promise<OrderBook[]>;

Parameters ​

ParameterType
params{ instId: string; sz?: string; }
params.instIdstring
params.sz?string

Returns ​

Promise<OrderBook[]>


getFundingRate() ​

ts
getFundingRate(params: GetFundingRateRequest): Promise<PublicFundingRate[]>;

Parameters ​

ParameterType
paramsGetFundingRateRequest

Returns ​

Promise<PublicFundingRate[]>


getFundingRateHistory() ​

ts
getFundingRateHistory(params: FundingRateRequest): Promise<FundingRateHistory[]>;

Parameters ​

ParameterType
paramsFundingRateRequest

Returns ​

Promise<FundingRateHistory[]>


getFundsTransferState() ​

ts
getFundsTransferState(params?: object): Promise<FundTransferState[]>;

Either parameter transId or clientId is required.

Parameters ​

ParameterType
params?{ clientId?: string; transId?: string; type?: "0" | "1" | "2"; }
params.clientId?string
params.transId?string
params.type?"0" | "1" | "2"

Returns ​

Promise<FundTransferState[]>


getGlpHistoricalPerformance() ​

ts
getGlpHistoricalPerformance(params: GetGlpHistoricalPerformanceRequest): Promise<GlpHistoricalPerformanceItem[]>;

Parameters ​

ParameterType
paramsGetGlpHistoricalPerformanceRequest

Returns ​

Promise<GlpHistoricalPerformanceItem[]>


getGlpTodayPerformance() ​

ts
getGlpTodayPerformance(): Promise<GlpTodayPerformance[]>;

GLP performance endpoints (market makers)

Returns ​

Promise<GlpTodayPerformance[]>


getGlpV2AssessmentDetails() ​

ts
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 ​

ParameterType
paramsGetGlpV2AssessmentDetailsRequest

Returns ​

Promise<GlpV2AssessmentDetails[]>

See ​

GET /api/v5/users/glp/v2/details


getGlpV2Overview() ​

ts
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() ​

ts
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 ​

ParameterType
paramsGetGlpV2PerformanceHistoryRequest

Returns ​

Promise<GlpV2PerformanceHistory[]>

See ​

GET /api/v5/users/glp/v2/history/performance


getGreeks() ​

ts
getGreeks(params?: object): Promise<any[]>;

Parameters ​

ParameterType
params?{ ccy?: string; }
params.ccy?string

Returns ​

Promise<any[]>


getGridAIParameter() ​

ts
getGridAIParameter(params: object): Promise<any[]>;

Parameters ​

ParameterType
params{ algoOrdType: GridAlgoOrderType; direction: ContractGridDirection; duration?: "30D" | "7D" | "180D"; instId: string; }
params.algoOrdTypeGridAlgoOrderType
params.directionContractGridDirection
params.duration?"30D" | "7D" | "180D"
params.instIdstring

Returns ​

Promise<any[]>


getGridAlgoOrderDetails() ​

ts
getGridAlgoOrderDetails(params: object): Promise<any[]>;

Parameters ​

ParameterType
params{ algoId: string; algoOrdType: GridAlgoOrderType; }
params.algoIdstring
params.algoOrdTypeGridAlgoOrderType

Returns ​

Promise<any[]>


getGridAlgoOrderHistory() ​

ts
getGridAlgoOrderHistory(params: GetGridAlgoOrdersRequest): Promise<any[]>;

Parameters ​

ParameterType
paramsGetGridAlgoOrdersRequest

Returns ​

Promise<any[]>


getGridAlgoOrderList() ​

ts
getGridAlgoOrderList(params: GetGridAlgoOrdersRequest): Promise<any[]>;

Parameters ​

ParameterType
paramsGetGridAlgoOrdersRequest

Returns ​

Promise<any[]>


getGridAlgoOrderPositions() ​

ts
getGridAlgoOrderPositions(params: object): Promise<any[]>;

Parameters ​

ParameterType
params{ algoId: string; algoOrdType: "contract_grid"; }
params.algoIdstring
params.algoOrdType"contract_grid"

Returns ​

Promise<any[]>


getGridAlgoSubOrders() ​

ts
getGridAlgoSubOrders(params: object): Promise<any[]>;

Parameters ​

ParameterType
params{ after?: string; algoId: string; algoOrdType: GridAlgoOrderType; before?: string; groupId?: string; limit?: number; type: GridAlgoSubOrderType; }
params.after?string
params.algoIdstring
params.algoOrdTypeGridAlgoOrderType
params.before?string
params.groupId?string
params.limit?number
params.typeGridAlgoSubOrderType

Returns ​

Promise<any[]>


getHistoricalMarketData() ​

ts
getHistoricalMarketData(params: GetHistoricalMarketDataRequest): Promise<MarketDataHistoryResult[]>;

Parameters ​

ParameterType
paramsGetHistoricalMarketDataRequest

Returns ​

Promise<MarketDataHistoryResult[]>


getHistoricCandles() ​

ts
getHistoricCandles(params: CandleRequest): Promise<Candle[]>;

Parameters ​

ParameterType
paramsCandleRequest

Returns ​

Promise<Candle[]>


getHistoricIndexCandles() ​

ts
getHistoricIndexCandles(params: CandleRequest): Promise<CandleNoVolume[]>;

Parameters ​

ParameterType
paramsCandleRequest

Returns ​

Promise<CandleNoVolume[]>


getHistoricMarkPriceCandles() ​

ts
getHistoricMarkPriceCandles(params: CandleRequest): Promise<CandleNoVolume[]>;

Parameters ​

ParameterType
paramsCandleRequest

Returns ​

Promise<CandleNoVolume[]>


getHistoricTrades() ​

ts
getHistoricTrades(params: object): Promise<Trade[]>;

Parameters ​

ParameterType
params{ after?: string; before?: string; instId: string; limit?: string; type?: "1" | "2"; }
params.after?string
params.before?string
params.instIdstring
params.limit?string
params.type?"1" | "2"

Returns ​

Promise<Trade[]>


getIndexCandles() ​

ts
getIndexCandles(params: CandleRequest): Promise<CandleNoVolume[]>;

Parameters ​

ParameterType
paramsCandleRequest

Returns ​

Promise<CandleNoVolume[]>


getIndexComponents() ​

ts
getIndexComponents(params: object): Promise<any[]>;

Parameters ​

ParameterType
params{ index: string; }
params.indexstring

Returns ​

Promise<any[]>


getIndexTickers() ​

ts
getIndexTickers(params?: object): Promise<IndexTicker[]>;

Parameters ​

ParameterType
params?{ instId?: string; quoteCcy?: string; }
params.instId?string
params.quoteCcy?string

Returns ​

Promise<IndexTicker[]>


getInstruments() ​

ts
getInstruments(params: GetInstrumentsRequest): Promise<Instrument[]>;

Public data - rest endpoints

Parameters ​

ParameterType
paramsGetInstrumentsRequest

Returns ​

Promise<Instrument[]>


getInsuranceFund() ​

ts
getInsuranceFund(params?: GetInsuranceFundRequest): Promise<InsuranceFund[]>;

Parameters ​

ParameterType
params?GetInsuranceFundRequest

Returns ​

Promise<InsuranceFund[]>


getInterestAccrued() ​

ts
getInterestAccrued(params?: object): Promise<InterestAccrued[]>;

Parameters ​

ParameterType
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() ​

ts
getInterestRate(params?: object): Promise<InterestRate[]>;

Parameters ​

ParameterType
params?{ ccy?: string; }
params.ccy?string

Returns ​

Promise<InterestRate[]>


getInterestRateAndLoanQuota() ​

ts
getInterestRateAndLoanQuota(): Promise<InterestRateAndLoanQuota[]>;

Returns ​

Promise<InterestRateAndLoanQuota[]>


getLendingAPYHistory() ​

ts
getLendingAPYHistory(params: object): Promise<any[]>;

Parameters ​

ParameterType
params{ ccy: string; term: string; }
params.ccystring
params.termstring

Returns ​

Promise<any[]>


getLendingHistory() ​

ts
getLendingHistory(params?: PaginatedSymbolRequest): Promise<any[]>;

Parameters ​

ParameterType
params?PaginatedSymbolRequest

Returns ​

Promise<any[]>


getLendingOffers() ​

ts
getLendingOffers(params?: object): Promise<any[]>;

Financial product - simple earn fixed endpoints

Parameters ​

ParameterType
params?{ ccy?: string; term?: string; }
params.ccy?string
params.term?string

Returns ​

Promise<any[]>


getLendingOrders() ​

ts
getLendingOrders(params: GetLendingOrderListRequest): Promise<any[]>;

Parameters ​

ParameterType
paramsGetLendingOrderListRequest

Returns ​

Promise<any[]>


getLendingSubOrders() ​

ts
getLendingSubOrders(params: GetLendingSubOrderListRequest): Promise<any[]>;

Parameters ​

ParameterType
paramsGetLendingSubOrderListRequest

Returns ​

Promise<any[]>


getLendingVolume() ​

ts
getLendingVolume(params: object): Promise<any[]>;

Parameters ​

ParameterType
params{ ccy: string; term: string; }
params.ccystring
params.termstring

Returns ​

Promise<any[]>


getLeverage() ​

ts
getLeverage(params: object): Promise<AccountLeverage[]>;

Parameters ​

ParameterType
params{ ccy?: string; instId?: string; mgnMode: MarginMode; }
params.ccy?string
params.instId?string
params.mgnModeMarginMode

Returns ​

Promise<AccountLeverage[]>


getLeverageEstimatedInfo() ​

ts
getLeverageEstimatedInfo(params: object): Promise<AdjustLeverageInfo[]>;

Parameters ​

ParameterType
params{ ccy?: string; instId?: string; instType: string; lever: string; mgnMode: MarginMode; posSide: PositionSide; }
params.ccy?string
params.instId?string
params.instTypestring
params.leverstring
params.mgnModeMarginMode
params.posSidePositionSide

Returns ​

Promise<AdjustLeverageInfo[]>


getLeverageV2() ​

ts
getLeverageV2(params: object): Promise<AccountLeverage[]>;

Parameters ​

ParameterType
params{ ccy?: string; instId?: string; mgnMode: MarginMode; }
params.ccy?string
params.instId?string
params.mgnModeMarginMode

Returns ​

Promise<AccountLeverage[]>

Deprecated ​

Use getLeverage() instead. Both methods call the same leverage-info endpoint in SDK 3.2.9.


getLightningDeposits() ​

ts
getLightningDeposits(params: object): Promise<any[]>;

Parameters ​

ParameterType
params{ amt: string; ccy: string; to?: "6" | "18"; }
params.amtstring
params.ccystring
params.to?"6" | "18"

Returns ​

Promise<any[]>


getLoanHistory() ​

ts
getLoanHistory(params?: LoanHistoryRequest): Promise<LoanHistoryItem[]>;

Parameters ​

ParameterType
params?LoanHistoryRequest

Returns ​

Promise<LoanHistoryItem[]>


getLoanInfo() ​

ts
getLoanInfo(params?: GetLoanInfoRequest): Promise<LoanInfo[]>;

Parameters ​

ParameterType
params?GetLoanInfoRequest

Returns ​

Promise<LoanInfo[]>


getLongShortContractRatio() ​

ts
getLongShortContractRatio(params: GetTopTradersContractLongShortRatioRequest): Promise<any[]>;

Parameters ​

ParameterType
paramsGetTopTradersContractLongShortRatioRequest

Returns ​

Promise<any[]>


getLongShortRatio() ​

ts
getLongShortRatio(params: object): Promise<any[]>;

Parameters ​

ParameterType
params{ begin?: string; ccy: string; end?: string; period: "5m" | "1H" | "1D"; }
params.begin?string
params.ccystring
params.end?string
params.period"5m" | "1H" | "1D"

Returns ​

Promise<any[]>


getManagedSubAccountTransferHistory() ​

ts
getManagedSubAccountTransferHistory(params: GetManagedSubAccountTransferHistoryRequest): Promise<ManagedSubAccountTransfer[]>;

Parameters ​

ParameterType
paramsGetManagedSubAccountTransferHistoryRequest

Returns ​

Promise<ManagedSubAccountTransfer[]>


getMarginLendingRatio() ​

ts
getMarginLendingRatio(params: object): Promise<any[]>;

Parameters ​

ParameterType
params{ begin?: string; ccy: string; end?: string; period: "5m" | "1H" | "1D"; }
params.begin?string
params.ccystring
params.end?string
params.period"5m" | "1H" | "1D"

Returns ​

Promise<any[]>


getMarkPrice() ​

ts
getMarkPrice(params: any): Promise<any[]>;

Parameters ​

ParameterType
paramsany

Returns ​

Promise<any[]>


getMarkPriceCandles() ​

ts
getMarkPriceCandles(params: CandleRequest): Promise<CandleNoVolume[]>;

Parameters ​

ParameterType
paramsCandleRequest

Returns ​

Promise<CandleNoVolume[]>


getMaxAvailableTradableAmount() ​

ts
getMaxAvailableTradableAmount(params: object): Promise<AccountMaxTradableAmount[]>;

Parameters ​

ParameterType
params{ ccy?: string; instId: string; reduceOnly?: boolean; tdMode: "cross" | "isolated" | "cash"; unSpotOffset?: boolean; }
params.ccy?string
params.instIdstring
params.reduceOnly?boolean
params.tdMode"cross" | "isolated" | "cash"
params.unSpotOffset?boolean

Returns ​

Promise<AccountMaxTradableAmount[]>


getMaxBuySellAmount() ​

ts
getMaxBuySellAmount(params: object): Promise<AccountMaxOrderAmount[]>;

Max buy/sell amount or open amount

Parameters ​

ParameterTypeDescription
params{ ccy?: string; instId: string; leverage?: string; outcome?: string; px?: string; tdMode: "cross" | "isolated" | "cash"; unSpotOffset?: boolean; }-
params.ccy?string-
params.instIdstring-
params.leverage?string-
params.outcome?stringMarket 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() ​

ts
getMaxGridQuantity(params: MaxGridQuantityRequest): Promise<object[]>;

Parameters ​

ParameterType
paramsMaxGridQuantityRequest

Returns ​

Promise<object[]>


getMaxLoan() ​

ts
getMaxLoan(params: object): Promise<AccountMaxLoan[]>;

Parameters ​

ParameterType
params{ ccy?: string; instId: string; mgnCcy?: string; mgnMode: MarginMode; }
params.ccy?string
params.instIdstring
params.mgnCcy?string
params.mgnModeMarginMode

Returns ​

Promise<AccountMaxLoan[]>


getMaxLoanAmount() ​

ts
getMaxLoanAmount(params: MaxLoanRequest): Promise<MaxLoanResponse[]>;

Parameters ​

ParameterType
paramsMaxLoanRequest

Returns ​

Promise<MaxLoanResponse[]>


getMaxWithdrawals() ​

ts
getMaxWithdrawals(params?: object): Promise<MaxWithdrawal[]>;

Parameters ​

ParameterType
params?{ ccy?: string; }
params.ccy?string

Returns ​

Promise<MaxWithdrawal[]>


getMinMaxLimitPrice() ​

ts
getMinMaxLimitPrice(params: any): Promise<any[]>;

Parameters ​

ParameterType
paramsany

Returns ​

Promise<any[]>


getMmInstrumentTypes() ​

ts
getMmInstrumentTypes(params?: object): Promise<MmInstrumentType[]>;

Parameters ​

ParameterType
params?{ instId?: string; instType?: "SPOT" | "SWAP"; }
params.instId?string
params.instType?"SPOT" | "SWAP"

Returns ​

Promise<MmInstrumentType[]>


getMMPConfig() ​

ts
getMMPConfig(params?: object): Promise<MMPConfig[]>;

Parameters ​

ParameterType
params?{ instFamily?: string; }
params.instFamily?string

Returns ​

Promise<MMPConfig[]>


getMonthlyStatement() ​

ts
getMonthlyStatement(params: object): Promise<any[]>;

Parameters ​

ParameterType
params{ month: string; }
params.monthstring

Returns ​

Promise<any[]>


getMovePositionsHistory() ​

ts
getMovePositionsHistory(params?: GetMovePositionsHistoryRequest): Promise<MovePositionsResult[]>;

Move position history for the last 3 days (VIP6+).

Parameters ​

ParameterType
params?GetMovePositionsHistoryRequest

Returns ​

Promise<MovePositionsResult[]>

See ​

GET /api/v5/account/move-positions-history


getNonTradableAssets() ​

ts
getNonTradableAssets(params?: object): Promise<NonTradableAsset[]>;

Parameters ​

ParameterType
params?{ ccy?: string; }
params.ccy?string

Returns ​

Promise<NonTradableAsset[]>


getOkusdLimits() ​

ts
getOkusdLimits(): Promise<OkusdLimits[]>;

Financial product — OKUSD endpoints

Returns ​

Promise<OkusdLimits[]>


getOneClickRepayCurrencyList() ​

ts
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 ​

ParameterType
params?{ debtType?: "cross" | "isolated"; }
params.debtType?"cross" | "isolated"

Returns ​

Promise<APIResponse<any>>


getOneClickRepayHistory() ​

ts
getOneClickRepayHistory(params?: Pagination): Promise<APIResponse<any>>;

Get the history and status of one-click repay trades.

Parameters ​

ParameterType
params?Pagination

Returns ​

Promise<APIResponse<any>>


getOpenInterest() ​

ts
getOpenInterest(params: any): Promise<any[]>;

Parameters ​

ParameterType
paramsany

Returns ​

Promise<any[]>


getOpenInterestAndVolumeExpiry() ​

ts
getOpenInterestAndVolumeExpiry(params: object): Promise<any[]>;

Parameters ​

ParameterType
params{ ccy: string; period: "1D" | "8H"; }
params.ccystring
params.period"1D" | "8H"

Returns ​

Promise<any[]>


getOpenInterestAndVolumeStrike() ​

ts
getOpenInterestAndVolumeStrike(params: object): Promise<any[]>;

Parameters ​

ParameterType
params{ ccy: string; expTime: string; period?: "1D" | "8H"; }
params.ccystring
params.expTimestring
params.period?"1D" | "8H"

Returns ​

Promise<any[]>


getOpenInterestHistory() ​

ts
getOpenInterestHistory(params: GetContractOpenInterestHistoryRequest): Promise<any[]>;

Parameters ​

ParameterType
paramsGetContractOpenInterestHistoryRequest

Returns ​

Promise<any[]>


getOptionMarketData() ​

ts
getOptionMarketData(params: any): Promise<any[]>;

Parameters ​

ParameterType
paramsany

Returns ​

Promise<any[]>


getOptionsOpenInterestAndVolume() ​

ts
getOptionsOpenInterestAndVolume(params: object): Promise<any[]>;

Parameters ​

ParameterType
params{ ccy: string; period: "1D" | "8H"; }
params.ccystring
params.period"1D" | "8H"

Returns ​

Promise<any[]>


getOptionTickBands() ​

ts
getOptionTickBands(params: object): Promise<any[]>;

Parameters ​

ParameterType
params{ instFamily?: string; instType: string; }
params.instFamily?string
params.instTypestring

Returns ​

Promise<any[]>


getOptionTrades() ​

ts
getOptionTrades(params: GetOptionTradesRequest): Promise<OptionTrades[]>;

Parameters ​

ParameterType
paramsGetOptionTradesRequest

Returns ​

Promise<OptionTrades[]>


getOptionTradesByInstrument() ​

ts
getOptionTradesByInstrument(params: object): Promise<OptionTrade[]>;

Parameters ​

ParameterType
params{ instFamily: string; }
params.instFamilystring

Returns ​

Promise<OptionTrade[]>


getOracle() ​

ts
getOracle(): Promise<any[]>;

Returns ​

Promise<any[]>


getOrderBook() ​

ts
getOrderBook(params: object): Promise<OrderBook[]>;

Parameters ​

ParameterType
params{ instId: string; sz?: string; }
params.instIdstring
params.sz?string

Returns ​

Promise<OrderBook[]>

See ​

Read an order book


getOrderDetails() ​

ts
getOrderDetails(params: OrderIdRequest): Promise<OrderDetails[]>;

Parameters ​

ParameterType
paramsOrderIdRequest

Returns ​

Promise<OrderDetails[]>

See ​

Order management


getOrderHistory() ​

ts
getOrderHistory(params: OrderHistoryRequest): Promise<HistoricOrder[]>;

Get history for last 7 days

Parameters ​

ParameterType
paramsOrderHistoryRequest

Returns ​

Promise<HistoricOrder[]>

See ​

Order management


getOrderHistoryArchive() ​

ts
getOrderHistoryArchive(params: OrderHistoryRequest): Promise<HistoricOrder[]>;

Get history for last 3 months

Parameters ​

ParameterType
paramsOrderHistoryRequest

Returns ​

Promise<HistoricOrder[]>


getOrderList() ​

ts
getOrderList(params?: OrderHistoryRequest): Promise<OrderListItem[]>;

Parameters ​

ParameterType
params?OrderHistoryRequest

Returns ​

Promise<OrderListItem[]>

See ​

Order management


getPMLimitation() ​

ts
getPMLimitation(params: object): Promise<any[]>;

Parameters ​

ParameterType
params{ instFamily?: string; instType: "SWAP" | "FUTURES" | "OPTION"; uly?: string; }
params.instFamily?string
params.instType"SWAP" | "FUTURES" | "OPTION"
params.uly?string

Returns ​

Promise<any[]>


getPositions() ​

ts
getPositions(params?: GetPositionsParams): Promise<AccountPosition[]>;

Parameters ​

ParameterType
params?GetPositionsParams

Returns ​

Promise<AccountPosition[]>


getPositionsHistory() ​

ts
getPositionsHistory(params?: GetHistoricPositionParams): Promise<HistoricAccountPosition[]>;

Parameters ​

ParameterType
params?GetHistoricPositionParams

Returns ​

Promise<HistoricAccountPosition[]>


getPositionTiers() ​

ts
getPositionTiers(params: any): Promise<any[]>;

Parameters ​

ParameterType
paramsany

Returns ​

Promise<any[]>


getPremiumHistory() ​

ts
getPremiumHistory(params: GetPremiumHistoryRequest): Promise<any[]>;

Parameters ​

ParameterType
paramsGetPremiumHistoryRequest

Returns ​

Promise<any[]>


getPrivate() ​

ts
getPrivate(endpoint: string, params?: any): Promise<any>;

Parameters ​

ParameterType
endpointstring
params?any

Returns ​

Promise<any>

Inherited from ​

BaseRestClient.getPrivate


getPublicBlockTrades() ​

ts
getPublicBlockTrades(params: object): Promise<any[]>;

Parameters ​

ParameterType
params{ instId: string; }
params.instIdstring

Returns ​

Promise<any[]>


getPublicBorrowHistory() ​

ts
getPublicBorrowHistory(params?: PaginatedSymbolRequest): Promise<PublicBorrowHistoryRecord[]>;

Parameters ​

ParameterType
params?PaginatedSymbolRequest

Returns ​

Promise<PublicBorrowHistoryRecord[]>


getPublicBorrowInfo() ​

ts
getPublicBorrowInfo(params?: object): Promise<any[]>;

Parameters ​

ParameterType
params?{ ccy?: string; }
params.ccy?string

Returns ​

Promise<any[]>


getPublicRFQBlockTrades() ​

ts
getPublicRFQBlockTrades(params?: any): Promise<PublicBlockTrade[]>;

Parameters ​

ParameterType
params?any

Returns ​

Promise<PublicBlockTrade[]>


getPutCallRatio() ​

ts
getPutCallRatio(params: object): Promise<any[]>;

Parameters ​

ParameterType
params{ ccy: string; period: "1D" | "8H"; }
params.ccystring
params.period"1D" | "8H"

Returns ​

Promise<any[]>


getQuickMarginBorrowRepayHistory() ​

ts
getQuickMarginBorrowRepayHistory(params: GetQuickMarginBorrowRepayHistoryRequest): Promise<QuickMarginBorrowRepayRecord[]>;

Parameters ​

ParameterType
paramsGetQuickMarginBorrowRepayHistoryRequest

Returns ​

Promise<QuickMarginBorrowRepayRecord[]>


getQuoteProducts() ​

ts
getQuoteProducts(): Promise<BlockMakerInstrumentSettings[]>;

Returns ​

Promise<BlockMakerInstrumentSettings[]>


getRecurringBuyOrderDetails() ​

ts
getRecurringBuyOrderDetails(params: object): Promise<RecurringBuyOrder[]>;

Parameters ​

ParameterType
params{ algoId: string; }
params.algoIdstring

Returns ​

Promise<RecurringBuyOrder[]>


getRecurringBuyOrderHistory() ​

ts
getRecurringBuyOrderHistory(params: GetRecurringBuyOrderListRequest): Promise<RecurringBuyOrder[]>;

Parameters ​

ParameterType
paramsGetRecurringBuyOrderListRequest

Returns ​

Promise<RecurringBuyOrder[]>


getRecurringBuyOrders() ​

ts
getRecurringBuyOrders(params: GetRecurringBuyOrderListRequest): Promise<RecurringBuyOrder[]>;

Parameters ​

ParameterType
paramsGetRecurringBuyOrderListRequest

Returns ​

Promise<RecurringBuyOrder[]>


getRecurringBuySubOrders() ​

ts
getRecurringBuySubOrders(params: GetRecurringBuyOrderListRequest): Promise<RecurringBuySubOrder[]>;

Parameters ​

ParameterType
paramsGetRecurringBuyOrderListRequest

Returns ​

Promise<RecurringBuySubOrder[]>


ts
getRequestedBillsHistoryLink(params: BillsHistoryArchiveRequest): Promise<AccountHistoryBill[]>;

This endpoint returns the link to the bill data which you can request using requestBillsHistoryDownloadLink.

Parameters ​

ParameterType
paramsBillsHistoryArchiveRequest

Returns ​

Promise<AccountHistoryBill[]>


getRpiOrderBook() ​

ts
getRpiOrderBook(params: object): Promise<OrderBookRpi[]>;

Parameters ​

ParameterType
params{ instId: string; sz?: string; }
params.instIdstring
params.sz?string

Returns ​

Promise<OrderBookRpi[]>


getRSIBackTesting() ​

ts
getRSIBackTesting(params: GetRSIBackTestingRequest): Promise<object[]>;

Parameters ​

ParameterType
paramsGetRSIBackTestingRequest

Returns ​

Promise<object[]>


getSavingBalance() ​

ts
getSavingBalance(params?: object): Promise<any[]>;

Financial product - simple earn flexible endpoints

Parameters ​

ParameterType
params?{ ccy?: string; }
params.ccy?string

Returns ​

Promise<any[]>


getServerTime() ​

ts
getServerTime(): Promise<number>;

OKX misc endpoints

Returns ​

Promise<number>


getSignalBotEventHistory() ​

ts
getSignalBotEventHistory(params: GetSignalBotEventHistoryRequest): Promise<any[]>;

Parameters ​

ParameterType
paramsGetSignalBotEventHistoryRequest

Returns ​

Promise<any[]>


getSignalBotHistory() ​

ts
getSignalBotHistory(params: GetSignalBotRequest): Promise<any[]>;

Parameters ​

ParameterType
paramsGetSignalBotRequest

Returns ​

Promise<any[]>


getSignalBotOrder() ​

ts
getSignalBotOrder(params: object): Promise<any[]>;

Parameters ​

ParameterType
params{ algoId: string; algoOrdType: string; }
params.algoIdstring
params.algoOrdTypestring

Returns ​

Promise<any[]>


getSignalBotPositionHistory() ​

ts
getSignalBotPositionHistory(params: GetSignalBotPositionHistoryRequest): Promise<any[]>;

Parameters ​

ParameterType
paramsGetSignalBotPositionHistoryRequest

Returns ​

Promise<any[]>


getSignalBotPositions() ​

ts
getSignalBotPositions(params: object): Promise<any[]>;

Parameters ​

ParameterType
params{ algoId: string; algoOrdType: string; }
params.algoIdstring
params.algoOrdTypestring

Returns ​

Promise<any[]>


getSignalBotSubOrders() ​

ts
getSignalBotSubOrders(params: GetSignalBotSubOrdersRequest): Promise<any[]>;

Parameters ​

ParameterType
paramsGetSignalBotSubOrdersRequest

Returns ​

Promise<any[]>


getSignals() ​

ts
getSignals(params: GetSignalsRequest): Promise<GetSignalsResult[]>;

Parameters ​

ParameterType
paramsGetSignalsRequest

Returns ​

Promise<GetSignalsResult[]>


getSOLStakingProductInfo() ​

ts
getSOLStakingProductInfo(): Promise<SolStakingProductInfo>;

Returns ​

Promise<SolStakingProductInfo>


getSpreadActiveOrders() ​

ts
getSpreadActiveOrders(params?: GetActiveSpreadOrdersRequest): Promise<SpreadOrder[]>;

Parameters ​

ParameterType
params?GetActiveSpreadOrdersRequest

Returns ​

Promise<SpreadOrder[]>


getSpreadCandles() ​

ts
getSpreadCandles(params: GetSpreadCandlesRequest): Promise<SpreadCandle[]>;

Parameters ​

ParameterType
paramsGetSpreadCandlesRequest

Returns ​

Promise<SpreadCandle[]>


getSpreadHistoryCandles() ​

ts
getSpreadHistoryCandles(params: GetSpreadCandlesRequest): Promise<SpreadCandle[]>;

Parameters ​

ParameterType
paramsGetSpreadCandlesRequest

Returns ​

Promise<SpreadCandle[]>


getSpreadOrder() ​

ts
getSpreadOrder(params: object): Promise<SpreadOrder[]>;

Parameters ​

ParameterType
params{ clOrdId?: string; ordId?: string; }
params.clOrdId?string
params.ordId?string

Returns ​

Promise<SpreadOrder[]>


getSpreadOrderBook() ​

ts
getSpreadOrderBook(params: object): Promise<SpreadOrderBook[]>;

Parameters ​

ParameterType
params{ sprdId: string; sz?: string; }
params.sprdIdstring
params.sz?string

Returns ​

Promise<SpreadOrderBook[]>


getSpreadOrdersArchive() ​

ts
getSpreadOrdersArchive(params?: GetSpreadOrderHistoryArchiveRequest): Promise<SpreadOrder[]>;

Parameters ​

ParameterType
params?GetSpreadOrderHistoryArchiveRequest

Returns ​

Promise<SpreadOrder[]>


getSpreadOrdersRecent() ​

ts
getSpreadOrdersRecent(params?: GetSpreadOrderHistoryRequest): Promise<SpreadOrder[]>;

Parameters ​

ParameterType
params?GetSpreadOrderHistoryRequest

Returns ​

Promise<SpreadOrder[]>


getSpreadPublicTrades() ​

ts
getSpreadPublicTrades(params?: object): Promise<PublicSpreadTrade[]>;

Parameters ​

ParameterType
params?{ sprdId?: string; }
params.sprdId?string

Returns ​

Promise<PublicSpreadTrade[]>


getSpreads() ​

ts
getSpreads(params?: GetSpreadsRequest): Promise<SpreadDetails[]>;

Parameters ​

ParameterType
params?GetSpreadsRequest

Returns ​

Promise<SpreadDetails[]>


getSpreadTicker() ​

ts
getSpreadTicker(params: object): Promise<SpreadTicker[]>;

Parameters ​

ParameterType
params{ sprdId: string; }
params.sprdIdstring

Returns ​

Promise<SpreadTicker[]>


getSpreadTrades() ​

ts
getSpreadTrades(params?: GetSpreadTradesRequest): Promise<SpreadTrade[]>;

Parameters ​

ParameterType
params?GetSpreadTradesRequest

Returns ​

Promise<SpreadTrade[]>


getStableRewardsApyHistory() ​

ts
getStableRewardsApyHistory(params: GetStableRewardsApyHistoryRequest): Promise<StableRewardsApyHistoryItem[]>;

Parameters ​

ParameterType
paramsGetStableRewardsApyHistoryRequest

Returns ​

Promise<StableRewardsApyHistoryItem[]>


getStableRewardsBalance() ​

ts
getStableRewardsBalance(params?: GetStableRewardsBalanceRequest): Promise<StableRewardsBalance[]>;

Parameters ​

ParameterType
params?GetStableRewardsBalanceRequest

Returns ​

Promise<StableRewardsBalance[]>


getStableRewardsProductInfo() ​

ts
getStableRewardsProductInfo(params: GetStableRewardsProductInfoRequest): Promise<StableRewardsProductInfo[]>;

Financial product — stable rewards endpoints

Parameters ​

ParameterType
paramsGetStableRewardsProductInfoRequest

Returns ​

Promise<StableRewardsProductInfo[]>

See ​

https://www.okx.com/docs-v5/en/ (2026-04-24 release)


getStableRewardsSubscribeRedeemHistory() ​

ts
getStableRewardsSubscribeRedeemHistory(params: GetStableRewardsSubscribeRedeemHistoryRequest): Promise<StableRewardsSubscribeRedeemHistoryItem[]>;

Parameters ​

ParameterType
paramsGetStableRewardsSubscribeRedeemHistoryRequest

Returns ​

Promise<StableRewardsSubscribeRedeemHistoryItem[]>

Deprecated ​

Decommissioned 2026-07-14. Use order book trading APIs.


getStakingOffers() ​

ts
getStakingOffers(params?: object): Promise<any[]>;

Get earn offers

Parameters ​

ParameterType
params?{ ccy?: string; productId?: string; protocolType?: "staking" | "defi"; }
params.ccy?string
params.productId?string
params.protocolType?"staking" | "defi"

Returns ​

Promise<any[]>


getStakingOrderHistory() ​

ts
getStakingOrderHistory(params?: object): Promise<any[]>;

Earn/staking get order history

Parameters ​

ParameterType
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() ​

ts
getSubAccountBalances(params: object): Promise<SubAccountBalances[]>;

Parameters ​

ParameterType
params{ subAcct: string; }
params.subAcctstring

Returns ​

Promise<SubAccountBalances[]>


getSubAccountBorrowInterestAndLimit() ​

ts
getSubAccountBorrowInterestAndLimit(params: object): Promise<any[]>;

Parameters ​

ParameterType
params{ ccy?: string; subAcct: string; }
params.ccy?string
params.subAcctstring

Returns ​

Promise<any[]>


getSubAccountCustodyTradingList() ​

ts
getSubAccountCustodyTradingList(params?: object): Promise<any[]>;

Parameters ​

ParameterType
params?{ subAcct?: string; }
params.subAcct?string

Returns ​

Promise<any[]>


getSubAccountFundingBalances() ​

ts
getSubAccountFundingBalances(params: object): Promise<FundingBalance[]>;

Parameters ​

ParameterType
params{ ccy?: string; subAcct: string; }
params.ccy?string
params.subAcctstring

Returns ​

Promise<FundingBalance[]>


getSubAccountList() ​

ts
getSubAccountList(params?: any): Promise<SubAccount[]>;

View sub-account list

Parameters ​

ParameterType
params?any

Returns ​

Promise<SubAccount[]>


getSubAccountMaxWithdrawal() ​

ts
getSubAccountMaxWithdrawal(params: GetSubAccountMaxWithdrawalsRequest): Promise<SubAccountMaxWithdrawal[]>;

Parameters ​

ParameterType
paramsGetSubAccountMaxWithdrawalsRequest

Returns ​

Promise<SubAccountMaxWithdrawal[]>


getSubAccountTransferHistory() ​

ts
getSubAccountTransferHistory(params?: object): Promise<any[]>;

History of sub-account transfer

Parameters ​

ParameterType
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() ​

ts
getSupportCoin(): Promise<any[]>;

Trading statistics - REST endpoints

Returns ​

Promise<any[]>


getSystemStatus() ​

ts
getSystemStatus(params: object): Promise<any[]>;

Status endpoints (public)

Parameters ​

ParameterType
params{ state?: "completed" | "canceled" | "ongoing" | "scheduled" | "pre_open"; }
params.state?"completed" | "canceled" | "ongoing" | "scheduled" | "pre_open"

Returns ​

Promise<any[]>


getSystemTime() ​

ts
getSystemTime(params: any): Promise<SystemTime[]>;

Parameters ​

ParameterType
paramsany

Returns ​

Promise<SystemTime[]>


getTakerFlow() ​

ts
getTakerFlow(params: object): Promise<any[]>;

Parameters ​

ParameterType
params{ ccy: string; period: "1D" | "8H"; }
params.ccystring
params.period"1D" | "8H"

Returns ​

Promise<any[]>


getTakerVolume() ​

ts
getTakerVolume(params: object): Promise<any[]>;

Parameters ​

ParameterType
params{ begin?: string; ccy: string; end?: string; instType: string; period?: string; }
params.begin?string
params.ccystring
params.end?string
params.instTypestring
params.period?string

Returns ​

Promise<any[]>


getTicker() ​

ts
getTicker(params: object): Promise<Ticker[]>;

Parameters ​

ParameterType
params{ instId: string; }
params.instIdstring

Returns ​

Promise<Ticker[]>

See ​

Read a public ticker


getTickers() ​

ts
getTickers(params: object): Promise<Ticker[]>;

Orderbook trading - Market data endpoints

Parameters ​

ParameterType
params{ instFamily?: string; instType: InstrumentType; uly?: string; }
params.instFamily?string
params.instTypeInstrumentType
params.uly?string

Returns ​

Promise<Ticker[]>


getTopTradersAccountRatio() ​

ts
getTopTradersAccountRatio(params: GetTopTradersContractLongShortRatioRequest): Promise<any[]>;

Parameters ​

ParameterType
paramsGetTopTradersContractLongShortRatioRequest

Returns ​

Promise<any[]>


getTopTradersContractPositionRatio() ​

ts
getTopTradersContractPositionRatio(params: GetTopTradersContractLongShortRatioRequest): Promise<any[]>;

Parameters ​

ParameterType
paramsGetTopTradersContractLongShortRatioRequest

Returns ​

Promise<any[]>


getTrades() ​

ts
getTrades(params: object): Promise<Trade[]>;

Parameters ​

ParameterType
params{ instId: string; limit?: number; }
params.instIdstring
params.limit?number

Returns ​

Promise<Trade[]>


getUnderlying() ​

ts
getUnderlying(params: any): Promise<any[]>;

Parameters ​

ParameterType
paramsany

Returns ​

Promise<any[]>


getUnitConvert() ​

ts
getUnitConvert(params: UnitConvertRequest): Promise<UnitConvertData[]>;

Parameters ​

ParameterType
paramsUnitConvertRequest

Returns ​

Promise<UnitConvertData[]>


getVIPInterestAccrued() ​

ts
getVIPInterestAccrued(params: GetVIPInterestRequest): Promise<VIPInterest[]>;

Parameters ​

ParameterType
paramsGetVIPInterestRequest

Returns ​

Promise<VIPInterest[]>


getVIPInterestDeducted() ​

ts
getVIPInterestDeducted(params: GetVIPInterestRequest): Promise<VIPInterest[]>;

Parameters ​

ParameterType
paramsGetVIPInterestRequest

Returns ​

Promise<VIPInterest[]>


getVIPInterestRateAndLoanQuota() ​

ts
getVIPInterestRateAndLoanQuota(params: any): Promise<any[]>;

Parameters ​

ParameterType
paramsany

Returns ​

Promise<any[]>


getVIPLoanBorrowRepayHistory() ​

ts
getVIPLoanBorrowRepayHistory(params?: any): Promise<any[]>;

Parameters ​

ParameterType
params?any

Returns ​

Promise<any[]>


getVIPLoanOrder() ​

ts
getVIPLoanOrder(params: GetVIPLoanOrderDetailRequest): Promise<VIPLoanOrderDetail[]>;

Parameters ​

ParameterType
paramsGetVIPLoanOrderDetailRequest

Returns ​

Promise<VIPLoanOrderDetail[]>


getVIPLoanOrders() ​

ts
getVIPLoanOrders(params: GetVIPLoanOrderListRequest): Promise<VIPLoanOrder[]>;

Parameters ​

ParameterType
paramsGetVIPLoanOrderListRequest

Returns ​

Promise<VIPLoanOrder[]>


getWithdrawalHistory() ​

ts
getWithdrawalHistory(params?: WithdrawalHistoryRequest): Promise<any[]>;

Parameters ​

ParameterType
params?WithdrawalHistoryRequest

Returns ​

Promise<any[]>


instantTriggerGridAlgoOrder() ​

ts
instantTriggerGridAlgoOrder(params: object): Promise<object[]>;

Parameters ​

ParameterType
params{ algoId: string; }
params.algoIdstring

Returns ​

Promise<object[]>


manualBorrowRepay() ​

ts
manualBorrowRepay(params: object): Promise<object[]>;

Parameters ​

ParameterType
params{ amt: string; ccy: string; side: "borrow" | "repay"; }
params.amtstring
params.ccystring
params.side"borrow" | "repay"

Returns ​

Promise<object[]>


manualRenewFixedLoanBorrowOrder() ​

ts
manualRenewFixedLoanBorrowOrder(params: object): Promise<object[]>;

Parameters ​

ParameterType
params{ maxRate: string; ordId: string; }
params.maxRatestring
params.ordIdstring

Returns ​

Promise<object[]>


movePositions() ​

ts
movePositions(params: MovePositionsRequest): Promise<MovePositionsResult[]>;

Move positions between accounts under the same master account (VIP6+). TradeFi positions are not supported (error 70004).

Parameters ​

ParameterType
paramsMovePositionsRequest

Returns ​

Promise<MovePositionsResult[]>

See ​

POST /api/v5/account/move-positions — 2026-05-15 changelog


placeAlgoOrder() ​

ts
placeAlgoOrder(params: AlgoOrderRequest): Promise<AlgoOrderResult[]>;

Orderbook trading - Algo trading endpoints

Parameters ​

ParameterType
paramsAlgoOrderRequest

Returns ​

Promise<AlgoOrderResult[]>


placeGridAlgoOrder() ​

ts
placeGridAlgoOrder(params: GridAlgoOrderRequest): Promise<any[]>;

Orderbook trading - Grid trading endpoints

Parameters ​

ParameterType
paramsGridAlgoOrderRequest

Returns ​

Promise<any[]>


placeLendingOrder() ​

ts
placeLendingOrder(params: LendingOrder): Promise<any[]>;

Parameters ​

ParameterType
paramsLendingOrder

Returns ​

Promise<any[]>


placeSignalBotSubOrder() ​

ts
placeSignalBotSubOrder(params: PlaceSubOrderRequest): Promise<any[]>;

Parameters ​

ParameterType
paramsPlaceSubOrderRequest

Returns ​

Promise<any[]>


positionBuilder() ​

ts
positionBuilder(params: PositionBuilderRequest): Promise<any[]>;

Parameters ​

ParameterType
paramsPositionBuilderRequest

Returns ​

Promise<any[]>


post() ​

ts
post(endpoint: string, params?: any): Promise<any>;

Parameters ​

ParameterType
endpointstring
params?any

Returns ​

Promise<any>

Inherited from ​

BaseRestClient.post


postPrivate() ​

ts
postPrivate(endpoint: string, params?: any): Promise<any>;

Parameters ​

ParameterType
endpointstring
params?any

Returns ​

Promise<any>

Inherited from ​

BaseRestClient.postPrivate


precheckSetDeltaNeutral() ​

ts
precheckSetDeltaNeutral(params: PrecheckSetDeltaNeutralRequest): Promise<PrecheckSetDeltaNeutralResult[]>;

Parameters ​

ParameterType
paramsPrecheckSetDeltaNeutralRequest

Returns ​

Promise<PrecheckSetDeltaNeutralResult[]>


presetAccountLevelSwitch() ​

ts
presetAccountLevelSwitch(params: object): Promise<any[]>;

Parameters ​

ParameterType
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() ​

ts
purchaseETHStaking(params: object): Promise<any[]>;

Parameters ​

ParameterType
params{ amt: string; }
params.amtstring

Returns ​

Promise<any[]>


redeemETHStaking() ​

ts
redeemETHStaking(params: object): Promise<any[]>;

Parameters ​

ParameterType
params{ amt: string; }
params.amtstring

Returns ​

Promise<any[]>


redeemOkusd() ​

ts
redeemOkusd(params: RedeemOkusdRequest): Promise<OkusdRedeemResult[]>;

Parameters ​

ParameterType
paramsRedeemOkusdRequest

Returns ​

Promise<OkusdRedeemResult[]>


redeemStake() ​

ts
redeemStake(params: object): Promise<any[]>;

Parameters ​

ParameterType
params{ allowEarlyRedeem?: boolean; ordId: string; protocolType: "staking" | "defi"; }
params.allowEarlyRedeem?boolean
params.ordIdstring
params.protocolType"staking" | "defi"

Returns ​

Promise<any[]>


reduceFixedLoanLiabilities() ​

ts
reduceFixedLoanLiabilities(params: object): Promise<object[]>;

Parameters ​

ParameterType
params{ ordId: string; pendingRepay: boolean; }
params.ordIdstring
params.pendingRepayboolean

Returns ​

Promise<object[]>


repayFixedLoanBorrowOrder() ​

ts
repayFixedLoanBorrowOrder(params: object): Promise<object[]>;

Parameters ​

ParameterType
params{ ordId: string; }
params.ordIdstring

Returns ​

Promise<object[]>


ts
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 ​

ParameterType
paramsBillsHistoryArchiveRequest

Returns ​

Promise<AccountHistoryBill[]>


requestDcdQuote() ​

ts
requestDcdQuote(params: RequestDcdQuoteRequest): Promise<DcdQuote[]>;

Parameters ​

ParameterType
paramsRequestDcdQuoteRequest

Returns ​

Promise<DcdQuote[]>


requestDcdRedeemQuote() ​

ts
requestDcdRedeemQuote(params: RequestDcdRedeemQuoteRequest): Promise<DcdRedeemQuote[]>;

Parameters ​

ParameterType
paramsRequestDcdRedeemQuoteRequest

Returns ​

Promise<DcdRedeemQuote[]>


requestStableRewardsQuote() ​

ts
requestStableRewardsQuote(params: RequestStableRewardsQuoteRequest): Promise<StableRewardsQuote[]>;

Parameters ​

ParameterType
paramsRequestStableRewardsQuoteRequest

Returns ​

Promise<StableRewardsQuote[]>

Deprecated ​

Decommissioned 2026-07-14. Use order book trading APIs.


resetBlockMmp() ​

ts
resetBlockMmp(): Promise<object[]>;

Returns ​

Promise<object[]>


resetMMPStatus() ​

ts
resetMMPStatus(params: object): Promise<object[]>;

Parameters ​

ParameterType
params{ instFamily: string; instType?: "OPTION"; }
params.instFamilystring
params.instType?"OPTION"

Returns ​

Promise<object[]>


resetSubAccountAPIKey() ​

ts
resetSubAccountAPIKey(params: object): Promise<SubAccountAPIReset[]>;

Parameters ​

ParameterType
params{ apiKey: string; ip?: string; label?: string; perm?: string; subAcct: string; }
params.apiKeystring
params.ip?string
params.label?string
params.perm?string
params.subAcctstring

Returns ​

Promise<SubAccountAPIReset[]>


savingsPurchaseRedemption() ​

ts
savingsPurchaseRedemption(params: object): Promise<any[]>;

Parameters ​

ParameterType
params{ amt: string; ccy: string; rate: string; side: "purchase" | "redempt"; }
params.amtstring
params.ccystring
params.ratestring
params.side"purchase" | "redempt"

Returns ​

Promise<any[]>


setAccountCollateralAssets() ​

ts
setAccountCollateralAssets(params: object): Promise<object[]>;

Parameters ​

ParameterType
params{ ccyList?: string[]; collateralEnabled: boolean; type: "all" | "custom"; }
params.ccyList?string[]
params.collateralEnabledboolean
params.type"all" | "custom"

Returns ​

Promise<object[]>


setAccountMode() ​

ts
setAccountMode(params: object): Promise<AccountModeResult[]>;

Parameters ​

ParameterType
params{ acctLv: AccountLevel; }
params.acctLvAccountLevel

Returns ​

Promise<AccountModeResult[]>


setAutoLoan() ​

ts
setAutoLoan(params: object): Promise<AutoLoanResult[]>;

Parameters ​

ParameterType
params{ autoLoan: boolean; }
params.autoLoanboolean

Returns ​

Promise<AutoLoanResult[]>


setAutoRepay() ​

ts
setAutoRepay(params: object): Promise<object[]>;

Parameters ​

ParameterType
params{ autoRepay: boolean; }
params.autoRepayboolean

Returns ​

Promise<object[]>


setCopytradingBatchLeverage() ​

ts
setCopytradingBatchLeverage(params: SetCTBatchLeverageRequest): Promise<SetCTBatchLeverageResult[]>;

Parameters ​

ParameterType
paramsSetCTBatchLeverageRequest

Returns ​

Promise<SetCTBatchLeverageResult[]>


setCopytradingFirstCopy() ​

ts
setCopytradingFirstCopy(params: CopySettingsRequest): Promise<object[]>;

Parameters ​

ParameterType
paramsCopySettingsRequest

Returns ​

Promise<object[]>


setCopytradingInstruments() ​

ts
setCopytradingInstruments(params: object): Promise<object[]>;

Parameters ​

ParameterType
params{ instId: string; instType?: "SPOT" | "SWAP"; }
params.instIdstring
params.instType?"SPOT" | "SWAP"

Returns ​

Promise<object[]>


setFeeType() ​

ts
setFeeType(params: SetFeeTypeRequest): Promise<SetFeeTypeResult[]>;

Parameters ​

ParameterType
paramsSetFeeTypeRequest

Returns ​

Promise<SetFeeTypeResult[]>


setGreeksDisplayType() ​

ts
setGreeksDisplayType(params: object): Promise<Greeks[]>;

Parameters ​

ParameterType
params{ greeksType: "BS" | "PA"; }
params.greeksType"BS" | "PA"

Returns ​

Promise<Greeks[]>


setIsolatedMode() ​

ts
setIsolatedMode(params: object): Promise<AccountIsolatedMode[]>;

Parameters ​

ParameterType
params{ isoMode: "autonomy" | "automatic"; type: "MARGIN" | "CONTRACTS"; }
params.isoMode"autonomy" | "automatic"
params.type"MARGIN" | "CONTRACTS"

Returns ​

Promise<AccountIsolatedMode[]>


setLendingRate() ​

ts
setLendingRate(params: object): Promise<any[]>;

Parameters ​

ParameterType
params{ ccy: string; rate: string; }
params.ccystring
params.ratestring

Returns ​

Promise<any[]>


setLeverage() ​

ts
setLeverage(params: SetLeverageRequest): Promise<AccountLeverageResult[]>;

Parameters ​

ParameterType
paramsSetLeverageRequest

Returns ​

Promise<AccountLeverageResult[]>


setMMPConfig() ​

ts
setMMPConfig(params: SetMMPConfigRequest): Promise<SetMMPConfigResult[]>;

Parameters ​

ParameterType
paramsSetMMPConfigRequest

Returns ​

Promise<SetMMPConfigResult[]>


setPositionMode() ​

ts
setPositionMode(params: object): Promise<AccountPositionModeResult[]>;

Parameters ​

ParameterType
params{ posMode: PosMode; }
params.posModePosMode

Returns ​

Promise<AccountPositionModeResult[]>


setSettleCurrency() ​

ts
setSettleCurrency(params: SetSettleCurrencyRequest): Promise<SetSettleCurrencyResult[]>;

Parameters ​

ParameterType
paramsSetSettleCurrencyRequest

Returns ​

Promise<SetSettleCurrencyResult[]>


setSignalInstruments() ​

ts
setSignalInstruments(params: SetSignalInstrumentsRequest): Promise<object[]>;

Parameters ​

ParameterType
paramsSetSignalInstrumentsRequest

Returns ​

Promise<object[]>


setSubAccountLoanAllocation() ​

ts
setSubAccountLoanAllocation(params: SetSubAccountLoanAllocationRequest): Promise<object[]>;

Parameters ​

ParameterType
paramsSetSubAccountLoanAllocationRequest

Returns ​

Promise<object[]>


setSubAccountTransferOutPermission() ​

ts
setSubAccountTransferOutPermission(params: object): Promise<any[]>;

Parameters ​

ParameterType
params{ canTransOut: boolean; subAcct: string; }
params.canTransOutboolean
params.subAcctstring

Returns ​

Promise<any[]>


setTradingConfig() ​

ts
setTradingConfig(params: SetTradingConfigRequest): Promise<SetTradingConfigResult[]>;

Parameters ​

ParameterType
paramsSetTradingConfigRequest

Returns ​

Promise<SetTradingConfigResult[]>


spotGridWithdrawIncome() ​

ts
spotGridWithdrawIncome(params: object): Promise<any[]>;

Parameters ​

ParameterType
params{ algoId: string; }
params.algoIdstring

Returns ​

Promise<any[]>


stopCopytradingCopy() ​

ts
stopCopytradingCopy(params: object): Promise<object[]>;

Parameters ​

ParameterType
params{ instType?: "SWAP"; subPosCloseType: "market_close" | "copy_close" | "manual_close"; uniqueCode: string; }
params.instType?"SWAP"
params.subPosCloseType"market_close" | "copy_close" | "manual_close"
params.uniqueCodestring

Returns ​

Promise<object[]>


stopCopytradingLeadTrading() ​

ts
stopCopytradingLeadTrading(params?: object): Promise<object[]>;

Parameters ​

ParameterType
params?{ instType?: "SWAP"; }
params.instType?"SWAP"

Returns ​

Promise<object[]>


stopGridAlgoOrder() ​

ts
stopGridAlgoOrder(orders: StopGridAlgoOrderRequest[]): Promise<any[]>;

Parameters ​

ParameterType
ordersStopGridAlgoOrderRequest[]

Returns ​

Promise<any[]>


stopRecurringBuyOrder() ​

ts
stopRecurringBuyOrder(params: object): Promise<RecurringBuyOrderResult[]>;

Parameters ​

ParameterType
params{ algoId: string; }
params.algoIdstring

Returns ​

Promise<RecurringBuyOrderResult[]>


submitCopytradingAlgoOrder() ​

ts
submitCopytradingAlgoOrder(params: PlaceCTAlgoOrderRequest): Promise<PlaceCTAlgoOrderResult[]>;

Parameters ​

ParameterType
paramsPlaceCTAlgoOrderRequest

Returns ​

Promise<PlaceCTAlgoOrderResult[]>


submitDcdRedeem() ​

ts
submitDcdRedeem(params: SubmitDcdRedeemRequest): Promise<DcdRedeemResult[]>;

Parameters ​

ParameterType
paramsSubmitDcdRedeemRequest

Returns ​

Promise<DcdRedeemResult[]>


submitDcdTrade() ​

ts
submitDcdTrade(params: SubmitDcdTradeRequest): Promise<DcdTradeResult[]>;

Parameters ​

ParameterType
paramsSubmitDcdTradeRequest

Returns ​

Promise<DcdTradeResult[]>


submitEasyConvert() ​

ts
submitEasyConvert(params: object): Promise<APIResponse<any>>;

Convert small balances to a supported receiving currency, with up to five source currencies per request.

Parameters ​

ParameterType
params{ fromCcys: string[]; source?: string; toCcy: string; }
params.fromCcysstring[]
params.source?string
params.toCcystring

Returns ​

Promise<APIResponse<any>>


submitFixedLoanBorrowOrder() ​

ts
submitFixedLoanBorrowOrder(params: SubmitFixedLoanBorrowingOrderRequest): Promise<object[]>;

Parameters ​

ParameterType
paramsSubmitFixedLoanBorrowingOrderRequest

Returns ​

Promise<object[]>


submitMultipleOrders() ​

ts
submitMultipleOrders(params: OrderRequest[]): Promise<OrderResult[]>;

Parameters ​

ParameterType
paramsOrderRequest[]

Returns ​

Promise<OrderResult[]>


submitOneClickRepay() ​

ts
submitOneClickRepay(params: object): Promise<APIResponse<any>>;

Repay cross-margin debt using available funding and trading balances. Isolated debt is not supported.

Parameters ​

ParameterType
params{ debtCcys: string[]; repayCcy: string; }
params.debtCcysstring[]
params.repayCcystring

Returns ​

Promise<APIResponse<any>>


submitOrder() ​

ts
submitOrder(params: OrderRequest): Promise<OrderResult[]>;

Orderbook trading - trade endpoints

Parameters ​

ParameterType
paramsOrderRequest

Returns ​

Promise<OrderResult[]>

See ​

Order management


submitOrderPrecheck() ​

ts
submitOrderPrecheck(params: OrderPrecheckRequest): Promise<any[]>;

Parameters ​

ParameterType
paramsOrderPrecheckRequest

Returns ​

Promise<any[]>


submitQuickMarginBorrowRepay() ​

ts
submitQuickMarginBorrowRepay(params: QuickMarginBorrowRepayRequest): Promise<QuickMarginBorrowRepayResult[]>;

Parameters ​

ParameterType
paramsQuickMarginBorrowRepayRequest

Returns ​

Promise<QuickMarginBorrowRepayResult[]>


submitRecurringBuyOrder() ​

ts
submitRecurringBuyOrder(params: PlaceRecurringBuyOrderRequest): Promise<RecurringBuyOrderResult[]>;

Orderbook trading - Recurring buy endpoints

Parameters ​

ParameterType
paramsPlaceRecurringBuyOrderRequest

Returns ​

Promise<RecurringBuyOrderResult[]>


submitSpreadOrder() ​

ts
submitSpreadOrder(params: PlaceSpreadOrderRequest): Promise<PlaceSpreadOrderResponse[]>;

Spread trading - REST endpoints

Parameters ​

ParameterType
paramsPlaceSpreadOrderRequest

Returns ​

Promise<PlaceSpreadOrderResponse[]>


submitStableRewardsTrade() ​

ts
submitStableRewardsTrade(params: SubmitStableRewardsTradeRequest): Promise<StableRewardsTradeResult[]>;

Parameters ​

ParameterType
paramsSubmitStableRewardsTradeRequest

Returns ​

Promise<StableRewardsTradeResult[]>

Deprecated ​

Decommissioned 2026-07-14. Use order book trading APIs.


submitStake() ​

ts
submitStake(params: object): Promise<any[]>;

Parameters ​

ParameterType
params{ investData: object[]; productId: string; term?: string; }
params.investDataobject[]
params.productIdstring
params.term?string

Returns ​

Promise<any[]>


submitWithdraw() ​

ts
submitWithdraw(params: WithdrawRequest): Promise<WithdrawResponse[]>;

Parameters ​

ParameterType
paramsWithdrawRequest

Returns ​

Promise<WithdrawResponse[]>


submitWithdrawLightning() ​

ts
submitWithdrawLightning(params: object): Promise<any[]>;

Parameters ​

ParameterType
params{ ccy: string; invoice: string; memo?: string; }
params.ccystring
params.invoicestring
params.memo?string

Returns ​

Promise<any[]>


subscribeOkusd() ​

ts
subscribeOkusd(params: SubscribeOkusdRequest): Promise<OkusdSubscribeResult[]>;

Parameters ​

ParameterType
paramsSubscribeOkusdRequest

Returns ​

Promise<OkusdSubscribeResult[]>


transferSubAccountBalance() ​

ts
transferSubAccountBalance(params: SubAccountTransferRequest): Promise<SubAccountTransferResult[]>;

Master accounts manage the transfers between sub-accounts

Parameters ​

ParameterType
paramsSubAccountTransferRequest

Returns ​

Promise<SubAccountTransferResult[]>


updateBlockMmpConfig() ​

ts
updateBlockMmpConfig(params: SetMmpConfigRequest): Promise<SetMmpConfigResult[]>;

Parameters ​

ParameterType
paramsSetMmpConfigRequest

Returns ​

Promise<SetMmpConfigResult[]>


updateBlockQuoteProducts() ​

ts
updateBlockQuoteProducts(params: SetQuoteProductsRequest): Promise<object[]>;

Parameters ​

ParameterType
paramsSetQuoteProductsRequest

Returns ​

Promise<object[]>


updateCopytradingCopySettings() ​

ts
updateCopytradingCopySettings(params: CopySettingsRequest): Promise<object[]>;

Parameters ​

ParameterType
paramsCopySettingsRequest

Returns ​

Promise<object[]>


updateCopytradingProfitSharing() ​

ts
updateCopytradingProfitSharing(params: object): Promise<object[]>;

Parameters ​

ParameterType
params{ instType?: "SWAP"; profitSharingRatio: string; }
params.instType?"SWAP"
params.profitSharingRatiostring

Returns ​

Promise<object[]>


updateFixedLoanBorrowOrder() ​

ts
updateFixedLoanBorrowOrder(params: UpdateFixedLoanBorrowingOrderRequest): Promise<object[]>;

Parameters ​

ParameterType
paramsUpdateFixedLoanBorrowingOrderRequest

Returns ​

Promise<object[]>


updateRiskOffsetAmount() ​

ts
updateRiskOffsetAmount(params: object): Promise<object[]>;

Parameters ​

ParameterType
params{ ccy: string; clSpotInUseAmt: string; }
params.ccystring
params.clSpotInUseAmtstring

Returns ​

Promise<object[]>


updateRiskOffsetType() ​

ts
updateRiskOffsetType(params: object): Promise<object[]>;

Parameters ​

ParameterType
params{ type: "1" | "2" | "3" | "4"; }
params.type"1" | "2" | "3" | "4"

Returns ​

Promise<object[]>


updateSignalMargin() ​

ts
updateSignalMargin(params: AdjustMarginBalanceRequest): Promise<object[]>;

Parameters ​

ParameterType
paramsAdjustMarginBalanceRequest

Returns ​

Promise<object[]>


updateSignalTPSL() ​

ts
updateSignalTPSL(params: AmendTPSLRequest): Promise<object[]>;

Parameters ​

ParameterType
paramsAmendTPSLRequest

Returns ​

Promise<object[]>


updateSpreadOrder() ​

ts
updateSpreadOrder(params: UpdateSpreadOrderRequest): Promise<UpdateSpreadOrderResponse[]>;

Parameters ​

ParameterType
paramsUpdateSpreadOrderRequest

Returns ​

Promise<UpdateSpreadOrderResponse[]>

Built by Siebly. Open source SDKs for exchange APIs.