@yuants/vendor-okx 0.23.22 → 0.23.24

package/lib/public-api.d.ts

@@ -0,0 +1,359 @@
+/**
+ * 获取所有产品行情信息
+ *
+ * 获取产品行情信息
+ *
+ * 限速：20次/2s
+ * 限速规则：IP
+ *
+ * https://www.okx.com/docs-v5/zh/#order-book-trading-market-data-get-tickers
+ */
+export declare const getMarketTickers: (params: {
+    instType: string;
+    uly?: string;
+    instFamily?: string;
+}) => Promise<{
+    code: string;
+    msg: string;
+    data: Array<{
+        instType: string;
+        instId: string;
+        last: string;
+        lastSz: string;
+        askPx: string;
+        askSz: string;
+        bidPx: string;
+        bidSz: string;
+        open24h: string;
+        high24h: string;
+        low24h: string;
+        volCcy24h: string;
+        vol24h: string;
+        sodUtc0: string;
+        sodUtc8: string;
+        ts: string;
+    }>;
+}>;
+/**
+ * 获取交易产品基础信息
+ *
+ * 获取所有可交易产品的信息列表。
+ *
+ * 限速：20次/2s
+ * 限速规则：IP +instType
+ *
+ * https://www.okx.com/docs-v5/zh/#public-data-rest-api-get-instruments
+ */
+export declare const getInstruments: (params: {
+    instType: string;
+    uly?: string;
+    instFamily?: string;
+    instId?: string;
+}) => Promise<{
+    code: string;
+    msg: string;
+    data: Array<{
+        alias: string;
+        baseCcy: string;
+        category: string;
+        ctMult: string;
+        ctType: string;
+        ctVal: string;
+        ctValCcy: string;
+        expTime: string;
+        instFamily: string;
+        instId: string;
+        instType: string;
+        lever: string;
+        listTime: string;
+        lotSz: string;
+        maxIcebergSz: string;
+        maxLmtAmt: string;
+        maxLmtSz: string;
+        maxMktAmt: string;
+        maxMktSz: string;
+        maxStopSz: string;
+        maxTriggerSz: string;
+        maxTwapSz: string;
+        minSz: string;
+        optType: string;
+        quoteCcy: string;
+        settleCcy: string;
+        state: string;
+        stk: string;
+        tickSz: string;
+        uly: string;
+    }>;
+}>;
+/**
+ * 获取永续合约当前资金费率
+ *
+ * 获取当前资金费率
+ *
+ * 限速：20次/2s
+ * 限速规则：IP +instrumentID
+ *
+ * https://www.okx.com/docs-v5/zh/#public-data-rest-api-get-funding-rate
+ */
+export declare const getFundingRate: (params: {
+    instId: string;
+}) => Promise<{
+    code: string;
+    data: Array<{
+        fundingRate: string;
+        fundingTime: string;
+        instId: string;
+        instType: string;
+        method: string;
+        maxFundingRate: string;
+        minFundingRate: string;
+        nextFundingRate: string;
+        nextFundingTime: string;
+        premium: string;
+        settFundingRate: string;
+        settState: string;
+        ts: string;
+    }>;
+    msg: string;
+}>;
+/**
+ * 获取永续合约历史资金费率
+ *
+ * 获取最近3个月的历史资金费率
+ *
+ * 限速：10次/2s
+ * 限速规则：IP +instrumentID
+ *
+ * https://www.okx.com/docs-v5/zh/#public-data-rest-api-get-funding-rate-history
+ */
+export declare const getFundingRateHistory: (params: {
+    instId: string;
+    before?: string;
+    after?: string;
+    limit?: string;
+}) => Promise<{
+    code: string;
+    msg: string;
+    data: Array<{
+        fundingRate: string;
+        fundingTime: string;
+        instId: string;
+        instType: string;
+        method: string;
+        realizedRate: string;
+    }>;
+}>;
+/**
+ * 获取标记价格历史K线数据
+ *
+ * 获取最近几年的标记价格K线数据
+ *
+ * 限速：10次/2s
+ * 限速规则：IP
+ *
+ * https://www.okx.com/docs-v5/zh/#public-data-rest-api-get-mark-price-candlesticks-history
+ */
+export declare const getHistoryMarkPriceCandles: (params: {
+    instId: string;
+    bar?: string;
+    after?: string;
+    before?: string;
+    limit?: string;
+}) => Promise<{
+    code: string;
+    msg: string;
+    data: Array<[ts: string, o: string, h: string, l: string, c: string, confirm: string]>;
+}>;
+/**
+ * 获取交易产品历史K线数据
+ *
+ * 获取最近几年的历史k线数据(1s k线支持查询最近3个月的数据)
+ *
+ * 限速：20次/2s
+ * 限速规则：IP
+ *
+ * 期权不支持 1s K线， 其他业务线 (币币, 杠杆, 交割和永续)支持
+ *
+ * https://www.okx.com/docs-v5/zh/#order-book-trading-market-data-get-candlesticks-history
+ */
+export declare const getHistoryCandles: (params: {
+    instId: string;
+    bar?: string;
+    after?: string;
+    before?: string;
+    limit?: string;
+}) => Promise<{
+    code: string;
+    msg: string;
+    data: Array<[
+        ts: string,
+        o: string,
+        h: string,
+        l: string,
+        c: string,
+        vol: string,
+        volCcy: string,
+        volCcyQuote: string,
+        confirm: string
+    ]>;
+}>;
+/**
+ * 获取持仓总量
+ *
+ * 查询单个交易产品的市场的持仓总量
+ *
+ * 限速：20次/2s
+ * 限速规则：IP + instrumentID
+ *
+ * https://www.okx.com/docs-v5/zh/#public-data-rest-api-get-open-interest
+ */
+export declare const getOpenInterest: (params: {
+    instType: string;
+    uly?: string;
+    instFamily?: string;
+    instId?: string;
+}) => Promise<{
+    code: string;
+    msg: string;
+    data: {
+        instType: string;
+        instId: string;
+        oi: string;
+        oiCcy: string;
+        ts: string;
+    }[];
+}>;
+/**
+ * 获取市场借币杠杆利率和借币限额
+ *
+ * 限速：2次/2s
+ * 限速规则：IP
+ *
+ * https://www.okx.com/docs-v5/zh/#public-data-rest-api-get-interest-rate-and-loan-quota
+ */
+export declare const getInterestRateLoanQuota: () => Promise<{
+    code: string;
+    data?: Array<{
+        basic: Array<{
+            ccy: string;
+            rate: string;
+            quota: string;
+        }>;
+        vip: Array<{
+            loanQuotaCoef: string;
+            level: string;
+        }>;
+        regular: Array<{
+            loanQuotaCoef: string;
+            level: string;
+        }>;
+    }>;
+}>;
+/**
+ * 获取市场借贷历史（公共）
+ *
+ * 公共接口无须鉴权
+ *
+ * 返回2021年12月14日后的记录
+ *
+ * 限速：6次/s
+ * 限速规则：IP
+ *
+ * https://www.okx.com/docs-v5/zh/#financial-product-savings-get-public-borrow-history-public
+ */
+export declare const getLendingRateHistory: (params: {
+    ccy?: string;
+    after?: string;
+    before?: string;
+    limit?: string;
+}) => Promise<{
+    code: string;
+    msg: string;
+    data: Array<{
+        ccy: string;
+        amt: string;
+        rate: string;
+        ts: string;
+    }>;
+}>;
+/**
+ * 获取指数行情数据
+ *
+ * 限速：20次/2s
+ *
+ * https://www.okx.com/docs-v5/zh/#public-data-rest-api-get-index-tickers
+ */
+export declare const getMarketIndexTicker: (params?: {
+    quoteCcy?: string;
+    instId?: string;
+}) => Promise<{
+    code: string;
+    msg: string;
+    data: {
+        instId: string;
+        idxPx: string;
+        high24h: string;
+        sodUtc0: string;
+        open24h: string;
+        low24h: string;
+        sodUtc8: string;
+        ts: string;
+    }[];
+}>;
+/**
+ * 获取产品深度
+ *
+ * 限速：40次/2s
+ * 限速规则：IP
+ *
+ * https://www.okx.com/docs-v5/zh/#order-book-trading-market-data-get-order-book
+ */
+export declare const getMarketBooks: (params: {
+    sz?: string;
+    instId: string;
+}) => Promise<{
+    code: string;
+    data: {
+        asks: [price: string, volume: string, abandon: string, order_number: string][];
+        bids: [price: string, volume: string, abandon: string, order_number: string][];
+        ts: string;
+    }[];
+    msg: string;
+}>;
+/**
+ * 获取衍生品仓位档位
+ *
+ * 获取全部仓位档位对应信息
+ *
+ * 限速：10次/2s
+ * 限速规则：IP
+ *
+ * https://www.okx.com/docs-v5/zh/#public-data-rest-api-get-position-tiers
+ */
+export declare const getPositionTiers: (params: {
+    instType: string;
+    tdMode: string;
+    instFamily?: string;
+    instId?: string;
+    uly?: string;
+    ccy?: string;
+    tier?: string;
+}) => Promise<{
+    code: string;
+    msg: string;
+    data: Array<{
+        uly: string;
+        instFamily: string;
+        instId: string;
+        tier: string;
+        minSz: string;
+        maxSz: string;
+        mmr: string;
+        imr: string;
+        maxLever: string;
+        optMgnFactor: string;
+        quoteMaxLoan: string;
+        baseMaxLoan: string;
+    }>;
+}>;
+//# sourceMappingURL=public-api.d.ts.map

package/lib/public-api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"public-api.d.ts","sourceRoot":"","sources":["../src/public-api.ts"],"names":[],"mappings":"AAmBA;;;;;;;;;GASG;AACH,eAAO,MAAM,gBAAgB,WAAY;IACvC,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,KAAG,QAAQ;IACV,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM;QACV,QAAQ,EAAE,MAAM,CAAC;QACjB,MAAM,EAAE,MAAM,CAAC;QACf,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,MAAM,CAAC;QACd,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,MAAM,CAAC;QAChB,MAAM,EAAE,MAAM,CAAC;QACf,SAAS,EAAE,MAAM,CAAC;QAClB,MAAM,EAAE,MAAM,CAAC;QACf,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,MAAM,CAAC;QAChB,EAAE,EAAE,MAAM,CAAC;KACZ,CAAC,CAAC;CACJ,CAA2D,CAAC;AAE7D;;;;;;;;;GASG;AACH,eAAO,MAAM,cAAc,WAAY;IACrC,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,KAAG,QAAQ;IACV,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM;QACV,KAAK,EAAE,MAAM,CAAC;QACd,OAAO,EAAE,MAAM,CAAC;QAChB,QAAQ,EAAE,MAAM,CAAC;QACjB,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,EAAE,MAAM,CAAC;QACd,QAAQ,EAAE,MAAM,CAAC;QACjB,OAAO,EAAE,MAAM,CAAC;QAChB,UAAU,EAAE,MAAM,CAAC;QACnB,MAAM,EAAE,MAAM,CAAC;QACf,QAAQ,EAAE,MAAM,CAAC;QACjB,KAAK,EAAE,MAAM,CAAC;QACd,QAAQ,EAAE,MAAM,CAAC;QACjB,KAAK,EAAE,MAAM,CAAC;QACd,YAAY,EAAE,MAAM,CAAC;QACrB,SAAS,EAAE,MAAM,CAAC;QAClB,QAAQ,EAAE,MAAM,CAAC;QACjB,SAAS,EAAE,MAAM,CAAC;QAClB,QAAQ,EAAE,MAAM,CAAC;QACjB,SAAS,EAAE,MAAM,CAAC;QAClB,YAAY,EAAE,MAAM,CAAC;QACrB,SAAS,EAAE,MAAM,CAAC;QAClB,KAAK,EAAE,MAAM,CAAC;QACd,OAAO,EAAE,MAAM,CAAC;QAChB,QAAQ,EAAE,MAAM,CAAC;QACjB,SAAS,EAAE,MAAM,CAAC;QAClB,KAAK,EAAE,MAAM,CAAC;QACd,GAAG,EAAE,MAAM,CAAC;QACZ,MAAM,EAAE,MAAM,CAAC;QACf,GAAG,EAAE,MAAM,CAAC;KACb,CAAC,CAAC;CACJ,CAA+D,CAAC;AAEjE;;;;;;;;;GASG;AACH,eAAO,MAAM,cAAc,WAAY;IACrC,MAAM,EAAE,MAAM,CAAC;CAChB,KAAG,QAAQ;IACV,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM;QACV,WAAW,EAAE,MAAM,CAAC;QACpB,WAAW,EAAE,MAAM,CAAC;QACpB,MAAM,EAAE,MAAM,CAAC;QACf,QAAQ,EAAE,MAAM,CAAC;QACjB,MAAM,EAAE,MAAM,CAAC;QACf,cAAc,EAAE,MAAM,CAAC;QACvB,cAAc,EAAE,MAAM,CAAC;QACvB,eAAe,EAAE,MAAM,CAAC;QACxB,eAAe,EAAE,MAAM,CAAC;QACxB,OAAO,EAAE,MAAM,CAAC;QAChB,eAAe,EAAE,MAAM,CAAC;QACxB,SAAS,EAAE,MAAM,CAAC;QAClB,EAAE,EAAE,MAAM,CAAC;KACZ,CAAC,CAAC;IACH,GAAG,EAAE,MAAM,CAAC;CACb,CAAgE,CAAC;AAElE;;;;;;;;;GASG;AACH,eAAO,MAAM,qBAAqB,WAAY;IAC5C,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,KAAG,QAAQ;IACV,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM;QACV,WAAW,EAAE,MAAM,CAAC;QACpB,WAAW,EAAE,MAAM,CAAC;QACpB,MAAM,EAAE,MAAM,CAAC;QACf,QAAQ,EAAE,MAAM,CAAC;QACjB,MAAM,EAAE,MAAM,CAAC;QACf,YAAY,EAAE,MAAM,CAAC;KACtB,CAAC,CAAC;CACJ,CAAwE,CAAC;AAE1E;;;;;;;;;GASG;AACH,eAAO,MAAM,0BAA0B,WAAY;IACjD,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,KAAG,QAAQ;IACV,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,SAAS,MAAM,CAAC,CAAC,CAAC;CACxF,CAA8E,CAAC;AAEhF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,iBAAiB,WAAY;IACxC,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,KAAG,QAAQ;IACV,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MACJ;QACE,EAAE,EAAE,MAAM;QACV,CAAC,EAAE,MAAM;QACT,CAAC,EAAE,MAAM;QACT,CAAC,EAAE,MAAM;QACT,CAAC,EAAE,MAAM;QACT,GAAG,EAAE,MAAM;QACX,MAAM,EAAE,MAAM;QACd,WAAW,EAAE,MAAM;QACnB,SAAS,MAAM;KAChB,CACF,CAAC;CACH,CAAmE,CAAC;AAErE;;;;;;;;;GASG;AACH,eAAO,MAAM,eAAe,WAAY;IACtC,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,KAAG,QAAQ;IACV,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE;QACJ,QAAQ,EAAE,MAAM,CAAC;QACjB,MAAM,EAAE,MAAM,CAAC;QACf,EAAE,EAAE,MAAM,CAAC;QACX,KAAK,EAAE,MAAM,CAAC;QACd,EAAE,EAAE,MAAM,CAAC;KACZ,EAAE,CAAC;CACL,CAAiE,CAAC;AAEnE;;;;;;;GAOG;AACH,eAAO,MAAM,wBAAwB,QAAO,QAAQ;IAClD,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM;QACX,KAAK,EAAE,MAAM;YACX,GAAG,EAAE,MAAM,CAAC;YACZ,IAAI,EAAE,MAAM,CAAC;YACb,KAAK,EAAE,MAAM,CAAC;SACf,CAAC,CAAC;QACH,GAAG,EAAE,MAAM;YACT,aAAa,EAAE,MAAM,CAAC;YACtB,KAAK,EAAE,MAAM,CAAC;SACf,CAAC,CAAC;QACH,OAAO,EAAE,MAAM;YACb,aAAa,EAAE,MAAM,CAAC;YACtB,KAAK,EAAE,MAAM,CAAC;SACf,CAAC,CAAC;KACJ,CAAC,CAAC;CACJ,CAAoE,CAAC;AAEtE;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,qBAAqB,WAAY;IAC5C,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,KAAG,QAAQ;IACV,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM;QACV,GAAG,EAAE,MAAM,CAAC;QACZ,GAAG,EAAE,MAAM,CAAC;QACZ,IAAI,EAAE,MAAM,CAAC;QACb,EAAE,EAAE,MAAM,CAAC;KACZ,CAAC,CAAC;CACJ,CAAiF,CAAC;AAEnF;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB,YAAa;IAC5C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,KAAG,QAAQ;IACV,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE;QACJ,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,EAAE,MAAM,CAAC;QACd,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,MAAM,CAAC;QAChB,MAAM,EAAE,MAAM,CAAC;QACf,OAAO,EAAE,MAAM,CAAC;QAChB,EAAE,EAAE,MAAM,CAAC;KACZ,EAAE,CAAC;CACL,CAAiE,CAAC;AAEnE;;;;;;;GAOG;AACH,eAAO,MAAM,cAAc,WAAY;IACrC,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;CAChB,KAAG,QAAQ;IACV,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE;QACJ,IAAI,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,CAAC,EAAE,CAAC;QAC/E,IAAI,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,CAAC,EAAE,CAAC;QAC/E,EAAE,EAAE,MAAM,CAAC;KACZ,EAAE,CAAC;IACJ,GAAG,EAAE,MAAM,CAAC;CACb,CAAyD,CAAC;AAE3D;;;;;;;;;GASG;AACH,eAAO,MAAM,gBAAgB,WAAY;IACvC,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,KAAG,QAAQ;IACV,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM;QACV,GAAG,EAAE,MAAM,CAAC;QACZ,UAAU,EAAE,MAAM,CAAC;QACnB,MAAM,EAAE,MAAM,CAAC;QACf,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,MAAM,CAAC;QACd,GAAG,EAAE,MAAM,CAAC;QACZ,GAAG,EAAE,MAAM,CAAC;QACZ,QAAQ,EAAE,MAAM,CAAC;QACjB,YAAY,EAAE,MAAM,CAAC;QACrB,YAAY,EAAE,MAAM,CAAC;QACrB,WAAW,EAAE,MAAM,CAAC;KACrB,CAAC,CAAC;CACJ,CAAkE,CAAC"}

package/lib/public-api.js

@@ -0,0 +1,161 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPositionTiers = exports.getMarketBooks = exports.getMarketIndexTicker = exports.getLendingRateHistory = exports.getInterestRateLoanQuota = exports.getOpenInterest = exports.getHistoryCandles = exports.getHistoryMarkPriceCandles = exports.getFundingRateHistory = exports.getFundingRate = exports.getInstruments = exports.getMarketTickers = void 0;
+const utils_1 = require("@yuants/utils");
+/**
+ * 基础公共请求函数
+ */
+async function publicRequest(method, path, params) {
+    const url = new URL('https://www.okx.com');
+    url.pathname = path;
+    if (method === 'GET') {
+        for (const key in params) {
+            url.searchParams.set(key, params[key]);
+        }
+    }
+    console.info((0, utils_1.formatTime)(Date.now()), method, url.href);
+    const res = await fetch(url.href, { method });
+    return res.json();
+}
+/**
+ * 获取所有产品行情信息
+ *
+ * 获取产品行情信息
+ *
+ * 限速：20次/2s
+ * 限速规则：IP
+ *
+ * https://www.okx.com/docs-v5/zh/#order-book-trading-market-data-get-tickers
+ */
+const getMarketTickers = (params) => publicRequest('GET', '/api/v5/market/tickers', params);
+exports.getMarketTickers = getMarketTickers;
+/**
+ * 获取交易产品基础信息
+ *
+ * 获取所有可交易产品的信息列表。
+ *
+ * 限速：20次/2s
+ * 限速规则：IP +instType
+ *
+ * https://www.okx.com/docs-v5/zh/#public-data-rest-api-get-instruments
+ */
+const getInstruments = (params) => publicRequest('GET', '/api/v5/public/instruments', params);
+exports.getInstruments = getInstruments;
+/**
+ * 获取永续合约当前资金费率
+ *
+ * 获取当前资金费率
+ *
+ * 限速：20次/2s
+ * 限速规则：IP +instrumentID
+ *
+ * https://www.okx.com/docs-v5/zh/#public-data-rest-api-get-funding-rate
+ */
+const getFundingRate = (params) => publicRequest('GET', '/api/v5/public/funding-rate', params);
+exports.getFundingRate = getFundingRate;
+/**
+ * 获取永续合约历史资金费率
+ *
+ * 获取最近3个月的历史资金费率
+ *
+ * 限速：10次/2s
+ * 限速规则：IP +instrumentID
+ *
+ * https://www.okx.com/docs-v5/zh/#public-data-rest-api-get-funding-rate-history
+ */
+const getFundingRateHistory = (params) => publicRequest('GET', '/api/v5/public/funding-rate-history', params);
+exports.getFundingRateHistory = getFundingRateHistory;
+/**
+ * 获取标记价格历史K线数据
+ *
+ * 获取最近几年的标记价格K线数据
+ *
+ * 限速：10次/2s
+ * 限速规则：IP
+ *
+ * https://www.okx.com/docs-v5/zh/#public-data-rest-api-get-mark-price-candlesticks-history
+ */
+const getHistoryMarkPriceCandles = (params) => publicRequest('GET', '/api/v5/market/history-mark-price-candles', params);
+exports.getHistoryMarkPriceCandles = getHistoryMarkPriceCandles;
+/**
+ * 获取交易产品历史K线数据
+ *
+ * 获取最近几年的历史k线数据(1s k线支持查询最近3个月的数据)
+ *
+ * 限速：20次/2s
+ * 限速规则：IP
+ *
+ * 期权不支持 1s K线， 其他业务线 (币币, 杠杆, 交割和永续)支持
+ *
+ * https://www.okx.com/docs-v5/zh/#order-book-trading-market-data-get-candlesticks-history
+ */
+const getHistoryCandles = (params) => publicRequest('GET', '/api/v5/market/history-candles', params);
+exports.getHistoryCandles = getHistoryCandles;
+/**
+ * 获取持仓总量
+ *
+ * 查询单个交易产品的市场的持仓总量
+ *
+ * 限速：20次/2s
+ * 限速规则：IP + instrumentID
+ *
+ * https://www.okx.com/docs-v5/zh/#public-data-rest-api-get-open-interest
+ */
+const getOpenInterest = (params) => publicRequest('GET', '/api/v5/public/open-interest', params);
+exports.getOpenInterest = getOpenInterest;
+/**
+ * 获取市场借币杠杆利率和借币限额
+ *
+ * 限速：2次/2s
+ * 限速规则：IP
+ *
+ * https://www.okx.com/docs-v5/zh/#public-data-rest-api-get-interest-rate-and-loan-quota
+ */
+const getInterestRateLoanQuota = () => publicRequest('GET', '/api/v5/public/interest-rate-loan-quota');
+exports.getInterestRateLoanQuota = getInterestRateLoanQuota;
+/**
+ * 获取市场借贷历史（公共）
+ *
+ * 公共接口无须鉴权
+ *
+ * 返回2021年12月14日后的记录
+ *
+ * 限速：6次/s
+ * 限速规则：IP
+ *
+ * https://www.okx.com/docs-v5/zh/#financial-product-savings-get-public-borrow-history-public
+ */
+const getLendingRateHistory = (params) => publicRequest('GET', '/api/v5/finance/savings/lending-rate-history', params);
+exports.getLendingRateHistory = getLendingRateHistory;
+/**
+ * 获取指数行情数据
+ *
+ * 限速：20次/2s
+ *
+ * https://www.okx.com/docs-v5/zh/#public-data-rest-api-get-index-tickers
+ */
+const getMarketIndexTicker = (params) => publicRequest('GET', '/api/v5/market/index-tickers', params);
+exports.getMarketIndexTicker = getMarketIndexTicker;
+/**
+ * 获取产品深度
+ *
+ * 限速：40次/2s
+ * 限速规则：IP
+ *
+ * https://www.okx.com/docs-v5/zh/#order-book-trading-market-data-get-order-book
+ */
+const getMarketBooks = (params) => publicRequest('GET', '/api/v5/market/books', params);
+exports.getMarketBooks = getMarketBooks;
+/**
+ * 获取衍生品仓位档位
+ *
+ * 获取全部仓位档位对应信息
+ *
+ * 限速：10次/2s
+ * 限速规则：IP
+ *
+ * https://www.okx.com/docs-v5/zh/#public-data-rest-api-get-position-tiers
+ */
+const getPositionTiers = (params) => publicRequest('GET', '/api/v5/public/position-tiers', params);
+exports.getPositionTiers = getPositionTiers;
+//# sourceMappingURL=public-api.js.map

package/lib/public-api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"public-api.js","sourceRoot":"","sources":["../src/public-api.ts"],"names":[],"mappings":";;;AAAA,yCAA2C;AAE3C;;GAEG;AACH,KAAK,UAAU,aAAa,CAAC,MAAc,EAAE,IAAY,EAAE,MAAY;IACrE,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,qBAAqB,CAAC,CAAC;IAC3C,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC;IACpB,IAAI,MAAM,KAAK,KAAK,EAAE;QACpB,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE;YACxB,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;SACxC;KACF;IAED,OAAO,CAAC,IAAI,CAAC,IAAA,kBAAU,EAAC,IAAI,CAAC,GAAG,EAAE,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;IACvD,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IAC9C,OAAO,GAAG,CAAC,IAAI,EAAE,CAAC;AACpB,CAAC;AAED;;;;;;;;;GASG;AACI,MAAM,gBAAgB,GAAG,CAAC,MAIhC,EAqBE,EAAE,CAAC,aAAa,CAAC,KAAK,EAAE,wBAAwB,EAAE,MAAM,CAAC,CAAC;AAzBhD,QAAA,gBAAgB,oBAyBgC;AAE7D;;;;;;;;;GASG;AACI,MAAM,cAAc,GAAG,CAAC,MAK9B,EAmCE,EAAE,CAAC,aAAa,CAAC,KAAK,EAAE,4BAA4B,EAAE,MAAM,CAAC,CAAC;AAxCpD,QAAA,cAAc,kBAwCsC;AAEjE;;;;;;;;;GASG;AACI,MAAM,cAAc,GAAG,CAAC,MAE9B,EAkBE,EAAE,CAAC,aAAa,CAAC,KAAK,EAAE,6BAA6B,EAAE,MAAM,CAAC,CAAC;AApBrD,QAAA,cAAc,kBAoBuC;AAElE;;;;;;;;;GASG;AACI,MAAM,qBAAqB,GAAG,CAAC,MAKrC,EAWE,EAAE,CAAC,aAAa,CAAC,KAAK,EAAE,qCAAqC,EAAE,MAAM,CAAC,CAAC;AAhB7D,QAAA,qBAAqB,yBAgBwC;AAE1E;;;;;;;;;GASG;AACI,MAAM,0BAA0B,GAAG,CAAC,MAM1C,EAIE,EAAE,CAAC,aAAa,CAAC,KAAK,EAAE,2CAA2C,EAAE,MAAM,CAAC,CAAC;AAVnE,QAAA,0BAA0B,8BAUyC;AAEhF;;;;;;;;;;;GAWG;AACI,MAAM,iBAAiB,GAAG,CAAC,MAMjC,EAgBE,EAAE,CAAC,aAAa,CAAC,KAAK,EAAE,gCAAgC,EAAE,MAAM,CAAC,CAAC;AAtBxD,QAAA,iBAAiB,qBAsBuC;AAErE;;;;;;;;;GASG;AACI,MAAM,eAAe,GAAG,CAAC,MAK/B,EAUE,EAAE,CAAC,aAAa,CAAC,KAAK,EAAE,8BAA8B,EAAE,MAAM,CAAC,CAAC;AAftD,QAAA,eAAe,mBAeuC;AAEnE;;;;;;;GAOG;AACI,MAAM,wBAAwB,GAAG,GAiBrC,EAAE,CAAC,aAAa,CAAC,KAAK,EAAE,yCAAyC,CAAC,CAAC;AAjBzD,QAAA,wBAAwB,4BAiBiC;AAEtE;;;;;;;;;;;GAWG;AACI,MAAM,qBAAqB,GAAG,CAAC,MAKrC,EASE,EAAE,CAAC,aAAa,CAAC,KAAK,EAAE,8CAA8C,EAAE,MAAM,CAAC,CAAC;AAdtE,QAAA,qBAAqB,yBAciD;AAEnF;;;;;;GAMG;AACI,MAAM,oBAAoB,GAAG,CAAC,MAGpC,EAaE,EAAE,CAAC,aAAa,CAAC,KAAK,EAAE,8BAA8B,EAAE,MAAM,CAAC,CAAC;AAhBtD,QAAA,oBAAoB,wBAgBkC;AAEnE;;;;;;;GAOG;AACI,MAAM,cAAc,GAAG,CAAC,MAG9B,EAQE,EAAE,CAAC,aAAa,CAAC,KAAK,EAAE,sBAAsB,EAAE,MAAM,CAAC,CAAC;AAX9C,QAAA,cAAc,kBAWgC;AAE3D;;;;;;;;;GASG;AACI,MAAM,gBAAgB,GAAG,CAAC,MAQhC,EAiBE,EAAE,CAAC,aAAa,CAAC,KAAK,EAAE,+BAA+B,EAAE,MAAM,CAAC,CAAC;AAzBvD,QAAA,gBAAgB,oBAyBuC","sourcesContent":["import { formatTime } from '@yuants/utils';\n\n/**\n * 基础公共请求函数\n */\nasync function publicRequest(method: string, path: string, params?: any) {\n  const url = new URL('https://www.okx.com');\n  url.pathname = path;\n  if (method === 'GET') {\n    for (const key in params) {\n      url.searchParams.set(key, params[key]);\n    }\n  }\n\n  console.info(formatTime(Date.now()), method, url.href);\n  const res = await fetch(url.href, { method });\n  return res.json();\n}\n\n/**\n * 获取所有产品行情信息\n *\n * 获取产品行情信息\n *\n * 限速：20次/2s\n * 限速规则：IP\n *\n * https://www.okx.com/docs-v5/zh/#order-book-trading-market-data-get-tickers\n */\nexport const getMarketTickers = (params: {\n  instType: string;\n  uly?: string;\n  instFamily?: string;\n}): Promise<{\n  code: string;\n  msg: string;\n  data: Array<{\n    instType: string;\n    instId: string;\n    last: string;\n    lastSz: string;\n    askPx: string;\n    askSz: string;\n    bidPx: string;\n    bidSz: string;\n    open24h: string;\n    high24h: string;\n    low24h: string;\n    volCcy24h: string;\n    vol24h: string;\n    sodUtc0: string;\n    sodUtc8: string;\n    ts: string;\n  }>;\n}> => publicRequest('GET', '/api/v5/market/tickers', params);\n\n/**\n * 获取交易产品基础信息\n *\n * 获取所有可交易产品的信息列表。\n *\n * 限速：20次/2s\n * 限速规则：IP +instType\n *\n * https://www.okx.com/docs-v5/zh/#public-data-rest-api-get-instruments\n */\nexport const getInstruments = (params: {\n  instType: string;\n  uly?: string;\n  instFamily?: string;\n  instId?: string;\n}): Promise<{\n  code: string;\n  msg: string;\n  data: Array<{\n    alias: string;\n    baseCcy: string;\n    category: string;\n    ctMult: string;\n    ctType: string;\n    ctVal: string;\n    ctValCcy: string;\n    expTime: string;\n    instFamily: string;\n    instId: string;\n    instType: string;\n    lever: string;\n    listTime: string;\n    lotSz: string;\n    maxIcebergSz: string;\n    maxLmtAmt: string;\n    maxLmtSz: string;\n    maxMktAmt: string;\n    maxMktSz: string;\n    maxStopSz: string;\n    maxTriggerSz: string;\n    maxTwapSz: string;\n    minSz: string;\n    optType: string;\n    quoteCcy: string;\n    settleCcy: string;\n    state: string;\n    stk: string;\n    tickSz: string;\n    uly: string;\n  }>;\n}> => publicRequest('GET', '/api/v5/public/instruments', params);\n\n/**\n * 获取永续合约当前资金费率\n *\n * 获取当前资金费率\n *\n * 限速：20次/2s\n * 限速规则：IP +instrumentID\n *\n * https://www.okx.com/docs-v5/zh/#public-data-rest-api-get-funding-rate\n */\nexport const getFundingRate = (params: {\n  instId: string;\n}): Promise<{\n  code: string;\n  data: Array<{\n    fundingRate: string;\n    fundingTime: string;\n    instId: string;\n    instType: string;\n    method: string;\n    maxFundingRate: string;\n    minFundingRate: string;\n    nextFundingRate: string;\n    nextFundingTime: string;\n    premium: string;\n    settFundingRate: string;\n    settState: string;\n    ts: string;\n  }>;\n  msg: string;\n}> => publicRequest('GET', '/api/v5/public/funding-rate', params);\n\n/**\n * 获取永续合约历史资金费率\n *\n * 获取最近3个月的历史资金费率\n *\n * 限速：10次/2s\n * 限速规则：IP +instrumentID\n *\n * https://www.okx.com/docs-v5/zh/#public-data-rest-api-get-funding-rate-history\n */\nexport const getFundingRateHistory = (params: {\n  instId: string;\n  before?: string;\n  after?: string;\n  limit?: string;\n}): Promise<{\n  code: string;\n  msg: string;\n  data: Array<{\n    fundingRate: string;\n    fundingTime: string;\n    instId: string;\n    instType: string;\n    method: string;\n    realizedRate: string;\n  }>;\n}> => publicRequest('GET', '/api/v5/public/funding-rate-history', params);\n\n/**\n * 获取标记价格历史K线数据\n *\n * 获取最近几年的标记价格K线数据\n *\n * 限速：10次/2s\n * 限速规则：IP\n *\n * https://www.okx.com/docs-v5/zh/#public-data-rest-api-get-mark-price-candlesticks-history\n */\nexport const getHistoryMarkPriceCandles = (params: {\n  instId: string;\n  bar?: string;\n  after?: string;\n  before?: string;\n  limit?: string;\n}): Promise<{\n  code: string;\n  msg: string;\n  data: Array<[ts: string, o: string, h: string, l: string, c: string, confirm: string]>;\n}> => publicRequest('GET', '/api/v5/market/history-mark-price-candles', params);\n\n/**\n * 获取交易产品历史K线数据\n *\n * 获取最近几年的历史k线数据(1s k线支持查询最近3个月的数据)\n *\n * 限速：20次/2s\n * 限速规则：IP\n *\n * 期权不支持 1s K线， 其他业务线 (币币, 杠杆, 交割和永续)支持\n *\n * https://www.okx.com/docs-v5/zh/#order-book-trading-market-data-get-candlesticks-history\n */\nexport const getHistoryCandles = (params: {\n  instId: string;\n  bar?: string;\n  after?: string;\n  before?: string;\n  limit?: string;\n}): Promise<{\n  code: string;\n  msg: string;\n  data: Array<\n    [\n      ts: string,\n      o: string,\n      h: string,\n      l: string,\n      c: string,\n      vol: string,\n      volCcy: string,\n      volCcyQuote: string,\n      confirm: string,\n    ]\n  >;\n}> => publicRequest('GET', '/api/v5/market/history-candles', params);\n\n/**\n * 获取持仓总量\n *\n * 查询单个交易产品的市场的持仓总量\n *\n * 限速：20次/2s\n * 限速规则：IP + instrumentID\n *\n * https://www.okx.com/docs-v5/zh/#public-data-rest-api-get-open-interest\n */\nexport const getOpenInterest = (params: {\n  instType: string;\n  uly?: string;\n  instFamily?: string;\n  instId?: string;\n}): Promise<{\n  code: string;\n  msg: string;\n  data: {\n    instType: string;\n    instId: string;\n    oi: string;\n    oiCcy: string;\n    ts: string;\n  }[];\n}> => publicRequest('GET', '/api/v5/public/open-interest', params);\n\n/**\n * 获取市场借币杠杆利率和借币限额\n *\n * 限速：2次/2s\n * 限速规则：IP\n *\n * https://www.okx.com/docs-v5/zh/#public-data-rest-api-get-interest-rate-and-loan-quota\n */\nexport const getInterestRateLoanQuota = (): Promise<{\n  code: string;\n  data?: Array<{\n    basic: Array<{\n      ccy: string;\n      rate: string;\n      quota: string;\n    }>;\n    vip: Array<{\n      loanQuotaCoef: string;\n      level: string;\n    }>;\n    regular: Array<{\n      loanQuotaCoef: string;\n      level: string;\n    }>;\n  }>;\n}> => publicRequest('GET', '/api/v5/public/interest-rate-loan-quota');\n\n/**\n * 获取市场借贷历史（公共）\n *\n * 公共接口无须鉴权\n *\n * 返回2021年12月14日后的记录\n *\n * 限速：6次/s\n * 限速规则：IP\n *\n * https://www.okx.com/docs-v5/zh/#financial-product-savings-get-public-borrow-history-public\n */\nexport const getLendingRateHistory = (params: {\n  ccy?: string;\n  after?: string;\n  before?: string;\n  limit?: string;\n}): Promise<{\n  code: string;\n  msg: string;\n  data: Array<{\n    ccy: string;\n    amt: string;\n    rate: string;\n    ts: string;\n  }>;\n}> => publicRequest('GET', '/api/v5/finance/savings/lending-rate-history', params);\n\n/**\n * 获取指数行情数据\n *\n * 限速：20次/2s\n *\n * https://www.okx.com/docs-v5/zh/#public-data-rest-api-get-index-tickers\n */\nexport const getMarketIndexTicker = (params?: {\n  quoteCcy?: string;\n  instId?: string;\n}): Promise<{\n  code: string;\n  msg: string;\n  data: {\n    instId: string;\n    idxPx: string;\n    high24h: string;\n    sodUtc0: string;\n    open24h: string;\n    low24h: string;\n    sodUtc8: string;\n    ts: string;\n  }[];\n}> => publicRequest('GET', '/api/v5/market/index-tickers', params);\n\n/**\n * 获取产品深度\n *\n * 限速：40次/2s\n * 限速规则：IP\n *\n * https://www.okx.com/docs-v5/zh/#order-book-trading-market-data-get-order-book\n */\nexport const getMarketBooks = (params: {\n  sz?: string;\n  instId: string;\n}): Promise<{\n  code: string;\n  data: {\n    asks: [price: string, volume: string, abandon: string, order_number: string][];\n    bids: [price: string, volume: string, abandon: string, order_number: string][];\n    ts: string;\n  }[];\n  msg: string;\n}> => publicRequest('GET', '/api/v5/market/books', params);\n\n/**\n * 获取衍生品仓位档位\n *\n * 获取全部仓位档位对应信息\n *\n * 限速：10次/2s\n * 限速规则：IP\n *\n * https://www.okx.com/docs-v5/zh/#public-data-rest-api-get-position-tiers\n */\nexport const getPositionTiers = (params: {\n  instType: string;\n  tdMode: string;\n  instFamily?: string;\n  instId?: string;\n  uly?: string;\n  ccy?: string;\n  tier?: string;\n}): Promise<{\n  code: string;\n  msg: string;\n  data: Array<{\n    uly: string;\n    instFamily: string;\n    instId: string;\n    tier: string;\n    minSz: string;\n    maxSz: string;\n    mmr: string;\n    imr: string;\n    maxLever: string;\n    optMgnFactor: string;\n    quoteMaxLoan: string;\n    baseMaxLoan: string;\n  }>;\n}> => publicRequest('GET', '/api/v5/public/position-tiers', params);\n"]}

package/lib/quote.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"quote.d.ts","sourceRoot":"","sources":["../src/quote.ts"],"names":[],"mappings":"AA8CA,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;EAW9B,CAAC;AA8KF,eAAO,MAAM,iBAAiB,6CAG7B,CAAC"}
+{"version":3,"file":"quote.d.ts","sourceRoot":"","sources":["../src/quote.ts"],"names":[],"mappings":"AA8DA,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;EAW9B,CAAC;AAsRF,eAAO,MAAM,iBAAiB,6CAG7B,CAAC"}