okx-api 1.3.6 → 1.4.0

package/lib/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';
+    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';
+    state?: 'live' | 'partially_filled';
+    beginId?: string;
+    endId?: string;
+    limit?: string;
+}
+export interface GetSpreadOrderHistoryRequest {
+    sprdId?: string;
+    ordType?: 'limit' | 'post_only' | 'ioc';
+    state?: 'canceled' | 'filled';
+    beginId?: string;
+    endId?: string;
+    begin?: string;
+    end?: string;
+    limit?: string;
+}
+export interface GetSpreadOrderHistoryArchiveRequest {
+    sprdId?: string;
+    ordType?: 'limit' | 'post_only' | 'ioc';
+    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/lib/types/rest/request/spread-trading.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=spread-trading.js.map

package/lib/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/lib/types/rest/request/subaccount.d.ts

@@ -9,4 +9,25 @@ export interface SubAccountTransferRequest {
     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/lib/types/rest/request/trade.d.ts

@@ -142,3 +142,7 @@ export interface OrderRequest {
     /** Quick margin type */
     quickMgnType?: 'manual' | 'auto_borrow' | 'auto_repay';
 }
+export interface GetTransactionDetailsArchiveRequest {
+    year: string;
+    quarter: 'Q1' | 'Q2' | 'Q3' | 'Q4';
+}

package/lib/types/rest/response/index.d.ts

@@ -4,3 +4,7 @@ export * from './private-funding';
 export * from './private-subaccount';
 export * from './private-trade';
 export * from './public-data';
+export * from './private-signal-bot';
+export * from './private-recurring-buy';
+export * from './private-copy-trading';
+export * from './private-spread-trading';

package/lib/types/rest/response/index.js

@@ -20,4 +20,8 @@ __exportStar(require("./private-funding"), exports);
 __exportStar(require("./private-subaccount"), exports);
 __exportStar(require("./private-trade"), exports);
 __exportStar(require("./public-data"), exports);
+__exportStar(require("./private-signal-bot"), exports);
+__exportStar(require("./private-recurring-buy"), exports);
+__exportStar(require("./private-copy-trading"), exports);
+__exportStar(require("./private-spread-trading"), exports);
 //# sourceMappingURL=index.js.map

package/lib/types/rest/response/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/types/rest/response/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oDAAkC;AAClC,0DAAwC;AACxC,oDAAkC;AAClC,uDAAqC;AACrC,kDAAgC;AAChC,gDAA8B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/types/rest/response/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oDAAkC;AAClC,0DAAwC;AACxC,oDAAkC;AAClC,uDAAqC;AACrC,kDAAgC;AAChC,gDAA8B;AAC9B,uDAAqC;AACrC,0DAAwC;AACxC,yDAAuC;AACvC,2DAAyC"}

package/lib/types/rest/response/private-account.d.ts

@@ -292,3 +292,116 @@ export interface WithdrawalHistory {
     wdId: string;
     clientId: string;
 }
+export interface AccountInstrument {
+    baseCcy: string;
+    ctMult: string;
+    ctType: string;
+    ctVal: string;
+    ctValCcy: string;
+    expTime: string;
+    instFamily: string;
+    instId: string;
+    instType: string;
+    lever: string;
+    listTime: string;
+    lotSz: string;
+    maxIcebergSz: string;
+    maxLmtAmt: string;
+    maxLmtSz: string;
+    maxMktAmt: string;
+    maxMktSz: string;
+    maxStopSz: string;
+    maxTriggerSz: string;
+    maxTwapSz: string;
+    minSz: string;
+    optType: string;
+    quoteCcy: string;
+    settleCcy: string;
+    state: string;
+    stk: string;
+    tickSz: string;
+}
+export interface QuickMarginBorrowRepayResult {
+    instId: string;
+    ccy: string;
+    side: 'borrow' | 'repay';
+    amt: string;
+    posSide: string;
+    ts: string;
+}
+export interface QuickMarginBorrowRepayRecord {
+    instId: string;
+    ccy: string;
+    side: 'borrow' | 'repay';
+    accBorrowed: string;
+    amt: string;
+    refId: string;
+    ts: string;
+}
+export interface VIPInterest {
+    ordId: string;
+    ccy: string;
+    interest: string;
+    interestRate: string;
+    liab: string;
+    ts: string;
+}
+export interface VIPLoanOrder {
+    ts: string;
+    nextRefreshTime: string;
+    ccy: string;
+    ordId: string;
+    state: '1' | '2' | '3' | '4' | '5';
+    origRate: string;
+    curRate: string;
+    dueAmt: string;
+    borrowAmt: string;
+    repayAmt: string;
+}
+export interface VIPLoanOrderDetail {
+    amt: string;
+    ccy: string;
+    failReason: string;
+    rate: string;
+    ts: string;
+    type: '1' | '2' | '3' | '4';
+}
+export interface FixedLoanBorrowingLimitDetail {
+    ccy: string;
+    used: string;
+    borrowed: string;
+    availBorrow: string;
+    minBorrow: string;
+}
+export interface FixedLoanBorrowingLimit {
+    totalBorrowLmt: string;
+    totalAvailBorrow: string;
+    borrowed: string;
+    used: string;
+    availRepay: string;
+    details: FixedLoanBorrowingLimitDetail[];
+    ts: string;
+}
+export interface FixedLoanBorrowQuote {
+    ccy: string;
+    term: string;
+    estAvailBorrow: string;
+    estRate: string;
+    estInterest: string;
+    penaltyInterest: string;
+    ts: string;
+}
+export interface SetMMPConfigResult {
+    instFamily: string;
+    timeInterval: string;
+    frozenInterval: string;
+    qtyLimit: string;
+}
+export interface MMPConfig {
+    frozenInterval: string;
+    instFamily: string;
+    mmpFrozen: boolean;
+    mmpFrozenUntil: string;
+    qtyLimit: string;
+    timeInterval: string;
+}

package/lib/types/rest/response/private-block-trading.d.ts

@@ -87,3 +87,38 @@ export interface GetBlockQuoteResult {
     clRfqId: string;
     traderCode: string;
 }
+export interface BlockMakerInstrumentData {
+    uly?: string;
+    instId?: string;
+    maxBlockSz?: string;
+    makerPxBand?: string;
+}
+export interface BlockMakerInstrumentSettings {
+    instType: string;
+    includeALL: boolean;
+    data: BlockMakerInstrumentData[];
+}
+export interface SetMmpConfigResult {
+    timeInterval: string;
+    frozenInterval: string;
+    countLimit: string;
+}
+export interface BlockMMPConfig {
+    frozenInterval: string;
+    mmpFrozen: boolean;
+    mmpFrozenUntil: string;
+    countLimit: string;
+    timeInterval: string;
+}
+export interface PublicBlockTrade {
+    instId: string;
+    tradeId: string;
+    px: string;
+    sz: string;
+    side: 'buy' | 'sell';
+    fillVol?: string;
+    fwdPx?: string;
+    idxPx?: string;
+    markPx?: string;
+    ts: string;
+}

package/lib/types/rest/response/private-copy-trading.d.ts

@@ -0,0 +1,259 @@
+export interface CurrentSubposition {
+    algoId: string;
+    ccy: string;
+    instId: string;
+    instType: string;
+    lever: string;
+    margin: string;
+    markPx: string;
+    mgnMode: string;
+    openAvgPx: string;
+    openOrdId: string;
+    openTime: string;
+    posSide: string;
+    slOrdPx: string;
+    slTriggerPx: string;
+    subPos: string;
+    subPosId: string;
+    tpOrdPx: string;
+    tpTriggerPx: string;
+    uniqueCode: string;
+    upl: string;
+    uplRatio: string;
+    availSubPos: string;
+}
+export interface SubpositionsHistory {
+    ccy: string;
+    closeAvgPx: string;
+    closeTime: string;
+    instId: string;
+    instType: string;
+    lever: string;
+    margin: string;
+    markPx: string;
+    mgnMode: string;
+    openAvgPx: string;
+    openOrdId: string;
+    openTime: string;
+    pnl: string;
+    pnlRatio: string;
+    posSide: string;
+    profitSharingAmt: string;
+    subPos: string;
+    closeSubPos: string;
+    type: string;
+    subPosId: string;
+    uniqueCode: string;
+}
+export interface PlaceCTAlgoOrderResult {
+    subPosId: string;
+    tag: string;
+}
+export interface GetCTProfitDetailsResult {
+    ccy: string;
+    nickName: string;
+    profitSharingAmt: string;
+    profitSharingId: string;
+    portLink: string;
+    ts: string;
+    instType: string;
+}
+export interface GetCTTotalProfitResult {
+    ccy: string;
+    totalProfitSharingAmt: string;
+    instType: string;
+}
+export interface GetCTUnrealizedProfitResult {
+    ccy: string;
+    nickName: string;
+    portLink: string;
+    ts: string;
+    unrealizedProfitSharingAmt: string;
+    instType: string;
+}
+export interface AccountConfigurationDetails {
+    copyTraderNum: string;
+    instType: 'SPOT' | 'SWAP';
+    maxCopyTraderNum: string;
+    profitSharingRatio: string;
+    roleType: '0' | '1' | '2';
+}
+export interface GetAccountConfigurationResult {
+    uniqueCode: string;
+    nickName: string;
+    portLink: string;
+    details: AccountConfigurationDetails[];
+}
+export interface CopySettingsInstId {
+    instId: string;
+    enabled: string;
+}
+export interface GetCopySettingsResult {
+    ccy: string;
+    copyAmt: string;
+    copyInstIdType: 'custom' | 'copy';
+    copyMgnMode: 'cross' | 'isolated' | 'copy';
+    copyMode: 'fixed_amount' | 'ratio_copy';
+    copyRatio: string;
+    copyState: '0' | '1';
+    copyTotalAmt: string;
+    instIds: CopySettingsInstId[];
+    slRatio: string;
+    slTotalAmt: string;
+    subPosCloseType: 'market_close' | 'copy_close' | 'manual_close';
+    tpRatio: string;
+}
+export interface LeverageInfo {
+    lever: string;
+    posSide: 'long' | 'short';
+}
+export interface GetCTBatchLeverageInfoResult {
+    instId: string;
+    mgnMode: 'cross' | 'isolated';
+    leadTraderLevers: LeverageInfo[];
+    myLevers: LeverageInfo[];
+}
+export interface SetCTBatchLeverageResult {
+    succInstId: string;
+    failInstId: string;
+    result: '0' | '1' | '2';
+}
+export interface GetCTMyLeadTradersResult {
+    portLink: string;
+    nickName: string;
+    margin: string;
+    copyTotalAmt: string;
+    copyTotalPnl: string;
+    uniqueCode: string;
+    ccy: string;
+    profitSharingRatio: string;
+    beginCopyTime: string;
+    upl: string;
+    todayPnl: string;
+    leadMode: 'public' | 'private';
+}
+export interface GetCTHistoryLeadTradersResult {
+    portLink: string;
+    nickName: string;
+    uniqueCode: string;
+    copyNum: string;
+    copyTotalAmt: string;
+    copyTotalPnl: string;
+    copyAmt: string;
+    copyMode: 'fixed_amount' | 'ratio_copy';
+    copyRatio: string;
+    ccy: string;
+    profitSharingRatio: string;
+    beginCopyTime: string;
+    endCopyTime: string;
+    copyRelId: string;
+    copyState: '0' | '1';
+    leadMode: 'public' | 'private';
+}
+export interface GetCopyTradingConfigResult {
+    maxCopyAmt: string;
+    minCopyAmt: string;
+    maxCopyTotalAmt: string;
+    minCopyRatio: string;
+    maxCopyRatio: string;
+    maxTpRatio: string;
+    maxSlRatio: string;
+}
+export interface PnlRatio {
+    beginTs: string;
+    pnlRatio: string;
+}
+export interface LeadTraderRank {
+    accCopyTraderNum: string;
+    aum: string;
+    ccy: string;
+    copyState: '0' | '1';
+    copyTraderNum: string;
+    leadDays: string;
+    maxCopyTraderNum: string;
+    nickName: string;
+    pnl: string;
+    pnlRatio: string;
+    pnlRatios: PnlRatio[];
+    portLink: string;
+    traderInsts: string[];
+    uniqueCode: string;
+    winRatio: string;
+}
+export interface GetLeadTraderRanksResult {
+    dataVer: string;
+    ranks: LeadTraderRank[];
+    totalPage: string;
+}
+export interface LeadTraderPnl {
+    beginTs: string;
+    pnl: string;
+    pnlRatio: string;
+}
+export interface LeadTraderStats {
+    avgSubPosNotional: string;
+    ccy: string;
+    curCopyTraderPnl: string;
+    investAmt: string;
+    lossDays: string;
+    profitDays: string;
+    winRatio: string;
+}
+export interface LeadTraderPreference {
+    ccy: string;
+    ratio: string;
+}
+export interface LeadTraderCurrentPosition {
+    ccy: string;
+    instId: string;
+    instType: string;
+    lever: string;
+    margin: string;
+    markPx: string;
+    mgnMode: string;
+    openAvgPx: string;
+    openTime: string;
+    posSide: string;
+    subPos: string;
+    subPosId: string;
+    uniqueCode: string;
+    upl: string;
+    uplRatio: string;
+}
+export interface LeadTraderPositionHistory {
+    ccy: string;
+    closeAvgPx: string;
+    closeTime: string;
+    instId: string;
+    instType: string;
+    lever: string;
+    margin: string;
+    mgnMode: string;
+    openAvgPx: string;
+    openTime: string;
+    pnl: string;
+    pnlRatio: string;
+    posSide: string;
+    subPos: string;
+    subPosId: string;
+    uniqueCode: string;
+}
+export interface CopyTraderInfo {
+    beginCopyTime: string;
+    nickName: string;
+    portLink: string;
+    pnl: string;
+}
+export interface GetCopyTradersResult {
+    copyTotalPnl: string;
+    ccy: string;
+    copyTraderNumChg: string;
+    copyTraderNumChgRatio: string;
+    copyTraders: CopyTraderInfo[];
+}
+export interface GetPrivateLeadTraderRanksResult {
+    dataVer: string;
+    chanType: 'OKX' | 'ND';
+    ranks: LeadTraderRank[];
+    totalPage: string;
+}

package/lib/types/rest/response/private-copy-trading.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=private-copy-trading.js.map

package/lib/types/rest/response/private-copy-trading.js.map

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

package/lib/types/rest/response/private-funding.d.ts

@@ -73,3 +73,17 @@ export interface WithdrawResponse {
     wdId: string;
     clientId: string;
 }
+export interface NonTradableAsset {
+    ccy: string;
+    name: string;
+    logoLink: string;
+    bal: string;
+    canWd: boolean;
+    chain: string;
+    minWd: string;
+    wdAll: boolean;
+    fee: string;
+    ctAddr: string;
+    wdTickSz: string;
+    needTag: boolean;
+}

package/lib/types/rest/response/private-recurring-buy.d.ts

@@ -0,0 +1,63 @@
+export interface RecurringBuyOrderResult {
+    algoId: string;
+    algoClOrdId: string;
+    sCode: string;
+    sMsg: string;
+}
+export interface RecurringBuyInfoResult {
+    ccy: string;
+    ratio: string;
+}
+export interface RecurringBuyOrder {
+    algoId: string;
+    algoClOrdId: string;
+    instType: string;
+    cTime: string;
+    uTime: string;
+    algoOrdType: 'recurring';
+    state: 'running' | 'stopping';
+    stgyName: string;
+    recurringList: RecurringBuyInfoResult[];
+    period: 'monthly' | 'weekly' | 'daily' | 'hourly';
+    recurringDay?: string;
+    recurringHour?: string;
+    recurringTime: string;
+    timeZone: string;
+    amt: string;
+    investmentAmt: string;
+    investmentCcy: 'USDT' | 'USDC';
+    totalPnl: string;
+    totalAnnRate: string;
+    pnlRatio: string;
+    mktCap: string;
+    cycles: string;
+    tag: string;
+}
+export interface RecurringBuyInfoOrder {
+    ccy: string;
+    ratio: string;
+    totalAmt: string;
+    profit: string;
+    avgPx: string;
+    px: string;
+}
+export interface RecurringBuySubOrder {
+    algoId: string;
+    instType: string;
+    instId: string;
+    algoOrdType: 'recurring';
+    ordId: string;
+    cTime: string;
+    uTime: string;
+    tdMode: 'cross' | 'cash';
+    ordType: 'market';
+    sz: string;
+    state: 'canceled' | 'live' | 'partially_filled' | 'filled' | 'cancelling';
+    side: 'buy' | 'sell';
+    px: string;
+    fee: string;
+    feeCcy: string;
+    avgPx: string;
+    accFillSz: string;
+    tag: string;
+}

package/lib/types/rest/response/private-recurring-buy.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=private-recurring-buy.js.map

package/lib/types/rest/response/private-recurring-buy.js.map

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

package/lib/types/rest/response/private-signal-bot.d.ts

@@ -0,0 +1,22 @@
+export interface CreateSignalResult {
+    signalChanId: string;
+    signalToken: string;
+}
+export interface GetSignalsResult {
+    signalChanId: string;
+    signalChanName: string;
+    signalChanDesc: string;
+    signalChanToken: string;
+    signalSourceType: string;
+}
+export interface CreateSignalBotResult {
+    algoId: string;
+    algoClOrdId: string;
+    sCode: string;
+    sMsg: string;
+}
+export interface CancelSignalBotsResult {
+    algoId: string;
+    sCode: string;
+    sMsg: string;
+}

package/lib/types/rest/response/private-signal-bot.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=private-signal-bot.js.map

package/lib/types/rest/response/private-signal-bot.js.map

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