@0xarchive/sdk 0.9.0 → 0.9.1

package/README.md

@@ -407,18 +407,26 @@ for (const bucket of volume.data) {
 Check when each data type was last updated for a specific coin. Useful for verifying data recency before pulling it.
 
 ```typescript
+// Hyperliquid
 const freshness = await client.hyperliquid.freshness('BTC');
 console.log(`Orderbook last updated: ${freshness.orderbook.lastUpdated}, lag: ${freshness.orderbook.lagMs}ms`);
 console.log(`Trades last updated: ${freshness.trades.lastUpdated}, lag: ${freshness.trades.lagMs}ms`);
 console.log(`Funding last updated: ${freshness.funding.lastUpdated}`);
 console.log(`OI last updated: ${freshness.openInterest.lastUpdated}`);
+
+// Lighter.xyz
+const lighterFreshness = await client.lighter.freshness('BTC');
+
+// HIP-3 (case-sensitive coins)
+const hip3Freshness = await client.hyperliquid.hip3.freshness('km:US500');
 ```
 
-### Summary (Hyperliquid only)
+### Summary
 
 Get a combined market snapshot in a single call -- mark/oracle price, funding rate, open interest, 24h volume, and 24h liquidation volumes.
 
 ```typescript
+// Hyperliquid (includes volume + liquidation data)
 const summary = await client.hyperliquid.summary('BTC');
 console.log(`Mark price: ${summary.markPrice}`);
 console.log(`Oracle price: ${summary.oraclePrice}`);
@@ -428,14 +436,21 @@ console.log(`24h volume: ${summary.volume24h}`);
 console.log(`24h liquidation volume: $${summary.liquidationVolume24h}`);
 console.log(`  Long: $${summary.longLiquidationVolume24h}`);
 console.log(`  Short: $${summary.shortLiquidationVolume24h}`);
+
+// Lighter.xyz (price, funding, OI — no volume/liquidation data)
+const lighterSummary = await client.lighter.summary('BTC');
+
+// HIP-3 (includes mid_price — case-sensitive coins)
+const hip3Summary = await client.hyperliquid.hip3.summary('km:US500');
+console.log(`Mid price: ${hip3Summary.midPrice}`);
 ```
 
-### Price History (Hyperliquid only)
+### Price History
 
-Get mark, oracle, and mid price history over time. Supports aggregation intervals. Data projected from open interest records (available from May 2023).
+Get mark, oracle, and mid price history over time. Supports aggregation intervals. Data projected from open interest records.
 
 ```typescript
-// Get hourly price history for the last 24 hours
+// Hyperliquid — available from May 2023
 const prices = await client.hyperliquid.priceHistory('BTC', {
   start: Date.now() - 86400000,
   end: Date.now(),
@@ -446,6 +461,20 @@ for (const snapshot of prices.data) {
   console.log(`${snapshot.timestamp}: mark=${snapshot.markPrice}, oracle=${snapshot.oraclePrice}, mid=${snapshot.midPrice}`);
 }
 
+// Lighter.xyz
+const lighterPrices = await client.lighter.priceHistory('BTC', {
+  start: Date.now() - 86400000,
+  end: Date.now(),
+  interval: '1h'
+});
+
+// HIP-3 (case-sensitive coins)
+const hip3Prices = await client.hyperliquid.hip3.priceHistory('km:US500', {
+  start: Date.now() - 86400000,
+  end: Date.now(),
+  interval: '1d'
+});
+
 // Paginate for larger ranges
 let result = await client.hyperliquid.priceHistory('BTC', {
   start: Date.now() - 86400000 * 30,

package/dist/index.d.mts

@@ -363,6 +363,8 @@ interface Candle {
 interface CandleHistoryParams extends CursorPaginationParams {
     /** Candle interval (default: 1h) */
     interval?: CandleInterval;
+    /** Maximum number of results to return (default: 100, max: 10000 for candles) */
+    limit?: number;
 }
 /** Pre-aggregated liquidation volume bucket */
 interface LiquidationVolume {
@@ -1695,7 +1697,7 @@ declare class OpenInterestResource {
  *   start: Date.now() - 86400000,
  *   end: Date.now(),
  *   interval: '1h',
- *   limit: 1000
+ *   limit: 10000
  * });
  *
  * // Get all pages
@@ -1706,7 +1708,7 @@ declare class OpenInterestResource {
  *     end: Date.now(),
  *     interval: '1h',
  *     cursor: result.nextCursor,
- *     limit: 1000
+ *     limit: 10000
  *   });
  *   allCandles.push(...result.data);
  * }
@@ -2085,7 +2087,30 @@ declare class Hip3Client {
      * OHLCV candle data
      */
     readonly candles: CandlesResource;
+    private http;
     constructor(http: HttpClient);
+    /**
+     * Get per-coin data freshness across all data types
+     *
+     * @param coin - The coin symbol (case-sensitive, e.g., 'km:US500')
+     * @returns Per-coin freshness with last_updated and lag_ms for each data type
+     */
+    freshness(coin: string): Promise<CoinFreshness>;
+    /**
+     * Get combined market summary (price, funding, OI) in one call
+     *
+     * @param coin - The coin symbol (case-sensitive, e.g., 'km:US500')
+     * @returns Combined market summary
+     */
+    summary(coin: string): Promise<CoinSummary>;
+    /**
+     * Get mark/oracle/mid price history (projected from OI data)
+     *
+     * @param coin - The coin symbol (case-sensitive, e.g., 'km:US500')
+     * @param params - Time range, cursor, and interval parameters
+     * @returns CursorResponse with price snapshots
+     */
+    priceHistory(coin: string, params: PriceHistoryParams): Promise<CursorResponse<PriceSnapshot[]>>;
 }
 /**
  * Lighter.xyz exchange client
@@ -2126,7 +2151,30 @@ declare class LighterClient {
      * OHLCV candle data
      */
     readonly candles: CandlesResource;
+    private http;
     constructor(http: HttpClient);
+    /**
+     * Get per-coin data freshness across all data types
+     *
+     * @param coin - The coin symbol (e.g., 'BTC', 'ETH')
+     * @returns Per-coin freshness with last_updated and lag_ms for each data type
+     */
+    freshness(coin: string): Promise<CoinFreshness>;
+    /**
+     * Get combined market summary (price, funding, OI) in one call
+     *
+     * @param coin - The coin symbol (e.g., 'BTC', 'ETH')
+     * @returns Combined market summary
+     */
+    summary(coin: string): Promise<CoinSummary>;
+    /**
+     * Get mark/oracle price history (projected from OI data)
+     *
+     * @param coin - The coin symbol (e.g., 'BTC', 'ETH')
+     * @param params - Time range, cursor, and interval parameters
+     * @returns CursorResponse with price snapshots
+     */
+    priceHistory(coin: string, params: PriceHistoryParams): Promise<CursorResponse<PriceSnapshot[]>>;
 }
 
 /**

package/dist/index.d.ts

@@ -363,6 +363,8 @@ interface Candle {
 interface CandleHistoryParams extends CursorPaginationParams {
     /** Candle interval (default: 1h) */
     interval?: CandleInterval;
+    /** Maximum number of results to return (default: 100, max: 10000 for candles) */
+    limit?: number;
 }
 /** Pre-aggregated liquidation volume bucket */
 interface LiquidationVolume {
@@ -1695,7 +1697,7 @@ declare class OpenInterestResource {
  *   start: Date.now() - 86400000,
  *   end: Date.now(),
  *   interval: '1h',
- *   limit: 1000
+ *   limit: 10000
  * });
  *
  * // Get all pages
@@ -1706,7 +1708,7 @@ declare class OpenInterestResource {
  *     end: Date.now(),
  *     interval: '1h',
  *     cursor: result.nextCursor,
- *     limit: 1000
+ *     limit: 10000
  *   });
  *   allCandles.push(...result.data);
  * }
@@ -2085,7 +2087,30 @@ declare class Hip3Client {
      * OHLCV candle data
      */
     readonly candles: CandlesResource;
+    private http;
     constructor(http: HttpClient);
+    /**
+     * Get per-coin data freshness across all data types
+     *
+     * @param coin - The coin symbol (case-sensitive, e.g., 'km:US500')
+     * @returns Per-coin freshness with last_updated and lag_ms for each data type
+     */
+    freshness(coin: string): Promise<CoinFreshness>;
+    /**
+     * Get combined market summary (price, funding, OI) in one call
+     *
+     * @param coin - The coin symbol (case-sensitive, e.g., 'km:US500')
+     * @returns Combined market summary
+     */
+    summary(coin: string): Promise<CoinSummary>;
+    /**
+     * Get mark/oracle/mid price history (projected from OI data)
+     *
+     * @param coin - The coin symbol (case-sensitive, e.g., 'km:US500')
+     * @param params - Time range, cursor, and interval parameters
+     * @returns CursorResponse with price snapshots
+     */
+    priceHistory(coin: string, params: PriceHistoryParams): Promise<CursorResponse<PriceSnapshot[]>>;
 }
 /**
  * Lighter.xyz exchange client
@@ -2126,7 +2151,30 @@ declare class LighterClient {
      * OHLCV candle data
      */
     readonly candles: CandlesResource;
+    private http;
     constructor(http: HttpClient);
+    /**
+     * Get per-coin data freshness across all data types
+     *
+     * @param coin - The coin symbol (e.g., 'BTC', 'ETH')
+     * @returns Per-coin freshness with last_updated and lag_ms for each data type
+     */
+    freshness(coin: string): Promise<CoinFreshness>;
+    /**
+     * Get combined market summary (price, funding, OI) in one call
+     *
+     * @param coin - The coin symbol (e.g., 'BTC', 'ETH')
+     * @returns Combined market summary
+     */
+    summary(coin: string): Promise<CoinSummary>;
+    /**
+     * Get mark/oracle price history (projected from OI data)
+     *
+     * @param coin - The coin symbol (e.g., 'BTC', 'ETH')
+     * @param params - Time range, cursor, and interval parameters
+     * @returns CursorResponse with price snapshots
+     */
+    priceHistory(coin: string, params: PriceHistoryParams): Promise<CursorResponse<PriceSnapshot[]>>;
 }
 
 /**

package/dist/index.js

@@ -1596,7 +1596,9 @@ var Hip3Client = class {
    * OHLCV candle data
    */
   candles;
+  http;
   constructor(http) {
+    this.http = http;
     const basePath = "/v1/hyperliquid/hip3";
     const coinTransform = (c) => c;
     this.instruments = new Hip3InstrumentsResource(http, basePath, coinTransform);
@@ -1606,6 +1608,52 @@ var Hip3Client = class {
     this.openInterest = new OpenInterestResource(http, basePath, coinTransform);
     this.candles = new CandlesResource(http, basePath, coinTransform);
   }
+  /**
+   * Get per-coin data freshness across all data types
+   *
+   * @param coin - The coin symbol (case-sensitive, e.g., 'km:US500')
+   * @returns Per-coin freshness with last_updated and lag_ms for each data type
+   */
+  async freshness(coin) {
+    const response = await this.http.get(
+      `/v1/hyperliquid/hip3/freshness/${coin}`,
+      void 0,
+      this.http.validationEnabled ? CoinFreshnessResponseSchema : void 0
+    );
+    return response.data;
+  }
+  /**
+   * Get combined market summary (price, funding, OI) in one call
+   *
+   * @param coin - The coin symbol (case-sensitive, e.g., 'km:US500')
+   * @returns Combined market summary
+   */
+  async summary(coin) {
+    const response = await this.http.get(
+      `/v1/hyperliquid/hip3/summary/${coin}`,
+      void 0,
+      this.http.validationEnabled ? CoinSummaryResponseSchema : void 0
+    );
+    return response.data;
+  }
+  /**
+   * Get mark/oracle/mid price history (projected from OI data)
+   *
+   * @param coin - The coin symbol (case-sensitive, e.g., 'km:US500')
+   * @param params - Time range, cursor, and interval parameters
+   * @returns CursorResponse with price snapshots
+   */
+  async priceHistory(coin, params) {
+    const response = await this.http.get(
+      `/v1/hyperliquid/hip3/prices/${coin}`,
+      params,
+      this.http.validationEnabled ? PriceSnapshotArrayResponseSchema : void 0
+    );
+    return {
+      data: response.data,
+      nextCursor: response.meta.nextCursor
+    };
+  }
 };
 var LighterClient = class {
   /**
@@ -1632,7 +1680,9 @@ var LighterClient = class {
    * OHLCV candle data
    */
   candles;
+  http;
   constructor(http) {
+    this.http = http;
     const basePath = "/v1/lighter";
     this.orderbook = new OrderBookResource(http, basePath);
     this.trades = new TradesResource(http, basePath);
@@ -1641,6 +1691,52 @@ var LighterClient = class {
     this.openInterest = new OpenInterestResource(http, basePath);
     this.candles = new CandlesResource(http, basePath);
   }
+  /**
+   * Get per-coin data freshness across all data types
+   *
+   * @param coin - The coin symbol (e.g., 'BTC', 'ETH')
+   * @returns Per-coin freshness with last_updated and lag_ms for each data type
+   */
+  async freshness(coin) {
+    const response = await this.http.get(
+      `/v1/lighter/freshness/${coin.toUpperCase()}`,
+      void 0,
+      this.http.validationEnabled ? CoinFreshnessResponseSchema : void 0
+    );
+    return response.data;
+  }
+  /**
+   * Get combined market summary (price, funding, OI) in one call
+   *
+   * @param coin - The coin symbol (e.g., 'BTC', 'ETH')
+   * @returns Combined market summary
+   */
+  async summary(coin) {
+    const response = await this.http.get(
+      `/v1/lighter/summary/${coin.toUpperCase()}`,
+      void 0,
+      this.http.validationEnabled ? CoinSummaryResponseSchema : void 0
+    );
+    return response.data;
+  }
+  /**
+   * Get mark/oracle price history (projected from OI data)
+   *
+   * @param coin - The coin symbol (e.g., 'BTC', 'ETH')
+   * @param params - Time range, cursor, and interval parameters
+   * @returns CursorResponse with price snapshots
+   */
+  async priceHistory(coin, params) {
+    const response = await this.http.get(
+      `/v1/lighter/prices/${coin.toUpperCase()}`,
+      params,
+      this.http.validationEnabled ? PriceSnapshotArrayResponseSchema : void 0
+    );
+    return {
+      data: response.data,
+      nextCursor: response.meta.nextCursor
+    };
+  }
 };
 
 // src/client.ts