@0xarchive/sdk 0.8.1 → 0.8.3

package/README.md

@@ -22,7 +22,7 @@ pnpm add @0xarchive/sdk
 ```typescript
 import { OxArchive } from '@0xarchive/sdk';
 
-const client = new OxArchive({ apiKey: 'ox_your_api_key' });
+const client = new OxArchive({ apiKey: '0xa_your_api_key' });
 
 // Hyperliquid data
 const hlOrderbook = await client.hyperliquid.orderbook.get('BTC');
@@ -51,7 +51,7 @@ const history = await client.hyperliquid.orderbook.history('ETH', {
 
 ```typescript
 const client = new OxArchive({
-  apiKey: 'ox_your_api_key',       // Required
+  apiKey: '0xa_your_api_key',       // Required
   baseUrl: 'https://api.0xarchive.io',  // Optional
   timeout: 30000,                   // Optional, request timeout in ms (default: 30000)
   validate: false,                  // Optional, enable Zod schema validation
@@ -489,7 +489,7 @@ console.log(`API P99: ${sla.actual.apiLatencyP99Ms}ms (${sla.actual.latencyStatu
 
 ```typescript
 const client = new OxArchive({
-  apiKey: 'ox_your_api_key',
+  apiKey: '0xa_your_api_key',
   timeout: 60000  // 60 seconds for data quality endpoints
 });
 ```
@@ -513,7 +513,7 @@ The WebSocket client supports three modes: real-time streaming, historical repla
 ```typescript
 import { OxArchiveWs } from '@0xarchive/sdk';
 
-const ws = new OxArchiveWs({ apiKey: 'ox_your_api_key' });
+const ws = new OxArchiveWs({ apiKey: '0xa_your_api_key' });
 ```
 
 ### Real-time Streaming
@@ -672,7 +672,7 @@ Gap thresholds vary by channel:
 
 ```typescript
 const ws = new OxArchiveWs({
-  apiKey: 'ox_your_api_key',          // Required
+  apiKey: '0xa_your_api_key',          // Required
   wsUrl: 'wss://api.0xarchive.io/ws', // Optional
   autoReconnect: true,                // Auto-reconnect on disconnect (default: true)
   reconnectDelay: 1000,               // Initial reconnect delay in ms (default: 1000)
@@ -700,6 +700,7 @@ const ws = new OxArchiveWs({
 |---------|-------------|---------------|-------------------|
 | `hip3_orderbook` | HIP-3 L2 order book snapshots | Yes | Yes |
 | `hip3_trades` | HIP-3 trade/fill updates | Yes | Yes |
+| `hip3_candles` | HIP-3 OHLCV candle data | Yes | Yes |
 
 > **Note:** HIP-3 coins are case-sensitive (e.g., `km:US500`, `xyz:XYZ100`). Do not uppercase them.
 
@@ -754,6 +755,14 @@ ws.stream('hip3_trades', 'xyz:XYZ100', {
   end: Date.now(),
   batchSize: 1000,
 });
+
+// HIP-3 candles
+ws.replay('hip3_candles', 'km:US500', {
+  start: Date.now() - 86400000,
+  end: Date.now(),
+  speed: 100,
+  interval: '1h'
+});
 ```
 
 ### WebSocket Connection States
@@ -843,7 +852,7 @@ Enable Zod schema validation for API responses:
 
 ```typescript
 const client = new OxArchive({
-  apiKey: 'ox_your_api_key',
+  apiKey: '0xa_your_api_key',
   validate: true  // Enable runtime validation
 });
 ```

package/dist/index.d.mts

@@ -356,7 +356,7 @@ interface CandleHistoryParams extends CursorPaginationParams {
     interval?: CandleInterval;
 }
 /** WebSocket channel types. Note: ticker/all_tickers are real-time only. Liquidations is historical only (May 2025+). */
-type WsChannel = 'orderbook' | 'trades' | 'candles' | 'liquidations' | 'ticker' | 'all_tickers' | 'lighter_orderbook' | 'lighter_trades' | 'lighter_candles' | 'hip3_orderbook' | 'hip3_trades';
+type WsChannel = 'orderbook' | 'trades' | 'candles' | 'liquidations' | 'ticker' | 'all_tickers' | 'lighter_orderbook' | 'lighter_trades' | 'lighter_candles' | 'hip3_orderbook' | 'hip3_trades' | 'hip3_candles';
 /** Subscribe message from client */
 interface WsSubscribe {
     op: 'subscribe';
@@ -1591,7 +1591,8 @@ declare class OpenInterestResource {
 declare class CandlesResource {
     private http;
     private basePath;
-    constructor(http: HttpClient, basePath?: string);
+    private coinTransform;
+    constructor(http: HttpClient, basePath?: string, coinTransform?: (coin: string) => string);
     /**
      * Get historical OHLCV candle data with cursor-based pagination
      *
@@ -1878,7 +1879,7 @@ declare class HyperliquidClient {
      */
     readonly liquidations: LiquidationsResource;
     /**
-     * HIP-3 builder-deployed perpetuals (Pro+ only, February 2026+)
+     * HIP-3 builder-deployed perpetuals (February 2026+)
      */
     readonly hip3: Hip3Client;
     constructor(http: HttpClient);
@@ -1887,7 +1888,7 @@ declare class HyperliquidClient {
  * HIP-3 builder-deployed perpetuals client
  *
  * Access Hyperliquid HIP-3 builder perps data through the 0xarchive API.
- * Requires Pro tier or higher.
+ * Free: km:US500 only. Build+: all coins. Orderbook: Pro+.
  *
  * @example
  * ```typescript
@@ -1917,6 +1918,10 @@ declare class Hip3Client {
      * Open interest
      */
     readonly openInterest: OpenInterestResource;
+    /**
+     * OHLCV candle data
+     */
+    readonly candles: CandlesResource;
     constructor(http: HttpClient);
 }
 /**
@@ -1972,7 +1977,7 @@ declare class LighterClient {
  * ```typescript
  * import { OxArchive } from '@0xarchive/sdk';
  *
- * const client = new OxArchive({ apiKey: 'ox_your_api_key' });
+ * const client = new OxArchive({ apiKey: '0xa_your_api_key' });
  *
  * // Hyperliquid data
  * const hlOrderbook = await client.hyperliquid.orderbook.get('BTC');

package/dist/index.d.ts

@@ -356,7 +356,7 @@ interface CandleHistoryParams extends CursorPaginationParams {
     interval?: CandleInterval;
 }
 /** WebSocket channel types. Note: ticker/all_tickers are real-time only. Liquidations is historical only (May 2025+). */
-type WsChannel = 'orderbook' | 'trades' | 'candles' | 'liquidations' | 'ticker' | 'all_tickers' | 'lighter_orderbook' | 'lighter_trades' | 'lighter_candles' | 'hip3_orderbook' | 'hip3_trades';
+type WsChannel = 'orderbook' | 'trades' | 'candles' | 'liquidations' | 'ticker' | 'all_tickers' | 'lighter_orderbook' | 'lighter_trades' | 'lighter_candles' | 'hip3_orderbook' | 'hip3_trades' | 'hip3_candles';
 /** Subscribe message from client */
 interface WsSubscribe {
     op: 'subscribe';
@@ -1591,7 +1591,8 @@ declare class OpenInterestResource {
 declare class CandlesResource {
     private http;
     private basePath;
-    constructor(http: HttpClient, basePath?: string);
+    private coinTransform;
+    constructor(http: HttpClient, basePath?: string, coinTransform?: (coin: string) => string);
     /**
      * Get historical OHLCV candle data with cursor-based pagination
      *
@@ -1878,7 +1879,7 @@ declare class HyperliquidClient {
      */
     readonly liquidations: LiquidationsResource;
     /**
-     * HIP-3 builder-deployed perpetuals (Pro+ only, February 2026+)
+     * HIP-3 builder-deployed perpetuals (February 2026+)
      */
     readonly hip3: Hip3Client;
     constructor(http: HttpClient);
@@ -1887,7 +1888,7 @@ declare class HyperliquidClient {
  * HIP-3 builder-deployed perpetuals client
  *
  * Access Hyperliquid HIP-3 builder perps data through the 0xarchive API.
- * Requires Pro tier or higher.
+ * Free: km:US500 only. Build+: all coins. Orderbook: Pro+.
  *
  * @example
  * ```typescript
@@ -1917,6 +1918,10 @@ declare class Hip3Client {
      * Open interest
      */
     readonly openInterest: OpenInterestResource;
+    /**
+     * OHLCV candle data
+     */
+    readonly candles: CandlesResource;
     constructor(http: HttpClient);
 }
 /**
@@ -1972,7 +1977,7 @@ declare class LighterClient {
  * ```typescript
  * import { OxArchive } from '@0xarchive/sdk';
  *
- * const client = new OxArchive({ apiKey: 'ox_your_api_key' });
+ * const client = new OxArchive({ apiKey: '0xa_your_api_key' });
  *
  * // Hyperliquid data
  * const hlOrderbook = await client.hyperliquid.orderbook.get('BTC');

package/dist/index.js

@@ -1087,9 +1087,10 @@ var OpenInterestResource = class {
 
 // src/resources/candles.ts
 var CandlesResource = class {
-  constructor(http, basePath = "/v1") {
+  constructor(http, basePath = "/v1", coinTransform = (c) => c.toUpperCase()) {
     this.http = http;
     this.basePath = basePath;
+    this.coinTransform = coinTransform;
   }
   /**
    * Get historical OHLCV candle data with cursor-based pagination
@@ -1100,7 +1101,7 @@ var CandlesResource = class {
    */
   async history(coin, params) {
     const response = await this.http.get(
-      `${this.basePath}/candles/${coin.toUpperCase()}`,
+      `${this.basePath}/candles/${this.coinTransform(coin)}`,
       params,
       this.http.validationEnabled ? CandleArrayResponseSchema : void 0
     );
@@ -1385,7 +1386,7 @@ var HyperliquidClient = class {
    */
   liquidations;
   /**
-   * HIP-3 builder-deployed perpetuals (Pro+ only, February 2026+)
+   * HIP-3 builder-deployed perpetuals (February 2026+)
    */
   hip3;
   constructor(http) {
@@ -1421,6 +1422,10 @@ var Hip3Client = class {
    * Open interest
    */
   openInterest;
+  /**
+   * OHLCV candle data
+   */
+  candles;
   constructor(http) {
     const basePath = "/v1/hyperliquid/hip3";
     const coinTransform = (c) => c;
@@ -1429,6 +1434,7 @@ var Hip3Client = class {
     this.trades = new TradesResource(http, basePath, coinTransform);
     this.funding = new FundingResource(http, basePath, coinTransform);
     this.openInterest = new OpenInterestResource(http, basePath, coinTransform);
+    this.candles = new CandlesResource(http, basePath, coinTransform);
   }
 };
 var LighterClient = class {