okx-api 0.0.1 → 0.0.2

package/README.md

@@ -6,7 +6,9 @@
 
 [1]: https://www.npmjs.com/package/okx-api
 
-WARNING: This package is still early beta, following the designs of my other connectors. If you want to stay informed when this may be ready for testing, please get in touch via telegram.
+**WARNING: This package is still early beta! Expect breaking changes until this sees a major release.**
+
+If you want to stay informed when this may be ready for testing, please get in touch via telegram.
 
 Node.js connector for the okx APIs and WebSockets, with TypeScript & browser support.
 
@@ -17,6 +19,17 @@ Node.js connector for the okx APIs and WebSockets, with TypeScript & browser sup
 - Issues? Check the [issues tab](https://github.com/tiagosiebler/okx-api/issues).
 - Discuss & collaborate with other node devs? Join our [Node.js Algo Traders](https://t.me/nodetraders) engineering community on telegram.
 
+## Related projects
+- Try my connectors:
+  - [ftx-api](https://www.npmjs.com/package/ftx-api)
+  - [bybit-api](https://www.npmjs.com/package/bybit-api)
+  - [okx-api](https://www.npmjs.com/package/okx-api)
+  - [binance](https://www.npmjs.com/package/binance)
+- Try my misc utilities:
+  - [orderbooks](https://www.npmjs.com/package/orderbooks)
+- Check out my examples:
+  - [awesome-crypto-examples](https://github.com/tiagosiebler/awesome-crypto-examples)
+
 ## Documentation
 Most methods accept JS objects. These can be populated using parameters specified by okx's API documentation.
 - [OKX API Documentation](https://www.okx.com/docs-v5/en/#rest-api).
@@ -24,8 +37,8 @@ Most methods accept JS objects. These can be populated using parameters specifie
 ## Structure
 This project uses typescript. Resources are stored in 3 key structures:
 - [src](./src) - the whole connector written in typescript
-- [lib](./lib) - the javascript version of the project (compiled from typescript). This should not be edited directly, as it will be overwritten with each release.
-- [dist](./dist) - the packed bundle of the project for use in browser environments.
+- [lib](./lib) - the javascript version of the project (compiled from typescript). This should not be edited directly, as it will be overwritten with each release. This is also the version published to npm.
+- [dist](./dist) - the packed bundle of the project for use in browser environments (manual, using webpack).
 - [examples](./examples) - some implementation examples & demonstrations. Contributions are welcome!
 
 ---
@@ -34,171 +47,14 @@ This project uses typescript. Resources are stored in 3 key structures:
 Create API credentials at okx
 - [OKX my-api](https://www.okx.com/account/my-api)
 
-<!--
-### REST Inverse
-To use the inverse REST APIs, import the `InverseClient`:
-
-```javascript
-const { InverseClient } = require('okx-api');
-
-const restClientOptions = {
-  // override the max size of the request window (in ms)
-  recv_window?: number;
-
-  // how often to sync time drift with okx servers
-  sync_interval_ms?: number | string;
-
-  // Default: false. Disable above sync mechanism if true.
-  disable_time_sync?: boolean;
-
-  // Default: false. If true, we'll throw errors if any params are undefined
-  strict_param_validation?: boolean;
-
-  // Optionally override API protocol + domain
-  // e.g 'https://api.bytick.com'
-  baseUrl?: string;
-
-  // Default: true. whether to try and post-process request exceptions.
-  parse_exceptions?: boolean;
-};
-
-const API_KEY = 'xxx';
-const PRIVATE_KEY = 'yyy';
-const useLivenet = false;
-
-const client = new InverseClient(
-  API_KEY,
-  PRIVATE_KEY,
-
-  // optional, uses testnet by default. Set to 'true' to use livenet.
-  useLivenet,
-
-  // restClientOptions,
-  // requestLibraryOptions
-);
-
-client.getApiKeyInfo()
-  .then(result => {
-    console.log("apiKey result: ", result);
-  })
-  .catch(err => {
-    console.error("apiKey error: ", err);
-  });
-
-client.getOrderBook({ symbol: 'BTCUSD' })
-  .then(result => {
-    console.log("getOrderBook inverse result: ", result);
-  })
-  .catch(err => {
-    console.error("getOrderBook inverse error: ", err);
-  });
-```
-
-
-See [inverse-client.ts](./src/inverse-client.ts) for further information. -->
-
-## WebSockets
-Inverse, linear & spot WebSockets can be used via a shared `WebsocketClient`. However, make sure to make one instance of WebsocketClient per market type (spot vs inverse vs linear vs linearfutures):
-
-```javascript
-const { WebsocketClient } = require('okx-api');
-
-const API_KEY = 'xxx';
-const PRIVATE_KEY = 'yyy';
-
-const wsConfig = {
-  key: API_KEY,
-  secret: PRIVATE_KEY,
-
-  /*
-    The following parameters are optional:
-  */
-
-  // defaults to false == testnet. Set to true for livenet.
-  // livenet: true
-
-  // NOTE: to listen to multiple markets (spot vs inverse vs linear vs linearfutures) at once, make one WebsocketClient instance per market
-
-  // defaults to inverse:
-  // market: 'inverse'
-  // market: 'linear'
-  // market: 'spot'
-
-  // how long to wait (in ms) before deciding the connection should be terminated & reconnected
-  // pongTimeout: 1000,
-
-  // how often to check (in ms) that WS connection is still alive
-  // pingInterval: 10000,
-
-  // how long to wait before attempting to reconnect (in ms) after connection is closed
-  // reconnectTimeout: 500,
-
-  // config options sent to RestClient (used for time sync). See RestClient docs.
-  // restOptions: { },
-
-  // config for axios used for HTTP requests. E.g for proxy support
-  // requestOptions: { }
-
-  // override which URL to use for websocket connections
-  // wsUrl: 'wss://stream.bytick.com/realtime'
-};
-
-const ws = new WebsocketClient(wsConfig);
-
-// subscribe to multiple topics at once
-ws.subscribe(['position', 'execution', 'trade']);
-
-// and/or subscribe to individual topics on demand
-ws.subscribe('kline.BTCUSD.1m');
-
-// Listen to events coming from websockets. This is the primary data source
-ws.on('update', data => {
-  console.log('update', data);
-});
-
-// Optional: Listen to websocket connection open event (automatic after subscribing to one or more topics)
-ws.on('open', ({ wsKey, event }) => {
-  console.log('connection open for websocket with ID: ' + wsKey);
-});
-
-// Optional: Listen to responses to websocket queries (e.g. the response after subscribing to a topic)
-ws.on('response', response => {
-  console.log('response', response);
-});
-
-// Optional: Listen to connection close event. Unexpected connection closes are automatically reconnected.
-ws.on('close', () => {
-  console.log('connection closed');
-});
-
-// Optional: Listen to raw error events.
-// Note: responses to invalid topics are currently only sent in the "response" event.
-ws.on('error', err => {
-  console.error('ERR', err);
-});
-```
-
-
-See [websocket-client.ts](./src/websocket-client.ts) for further information.
-
-Note: for linear websockets, pass `linear: true` in the constructor options when instancing the `WebsocketClient`. To connect to both linear and inverse websockets, make two instances of the WebsocketClient.
-
----
-
-## Customise Logging
-Pass a custom logger which supports the log methods `silly`, `debug`, `notice`, `info`, `warning` and `error`, or override methods from the default logger as desired.
-
-```javascript
-const { WebsocketClient, DefaultLogger } = require('okx-api');
-
-// Disable all logging on the silly level
-DefaultLogger.silly = () => {};
+## REST Client
 
-const ws = new WebsocketClient(
-  { key: 'xxx', secret: 'yyy' },
-  DefaultLogger
-);
-```
+### Requests & Responses
+- If your IDE doesn't have IntelliSense, check the [rest-client.ts](./src/rest-client.ts) for a list of methods, params & return types.
+- Requests follow the same ordering and format as the categories in the [API docs](https://www.okx.com/docs-v5/en/#rest-api).
+- Responses are parsed automatically for less nesting. Error responses are thrown in full:
+  - If the response looks successful (HTTP 200 and "code" in the response body === "0"), only the `data` property is directly (without the `code`, `data` & `msg` properties).
+  - If the response looks like an error (HTTP error OR the "code" property in the response does not equal "0"), the full response is thrown (including `code` and `msg` properties). See the interface for [APIResponse<T>](./src/types/rest/shared.ts).
 
 ## Browser Usage
 Build a bundle using webpack:
@@ -214,8 +70,10 @@ The bundle can be found in `dist/`. Altough usage should be largely consistent,
 ### Donations
 #### tiagosiebler
 Support my efforts to make algo trading accessible to all - register with my referral links:
-- [okx](https://www.bybit.com/en-US/register?affiliate_id=9410&language=en-US&group_id=0&group_type=1)
+- [Bybit](https://www.bybit.com/en-US/register?affiliate_id=9410&language=en-US&group_id=0&group_type=1)
 - [Binance](https://www.binance.com/en/register?ref=20983262)
+- [OKX](https://www.okx.com/join/18504944)
+- [FTX](https://ftx.com/referrals#a=ftxapigithub)
 
 Or buy me a coffee using any of these:
 - BTC: `1C6GWZL1XW3jrjpPTS863XtZiXL1aTK7Jk`

package/lib/index.d.ts

@@ -1 +1,2 @@
-export declare const HELLO = "HELLO";
+export * from './rest-client';
+export * from './util/typeGuards';

package/lib/index.js

@@ -1,16 +1,20 @@
 "use strict";
-// export * from './inverse-client';
-// export * from './inverse-futures-client';
-// export * from './linear-client';
-// export * from './spot-client';
-// export * from './websocket-client';
-// export * from './logger';
-// export * from './types/shared';
-// export * from './types/spot';
-// export * from './util/WsStore';
-// export * from './constants/enum';
+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 });
-exports.HELLO = void 0;
-// Package under development
-exports.HELLO = 'HELLO';
+__exportStar(require("./rest-client"), exports);
+__exportStar(require("./util/typeGuards"), exports);
+// export * from './util/WsStore';
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,oCAAoC;AACpC,4CAA4C;AAC5C,mCAAmC;AACnC,iCAAiC;AACjC,sCAAsC;AACtC,4BAA4B;AAC5B,kCAAkC;AAClC,gCAAgC;AAChC,kCAAkC;AAClC,oCAAoC;;;AAEpC,4BAA4B;AACf,QAAA,KAAK,GAAG,OAAO,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gDAA8B;AAC9B,oDAAkC;AAClC,kCAAkC"}

package/lib/rest-client.d.ts

@@ -0,0 +1,315 @@
+import { AxiosRequestConfig } from 'axios';
+import { OKXEnvironment, RestClientOptions } from './util/requestUtils';
+import BaseRestClient, { APICredentials } from './util/BaseRestClient';
+import { ContractGridDirection, GridAlgoOrderType, GridAlgoSubOrderType, InstrumentType, MarginMode, numberInString, Ticker, AlgoOrderRequest, AmendOrderRequest, CancelAlgoOrderRequest, OrderIdRequest, ClosePositionRequest, OrderRequest, OrderHistoryRequest, FillsHistoryRequest, AlgoRecentHistoryRequest, AlgoLongHistoryRequest, PaginatedSymbolRequest, OrderResult, CancelledOrderResult, AmendedOrder, ClosedPositions, OrderDetails, OrderListItem, HistoricOrder, OrderFill, AlgoOrderResult, AlgoOrderListItem, HistoricAlgoOrder, BlockCounterParty, CreateBlockRFQRequest, CreateRFQResult, CancelBlockRFQRequest, CancelBlockQuoteResult, CancelMultipleBlockRFQRequest, TimestampObject, ExecuteBlockQuoteResult, ExecuteBlockQuoteRequest, CreateBlockQuoteRequest, CreateBlockQuoteResult, CancelBlockRFQResult, CancelBlockQuoteRequest, CancelMultipleBlockQuoteRequest, BlockRFQResult, GetBlockRFQSParams, GetBlockQuoteParams, GetBlockQuoteResult, FundingCurrency, FundingBalance, AccountAssetValuation, FundTransferResult, FundTransferState, AssetBillDetails, AccountBalance, GetPositionsParams, AccountPosition, GetHistoricPositionParams, HistoricAccountPosition, AccountPositionRisk, AccountBill, AccountConfiguration, AccountPositionModeResult, AccountLeverageResult, AccountMaxOrderAmount, AccountMaxTradableAmount, AccountChangeMarginResult, AccountLeverage, AccountMaxLoan, AccountFeeRate, AccountIsolatedMode, SubAccount, SubAccountAPIReset, SubAccountBalances, SubAccountTransferResult, IndexTicker, OrderBook, Candle, CandleNoVolume, Trade } from './types/rest';
+export declare class RestClient extends BaseRestClient {
+    /**
+     * @public Creates an instance of the REST API client.
+     */
+    constructor(credentials?: APICredentials | null, environment?: OKXEnvironment, restClientOptions?: RestClientOptions, requestOptions?: AxiosRequestConfig);
+    getServerTime(): Promise<number>;
+    /**
+     *
+     * Trade endpoints (private)
+     *
+     */
+    placeOrder(params: OrderRequest): Promise<OrderResult[]>;
+    placeMultipleOrders(params: OrderRequest[]): Promise<OrderResult[]>;
+    cancelOrder(params: OrderIdRequest): Promise<CancelledOrderResult[]>;
+    cancelMultipleOrders(params: OrderIdRequest[]): Promise<CancelledOrderResult[]>;
+    amendOrder(params: AmendOrderRequest): Promise<AmendedOrder[]>;
+    amendMultipleOrders(params: AmendOrderRequest[]): Promise<AmendedOrder[]>;
+    closePositions(params: ClosePositionRequest): Promise<ClosedPositions[]>;
+    getOrderDetails(params: OrderIdRequest): Promise<OrderDetails[]>;
+    getOrderList(params?: OrderHistoryRequest): Promise<OrderListItem[]>;
+    /**
+     * Get history for last 7 days
+     */
+    getOrderHistory(params: OrderHistoryRequest): Promise<HistoricOrder[]>;
+    /**
+     * Get history for last 3 months
+     */
+    getOrderHistoryArchive(params: OrderHistoryRequest): Promise<HistoricOrder[]>;
+    /**
+     * Get history for last 7 days
+     */
+    getFills(params?: FillsHistoryRequest): Promise<OrderFill[]>;
+    /**
+     * Get history for last 3 months
+     */
+    getFillsHistory(params: FillsHistoryRequest): Promise<OrderFill[]>;
+    placeAlgoOrder(params: AlgoOrderRequest): Promise<AlgoOrderResult[]>;
+    cancelAlgoOrder(params: CancelAlgoOrderRequest[]): Promise<AlgoOrderResult[]>;
+    cancelAdvanceAlgoOrder(params: CancelAlgoOrderRequest[]): Promise<AlgoOrderResult[]>;
+    getAlgoOrderList(params: AlgoRecentHistoryRequest): Promise<AlgoOrderListItem[]>;
+    getAlgoOrderHistory(params: AlgoLongHistoryRequest): Promise<HistoricAlgoOrder[]>;
+    /**
+     *
+     * Block trading endpoints (private)
+     *
+     */
+    getBlockCounterParties(): Promise<BlockCounterParty[]>;
+    createBlockRFQ(params: CreateBlockRFQRequest): Promise<CreateRFQResult[]>;
+    cancelBlockRFQ(params?: CancelBlockRFQRequest): Promise<CancelBlockRFQResult[]>;
+    cancelMultipleBlockRFQs(params: CancelMultipleBlockRFQRequest): Promise<CancelBlockRFQResult[]>;
+    cancelAllRFQs(): Promise<TimestampObject[]>;
+    executeBlockQuote(params: ExecuteBlockQuoteRequest): Promise<ExecuteBlockQuoteResult[]>;
+    createBlockQuote(params: CreateBlockQuoteRequest): Promise<CreateBlockQuoteResult[]>;
+    cancelBlockQuote(params: CancelBlockQuoteRequest): Promise<CancelBlockQuoteResult[]>;
+    cancelMultipleBlockQuotes(params: CancelMultipleBlockQuoteRequest): Promise<CancelBlockQuoteResult[]>;
+    cancelAllBlockQuotes(): Promise<TimestampObject[]>;
+    getBlockRFQs(params?: GetBlockRFQSParams): Promise<BlockRFQResult[]>;
+    getBlockQuotes(params?: GetBlockQuoteParams): Promise<GetBlockQuoteResult[]>;
+    getBlockTrades(params: unknown): Promise<unknown[]>;
+    getPublicRFQBlockTrades(params: unknown): Promise<unknown[]>;
+    /**
+     *
+     * Funding endpoints (private)
+     *
+     */
+    getCurrencies(ccy?: string): Promise<FundingCurrency[]>;
+    getBalances(ccy?: string): Promise<FundingBalance[]>;
+    getAccountAssetValuation(ccy?: string): Promise<AccountAssetValuation[]>;
+    fundsTransfer(params: unknown): Promise<FundTransferResult[]>;
+    getFundsTransferState(params: {
+        transId?: string;
+        clientId?: string;
+        type?: '0' | '1' | '2';
+    }): Promise<FundTransferState[]>;
+    getAssetBillsDetails(params?: {
+        ccy?: string;
+        type?: numberInString;
+        clientId?: string;
+        after?: numberInString;
+        before?: numberInString;
+        limit?: numberInString;
+    }): Promise<AssetBillDetails[]>;
+    getLightningDeposits(ccy: string, amt: numberInString, to?: '6' | '18'): Promise<unknown[]>;
+    getDepositAddress(ccy: string): Promise<unknown[]>;
+    getDepositHistory(params: unknown): Promise<unknown[]>;
+    withdraw(params: unknown): Promise<unknown[]>;
+    withdrawLightning(ccy: string, invoice: string, memo?: string): Promise<unknown[]>;
+    cancelWithdrawal(wdId: string): Promise<unknown[]>;
+    getWithdrawalHistory(params?: unknown): Promise<unknown[]>;
+    smallAssetsConvert(ccy: string[]): Promise<unknown[]>;
+    getSavingBalance(ccy?: string): Promise<unknown[]>;
+    savingsPurchaseRedemption(ccy: string, amt: numberInString, side: 'purchase' | 'redempt', rate: numberInString): Promise<unknown[]>;
+    setLendingRate(ccy: string, rate: numberInString): Promise<unknown[]>;
+    getLendingHistory(params?: PaginatedSymbolRequest): Promise<unknown[]>;
+    getPublicBorrowInfo(ccy?: string): Promise<unknown[]>;
+    getPublicBorrowHistory(params?: PaginatedSymbolRequest): Promise<unknown[]>;
+    /**
+     *
+     * Convert endpoints (private)
+     *
+     */
+    getConvertCurrencies(): Promise<unknown[]>;
+    getConvertCurrencyPair(fromCcy: string, toCcy: string): Promise<unknown[]>;
+    estimateConvertQuote(params: unknown): Promise<unknown[]>;
+    convertTrade(params: unknown): Promise<unknown[]>;
+    getConvertHistory(params?: unknown): Promise<unknown[]>;
+    /**
+     *
+     * Account endpoints (private)
+     *
+     */
+    getBalance(ccy?: string): Promise<AccountBalance[]>;
+    getPositions(params?: GetPositionsParams): Promise<AccountPosition[]>;
+    getPositionsHistory(params?: GetHistoricPositionParams): Promise<HistoricAccountPosition[]>;
+    getAccountPositionRisk(instType?: Omit<'SPOT', InstrumentType>): Promise<AccountPositionRisk[]>;
+    /** Up to last 7 days */
+    getBills(params?: unknown): Promise<AccountBill[]>;
+    /** Last 3 months */
+    getBillsArchive(params?: unknown): Promise<AccountBill[]>;
+    getAccountConfiguration(): Promise<AccountConfiguration[]>;
+    setPositionMode(posMode: 'long_short_mode' | 'net'): Promise<AccountPositionModeResult[]>;
+    setLeverage(params: unknown): Promise<AccountLeverageResult[]>;
+    /** Max buy/sell amount or open amount */
+    getMaxOrderAmount(params: unknown): Promise<AccountMaxOrderAmount[]>;
+    getMaxAvailableTradableAmount(params: unknown): Promise<AccountMaxTradableAmount[]>;
+    changePositionMargin(params: unknown): Promise<AccountChangeMarginResult[]>;
+    getLeverage(instId: string, mgnMode: MarginMode): Promise<AccountLeverage[]>;
+    getMaxLoan(instId: string, mgnMode: MarginMode, mgnCcy?: string): Promise<AccountMaxLoan[]>;
+    getFeeRates(instType: InstrumentType, instId?: string, uly?: string): Promise<AccountFeeRate[]>;
+    getInterestAccrued(params?: unknown): Promise<unknown[]>;
+    getInterestRate(ccy?: string): Promise<unknown[]>;
+    setGreeksDisplayType(greeksType: 'PA' | 'BS'): Promise<unknown[]>;
+    setIsolatedMode(isoMode: 'automatic' | 'autonomy', type: 'MARGIN' | 'CONTRACTS'): Promise<AccountIsolatedMode[]>;
+    getMaxWithdrawals(ccy?: string): Promise<unknown[]>;
+    getAccountRiskState(): Promise<unknown[]>;
+    VIPLoanBorrowRepay(ccy: string, side: 'borrow' | 'repay', amt: numberInString): Promise<unknown[]>;
+    getVIPLoanBorrowRepayHistory(params?: unknown): Promise<unknown[]>;
+    getBorrowInterestLimits(params?: {
+        type?: '1' | '2';
+        ccy?: string;
+    }): Promise<unknown[]>;
+    positionBuilder(params?: unknown): Promise<unknown[]>;
+    getGreeks(ccy?: string): Promise<unknown[]>;
+    getPMLimitation(instType: 'SWAP' | 'FUTURES' | 'OPTION', uly: string): Promise<unknown[]>;
+    /**
+     *
+     * SubAccount endpoints (private)
+     *
+     */
+    getSubAccountList(params?: unknown): Promise<SubAccount[]>;
+    resetSubAccountAPIKey(subAcct: string, apiKey: string, options?: {
+        label?: string;
+        perm?: string;
+        ip?: string;
+    }): Promise<SubAccountAPIReset[]>;
+    getSubAccountBalances(subAcct: string): Promise<SubAccountBalances[]>;
+    getSubAccountFundingBalances(subAcct: string, ccy?: string): Promise<FundingBalance[]>;
+    getSubAccountTransferHistory(params?: unknown): Promise<unknown[]>;
+    transferSubAccountBalance(params: unknown): Promise<SubAccountTransferResult[]>;
+    setSubAccountTransferOutPermission(subAcct: string, canTransOut?: boolean): Promise<unknown[]>;
+    getSubAccountListCustodyTrading(subAcct?: string): Promise<unknown[]>;
+    /**
+     *
+     * Grid trading endpoints (private)
+     *
+     */
+    placeGridAlgoOrder(params: unknown): Promise<unknown[]>;
+    amendGridAlgoOrder(algoId: string, instId: string, triggerPx: {
+        slTriggerPx?: numberInString;
+        tpTriggerPx?: numberInString;
+    }): Promise<unknown[]>;
+    stopGridAlgoOrder(algoId: string, instId: string, algoOrdType: GridAlgoOrderType, stopType: '1' | '2'): Promise<unknown[]>;
+    getGridAlgoOrderList(params: unknown): Promise<unknown[]>;
+    getGridAlgoOrderHistory(params: unknown): Promise<unknown[]>;
+    getGridAlgoOrderDetails(algoOrdType: GridAlgoOrderType, algoId: string): Promise<unknown[]>;
+    getGridAlgoSubOrders(algoOrdType: GridAlgoOrderType, algoId: string, type: GridAlgoSubOrderType, groupId?: string, pagination?: {
+        after?: numberInString;
+        before?: numberInString;
+        limit?: number;
+    }): Promise<unknown[]>;
+    /** Only contract grid supports this method */
+    getGridAlgoOrderPositions(algoOrdType: 'contract_grid', algoId: string): Promise<unknown[]>;
+    spotGridWithdrawIncome(algoId: string): Promise<unknown[]>;
+    computeGridMarginBalance(algoId: string, type: 'add' | 'reduce', amt?: numberInString): Promise<unknown[]>;
+    adjustGridMarginBalance(algoId: string, type: 'add' | 'reduce', change: {
+        amt?: numberInString;
+        percent?: numberInString;
+    }): Promise<unknown[]>;
+    getGridAIParameter(algoOrdType: GridAlgoOrderType, instId: string, direction?: ContractGridDirection, duration?: '7D' | '30D' | '180D'): Promise<unknown[]>;
+    /**
+     *
+     * Market data endpoints (public)
+     *
+     */
+    getTickers(instrumentType: InstrumentType, uly?: string): Promise<Ticker[]>;
+    getTicker(instId: string): Promise<Ticker[]>;
+    getIndexTickers(params: {
+        quoteCcy?: string;
+        instId?: string;
+    }): Promise<IndexTicker[]>;
+    getOrderBook(instId: string, sz?: numberInString): Promise<OrderBook[]>;
+    getCandles(instId: string, bar?: string, pagination?: {
+        after?: numberInString;
+        before?: numberInString;
+        limit?: numberInString;
+    }): Promise<Candle[]>;
+    getHistoricCandles(instId: string, bar?: string, pagination?: {
+        after?: numberInString;
+        before?: numberInString;
+        limit?: numberInString;
+    }): Promise<Candle[]>;
+    getIndexCandles(instId: string, bar?: string, pagination?: {
+        after?: numberInString;
+        before?: numberInString;
+        limit?: numberInString;
+    }): Promise<CandleNoVolume[]>;
+    getMarkPriceCandles(instId: string, bar?: string, pagination?: {
+        after?: numberInString;
+        before?: numberInString;
+        limit?: numberInString;
+    }): Promise<CandleNoVolume[]>;
+    getTrades(instId: string, limit?: number): Promise<Trade[]>;
+    getHistoricTrades(instId: string, pagination?: {
+        after?: numberInString;
+        before?: numberInString;
+        limit?: numberInString;
+        type?: '1' | '2';
+    }): Promise<Trade[]>;
+    get24hrTotalVolume(): Promise<unknown[]>;
+    getOracle(): Promise<unknown[]>;
+    getExchangeRate(): Promise<unknown[]>;
+    getIndexComponents(index: string): Promise<unknown[]>;
+    getBlockTickers(instType: InstrumentType, uly?: string): Promise<unknown[]>;
+    getBlockTicker(instId: string): Promise<unknown[]>;
+    getPublicBlockTrades(instId: string): Promise<unknown[]>;
+    /**
+     *
+     * Public data endpoints (public)
+     *
+     */
+    getInstruments(params: unknown): Promise<unknown[]>;
+    getDeliveryExerciseHistory(params: unknown): Promise<unknown[]>;
+    getOpenInterest(params: unknown): Promise<unknown[]>;
+    getFundingRate(params: unknown): Promise<unknown[]>;
+    getFundingRateHistory(params: unknown): Promise<unknown[]>;
+    getMinMaxLimitPrice(params: unknown): Promise<unknown[]>;
+    getOptionMarketData(params: unknown): Promise<unknown[]>;
+    getEstimatedDeliveryExercisePrice(params: unknown): Promise<unknown[]>;
+    getDiscountRateAndInterestFreeQuota(params: unknown): Promise<unknown[]>;
+    getSystemTime(params: unknown): Promise<unknown[]>;
+    getLiquidationOrders(params: unknown): Promise<unknown[]>;
+    getMarkPrice(params: unknown): Promise<unknown[]>;
+    getPositionTiers(params: unknown): Promise<unknown[]>;
+    getInterestRateAndLoanQuota(params: unknown): Promise<unknown[]>;
+    getVIPInterestRateAndLoanQuota(params: unknown): Promise<unknown[]>;
+    getUnderlying(params: unknown): Promise<unknown[]>;
+    getInsuranceFund(params: unknown): Promise<unknown[]>;
+    getUnitConvert(params: unknown): Promise<unknown[]>;
+    /**
+     *
+     * Trading data endpoints (public)
+     *
+     */
+    getSupportCoin(): Promise<unknown[]>;
+    getTakerVolume(): Promise<unknown[]>;
+    getMarginLendingRatio(params: {
+        ccy: string;
+        begin?: numberInString;
+        end?: numberInString;
+        period: '5m' | '1H' | '1D';
+    }): Promise<unknown[]>;
+    getLongShortRatio(params: {
+        ccy: string;
+        begin?: numberInString;
+        end?: numberInString;
+        period: '5m' | '1H' | '1D';
+    }): Promise<unknown[]>;
+    getContractsOpenInterestAndVolume(params: {
+        ccy: string;
+        begin?: numberInString;
+        end?: numberInString;
+        period: '5m' | '1H' | '1D';
+    }): Promise<unknown[]>;
+    getOptionsOpenInterestAndVolume(params: {
+        ccy: string;
+        period: '8H' | '1D';
+    }): Promise<unknown[]>;
+    getPutCallRatio(params: {
+        ccy: string;
+        period: '8H' | '1D';
+    }): Promise<unknown[]>;
+    getOpenInterestAndVolumeExpiry(params: {
+        ccy: string;
+        period: '8H' | '1D';
+    }): Promise<unknown[]>;
+    getOpenInterestAndVolumeStrike(params: {
+        ccy: string;
+        expTime: string;
+        period: '8H' | '1D';
+    }): Promise<unknown[]>;
+    getTakerFlow(params: {
+        ccy: string;
+        period: '8H' | '1D';
+    }): Promise<unknown[]>;
+    /**
+     *
+     * Status endpoints (public)
+     *
+     */
+    getSystemStatus(state?: 'scheduled' | 'ongoing' | 'pre_open' | 'completed' | 'canceled'): Promise<unknown[]>;
+}