okx-api 0.0.1 → 0.0.2

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

@@ -0,0 +1,67 @@
+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: string;
+    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":""}

package/lib/types/rest/response/public-data.d.ts

@@ -0,0 +1,70 @@
+import { InstrumentType, numberInString } from '../shared';
+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;
+}
+declare type OBPrice = string;
+declare type OBAssetQty = string;
+declare type OBOrderCount = string;
+declare type OrderBookLevel = [OBPrice, OBAssetQty, '0', OBOrderCount];
+export interface OrderBook {
+    asks: OrderBookLevel[];
+    bids: OrderBookLevel[];
+    ts: string;
+}
+declare type timestamp = string;
+declare type openPrice = string;
+declare type highPrice = string;
+declare type lowPrice = string;
+declare type closePrice = string;
+declare type vol = string;
+declare type volCcy = string;
+export declare type Candle = [
+    timestamp,
+    openPrice,
+    highPrice,
+    lowPrice,
+    closePrice,
+    vol,
+    volCcy
+];
+export declare type CandleNoVolume = [
+    timestamp,
+    openPrice,
+    highPrice,
+    lowPrice,
+    closePrice
+];
+export interface Trade {
+    instId: string;
+    side: string;
+    sz: string;
+    px: string;
+    tradeId: string;
+    ts: string;
+}
+export {};

package/lib/types/rest/response/public-data.js

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

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

@@ -0,0 +1,36 @@
+export declare type numberInString<T = string> = T;
+export interface APIResponse<T> {
+    code: '0';
+    msg: '';
+    data: T;
+}
+export declare type AlgoOrderType = 'conditional' | 'oco' | 'trigger' | 'move_order_stop' | 'iceberg' | 'twap';
+export declare type AlgoState = 'effective' | 'canceled' | 'order_failed';
+export declare type ContractGridDirection = 'long' | 'short' | 'neutral';
+export declare type GridAlgoOrderType = 'grid' | 'contract_grid';
+export declare type GridAlgoSubOrderType = 'live' | 'filled';
+export declare type InstrumentType = 'SPOT' | 'MARGIN' | 'SWAP' | 'FUTURES' | 'OPTION';
+export declare type MarginMode = 'cross' | 'isolated';
+export declare type OrderSide = 'buy' | 'sell';
+export declare type OrderType = 'market' | 'limit' | 'post_only' | 'fok' | 'ioc' | 'optimal_limit_ioc';
+export declare type PositionSide = 'net' | 'long' | 'short';
+export declare 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 declare type TradeMode = 'cross' | 'isolated' | 'cash';
+export interface TimestampObject {
+    ts: numberInString;
+}

package/lib/types/rest/shared.js

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

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

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

package/lib/util/BaseRestClient.d.ts

@@ -0,0 +1,35 @@
+import { AxiosRequestConfig } from 'axios';
+import { RestClientOptions, OKXEnvironment } from './requestUtils';
+export declare const MISSING_CREDENTIALS_ERROR = "Private endpoints require api and secret to be provided in the REST client constructor";
+export interface APICredentials {
+    apiKey: string;
+    apiSecret: string;
+    apiPassphrase: string;
+}
+export default abstract class BaseRestClient {
+    private options;
+    private baseUrl;
+    private globalRequestOptions;
+    private apiKey;
+    private apiSecret;
+    private apiPassphrase;
+    private environment;
+    constructor(credentials: APICredentials | undefined | null, baseUrl: string, options: RestClientOptions | undefined, requestOptions: AxiosRequestConfig | undefined, environment: OKXEnvironment);
+    get(endpoint: string, params?: any): Promise<any>;
+    post(endpoint: string, params?: any): Promise<any>;
+    getPrivate(endpoint: string, params?: any): Promise<any>;
+    postPrivate(endpoint: string, params?: any): Promise<any>;
+    deletePrivate(endpoint: string, params?: any): Promise<any>;
+    /**
+     * Make a HTTP request to a specific endpoint. Private endpoints are automatically signed.
+     */
+    private _call;
+    /**
+     * Sign request
+     */
+    private signRequest;
+    /**
+     * Generic handler to parse request exceptions
+     */
+    private parseException;
+}