okx-api 2.0.6 → 3.0.0-beta.0

package/dist/mjs/types/rest/request/public.d.ts

@@ -0,0 +1,55 @@
+export interface EconomicCalendarRequest {
+    region?: string;
+    importance?: '1' | '2' | '3';
+    before?: string;
+    after?: string;
+    limit?: string;
+}
+export interface UnitConvertRequest {
+    type?: '1' | '2';
+    instId: string;
+    sz: string;
+    px?: string;
+    unit?: 'coin' | 'usds';
+    opType: 'open' | 'close';
+}
+export interface CandleRequest {
+    instId: string;
+    after?: string;
+    before?: string;
+    bar?: string;
+    limit?: string;
+}
+export interface GetPremiumHistoryRequest {
+    instId: string;
+    after?: string;
+    before?: string;
+    limit?: string;
+}
+export interface GetContractOpenInterestHistoryRequest {
+    instId: string;
+    period?: string;
+    end?: string;
+    begin?: string;
+    limit?: string;
+}
+export interface GetContractTakerVolumeRequest {
+    instId: string;
+    period?: string;
+    unit?: string;
+    end?: string;
+    begin?: string;
+    limit?: string;
+}
+export interface GetTopTradersContractLongShortRatioRequest {
+    instId: string;
+    period?: string;
+    end?: string;
+    begin?: string;
+    limit?: string;
+}
+export interface GetOptionTradesRequest {
+    instId?: string;
+    instFamily?: string;
+    optType?: 'C' | 'P';
+}

package/dist/mjs/types/rest/request/public.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=public.js.map

package/dist/mjs/types/rest/request/public.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"public.js","sourceRoot":"","sources":["../../../../../src/types/rest/request/public.ts"],"names":[],"mappings":""}

package/dist/mjs/types/rest/request/recurring-buy.d.ts

@@ -0,0 +1,28 @@
+export interface RecurringBuyInfo {
+    ccy: string;
+    ratio: string;
+}
+export interface PlaceRecurringBuyOrderRequest {
+    stgyName: string;
+    recurringList: RecurringBuyInfo[];
+    period: 'monthly' | 'weekly' | 'daily' | 'hourly';
+    recurringDay?: string;
+    recurringHour?: string;
+    recurringTime: string;
+    timeZone: string;
+    amt: string;
+    investmentCcy: 'USDT' | 'USDC';
+    tdMode: 'cross' | 'cash';
+    algoClOrdId?: string;
+    tag?: string;
+}
+export interface AmendRecurringBuyOrderRequest {
+    algoId: string;
+    stgyName: string;
+}
+export interface GetRecurringBuyOrderListRequest {
+    algoId?: string;
+    after?: string;
+    before?: string;
+    limit?: string;
+}

package/dist/mjs/types/rest/request/recurring-buy.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=recurring-buy.js.map

package/dist/mjs/types/rest/request/recurring-buy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"recurring-buy.js","sourceRoot":"","sources":["../../../../../src/types/rest/request/recurring-buy.ts"],"names":[],"mappings":""}

package/dist/mjs/types/rest/request/shared.d.ts

@@ -0,0 +1,7 @@
+import { numberInString } from '../shared.js';
+export interface PaginatedSymbolRequest {
+    ccy?: string;
+    after?: numberInString;
+    before?: numberInString;
+    limit?: numberInString;
+}

package/dist/mjs/types/rest/request/shared.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=shared.js.map

package/dist/mjs/types/rest/request/shared.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shared.js","sourceRoot":"","sources":["../../../../../src/types/rest/request/shared.ts"],"names":[],"mappings":""}

package/dist/mjs/types/rest/request/signal-bot.d.ts

@@ -0,0 +1,97 @@
+export interface CreateSignalRequest {
+    signalChanName: string;
+    signalChanDesc?: string;
+}
+export interface GetSignalsRequest {
+    signalSourceType: string;
+    signalChanId?: string;
+    after?: string;
+    before?: string;
+    limit?: string;
+}
+export interface EntrySettingParam {
+    allowMultipleEntry?: string;
+    entryType?: string;
+    amt?: string;
+    ratio?: {
+        ratio: string;
+    }[];
+}
+export interface ExitSettingParam {
+    tpSlType: string;
+    tpPct?: string;
+    slPct?: string;
+}
+export interface CreateSignalBotRequest {
+    signalChanId: string;
+    lever: string;
+    investAmt: string;
+    subOrdType: string;
+    includeAll?: boolean;
+    instIds?: string;
+    ratio?: string;
+    entrySettingParam?: EntrySettingParam;
+    exitSettingParam?: ExitSettingParam;
+}
+export interface AdjustMarginBalanceRequest {
+    algoId: string;
+    type: 'add' | 'reduce';
+    amt: string;
+    allowReinvest?: boolean;
+}
+export interface AmendTPSLRequest {
+    algoId: string;
+    exitSettingParam: ExitSettingParam;
+}
+export interface SetSignalInstrumentsRequest {
+    algoId: string;
+    instIds: string[];
+    includeAll: boolean;
+}
+export interface GetSignalBotRequest {
+    algoOrdType: string;
+    algoId: string;
+    after: string;
+    before?: string;
+    limit?: string;
+}
+export interface GetSignalBotPositionHistoryRequest {
+    algoId?: string;
+    instId?: string;
+    after?: string;
+    before?: string;
+    limit?: string;
+}
+export interface PlaceSubOrderRequest {
+    instId: string;
+    algoId: string;
+    side: 'buy' | 'sell';
+    ordType: 'market' | 'limit';
+    sz: string;
+    px?: string;
+    reduceOnly?: boolean;
+}
+export interface CancelSubOrderRequest {
+    algoId: string;
+    instId: string;
+    signalOrdId: string;
+}
+export interface GetSignalBotSubOrdersRequest {
+    algoId: string;
+    algoOrdType: 'contract';
+    type?: 'live' | 'filled';
+    clOrdId?: string;
+    state?: 'live' | 'partially_filled' | 'filled' | 'cancelled';
+    signalOrdId?: string;
+    after?: string;
+    before?: string;
+    begin?: string;
+    end?: string;
+    limit?: string;
+}
+export interface GetSignalBotEventHistoryRequest {
+    algoId: string;
+    after?: string;
+    before?: string;
+    limit?: string;
+}

package/dist/mjs/types/rest/request/signal-bot.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=signal-bot.js.map

package/dist/mjs/types/rest/request/signal-bot.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"signal-bot.js","sourceRoot":"","sources":["../../../../../src/types/rest/request/signal-bot.ts"],"names":[],"mappings":""}

package/dist/mjs/types/rest/request/simple-earn.d.ts

@@ -0,0 +1,23 @@
+export interface GetLendingOrderListRequest {
+    ordId?: string;
+    ccy?: string;
+    term?: '30D';
+    state?: 'pending' | 'earning' | 'expired' | 'settled';
+    after?: string;
+    before?: string;
+    limit?: string;
+}
+export interface LendingOrder {
+    ccy: string;
+    amt: string;
+    rate?: string;
+    term: '30D';
+    autoRenewal?: boolean;
+}
+export interface GetLendingSubOrderListRequest {
+    ordId: string;
+    state?: 'earning' | 'expired' | 'settled';
+    after?: string;
+    before?: string;
+    limit?: string;
+}

package/dist/mjs/types/rest/request/simple-earn.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=simple-earn.js.map

package/dist/mjs/types/rest/request/simple-earn.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"simple-earn.js","sourceRoot":"","sources":["../../../../../src/types/rest/request/simple-earn.ts"],"names":[],"mappings":""}

package/dist/mjs/types/rest/request/spread-trading.d.ts

@@ -0,0 +1,69 @@
+export interface PlaceSpreadOrderRequest {
+    sprdId: string;
+    clOrdId?: string;
+    tag?: string;
+    side: 'buy' | 'sell';
+    ordType: 'limit' | 'post_only' | 'ioc' | 'market';
+    sz: string;
+    px: string;
+}
+export interface UpdateSpreadOrderRequest {
+    ordId?: string;
+    clOrdId?: string;
+    reqId?: string;
+    newSz?: string;
+    newPx?: string;
+}
+export interface GetActiveSpreadOrdersRequest {
+    sprdId?: string;
+    ordType?: 'limit' | 'post_only' | 'ioc' | 'market';
+    state?: 'live' | 'partially_filled';
+    beginId?: string;
+    endId?: string;
+    limit?: string;
+}
+export interface GetSpreadOrderHistoryRequest {
+    sprdId?: string;
+    ordType?: 'limit' | 'post_only' | 'ioc' | 'market';
+    state?: 'canceled' | 'filled';
+    beginId?: string;
+    endId?: string;
+    begin?: string;
+    end?: string;
+    limit?: string;
+}
+export interface GetSpreadOrderHistoryArchiveRequest {
+    sprdId?: string;
+    ordType?: 'limit' | 'post_only' | 'ioc' | 'market';
+    state?: 'canceled' | 'filled';
+    instType?: 'SPOT' | 'FUTURES' | 'SWAP';
+    instFamily?: string;
+    beginId?: string;
+    endId?: string;
+    begin?: string;
+    end?: string;
+    limit?: string;
+}
+export interface GetSpreadTradesRequest {
+    sprdId?: string;
+    tradeId?: string;
+    ordId?: string;
+    beginId?: string;
+    endId?: string;
+    begin?: string;
+    end?: string;
+    limit?: string;
+}
+export interface GetSpreadsRequest {
+    baseCcy?: string;
+    instId?: string;
+    sprdId?: string;
+    state?: 'live' | 'suspend' | 'expired';
+}
+export interface GetSpreadCandlesRequest {
+    sprdId: string;
+    bar?: string;
+    after?: string;
+    before?: string;
+    limit?: string;
+}

package/dist/mjs/types/rest/request/spread-trading.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=spread-trading.js.map

package/dist/mjs/types/rest/request/spread-trading.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"spread-trading.js","sourceRoot":"","sources":["../../../../../src/types/rest/request/spread-trading.ts"],"names":[],"mappings":""}

package/dist/mjs/types/rest/request/subaccount.d.ts

@@ -0,0 +1,33 @@
+type AccountType = '6' | '18';
+export interface SubAccountTransferRequest {
+    ccy: string;
+    amt: string;
+    from: AccountType;
+    to: AccountType;
+    fromSubAccount: string;
+    toSubAccount: string;
+    loanTrans?: boolean;
+    omitPosRisk?: boolean;
+}
+export interface GetSubAccountMaxWithdrawalsRequest {
+    subAcct: string;
+    ccy?: string;
+}
+export interface GetManagedSubAccountTransferHistoryRequest {
+    ccy?: string;
+    type?: '0' | '1';
+    subAcct?: string;
+    subUid?: string;
+    after?: string;
+    before?: string;
+    limit?: string;
+}
+export interface LoanAllocation {
+    subAcct: string;
+    loanAlloc: string;
+}
+export interface SetSubAccountLoanAllocationRequest {
+    enable: boolean;
+    alloc?: LoanAllocation[];
+}
+export {};

package/dist/mjs/types/rest/request/subaccount.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=subaccount.js.map

package/dist/mjs/types/rest/request/subaccount.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"subaccount.js","sourceRoot":"","sources":["../../../../../src/types/rest/request/subaccount.ts"],"names":[],"mappings":""}

package/dist/mjs/types/rest/request/trade.d.ts

@@ -0,0 +1,194 @@
+import { AlgoOrderState, AlgoOrderType, AlgoPositionSide, InstrumentType, MarginMode, numberInString, OrderSide, OrderType, PositionSide, PriceTriggerType, TradeMode } from '../shared.js';
+export interface AlgoRecentHistoryRequest {
+    ordType: AlgoOrderType;
+    algoId?: string;
+    instType?: InstrumentType;
+    instId?: string;
+    after?: string;
+    before?: string;
+    limit?: string;
+}
+export interface AlgoLongHistoryRequest {
+    ordType: AlgoOrderType;
+    state?: AlgoOrderState;
+    algoId?: string;
+    instType?: InstrumentType;
+    instId?: string;
+    after?: string;
+    before?: string;
+    limit?: string;
+}
+interface AlgoTriggerOrder {
+    newTpTriggerPx?: string;
+    newTpTriggerPxType?: 'last' | 'index' | 'mark';
+    newTpOrdPx?: string;
+    newSlTriggerPx?: string;
+    newSlTriggerPxType?: 'last' | 'index' | 'mark';
+    newSlOrdPx?: string;
+}
+export interface AlgoOrderRequest {
+    instId: string;
+    tdMode: TradeMode;
+    ccy?: string;
+    side: OrderSide;
+    posSide?: AlgoPositionSide;
+    ordType: AlgoOrderType;
+    algoClOrdId?: string;
+    sz: numberInString;
+    tag?: string;
+    reduceOnly?: boolean;
+    tgtCcy?: string;
+    tpTriggerPx?: numberInString;
+    tpTriggerPxType?: PriceTriggerType;
+    tpOrdPx?: numberInString;
+    tpOrdKind?: string;
+    slTriggerPx?: numberInString;
+    slTriggerPxType?: PriceTriggerType;
+    slOrdPx?: numberInString;
+    cxlOnClosePos?: boolean;
+    triggerPx?: numberInString;
+    triggerPxType?: PriceTriggerType;
+    orderPx?: numberInString;
+    chaseType?: string;
+    chaseVal?: numberInString;
+    maxChaseType?: string;
+    maxChaseVal?: numberInString;
+    callbackRatio?: numberInString;
+    callbackSpread?: numberInString;
+    activePx?: numberInString;
+    pxVar?: numberInString;
+    pxSpread?: numberInString;
+    szLimit?: numberInString;
+    pxLimit?: numberInString;
+    timeInterval?: string;
+    quickMgnType?: string;
+    closeFraction?: numberInString;
+    attachAlgoOrds?: AlgoTriggerOrder[];
+}
+export interface AmendOrderRequest {
+    instId: string;
+    cxlOnFail?: boolean;
+    ordId?: string;
+    clOrdId?: string;
+    reqId?: string;
+    newSz?: string;
+    newPx?: string;
+}
+export type AlgoOrderDetailsRequest = {
+    algoId: string;
+} | {
+    algoClOrdId: string;
+};
+export interface AmendAlgoOrderRequest {
+    instId: string;
+    algoId?: string;
+    algoClOrdId?: string;
+    cxlOnFail?: boolean;
+    reqId?: string;
+    newSz?: string;
+    newTpTriggerPx?: string;
+    newTpOrdPx?: string;
+    newSlTriggerPx?: string;
+    newSlOrdPx?: string;
+    newTpTriggerPxType?: 'last' | 'index' | 'mark';
+    newSlTriggerPxType?: 'last' | 'index' | 'mark';
+    newTriggerPx: string;
+    newOrdPx: string;
+    newTriggerPxType?: 'last' | 'index' | 'mark';
+    attachAlgoOrds?: AlgoTriggerOrder[];
+}
+export interface CancelAlgoOrderRequest {
+    algoId: string;
+    instId: string;
+}
+export interface ClosePositionRequest {
+    instId: string;
+    posSide?: PositionSide;
+    mgnMode: MarginMode;
+    ccy?: string;
+    autoCxl?: boolean;
+    clOrdId?: string;
+    tag?: string;
+}
+export interface FillsHistoryRequest {
+    instType?: InstrumentType;
+    uly?: string;
+    instId?: string;
+    ordId?: string;
+    after?: string;
+    before?: string;
+    begin?: string;
+    end?: string;
+    limit?: string;
+}
+export interface OrderIdRequest {
+    instId: string;
+    ordId?: string;
+    clOrdId?: string;
+}
+export interface OrderHistoryRequest {
+    instType: InstrumentType;
+    uly?: string;
+    instId?: string;
+    ordType?: OrderType;
+    state?: string;
+    category?: string;
+    after?: string;
+    before?: string;
+    begin?: string;
+    end?: string;
+    limit?: string;
+}
+export interface OrderRequest {
+    instId: string;
+    tdMode: TradeMode;
+    ccy?: string;
+    clOrdId?: string;
+    tag?: string;
+    side: OrderSide;
+    posSide?: PositionSide;
+    ordType: OrderType;
+    /** Quantity to buy or sell */
+    sz: numberInString;
+    px?: string;
+    reduceOnly?: boolean;
+    /** A spot buy on BTC-USDT with "base_ccy" would mean the QTY (sz) is in USDT */
+    tgtCcy?: 'base_ccy' | 'quote_ccy';
+    banAmend?: boolean;
+    /** Take Profit & Stop Loss params */
+    tpTriggerPx?: string;
+    tpOrdPx?: string;
+    slTriggerPx?: string;
+    slOrdPx?: string;
+    tpTriggerPxType?: PriceTriggerType;
+    slTriggerPxType?: PriceTriggerType;
+    /** Quick margin type */
+    quickMgnType?: 'manual' | 'auto_borrow' | 'auto_repay';
+}
+export interface GetTransactionDetailsArchiveRequest {
+    year: string;
+    quarter: 'Q1' | 'Q2' | 'Q3' | 'Q4';
+}
+export interface OrderPrecheckRequest {
+    instId: string;
+    tdMode: string;
+    side: string;
+    posSide?: string;
+    ordType: string;
+    sz: string;
+    px?: string;
+    reduceOnly?: boolean;
+    tgtCcy?: string;
+    attachAlgoOrds?: {
+        attachAlgoClOrdId?: string;
+        tpTriggerPx?: string;
+        tpOrdPx?: string;
+        tpOrdKind?: string;
+        slTriggerPx?: string;
+        slOrdPx?: string;
+        tpTriggerPxType?: string;
+        slTriggerPxType?: string;
+        sz?: string;
+    }[];
+}
+export {};

package/dist/mjs/types/rest/request/trade.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=trade.js.map

package/dist/mjs/types/rest/request/trade.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"trade.js","sourceRoot":"","sources":["../../../../../src/types/rest/request/trade.ts"],"names":[],"mappings":""}