okx-api 0.0.1 → 0.0.2

package/lib/types/rest/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./request"), exports);
+__exportStar(require("./response"), exports);
+__exportStar(require("./shared"), exports);
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/rest/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAA0B;AAC1B,6CAA2B;AAC3B,2CAAyB"}

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

@@ -0,0 +1,4 @@
+export * from './shared';
+export * from './private-account';
+export * from './private-trade';
+export * from './private-block-trading';

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

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./shared"), exports);
+__exportStar(require("./private-account"), exports);
+__exportStar(require("./private-trade"), exports);
+__exportStar(require("./private-block-trading"), exports);
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/types/rest/request/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAyB;AACzB,oDAAkC;AAClC,kDAAgC;AAChC,0DAAwC"}

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

@@ -0,0 +1,16 @@
+import { InstrumentType } from '../shared';
+export interface GetPositionsParams {
+    instType?: InstrumentType;
+    instId?: string;
+    posId?: string;
+}
+export interface GetHistoricPositionParams {
+    instType?: InstrumentType;
+    instId?: string;
+    mgnMode?: string;
+    type?: string;
+    posId?: string;
+    after?: string;
+    before?: string;
+    limit?: string;
+}

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

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

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

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

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

@@ -0,0 +1,60 @@
+import { OrderSide, RFQLeg } from '../shared';
+export interface CreateBlockRFQRequest {
+    counterparties: string[];
+    anonymous?: boolean;
+    clRfqId?: string;
+    legs: RFQLeg[];
+}
+export interface CancelBlockRFQRequest {
+    rfqId?: string;
+    clRfqId?: string;
+}
+export interface CancelMultipleBlockRFQRequest {
+    rfqId?: string[];
+    clRfqId?: string[];
+}
+export interface ExecuteBlockQuoteRequest {
+    rfqId: string;
+    quoteId: string;
+}
+export interface CreateBlockQuoteRequest {
+    rfqId: string;
+    clQuoteId?: string;
+    quoteSide: string;
+    anonymous?: boolean;
+    expiresIn?: string;
+    legs: CreateBlockQuoteLeg[];
+}
+export interface CreateBlockQuoteLeg {
+    px: string;
+    sz: string;
+    instId: string;
+    side: OrderSide;
+    tgtCcy?: 'base_ccy' | 'quote_ccy';
+}
+export interface CancelBlockQuoteRequest {
+    quoteId?: string;
+    clQuoteId?: string;
+}
+export interface CancelMultipleBlockQuoteRequest {
+    quoteId?: string[];
+    clQuoteId?: string[];
+}
+export interface GetBlockRFQSParams {
+    rfqId?: string;
+    clRfqId?: string;
+    state?: string;
+    beginId?: string;
+    endId?: string;
+    limit?: string;
+}
+export interface GetBlockQuoteParams {
+    rfqId?: string;
+    clRfqId?: string;
+    quoteId?: string;
+    clQuoteId?: string;
+    state?: string;
+    beginId?: string;
+    endId?: string;
+    limit?: string;
+}

package/lib/types/rest/request/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/request/private-block-trading.js.map

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

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

@@ -0,0 +1,111 @@
+import { TradeMode, OrderSide, PositionSide, AlgoOrderType, numberInString, PriceTriggerType, OrderType, MarginMode, InstrumentType, AlgoState } from '../shared';
+export interface AlgoRecentHistoryRequest {
+    ordType: AlgoOrderType;
+    algoId?: string;
+    instType?: string;
+    instId?: string;
+    after?: string;
+    before?: string;
+    limit?: string;
+}
+export interface AlgoLongHistoryRequest {
+    ordType: AlgoOrderType;
+    state?: AlgoState;
+    algoId?: string;
+    instType?: string;
+    instId?: string;
+    after?: string;
+    before?: string;
+    limit?: string;
+}
+export interface AlgoOrderRequest {
+    instId: string;
+    tdMode: TradeMode;
+    ccy?: string;
+    side: OrderSide;
+    posSide?: PositionSide;
+    ordType: AlgoOrderType;
+    sz: numberInString;
+    tag?: string;
+    reduceOnly?: boolean;
+    tgtCcy?: string;
+    tpTriggerPx?: numberInString;
+    tpTriggerPxType?: PriceTriggerType;
+    tpOrdPx?: numberInString;
+    slTriggerPx?: numberInString;
+    slTriggerPxType?: PriceTriggerType;
+    slOrdPx?: numberInString;
+    triggerPx?: numberInString;
+    triggerPxType?: PriceTriggerType;
+    orderPx?: numberInString;
+    callbackRatio?: numberInString;
+    callbackSpread?: numberInString;
+    activePx?: numberInString;
+    pxVar?: numberInString;
+    pxSpread?: numberInString;
+    szLimit?: numberInString;
+    pxLimit?: numberInString;
+    timeInterval?: string;
+}
+export interface AmendOrderRequest {
+    instId: string;
+    cxlOnFail?: boolean;
+    ordId?: string;
+    clOrdId?: string;
+    reqId?: string;
+    newSz?: string;
+    newPx?: string;
+}
+export interface CancelAlgoOrderRequest {
+    algoId: string;
+    instId: string;
+}
+export interface ClosePositionRequest {
+    instId: string;
+    posSide?: PositionSide;
+    mgnMode: MarginMode;
+    ccy?: string;
+    autoCxl?: boolean;
+}
+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;
+    limit?: string;
+}
+export interface OrderRequest {
+    instId: string;
+    tdMode: TradeMode;
+    ccy?: string;
+    clOrdId?: string;
+    tag?: string;
+    side: OrderSide;
+    posSide?: PositionSide;
+    ordType: OrderType;
+    sz: numberInString;
+    px?: string;
+    reduceOnly?: boolean;
+    tgtCcy?: string;
+    banAmend?: boolean;
+}

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

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

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

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

package/lib/types/rest/request/shared.d.ts

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

package/lib/types/rest/request/shared.js

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

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

@@ -0,0 +1,6 @@
+export * from './private-account';
+export * from './private-block-trading';
+export * from './private-funding';
+export * from './private-subaccount';
+export * from './private-trade';
+export * from './public-data';

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

@@ -0,0 +1,23 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./private-account"), exports);
+__exportStar(require("./private-block-trading"), exports);
+__exportStar(require("./private-funding"), exports);
+__exportStar(require("./private-subaccount"), exports);
+__exportStar(require("./private-trade"), exports);
+__exportStar(require("./public-data"), exports);
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +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"}

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":""}