okx-api 0.0.1 → 0.0.4

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

@@ -0,0 +1,213 @@
+export interface AccountBalance {
+    adjEq: string;
+    details: AccountBalanceDetail[];
+    imr: string;
+    isoEq: string;
+    mgnRatio: string;
+    mmr: string;
+    notionalUsd: string;
+    ordFroz: string;
+    totalEq: string;
+    uTime: string;
+}
+export interface AccountBalanceDetail {
+    availBal: string;
+    availEq: string;
+    cashBal: string;
+    ccy: string;
+    crossLiab: string;
+    disEq: string;
+    eq: string;
+    eqUsd: string;
+    frozenBal: string;
+    interest: string;
+    isoEq: string;
+    isoLiab: string;
+    isoUpl: string;
+    liab: string;
+    maxLoan: string;
+    mgnRatio: string;
+    notionalLever: string;
+    ordFrozen: string;
+    twap: string;
+    uTime: string;
+    upl: string;
+    uplLiab: string;
+    stgyEq: string;
+}
+export interface AccountPosition {
+    adl: string;
+    availPos: string;
+    avgPx: string;
+    cTime: string;
+    ccy: string;
+    deltaBS: string;
+    deltaPA: string;
+    gammaBS: string;
+    gammaPA: string;
+    imr: string;
+    instId: string;
+    instType: string;
+    interest: string;
+    usdPx: string;
+    last: string;
+    lever: string;
+    liab: string;
+    liabCcy: string;
+    liqPx: string;
+    markPx: string;
+    margin: string;
+    mgnMode: string;
+    mgnRatio: string;
+    mmr: string;
+    notionalUsd: string;
+    optVal: string;
+    pTime: string;
+    pos: string;
+    posCcy: string;
+    posId: string;
+    posSide: string;
+    thetaBS: string;
+    thetaPA: string;
+    tradeId: string;
+    uTime: string;
+    upl: string;
+    uplRatio: string;
+    vegaBS: string;
+    vegaPA: string;
+}
+export interface HistoricAccountPosition {
+    cTime: string;
+    ccy: string;
+    closeAvgPx: string;
+    closeTotalPos: string;
+    instId: string;
+    instType: string;
+    lever: string;
+    mgnMode: string;
+    openAvgPx: string;
+    openMaxPos: string;
+    pnl: string;
+    pnlRatio: string;
+    posId: string;
+    posSide: string;
+    triggerPx: string;
+    type: string;
+    uTime: string;
+    uly: string;
+}
+export interface AccountBalanceRiskData {
+    ccy: string;
+    disEq: string;
+    eq: string;
+}
+export interface AccountPositionRiskData {
+    baseBal: string;
+    ccy: string;
+    instId: string;
+    instType: string;
+    mgnMode: string;
+    notionalCcy: string;
+    notionalUsd: string;
+    pos: string;
+    posCcy: string;
+    posId: string;
+    posSide: string;
+    quoteBal: string;
+}
+export interface AccountPositionRisk {
+    adjEq: string;
+    balData: AccountBalanceRiskData[];
+    posData: AccountPositionRiskData[];
+    ts: string;
+}
+export interface AccountBill {
+    bal: string;
+    balChg: string;
+    billId: string;
+    ccy: string;
+    execType: string;
+    fee: string;
+    from: string;
+    instId: string;
+    instType: string;
+    mgnMode: string;
+    notes: string;
+    ordId: string;
+    pnl: string;
+    posBal: string;
+    posBalChg: string;
+    subType: string;
+    sz: string;
+    to: string;
+    ts: string;
+    type: string;
+}
+export interface AccountConfiguration {
+    acctLv: string;
+    autoLoan: boolean;
+    ctIsoMode: string;
+    greeksType: string;
+    level: string;
+    levelTmp: string;
+    mgnIsoMode: string;
+    posMode: string;
+    uid: string;
+}
+export interface AccountPositionModeResult {
+    posMode: string;
+}
+export interface AccountLeverageResult {
+    lever: string;
+    mgnMode: string;
+    instId: string;
+    posSide: string;
+}
+export interface AccountMaxOrderAmount {
+    ccy: string;
+    instId: string;
+    maxBuy: string;
+    maxSell: string;
+}
+export interface AccountMaxTradableAmount {
+    instId: string;
+    availBuy: string;
+    availSell: string;
+}
+export interface AccountChangeMarginResult {
+    amt: string;
+    ccy: string;
+    instId: string;
+    leverage: string;
+    posSide: string;
+    type: string;
+}
+export interface AccountLeverage {
+    instId: string;
+    mgnMode: string;
+    posSide: string;
+    lever: string;
+}
+export interface AccountMaxLoan {
+    instId: string;
+    mgnMode: string;
+    mgnCcy: string;
+    maxLoan: string;
+    ccy: string;
+    side: string;
+}
+export interface AccountFeeRate {
+    category: never;
+    delivery: string;
+    exercise: string;
+    instType: string;
+    level: string;
+    maker: string;
+    makerU: string;
+    taker: string;
+    takerU: string;
+    ts: string;
+}
+export interface AccountIsolatedMode {
+    isoMode: 'autonomy' | 'automatic';
+}

package/lib/types/rest/response/private-account.js

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

package/lib/types/rest/response/private-account.js.map

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

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

@@ -0,0 +1,89 @@
+import { RFQLeg, RFQQuoteLegExtended } from '../shared';
+export interface BlockCounterParty {
+    traderName: string;
+    traderCode: string;
+    type: never;
+}
+export interface CreateRFQResult {
+    cTime: string;
+    uTime: string;
+    traderCode: string;
+    rfqId: string;
+    clRfqId: string;
+    state: string;
+    validUntil: string;
+    counterparties: string[];
+    legs: Required<RFQLeg>[];
+}
+export interface CancelBlockRFQResult {
+    rfqId: string;
+    clRfqId: string;
+    sCode: string;
+    sMsg: string;
+}
+export interface ExecuteBlockQuoteResult {
+    blockTdId: string;
+    rfqId: string;
+    clRfqId: string;
+    quoteId: string;
+    clQuoteId: string;
+    tTraderCode: string;
+    mTraderCode: string;
+    cTime: string;
+    legs: RFQQuoteLegExtended[];
+}
+export interface CreateBlockQuoteResult {
+    cTime: string;
+    uTime: string;
+    quoteId: string;
+    clQuoteId: string;
+    rfqId: string;
+    quoteSide: string;
+    state: string;
+    validUntil: string;
+    legs: CreatedBlockQuoteLeg[];
+}
+export interface CreatedBlockQuoteLeg {
+    px: string;
+    sz: string;
+    instId: string;
+    side: string;
+    tgtCcy: string;
+}
+export interface CancelBlockQuoteResult {
+    rfqId: string;
+    clQuoteId: string;
+    sCode: string;
+    sMsg: string;
+}
+export interface BlockRFQResult {
+    rfqId: string;
+    clRfqId: string;
+    traderCode: string;
+    validUntil: string;
+    state: string;
+    counterparties: string[];
+    legs: Required<RFQLeg>[];
+    cTime: string;
+    uTime: string;
+}
+export interface BlockQuoteLeg {
+    px: string;
+    sz: string;
+    instId: string;
+    side: string;
+    tgtCcy: string;
+}
+export interface GetBlockQuoteResult {
+    validUntil: string;
+    uTime: string;
+    cTime: string;
+    legs: BlockQuoteLeg[];
+    quoteId: string;
+    rfqId: string;
+    quoteSide: string;
+    state: string;
+    clQuoteId: string;
+    clRfqId: string;
+    traderCode: string;
+}

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

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

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

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

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

@@ -0,0 +1,68 @@
+import { ASSET_BILL_TYPE } from '../../../constants';
+export interface FundingCurrency {
+    canDep: boolean;
+    canInternal: boolean;
+    canWd: boolean;
+    ccy: string;
+    chain: string;
+    logoLink: string;
+    mainNet: boolean;
+    maxFee: string;
+    maxWd: string;
+    minDep: string;
+    minDepArrivalConfirm: string;
+    minFee: string;
+    minWd: string;
+    minWdUnlockConfirm: string;
+    name: string;
+    needTag: boolean;
+    usedWdQuota: string;
+    wdQuota: string;
+    wdTickSz: 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;
+}

package/lib/types/rest/response/private-funding.js

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

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

@@ -0,0 +1,56 @@
+export interface SubAccount {
+    enable: boolean;
+    subAcct: string;
+    type: string;
+    label: string;
+    mobile: string;
+    gAuth: boolean;
+    canTransOut: boolean;
+    ts: string;
+}
+export interface SubAccountAPIReset {
+    subAcct: string;
+    label: string;
+    apiKey: string;
+    perm: string;
+    ip: string;
+    ts: string;
+}
+export interface SubAccountBalanceDetail {
+    availBal: string;
+    availEq: string;
+    cashBal: string;
+    ccy: string;
+    crossLiab: string;
+    disEq: string;
+    eq: string;
+    eqUsd: string;
+    frozenBal: string;
+    interest: string;
+    isoEq: string;
+    isoLiab: string;
+    liab: string;
+    maxLoan: string;
+    mgnRatio: string;
+    notionalLever: string;
+    ordFrozen: string;
+    twap: string;
+    uTime: string;
+    upl: string;
+    uplLiab: string;
+}
+export interface SubAccountBalances {
+    adjEq: string;
+    details: SubAccountBalanceDetail[];
+    imr: string;
+    isoEq: string;
+    mgnRatio: string;
+    mmr: string;
+    notionalUsd: string;
+    ordFroz: string;
+    totalEq: string;
+    uTime: string;
+}
+export interface SubAccountTransferResult {
+    transId: string;
+}

package/lib/types/rest/response/private-subaccount.js

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

package/lib/types/rest/response/private-subaccount.js.map

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

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

@@ -0,0 +1,235 @@
+import { numberInString } from '../shared';
+export interface OrderResult {
+    clOrdId: string;
+    ordId: string;
+    tag: string;
+    sCode: numberInString;
+    sMsg: string;
+}
+export interface CancelledOrderResult {
+    clOrdId: string;
+    ordId: string;
+    sCode: string;
+    sMsg: string;
+}
+export interface AmendedOrder {
+    clOrdId: string;
+    ordId: string;
+    reqId: string;
+    sCode: string;
+    sMsg: string;
+}
+export interface ClosedPositions {
+    instId: string;
+    posSide: string;
+}
+export interface OrderDetails {
+    instType: string;
+    instId: string;
+    ccy: string;
+    ordId: string;
+    clOrdId: string;
+    tag: string;
+    px: string;
+    sz: string;
+    pnl: string;
+    ordType: string;
+    side: string;
+    posSide: string;
+    tdMode: string;
+    accFillSz: string;
+    fillPx: string;
+    tradeId: string;
+    fillSz: string;
+    fillTime: string;
+    state: string;
+    avgPx: string;
+    lever: string;
+    tpTriggerPx: string;
+    tpTriggerPxType: string;
+    tpOrdPx: string;
+    slTriggerPx: string;
+    slTriggerPxType: string;
+    slOrdPx: string;
+    feeCcy: string;
+    fee: string;
+    rebateCcy: string;
+    rebate: string;
+    tgtCcy: string;
+    category: string;
+    uTime: string;
+    cTime: string;
+}
+export interface OrderListItem {
+    accFillSz: string;
+    avgPx: string;
+    cTime: string;
+    category: string;
+    ccy: string;
+    clOrdId: string;
+    fee: string;
+    feeCcy: string;
+    fillPx: string;
+    fillSz: string;
+    fillTime: string;
+    instId: string;
+    instType: string;
+    lever: string;
+    ordId: string;
+    ordType: string;
+    pnl: string;
+    posSide: string;
+    px: string;
+    rebate: string;
+    rebateCcy: string;
+    side: string;
+    slOrdPx: string;
+    slTriggerPx: string;
+    slTriggerPxType: string;
+    state: string;
+    sz: string;
+    tag: string;
+    tgtCcy: string;
+    tdMode: string;
+    source: string;
+    tpOrdPx: string;
+    tpTriggerPx: string;
+    tpTriggerPxType: string;
+    tradeId: string;
+    uTime: string;
+}
+export interface HistoricOrder {
+    instType: string;
+    instId: string;
+    ccy: string;
+    ordId: string;
+    clOrdId: string;
+    tag: string;
+    px: string;
+    sz: string;
+    ordType: string;
+    side: string;
+    posSide: string;
+    tdMode: string;
+    accFillSz: string;
+    fillPx: string;
+    tradeId: string;
+    fillSz: string;
+    fillTime: string;
+    state: string;
+    avgPx: string;
+    lever: string;
+    tpTriggerPx: string;
+    tpTriggerPxType: string;
+    tpOrdPx: string;
+    slTriggerPx: string;
+    slTriggerPxType: string;
+    slOrdPx: string;
+    feeCcy: string;
+    fee: string;
+    rebateCcy: string;
+    source: string;
+    rebate: string;
+    tgtCcy: string;
+    pnl: string;
+    category: string;
+    uTime: string;
+    cTime: string;
+}
+export interface OrderFill {
+    instType: string;
+    instId: string;
+    tradeId: string;
+    ordId: string;
+    clOrdId: string;
+    billId: string;
+    tag: string;
+    fillPx: string;
+    fillSz: string;
+    side: string;
+    posSide: string;
+    execType: string;
+    feeCcy: string;
+    fee: string;
+    ts: string;
+}
+export interface AlgoOrderResult {
+    algoId: string;
+    sCode: string;
+    sMsg: string;
+}
+export interface AlgoOrderListItem {
+    instType: string;
+    instId: string;
+    ordId: string;
+    ccy: string;
+    algoId: string;
+    sz: string;
+    ordType: string;
+    side: string;
+    posSide: string;
+    tdMode: string;
+    tgtCcy: string;
+    state: string;
+    lever: string;
+    tpTriggerPx: string;
+    tpTriggerPxType: string;
+    tpOrdPx: string;
+    slTriggerPx: string;
+    slTriggerPxType: string;
+    slOrdPx: string;
+    triggerPx: string;
+    triggerPxType: string;
+    ordPx: string;
+    actualSz: string;
+    actualPx: string;
+    actualSide: string;
+    pxVar: string;
+    pxSpread: string;
+    pxLimit: string;
+    szLimit: string;
+    timeInterval: string;
+    triggerTime: string;
+    callbackRatio: string;
+    callbackSpread: string;
+    activePx: string;
+    moveTriggerPx: string;
+    cTime: string;
+}
+export interface HistoricAlgoOrder {
+    instType: string;
+    instId: string;
+    ordId: string;
+    ccy: string;
+    algoId: string;
+    sz: string;
+    ordType: string;
+    side: string;
+    posSide: string;
+    tdMode: string;
+    tgtCcy: string;
+    state: string;
+    lever: string;
+    tpTriggerPx: string;
+    tpTriggerPxType: string;
+    tpOrdPx: string;
+    slTriggerPx: string;
+    slTriggerPxType: string;
+    triggerPx: string;
+    triggerPxType: string;
+    ordPx: string;
+    actualSz: string;
+    actualPx: string;
+    actualSide: string;
+    pxVar: string;
+    pxSpread: string;
+    pxLimit: string;
+    szLimit: string;
+    timeInterval: string;
+    callbackRatio: string;
+    callbackSpread: string;
+    activePx: string;
+    moveTriggerPx: string;
+    triggerTime: string;
+    cTime: string;
+}

package/lib/types/rest/response/private-trade.js

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

package/lib/types/rest/response/private-trade.js.map

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