okx-api 2.0.7 → 3.0.0-beta.0

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

@@ -0,0 +1,80 @@
+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;
+    spotBal: string;
+    openAvgPx: string[];
+    accAvgPx: string[];
+    spotUpl: string;
+    spotUplRatio: string;
+    totalPnl: string;
+    totalPnlRatio: string;
+}
+export interface SubAccountBalances {
+    adjEq: string;
+    details: SubAccountBalanceDetail[];
+    imr: string;
+    isoEq: string;
+    mgnRatio: string;
+    mmr: string;
+    notionalUsd: string;
+    ordFroz: string;
+    totalEq: string;
+    uTime: string;
+    spotCopyTradingEq: string;
+}
+export interface SubAccountTransferResult {
+    transId: string;
+}
+export interface SubAccountMaxWithdrawal {
+    ccy: string;
+    maxWd: string;
+    maxWdEx: string;
+    spotOffsetMaxWd: string;
+    spotOffsetMaxWdEx: string;
+}
+export interface ManagedSubAccountTransfer {
+    billId: string;
+    ccy: string;
+    amt: string;
+    type: string;
+    subAcct: string;
+    subUid: string;
+    ts: string;
+}

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

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

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

@@ -0,0 +1,355 @@
+import { AlgoOrderState, AlgoOrderType, AlgoPositionSide, numberInString, OrderState, OrderType, PositionSide } from '../shared.js';
+export interface OrderResult {
+    clOrdId: string;
+    ordId: string;
+    tag: string;
+    ts: 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: PositionSide;
+}
+export interface OrderDetails {
+    instType: string;
+    instId: string;
+    ccy: string;
+    ordId: string;
+    clOrdId: string;
+    tag: string;
+    px: string;
+    sz: string;
+    pnl: string;
+    ordType: OrderType;
+    side: string;
+    posSide: PositionSide;
+    tdMode: string;
+    accFillSz: string;
+    fillPx: string;
+    tradeId: string;
+    fillSz: string;
+    fillTime: string;
+    state: OrderState;
+    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: OrderType;
+    pnl: string;
+    posSide: PositionSide;
+    px: string;
+    pxUsd: string;
+    pxVol: string;
+    pxType: string;
+    rebate: string;
+    rebateCcy: string;
+    side: string;
+    attachAlgoClOrdId: string;
+    slOrdPx: string;
+    slTriggerPx: string;
+    slTriggerPxType: string;
+    attachAlgoOrds: any[];
+    state: OrderState;
+    stpId: string;
+    stpMode: string;
+    sz: string;
+    tag: string;
+    tgtCcy: string;
+    tdMode: string;
+    source: string;
+    tpOrdPx: string;
+    tpTriggerPx: string;
+    tpTriggerPxType: string;
+    tradeId: string;
+    reduceOnly: string;
+    quickMgnType: string;
+    algoClOrdId: string;
+    algoId: string;
+    uTime: string;
+}
+export interface HistoricOrder {
+    instType: string;
+    instId: string;
+    ccy: string;
+    ordId: string;
+    clOrdId: string;
+    tag: string;
+    px: string;
+    pxUsd: string;
+    pxVol: string;
+    pxType: string;
+    sz: string;
+    ordType: OrderType;
+    side: string;
+    posSide: PositionSide;
+    tdMode: string;
+    accFillSz: string;
+    fillPx: string;
+    tradeId: string;
+    fillSz: string;
+    fillTime: string;
+    state: OrderState;
+    avgPx: string;
+    lever: string;
+    attachAlgoClOrdId: string;
+    tpTriggerPx: string;
+    tpTriggerPxType: string;
+    tpOrdPx: string;
+    slTriggerPx: string;
+    slTriggerPxType: string;
+    slOrdPx: string;
+    attachAlgoOrds: any[];
+    stpId: string;
+    stpMode: string;
+    feeCcy: string;
+    fee: string;
+    rebateCcy: string;
+    source: string;
+    rebate: string;
+    tgtCcy: string;
+    pnl: string;
+    category: string;
+    reduceOnly: string;
+    cancelSource: string;
+    cancelSourceReason: string;
+    algoClOrdId: string;
+    algoId: 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: PositionSide;
+    execType: string;
+    feeCcy: string;
+    fee: string;
+    ts: string;
+}
+export interface AlgoOrderResult {
+    algoId: string;
+    algoClOrdId: string;
+    sCode: string;
+    sMsg: string;
+}
+export interface AmendAlgoOrderResult extends AlgoOrderResult {
+    reqId: string;
+}
+export interface AlgoOrderDetailsResult {
+    instType: string;
+    instId: string;
+    ordId: string;
+    ordIdList: string[];
+    ccy: string;
+    clOrdId: string;
+    algoId: string;
+    attachAlgoOrds: any[];
+    sz: string;
+    closeFraction: string;
+    ordType: AlgoOrderType;
+    side: string;
+    posSide: AlgoPositionSide;
+    tdMode: string;
+    tgtCcy: string;
+    state: AlgoOrderState;
+    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;
+    tag: string;
+    timeInterval: string;
+    callbackRatio: string;
+    callbackSpread: string;
+    activePx: string;
+    moveTriggerPx: string;
+    reduceOnly: string;
+    triggerTime: string;
+    quickMgnType: string;
+    last: string;
+    failCode: string;
+    algoClOrdId: string;
+    amendPxOnTriggerType: string;
+    cTime: string;
+    isTradeBorrowMode: boolean;
+    chaseType?: string;
+    chaseVal?: string;
+    maxChaseType?: string;
+    maxChaseVal?: string;
+}
+export interface AlgoOrderListItem {
+    activePx: string;
+    actualPx: string;
+    actualSide: string;
+    actualSz: string;
+    algoId: string;
+    attachAlgoOrds: any[];
+    cTime: string;
+    callbackRatio: string;
+    callbackSpread: string;
+    ccy: string;
+    clOrdId: string;
+    instId: string;
+    instType: string;
+    lever: string;
+    moveTriggerPx: string;
+    ordId: string;
+    ordIdList: any[];
+    ordPx: string;
+    ordType: AlgoOrderType;
+    posSide: AlgoPositionSide;
+    pxLimit: string;
+    pxSpread: string;
+    pxVar: string;
+    side: string;
+    slOrdPx: string;
+    slTriggerPx: string;
+    slTriggerPxType: string;
+    state: AlgoOrderState;
+    sz: string;
+    closeFraction: string;
+    szLimit: string;
+    tag: string;
+    tdMode: string;
+    tgtCcy: string;
+    timeInterval: string;
+    tpOrdPx: string;
+    tpTriggerPx: string;
+    tpTriggerPxType: string;
+    triggerPx: string;
+    reduceOnly: string;
+    triggerPxType: string;
+    quickMgnType: string;
+    last: string;
+    failCode: string;
+    algoClOrdId: string;
+    triggerTime: string;
+    amendPxOnTriggerType: string;
+    isTradeBorrowMode: boolean;
+    chaseType?: string;
+    chaseVal?: string;
+    maxChaseType?: string;
+    maxChaseVal?: string;
+}
+export interface HistoricAlgoOrder {
+    activePx: string;
+    actualPx: string;
+    actualSide: string;
+    actualSz: string;
+    algoClOrdId: string;
+    algoId: string;
+    attachAlgoOrds: any[];
+    cTime: string;
+    callbackRatio: string;
+    callbackSpread: string;
+    ccy: string;
+    clOrdId: string;
+    closeFraction: string;
+    failCode: string;
+    instId: string;
+    instType: string;
+    last: string;
+    lever: string;
+    moveTriggerPx: string;
+    ordId: string;
+    ordIdList: string[];
+    ordPx: string;
+    ordType: AlgoOrderType;
+    posSide: AlgoPositionSide;
+    pxLimit: string;
+    pxSpread: string;
+    pxVar: string;
+    quickMgnType: string;
+    reduceOnly: string;
+    side: string;
+    slOrdPx: string;
+    slTriggerPx: string;
+    slTriggerPxType: string;
+    state: AlgoOrderState;
+    sz: string;
+    szLimit: string;
+    tag: string;
+    tdMode: string;
+    tgtCcy: string;
+    timeInterval: string;
+    tpOrdPx: string;
+    tpTriggerPx: string;
+    tpTriggerPxType: string;
+    triggerPx: string;
+    triggerPxType: string;
+    triggerTime: string;
+    amendPxOnTriggerType: string;
+    isTradeBorrowMode: boolean;
+    chaseType?: string;
+    chaseVal?: string;
+    maxChaseType?: string;
+    maxChaseVal?: string;
+}
+export interface CancelAllAfterResponse {
+    triggerTime: string;
+    tag: string;
+    ts: string;
+}

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

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

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

package/dist/mjs/types/rest/response/public-data.d.ts

@@ -0,0 +1,174 @@
+import { InstrumentType, numberInString } from '../shared.js';
+export interface Ticker {
+    instType: InstrumentType;
+    instId: string;
+    last: numberInString;
+    lastSz: numberInString;
+    askPx: numberInString;
+    askSz: numberInString;
+    bidPx: numberInString;
+    bidSz: numberInString;
+    open24h: numberInString;
+    high24h: numberInString;
+    low24h: numberInString;
+    volCcy24h: numberInString;
+    vol24h: numberInString;
+    sodUtc0: numberInString;
+    sodUtc8: numberInString;
+    ts: numberInString;
+}
+export interface IndexTicker {
+    instId: string;
+    idxPx: string;
+    high24h: string;
+    sodUtc0: string;
+    open24h: string;
+    low24h: string;
+    sodUtc8: string;
+    ts: string;
+}
+type OBPrice = string;
+type OBAssetQty = string;
+type OBOrderCount = string;
+type OrderBookLevel = [OBPrice, OBAssetQty, '0', OBOrderCount];
+export interface OrderBook {
+    asks: OrderBookLevel[];
+    bids: OrderBookLevel[];
+    ts: string;
+}
+type timestamp = string;
+type openPrice = string;
+type highPrice = string;
+type lowPrice = string;
+type closePrice = string;
+type vol = string;
+type volCcy = string;
+type volCcyQuote = string;
+type confirm = string;
+export type Candle = [
+    timestamp,
+    openPrice,
+    highPrice,
+    lowPrice,
+    closePrice,
+    vol,
+    volCcy,
+    volCcyQuote,
+    confirm
+];
+export type CandleNoVolume = [
+    timestamp,
+    openPrice,
+    highPrice,
+    lowPrice,
+    closePrice
+];
+export interface Trade {
+    instId: string;
+    side: string;
+    sz: string;
+    px: string;
+    tradeId: string;
+    ts: string;
+}
+export interface Instrument {
+    instType: InstrumentType;
+    instId: string;
+    uly: string;
+    instFamily: string;
+    category: string;
+    baseCcy: string;
+    quoteCcy: string;
+    settleCcy: string;
+    ctVal: string;
+    ctMult: string;
+    ctValCcy: string;
+    optType: string;
+    stk: string;
+    listTime: string;
+    expTime: string;
+    lever: string;
+    tickSz: string;
+    lotSz: string;
+    minSz: string;
+    ctType: string;
+    alias: string;
+    state: string;
+    maxLmtSz: string;
+    maxMktSz: string;
+    maxTwapSz: string;
+    maxIcebergSz: string;
+    maxTriggerSz: string;
+    maxStopSz: string;
+    ruleType: string;
+    auctionEndTime: string;
+}
+export interface EconomicCalendarData {
+    calendarId: string;
+    date: string;
+    region: string;
+    category: string;
+    event: string;
+    refDate: string;
+    actual: string;
+    previous: string;
+    forecast: string;
+    dateSpan: string;
+    importance: string;
+    uTime: string;
+    prevInitial: string;
+    ccy: string;
+    unit: string;
+}
+export interface UnitConvertData {
+    type: '1' | '2';
+    instId: string;
+    px: string;
+    sz: string;
+    unit: 'coin' | 'usds';
+}
+export interface FundingRateHistory {
+    instType: string;
+    instId: string;
+    fundingRate: string;
+    realizedRate: string;
+    fundingTime: string;
+    method: string;
+}
+export interface SystemTime {
+    ts: string;
+}
+export interface OptionsTradeInfo {
+    instId: string;
+    tradeId: string;
+    px: string;
+    sz: string;
+    side: 'buy' | 'sell';
+    ts: string;
+}
+export interface OptionTrade {
+    vol24h: string;
+    optType: 'C' | 'P';
+    tradeInfo: OptionsTradeInfo[];
+}
+export interface OptionTrades {
+    instId: string;
+    instFamily: string;
+    tradeId: string;
+    px: string;
+    sz: string;
+    side: 'buy' | 'sell';
+    optType: 'C' | 'P';
+    fillVol: string;
+    fwdPx: string;
+    idxPx: string;
+    markPx: string;
+    ts: string;
+}
+export interface Announcement {
+    annType: string;
+    pTime: string;
+    title: string;
+    url: string;
+}
+export {};

package/dist/mjs/types/rest/response/public-data.js

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

package/dist/mjs/types/rest/response/public-data.js.map

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

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

@@ -0,0 +1,45 @@
+export type numberInString<T = string> = T;
+export interface APIResponse<T> {
+    code: '0';
+    msg: '';
+    data: T;
+}
+export type AlgoOrderType = 'conditional' | 'oco' | 'trigger' | 'move_order_stop' | 'iceberg' | 'twap' | 'chase';
+export type AlgoOrderState = 'live' | 'pause' | 'partially_effective' | 'effective' | 'canceled' | 'order_failed' | 'partially_failed';
+export type AlgoPositionSide = 'long' | 'short';
+export type ContractGridDirection = 'long' | 'short' | 'neutral';
+export type GridAlgoSubOrderType = 'live' | 'filled';
+export type InstrumentType = 'SPOT' | 'MARGIN' | 'SWAP' | 'FUTURES' | 'OPTION';
+export type MarginMode = 'cross' | 'isolated';
+export type OrderSide = 'buy' | 'sell';
+export type OrderType = 'market' | 'limit' | 'post_only' | 'fok' | 'ioc' | 'optimal_limit_ioc' | 'mmp' | 'mmp_and_post_only';
+export type OrderState = 'canceled' | 'live' | 'partially_filled' | 'filled' | 'mmp_canceled';
+export type PositionSide = 'net' | 'long' | 'short';
+export type PriceTriggerType = 'last' | 'index' | 'mark';
+export interface RFQLeg {
+    instId: string;
+    sz: string;
+    side: OrderSide;
+    tgtCcy?: string;
+}
+export interface RFQQuoteLegExtended {
+    px: string;
+    sz: string;
+    instId: string;
+    side: string;
+    fee: string;
+    feeCcy: string;
+    tradeId: string;
+}
+export type TradeMode = 'cross' | 'isolated' | 'cash' | 'spot_isolated';
+export interface TimestampObject {
+    ts: numberInString;
+}
+export interface Pagination {
+    after?: string;
+    before?: string;
+    limit?: string;
+}
+export type PosMode = 'long_short_mode' | 'net_mode';
+export type AccountLevel = '1' | '2' | '3' | '4';
+export type WithdrawState = '-3' | '-2' | '-1' | '0' | '1' | '2' | '4' | '5' | '6' | '8' | '9' | '10' | '12';

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

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

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

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

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

@@ -0,0 +1,13 @@
+export interface APICredentials {
+    apiKey: string;
+    apiSecret: string;
+    apiPass: string;
+}
+/**
+ * The API Market represents the OKX Domain that you have signed up for. At this time, there are 3 supported domain groups:
+ *
+ * - GLOBAL, otherwise known as "www.okx.com".
+ * - EEA, otherwise known as "my.okx.com".
+ * - US, otherwise known as "app.okx.com".
+ */
+export type APIMarket = 'prod' | 'GLOBAL' | 'EEA' | 'US';

package/dist/mjs/types/shared.js

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

package/{lib/types/rest → dist/mjs/types}/shared.js.map

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