okx-api 2.0.6 → 3.0.0-beta.0

package/dist/mjs/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/dist/mjs/types/rest/response/private-copy-trading.js

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

package/dist/mjs/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/dist/mjs/types/rest/response/private-flexible-loan.d.ts

@@ -0,0 +1,72 @@
+export interface CollateralAsset {
+    ccy: string;
+    amt: string;
+    notionalUsd: string;
+}
+export interface CollateralAssetsResponse {
+    assets: CollateralAsset[];
+}
+export interface SupplementaryCollateral {
+    ccy: string;
+    amt: string;
+}
+export interface MaxLoanRequest {
+    borrowCcy: string;
+    supCollateral?: SupplementaryCollateral[];
+}
+export interface MaxLoanResponse {
+    borrowCcy: string;
+    maxLoan: string;
+    notionalUsd: string;
+    remainingQuota: string;
+}
+export interface AdjustCollateralRequest {
+    type: 'add' | 'reduce';
+    collateralCcy: string;
+    collateralAmt: string;
+}
+export interface LoanCurrencyData {
+    ccy: string;
+    amt: string;
+}
+export interface RiskWarningData {
+    instId: string;
+    liqPx: string;
+}
+export interface LoanInfo {
+    loanNotionalUsd: string;
+    loanData: LoanCurrencyData[];
+    collateralNotionalUsd: string;
+    collateralData: LoanCurrencyData[];
+    riskWarningData: RiskWarningData;
+    curLTV: string;
+    marginCallLTV: string;
+    liqLTV: string;
+}
+export interface LoanHistoryRequest {
+    type?: 'borrowed' | 'repaid' | 'collateral_locked' | 'collateral_released' | 'forced_repayment_buy' | 'forced_repayment_sell' | 'forced_liquidation' | 'partial_liquidation';
+    after?: string;
+    before?: string;
+    limit?: string;
+}
+export interface LoanHistoryItem {
+    refId: string;
+    type: string;
+    ccy: string;
+    amt: string;
+    ts: string;
+}
+export interface AccruedInterestRequest {
+    ccy?: string;
+    after?: string;
+    before?: string;
+    limit?: string;
+}
+export interface AccruedInterestItem {
+    refId: string;
+    ccy: string;
+    loan: string;
+    interest: string;
+    interestRate: string;
+    ts: string;
+}

package/dist/mjs/types/rest/response/private-flexible-loan.js

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

package/dist/mjs/types/rest/response/private-flexible-loan.js.map

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

package/dist/mjs/types/rest/response/private-funding.d.ts

@@ -0,0 +1,102 @@
+import { ASSET_BILL_TYPE } from '../../../constants/funding.js';
+export interface FundingCurrency {
+    ccy: string;
+    name: string;
+    logoLink: string;
+    chain: string;
+    ctAddr: string;
+    canDep: boolean;
+    canWd: boolean;
+    canInternal: boolean;
+    depEstOpenTime: string;
+    wdEstOpenTime: string;
+    minDep: string;
+    minWd: string;
+    minInternal: string;
+    maxWd: string;
+    wdTickSz: string;
+    wdQuota: string;
+    usedWdQuota: string;
+    fee: string;
+    minFee: string;
+    maxFee: string;
+    minFeeForCtAddr: string;
+    maxFeeForCtAddr: string;
+    burningFeeRate: string;
+    mainNet: boolean;
+    needTag: boolean;
+    minDepArrivalConfirm: string;
+    minWdUnlockConfirm: string;
+    depQuotaFixed: string;
+    usedDepQuotaFixed: string;
+    depQuoteDailyLayer2: string;
+}
+export interface FundingBalance {
+    availBal: string;
+    bal: string;
+    ccy: string;
+    frozenBal: string;
+}
+export interface AccountAssetValuation {
+    details: {
+        classic: string;
+        earn: string;
+        funding: string;
+        trading: string;
+    };
+    totalBal: string;
+    ts: string;
+}
+export interface FundTransferResult {
+    transId: string;
+    ccy: string;
+    clientId: string;
+    from: string;
+    amt: string;
+    to: string;
+}
+export interface FundTransferState {
+    amt: string;
+    ccy: string;
+    clientId: string;
+    from: string;
+    instId: never;
+    state: string;
+    subAcct: string;
+    to: string;
+    toInstId: never;
+    transId: string;
+    type: string;
+}
+export interface AssetBillDetails {
+    billId: string;
+    ccy: string;
+    clientId: string;
+    balChg: string;
+    bal: string;
+    type: `${ASSET_BILL_TYPE}`;
+    ts: string;
+}
+export interface WithdrawResponse {
+    ccy: string;
+    chain: string;
+    amt: string;
+    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;
+    burningFeeRate: string;
+    feeCcy: string;
+}

package/dist/mjs/types/rest/response/private-funding.js

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

package/dist/mjs/types/rest/response/private-funding.js.map

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

package/dist/mjs/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' | 'pause';
+    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/dist/mjs/types/rest/response/private-recurring-buy.js

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

package/dist/mjs/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/dist/mjs/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/dist/mjs/types/rest/response/private-signal-bot.js

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

package/dist/mjs/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":""}

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

@@ -0,0 +1,126 @@
+export interface PlaceSpreadOrderResponse {
+    ordId: string;
+    clOrdId: string;
+    tag: string;
+    sCode: string;
+    sMsg: string;
+}
+export interface CancelSpreadOrderResponse {
+    ordId: string;
+    clOrdId: string;
+    sCode: string;
+    sMsg: string;
+}
+export interface UpdateSpreadOrderResponse {
+    ordId: string;
+    clOrdId: string;
+    reqId: string;
+    sCode: string;
+    sMsg: string;
+}
+export interface SpreadOrder {
+    instId: string;
+    ordId: string;
+    clOrdId: string;
+    tag: string;
+    px: string;
+    sz: string;
+    ordType: 'limit' | 'post_only' | 'ioc';
+    side: 'buy' | 'sell';
+    fillSz: string;
+    fillPx: string;
+    tradeId: string;
+    accFillSz: string;
+    pendingFillSz: string;
+    pendingSettleSz: string;
+    canceledSz: string;
+    avgPx: string;
+    state: 'canceled' | 'live' | 'partially_filled' | 'filled';
+    cancelSource: string;
+    uTime: string;
+    cTime: string;
+}
+export interface SpreadTradeLeg {
+    instId: string;
+    px: string;
+    sz: string;
+    side: 'buy' | 'sell';
+    fee: string;
+    szCont: string;
+    feeCcy: string;
+    tradeId: string;
+}
+export interface SpreadTrade {
+    sprdId: string;
+    tradeId: string;
+    ordId: string;
+    clOrdId: string;
+    tag: string;
+    fillPx: string;
+    fillSz: string;
+    side: 'buy' | 'sell';
+    state: 'filled' | 'rejected';
+    execType: 'T' | 'M';
+    ts: string;
+    legs: SpreadTradeLeg[];
+}
+export interface SpreadLeg {
+    instId: string;
+    side: 'buy' | 'sell';
+}
+export interface SpreadDetails {
+    sprdId: string;
+    sprdType: 'linear' | 'inverse' | 'hybrid';
+    state: 'live' | 'expired' | 'suspend';
+    baseCcy: string;
+    szCcy: string;
+    quoteCcy: string;
+    tickSz: string;
+    minSz: string;
+    lotSz: string;
+    listTime: string;
+    expTime: string;
+    uTime: string;
+    legs: SpreadLeg[];
+}
+export interface OrderBookEntry {
+    price: string;
+    quantity: string;
+    orderCount: string;
+}
+export interface SpreadOrderBook {
+    asks: OrderBookEntry[];
+    bids: OrderBookEntry[];
+    ts: string;
+}
+export interface SpreadTicker {
+    sprdId: string;
+    last: string;
+    lastSz: string;
+    askPx: string;
+    askSz: string;
+    bidPx: string;
+    bidSz: string;
+    open24h: string;
+    high24h: string;
+    low24h: string;
+    vol24h: string;
+    ts: string;
+}
+export interface PublicSpreadTrade {
+    sprdId: string;
+    tradeId: string;
+    px: string;
+    sz: string;
+    side: 'buy' | 'sell';
+    ts: string;
+}
+export interface SpreadCandle {
+    ts: string;
+    o: string;
+    h: string;
+    l: string;
+    c: string;
+    vol: string;
+    confirm: string;
+}

package/dist/mjs/types/rest/response/private-spread-trading.js

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

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

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