@0xarchive/sdk 0.7.0 → 0.8.0

package/README.md

@@ -4,6 +4,7 @@ Official TypeScript/JavaScript SDK for [0xarchive](https://0xarchive.io) - Histo
 
 Supports multiple exchanges:
 - **Hyperliquid** - Perpetuals data from April 2023
+- **Hyperliquid HIP-3** - Builder-deployed perpetuals (Pro+ only, February 2026+)
 - **Lighter.xyz** - Perpetuals data (August 2025+ for fills, Jan 2026+ for OB, OI, Funding Rate)
 
 ## Installation
@@ -31,6 +32,12 @@ console.log(`Hyperliquid BTC mid price: ${hlOrderbook.midPrice}`);
 const lighterOrderbook = await client.lighter.orderbook.get('BTC');
 console.log(`Lighter BTC mid price: ${lighterOrderbook.midPrice}`);
 
+// HIP-3 builder perps (Pro+ only, February 2026+)
+const hip3Orderbook = await client.hyperliquid.hip3.orderbook.get('xyz:XYZ100');
+const hip3Trades = await client.hyperliquid.hip3.trades.recent('xyz:XYZ100');
+const hip3Funding = await client.hyperliquid.hip3.funding.current('xyz:XYZ100');
+const hip3Oi = await client.hyperliquid.hip3.openInterest.current('xyz:XYZ100');
+
 // Get historical order book snapshots
 const history = await client.hyperliquid.orderbook.history('ETH', {
   start: Date.now() - 86400000, // 24 hours ago

package/dist/index.d.mts

@@ -1095,7 +1095,8 @@ interface TickHistoryParams {
 declare class OrderBookResource {
     private http;
     private basePath;
-    constructor(http: HttpClient, basePath?: string);
+    private coinTransform;
+    constructor(http: HttpClient, basePath?: string, coinTransform?: (coin: string) => string);
     /**
      * Get order book snapshot for a coin
      *
@@ -1287,7 +1288,8 @@ declare class OrderBookResource {
 declare class TradesResource {
     private http;
     private basePath;
-    constructor(http: HttpClient, basePath?: string);
+    private coinTransform;
+    constructor(http: HttpClient, basePath?: string, coinTransform?: (coin: string) => string);
     /**
      * Get trade history for a coin using cursor-based pagination
      *
@@ -1322,9 +1324,10 @@ declare class TradesResource {
     /**
      * Get most recent trades for a coin.
      *
-     * Note: This method is only available for Lighter (client.lighter.trades.recent())
-     * which has real-time data ingestion. Hyperliquid uses hourly backfill so this
-     * endpoint is not available for Hyperliquid.
+     * Note: This method is available for Lighter (client.lighter.trades.recent())
+     * and HIP-3 (client.hyperliquid.hip3.trades.recent()) which have real-time data
+     * ingestion. Hyperliquid uses hourly backfill so this endpoint is not available
+     * for Hyperliquid.
      *
      * @param coin - The coin symbol (e.g., 'BTC', 'ETH')
      * @param limit - Number of trades to return (default: 100)
@@ -1429,7 +1432,8 @@ declare class LighterInstrumentsResource {
 declare class FundingResource {
     private http;
     private basePath;
-    constructor(http: HttpClient, basePath?: string);
+    private coinTransform;
+    constructor(http: HttpClient, basePath?: string, coinTransform?: (coin: string) => string);
     /**
      * Get funding rate history for a coin with cursor-based pagination
      *
@@ -1478,7 +1482,8 @@ declare class FundingResource {
 declare class OpenInterestResource {
     private http;
     private basePath;
-    constructor(http: HttpClient, basePath?: string);
+    private coinTransform;
+    constructor(http: HttpClient, basePath?: string, coinTransform?: (coin: string) => string);
     /**
      * Get open interest history for a coin with cursor-based pagination
      *
@@ -1665,7 +1670,7 @@ declare class DataQualityResource {
     /**
      * Get data coverage for a specific exchange
      *
-     * @param exchange - Exchange name ('hyperliquid' or 'lighter')
+     * @param exchange - Exchange name ('hyperliquid', 'lighter', or 'hip3')
      * @returns ExchangeCoverage with coverage info for all data types on this exchange
      *
      * @example
@@ -1681,8 +1686,8 @@ declare class DataQualityResource {
      * Includes gap detection, empirical data cadence, and hour-level historical coverage.
      * Supports optional time bounds for gap detection (default: last 30 days).
      *
-     * @param exchange - Exchange name ('hyperliquid' or 'lighter')
-     * @param symbol - Symbol name (e.g., 'BTC', 'ETH')
+     * @param exchange - Exchange name ('hyperliquid', 'lighter', or 'hip3')
+     * @param symbol - Symbol name (e.g., 'BTC', 'ETH', or HIP3 coins like 'xyz:XYZ100')
      * @param options - Optional time bounds for gap detection window
      * @returns SymbolCoverageResponse with per-data-type coverage including gaps, cadence, and historical coverage
      *
@@ -1817,6 +1822,42 @@ declare class HyperliquidClient {
      * Liquidation events (May 2025+)
      */
     readonly liquidations: LiquidationsResource;
+    /**
+     * HIP-3 builder-deployed perpetuals (Pro+ only, February 2026+)
+     */
+    readonly hip3: Hip3Client;
+    constructor(http: HttpClient);
+}
+/**
+ * HIP-3 builder-deployed perpetuals client
+ *
+ * Access Hyperliquid HIP-3 builder perps data through the 0xarchive API.
+ * Requires Pro tier or higher.
+ *
+ * @example
+ * ```typescript
+ * const client = new OxArchive({ apiKey: '...' });
+ * const orderbook = await client.hyperliquid.hip3.orderbook.get('xyz:XYZ100');
+ * const trades = await client.hyperliquid.hip3.trades.recent('xyz:XYZ100');
+ * ```
+ */
+declare class Hip3Client {
+    /**
+     * Order book snapshots (February 2026+)
+     */
+    readonly orderbook: OrderBookResource;
+    /**
+     * Trade/fill history
+     */
+    readonly trades: TradesResource;
+    /**
+     * Funding rates
+     */
+    readonly funding: FundingResource;
+    /**
+     * Open interest
+     */
+    readonly openInterest: OpenInterestResource;
     constructor(http: HttpClient);
 }
 /**
@@ -4029,4 +4070,4 @@ type ValidatedCandle = z.infer<typeof CandleSchema>;
 type ValidatedLiquidation = z.infer<typeof LiquidationSchema>;
 type ValidatedWsServerMessage = z.infer<typeof WsServerMessageSchema>;
 
-export { type ApiError, type ApiMeta, ApiMetaSchema, type ApiResponse, ApiResponseSchema, type Candle, CandleArrayResponseSchema, type CandleHistoryParams, type CandleInterval, CandleIntervalSchema, CandleSchema, type ClientOptions, type CompletenessMetrics, type CoverageGap, type CoverageResponse, type CursorResponse, type DataCadence, type DataFreshness, type DataTypeCoverage, type DataTypeStatus, type ExchangeCoverage, type ExchangeLatency, type ExchangeStatus, type FundingRate, FundingRateArrayResponseSchema, FundingRateResponseSchema, FundingRateSchema, type GetOrderBookParams, type GetTradesCursorParams, HyperliquidClient, type Incident, type IncidentSeverityValue, type IncidentStatusValue, type IncidentsResponse, type Instrument, InstrumentArrayResponseSchema, InstrumentResponseSchema, InstrumentSchema, type InstrumentType, InstrumentTypeSchema, type LatencyResponse, LighterClient, type LighterGranularity, type LighterInstrument, type Liquidation, LiquidationArrayResponseSchema, type LiquidationHistoryParams, LiquidationSchema, LiquidationSideSchema, type LiquidationsByUserParams, type ListIncidentsParams, type OpenInterest, OpenInterestArrayResponseSchema, OpenInterestResponseSchema, OpenInterestSchema, type OrderBook, OrderBookArrayResponseSchema, type OrderBookHistoryParams, OrderBookReconstructor, OrderBookResponseSchema, OrderBookSchema, type OrderbookDelta, OxArchive, OxArchiveError, OxArchiveWs, type Pagination, type PriceLevel, PriceLevelSchema, type ReconstructOptions, type ReconstructedOrderBook, type RestApiLatency, type SlaActual, type SlaParams, type SlaResponse, type SlaTargets, type StatusResponse, type SymbolCoverageOptions, type SymbolCoverageResponse, type SymbolDataTypeCoverage, type SystemStatusValue, type TickData, type TickHistoryParams, type Timestamp, type TimestampedRecord, TimestampedRecordSchema, type Trade, TradeArrayResponseSchema, type TradeDirection, TradeDirectionSchema, TradeSchema, type TradeSide, TradeSideSchema, type ValidatedApiMeta, type ValidatedCandle, type ValidatedFundingRate, type ValidatedInstrument, type ValidatedLiquidation, type ValidatedOpenInterest, type ValidatedOrderBook, type ValidatedPriceLevel, type ValidatedTrade, type ValidatedWsServerMessage, type WebSocketLatency, type WsChannel, WsChannelSchema, type WsClientMessage, type WsConnectionState, WsConnectionStateSchema, type WsData, WsDataSchema, type WsError, WsErrorSchema, type WsEventHandlers, type WsHistoricalBatch, WsHistoricalBatchSchema, type WsHistoricalData, WsHistoricalDataSchema, type WsHistoricalTickData, type WsOptions, type WsPing, type WsPong, WsPongSchema, type WsReplay, type WsReplayCompleted, WsReplayCompletedSchema, type WsReplayPause, type WsReplayPaused, WsReplayPausedSchema, type WsReplayResume, type WsReplayResumed, WsReplayResumedSchema, type WsReplaySeek, type WsReplayStarted, WsReplayStartedSchema, type WsReplayStop, type WsReplayStopped, WsReplayStoppedSchema, type WsServerMessage, WsServerMessageSchema, type WsStream, type WsStreamCompleted, WsStreamCompletedSchema, type WsStreamProgress, WsStreamProgressSchema, type WsStreamStarted, WsStreamStartedSchema, type WsStreamStop, type WsStreamStopped, WsStreamStoppedSchema, type WsSubscribe, type WsSubscribed, WsSubscribedSchema, type WsUnsubscribe, type WsUnsubscribed, WsUnsubscribedSchema, OxArchive as default, reconstructFinal, reconstructOrderBook };
+export { type ApiError, type ApiMeta, ApiMetaSchema, type ApiResponse, ApiResponseSchema, type Candle, CandleArrayResponseSchema, type CandleHistoryParams, type CandleInterval, CandleIntervalSchema, CandleSchema, type ClientOptions, type CompletenessMetrics, type CoverageGap, type CoverageResponse, type CursorResponse, type DataCadence, type DataFreshness, type DataTypeCoverage, type DataTypeStatus, type ExchangeCoverage, type ExchangeLatency, type ExchangeStatus, type FundingRate, FundingRateArrayResponseSchema, FundingRateResponseSchema, FundingRateSchema, type GetOrderBookParams, type GetTradesCursorParams, Hip3Client, HyperliquidClient, type Incident, type IncidentSeverityValue, type IncidentStatusValue, type IncidentsResponse, type Instrument, InstrumentArrayResponseSchema, InstrumentResponseSchema, InstrumentSchema, type InstrumentType, InstrumentTypeSchema, type LatencyResponse, LighterClient, type LighterGranularity, type LighterInstrument, type Liquidation, LiquidationArrayResponseSchema, type LiquidationHistoryParams, LiquidationSchema, LiquidationSideSchema, type LiquidationsByUserParams, type ListIncidentsParams, type OpenInterest, OpenInterestArrayResponseSchema, OpenInterestResponseSchema, OpenInterestSchema, type OrderBook, OrderBookArrayResponseSchema, type OrderBookHistoryParams, OrderBookReconstructor, OrderBookResponseSchema, OrderBookSchema, type OrderbookDelta, OxArchive, OxArchiveError, OxArchiveWs, type Pagination, type PriceLevel, PriceLevelSchema, type ReconstructOptions, type ReconstructedOrderBook, type RestApiLatency, type SlaActual, type SlaParams, type SlaResponse, type SlaTargets, type StatusResponse, type SymbolCoverageOptions, type SymbolCoverageResponse, type SymbolDataTypeCoverage, type SystemStatusValue, type TickData, type TickHistoryParams, type Timestamp, type TimestampedRecord, TimestampedRecordSchema, type Trade, TradeArrayResponseSchema, type TradeDirection, TradeDirectionSchema, TradeSchema, type TradeSide, TradeSideSchema, type ValidatedApiMeta, type ValidatedCandle, type ValidatedFundingRate, type ValidatedInstrument, type ValidatedLiquidation, type ValidatedOpenInterest, type ValidatedOrderBook, type ValidatedPriceLevel, type ValidatedTrade, type ValidatedWsServerMessage, type WebSocketLatency, type WsChannel, WsChannelSchema, type WsClientMessage, type WsConnectionState, WsConnectionStateSchema, type WsData, WsDataSchema, type WsError, WsErrorSchema, type WsEventHandlers, type WsHistoricalBatch, WsHistoricalBatchSchema, type WsHistoricalData, WsHistoricalDataSchema, type WsHistoricalTickData, type WsOptions, type WsPing, type WsPong, WsPongSchema, type WsReplay, type WsReplayCompleted, WsReplayCompletedSchema, type WsReplayPause, type WsReplayPaused, WsReplayPausedSchema, type WsReplayResume, type WsReplayResumed, WsReplayResumedSchema, type WsReplaySeek, type WsReplayStarted, WsReplayStartedSchema, type WsReplayStop, type WsReplayStopped, WsReplayStoppedSchema, type WsServerMessage, WsServerMessageSchema, type WsStream, type WsStreamCompleted, WsStreamCompletedSchema, type WsStreamProgress, WsStreamProgressSchema, type WsStreamStarted, WsStreamStartedSchema, type WsStreamStop, type WsStreamStopped, WsStreamStoppedSchema, type WsSubscribe, type WsSubscribed, WsSubscribedSchema, type WsUnsubscribe, type WsUnsubscribed, WsUnsubscribedSchema, OxArchive as default, reconstructFinal, reconstructOrderBook };

package/dist/index.d.ts

@@ -1095,7 +1095,8 @@ interface TickHistoryParams {
 declare class OrderBookResource {
     private http;
     private basePath;
-    constructor(http: HttpClient, basePath?: string);
+    private coinTransform;
+    constructor(http: HttpClient, basePath?: string, coinTransform?: (coin: string) => string);
     /**
      * Get order book snapshot for a coin
      *
@@ -1287,7 +1288,8 @@ declare class OrderBookResource {
 declare class TradesResource {
     private http;
     private basePath;
-    constructor(http: HttpClient, basePath?: string);
+    private coinTransform;
+    constructor(http: HttpClient, basePath?: string, coinTransform?: (coin: string) => string);
     /**
      * Get trade history for a coin using cursor-based pagination
      *
@@ -1322,9 +1324,10 @@ declare class TradesResource {
     /**
      * Get most recent trades for a coin.
      *
-     * Note: This method is only available for Lighter (client.lighter.trades.recent())
-     * which has real-time data ingestion. Hyperliquid uses hourly backfill so this
-     * endpoint is not available for Hyperliquid.
+     * Note: This method is available for Lighter (client.lighter.trades.recent())
+     * and HIP-3 (client.hyperliquid.hip3.trades.recent()) which have real-time data
+     * ingestion. Hyperliquid uses hourly backfill so this endpoint is not available
+     * for Hyperliquid.
      *
      * @param coin - The coin symbol (e.g., 'BTC', 'ETH')
      * @param limit - Number of trades to return (default: 100)
@@ -1429,7 +1432,8 @@ declare class LighterInstrumentsResource {
 declare class FundingResource {
     private http;
     private basePath;
-    constructor(http: HttpClient, basePath?: string);
+    private coinTransform;
+    constructor(http: HttpClient, basePath?: string, coinTransform?: (coin: string) => string);
     /**
      * Get funding rate history for a coin with cursor-based pagination
      *
@@ -1478,7 +1482,8 @@ declare class FundingResource {
 declare class OpenInterestResource {
     private http;
     private basePath;
-    constructor(http: HttpClient, basePath?: string);
+    private coinTransform;
+    constructor(http: HttpClient, basePath?: string, coinTransform?: (coin: string) => string);
     /**
      * Get open interest history for a coin with cursor-based pagination
      *
@@ -1665,7 +1670,7 @@ declare class DataQualityResource {
     /**
      * Get data coverage for a specific exchange
      *
-     * @param exchange - Exchange name ('hyperliquid' or 'lighter')
+     * @param exchange - Exchange name ('hyperliquid', 'lighter', or 'hip3')
      * @returns ExchangeCoverage with coverage info for all data types on this exchange
      *
      * @example
@@ -1681,8 +1686,8 @@ declare class DataQualityResource {
      * Includes gap detection, empirical data cadence, and hour-level historical coverage.
      * Supports optional time bounds for gap detection (default: last 30 days).
      *
-     * @param exchange - Exchange name ('hyperliquid' or 'lighter')
-     * @param symbol - Symbol name (e.g., 'BTC', 'ETH')
+     * @param exchange - Exchange name ('hyperliquid', 'lighter', or 'hip3')
+     * @param symbol - Symbol name (e.g., 'BTC', 'ETH', or HIP3 coins like 'xyz:XYZ100')
      * @param options - Optional time bounds for gap detection window
      * @returns SymbolCoverageResponse with per-data-type coverage including gaps, cadence, and historical coverage
      *
@@ -1817,6 +1822,42 @@ declare class HyperliquidClient {
      * Liquidation events (May 2025+)
      */
     readonly liquidations: LiquidationsResource;
+    /**
+     * HIP-3 builder-deployed perpetuals (Pro+ only, February 2026+)
+     */
+    readonly hip3: Hip3Client;
+    constructor(http: HttpClient);
+}
+/**
+ * HIP-3 builder-deployed perpetuals client
+ *
+ * Access Hyperliquid HIP-3 builder perps data through the 0xarchive API.
+ * Requires Pro tier or higher.
+ *
+ * @example
+ * ```typescript
+ * const client = new OxArchive({ apiKey: '...' });
+ * const orderbook = await client.hyperliquid.hip3.orderbook.get('xyz:XYZ100');
+ * const trades = await client.hyperliquid.hip3.trades.recent('xyz:XYZ100');
+ * ```
+ */
+declare class Hip3Client {
+    /**
+     * Order book snapshots (February 2026+)
+     */
+    readonly orderbook: OrderBookResource;
+    /**
+     * Trade/fill history
+     */
+    readonly trades: TradesResource;
+    /**
+     * Funding rates
+     */
+    readonly funding: FundingResource;
+    /**
+     * Open interest
+     */
+    readonly openInterest: OpenInterestResource;
     constructor(http: HttpClient);
 }
 /**
@@ -4029,4 +4070,4 @@ type ValidatedCandle = z.infer<typeof CandleSchema>;
 type ValidatedLiquidation = z.infer<typeof LiquidationSchema>;
 type ValidatedWsServerMessage = z.infer<typeof WsServerMessageSchema>;
 
-export { type ApiError, type ApiMeta, ApiMetaSchema, type ApiResponse, ApiResponseSchema, type Candle, CandleArrayResponseSchema, type CandleHistoryParams, type CandleInterval, CandleIntervalSchema, CandleSchema, type ClientOptions, type CompletenessMetrics, type CoverageGap, type CoverageResponse, type CursorResponse, type DataCadence, type DataFreshness, type DataTypeCoverage, type DataTypeStatus, type ExchangeCoverage, type ExchangeLatency, type ExchangeStatus, type FundingRate, FundingRateArrayResponseSchema, FundingRateResponseSchema, FundingRateSchema, type GetOrderBookParams, type GetTradesCursorParams, HyperliquidClient, type Incident, type IncidentSeverityValue, type IncidentStatusValue, type IncidentsResponse, type Instrument, InstrumentArrayResponseSchema, InstrumentResponseSchema, InstrumentSchema, type InstrumentType, InstrumentTypeSchema, type LatencyResponse, LighterClient, type LighterGranularity, type LighterInstrument, type Liquidation, LiquidationArrayResponseSchema, type LiquidationHistoryParams, LiquidationSchema, LiquidationSideSchema, type LiquidationsByUserParams, type ListIncidentsParams, type OpenInterest, OpenInterestArrayResponseSchema, OpenInterestResponseSchema, OpenInterestSchema, type OrderBook, OrderBookArrayResponseSchema, type OrderBookHistoryParams, OrderBookReconstructor, OrderBookResponseSchema, OrderBookSchema, type OrderbookDelta, OxArchive, OxArchiveError, OxArchiveWs, type Pagination, type PriceLevel, PriceLevelSchema, type ReconstructOptions, type ReconstructedOrderBook, type RestApiLatency, type SlaActual, type SlaParams, type SlaResponse, type SlaTargets, type StatusResponse, type SymbolCoverageOptions, type SymbolCoverageResponse, type SymbolDataTypeCoverage, type SystemStatusValue, type TickData, type TickHistoryParams, type Timestamp, type TimestampedRecord, TimestampedRecordSchema, type Trade, TradeArrayResponseSchema, type TradeDirection, TradeDirectionSchema, TradeSchema, type TradeSide, TradeSideSchema, type ValidatedApiMeta, type ValidatedCandle, type ValidatedFundingRate, type ValidatedInstrument, type ValidatedLiquidation, type ValidatedOpenInterest, type ValidatedOrderBook, type ValidatedPriceLevel, type ValidatedTrade, type ValidatedWsServerMessage, type WebSocketLatency, type WsChannel, WsChannelSchema, type WsClientMessage, type WsConnectionState, WsConnectionStateSchema, type WsData, WsDataSchema, type WsError, WsErrorSchema, type WsEventHandlers, type WsHistoricalBatch, WsHistoricalBatchSchema, type WsHistoricalData, WsHistoricalDataSchema, type WsHistoricalTickData, type WsOptions, type WsPing, type WsPong, WsPongSchema, type WsReplay, type WsReplayCompleted, WsReplayCompletedSchema, type WsReplayPause, type WsReplayPaused, WsReplayPausedSchema, type WsReplayResume, type WsReplayResumed, WsReplayResumedSchema, type WsReplaySeek, type WsReplayStarted, WsReplayStartedSchema, type WsReplayStop, type WsReplayStopped, WsReplayStoppedSchema, type WsServerMessage, WsServerMessageSchema, type WsStream, type WsStreamCompleted, WsStreamCompletedSchema, type WsStreamProgress, WsStreamProgressSchema, type WsStreamStarted, WsStreamStartedSchema, type WsStreamStop, type WsStreamStopped, WsStreamStoppedSchema, type WsSubscribe, type WsSubscribed, WsSubscribedSchema, type WsUnsubscribe, type WsUnsubscribed, WsUnsubscribedSchema, OxArchive as default, reconstructFinal, reconstructOrderBook };
+export { type ApiError, type ApiMeta, ApiMetaSchema, type ApiResponse, ApiResponseSchema, type Candle, CandleArrayResponseSchema, type CandleHistoryParams, type CandleInterval, CandleIntervalSchema, CandleSchema, type ClientOptions, type CompletenessMetrics, type CoverageGap, type CoverageResponse, type CursorResponse, type DataCadence, type DataFreshness, type DataTypeCoverage, type DataTypeStatus, type ExchangeCoverage, type ExchangeLatency, type ExchangeStatus, type FundingRate, FundingRateArrayResponseSchema, FundingRateResponseSchema, FundingRateSchema, type GetOrderBookParams, type GetTradesCursorParams, Hip3Client, HyperliquidClient, type Incident, type IncidentSeverityValue, type IncidentStatusValue, type IncidentsResponse, type Instrument, InstrumentArrayResponseSchema, InstrumentResponseSchema, InstrumentSchema, type InstrumentType, InstrumentTypeSchema, type LatencyResponse, LighterClient, type LighterGranularity, type LighterInstrument, type Liquidation, LiquidationArrayResponseSchema, type LiquidationHistoryParams, LiquidationSchema, LiquidationSideSchema, type LiquidationsByUserParams, type ListIncidentsParams, type OpenInterest, OpenInterestArrayResponseSchema, OpenInterestResponseSchema, OpenInterestSchema, type OrderBook, OrderBookArrayResponseSchema, type OrderBookHistoryParams, OrderBookReconstructor, OrderBookResponseSchema, OrderBookSchema, type OrderbookDelta, OxArchive, OxArchiveError, OxArchiveWs, type Pagination, type PriceLevel, PriceLevelSchema, type ReconstructOptions, type ReconstructedOrderBook, type RestApiLatency, type SlaActual, type SlaParams, type SlaResponse, type SlaTargets, type StatusResponse, type SymbolCoverageOptions, type SymbolCoverageResponse, type SymbolDataTypeCoverage, type SystemStatusValue, type TickData, type TickHistoryParams, type Timestamp, type TimestampedRecord, TimestampedRecordSchema, type Trade, TradeArrayResponseSchema, type TradeDirection, TradeDirectionSchema, TradeSchema, type TradeSide, TradeSideSchema, type ValidatedApiMeta, type ValidatedCandle, type ValidatedFundingRate, type ValidatedInstrument, type ValidatedLiquidation, type ValidatedOpenInterest, type ValidatedOrderBook, type ValidatedPriceLevel, type ValidatedTrade, type ValidatedWsServerMessage, type WebSocketLatency, type WsChannel, WsChannelSchema, type WsClientMessage, type WsConnectionState, WsConnectionStateSchema, type WsData, WsDataSchema, type WsError, WsErrorSchema, type WsEventHandlers, type WsHistoricalBatch, WsHistoricalBatchSchema, type WsHistoricalData, WsHistoricalDataSchema, type WsHistoricalTickData, type WsOptions, type WsPing, type WsPong, WsPongSchema, type WsReplay, type WsReplayCompleted, WsReplayCompletedSchema, type WsReplayPause, type WsReplayPaused, WsReplayPausedSchema, type WsReplayResume, type WsReplayResumed, WsReplayResumedSchema, type WsReplaySeek, type WsReplayStarted, WsReplayStartedSchema, type WsReplayStop, type WsReplayStopped, WsReplayStoppedSchema, type WsServerMessage, WsServerMessageSchema, type WsStream, type WsStreamCompleted, WsStreamCompletedSchema, type WsStreamProgress, WsStreamProgressSchema, type WsStreamStarted, WsStreamStartedSchema, type WsStreamStop, type WsStreamStopped, WsStreamStoppedSchema, type WsSubscribe, type WsSubscribed, WsSubscribedSchema, type WsUnsubscribe, type WsUnsubscribed, WsUnsubscribedSchema, OxArchive as default, reconstructFinal, reconstructOrderBook };

package/dist/index.js

@@ -28,6 +28,7 @@ __export(index_exports, {
   FundingRateArrayResponseSchema: () => FundingRateArrayResponseSchema,
   FundingRateResponseSchema: () => FundingRateResponseSchema,
   FundingRateSchema: () => FundingRateSchema,
+  Hip3Client: () => Hip3Client,
   HyperliquidClient: () => HyperliquidClient,
   InstrumentArrayResponseSchema: () => InstrumentArrayResponseSchema,
   InstrumentResponseSchema: () => InstrumentResponseSchema,
@@ -596,9 +597,10 @@ function reconstructFinal(tickData, depth) {
 
 // src/resources/orderbook.ts
 var OrderBookResource = class {
-  constructor(http, basePath = "/v1") {
+  constructor(http, basePath = "/v1", coinTransform = (c) => c.toUpperCase()) {
     this.http = http;
     this.basePath = basePath;
+    this.coinTransform = coinTransform;
   }
   /**
    * Get order book snapshot for a coin
@@ -609,7 +611,7 @@ var OrderBookResource = class {
    */
   async get(coin, params) {
     const response = await this.http.get(
-      `${this.basePath}/orderbook/${coin.toUpperCase()}`,
+      `${this.basePath}/orderbook/${this.coinTransform(coin)}`,
       params,
       this.http.validationEnabled ? OrderBookResponseSchema : void 0
     );
@@ -644,7 +646,7 @@ var OrderBookResource = class {
    */
   async history(coin, params) {
     const response = await this.http.get(
-      `${this.basePath}/orderbook/${coin.toUpperCase()}/history`,
+      `${this.basePath}/orderbook/${this.coinTransform(coin)}/history`,
       params,
       this.http.validationEnabled ? OrderBookArrayResponseSchema : void 0
     );
@@ -684,7 +686,7 @@ var OrderBookResource = class {
    */
   async historyTick(coin, params) {
     const response = await this.http.get(
-      `${this.basePath}/orderbook/${coin.toUpperCase()}/history`,
+      `${this.basePath}/orderbook/${this.coinTransform(coin)}/history`,
       {
         ...params,
         granularity: "tick"
@@ -837,9 +839,10 @@ var OrderBookResource = class {
 
 // src/resources/trades.ts
 var TradesResource = class {
-  constructor(http, basePath = "/v1") {
+  constructor(http, basePath = "/v1", coinTransform = (c) => c.toUpperCase()) {
     this.http = http;
     this.basePath = basePath;
+    this.coinTransform = coinTransform;
   }
   /**
    * Get trade history for a coin using cursor-based pagination
@@ -873,7 +876,7 @@ var TradesResource = class {
    */
   async list(coin, params) {
     const response = await this.http.get(
-      `${this.basePath}/trades/${coin.toUpperCase()}`,
+      `${this.basePath}/trades/${this.coinTransform(coin)}`,
       params,
       this.http.validationEnabled ? TradeArrayResponseSchema : void 0
     );
@@ -885,9 +888,10 @@ var TradesResource = class {
   /**
    * Get most recent trades for a coin.
    *
-   * Note: This method is only available for Lighter (client.lighter.trades.recent())
-   * which has real-time data ingestion. Hyperliquid uses hourly backfill so this
-   * endpoint is not available for Hyperliquid.
+   * Note: This method is available for Lighter (client.lighter.trades.recent())
+   * and HIP-3 (client.hyperliquid.hip3.trades.recent()) which have real-time data
+   * ingestion. Hyperliquid uses hourly backfill so this endpoint is not available
+   * for Hyperliquid.
    *
    * @param coin - The coin symbol (e.g., 'BTC', 'ETH')
    * @param limit - Number of trades to return (default: 100)
@@ -895,7 +899,7 @@ var TradesResource = class {
    */
   async recent(coin, limit) {
     const response = await this.http.get(
-      `${this.basePath}/trades/${coin.toUpperCase()}/recent`,
+      `${this.basePath}/trades/${this.coinTransform(coin)}/recent`,
       { limit },
       this.http.validationEnabled ? TradeArrayResponseSchema : void 0
     );
@@ -969,9 +973,10 @@ var LighterInstrumentsResource = class {
 
 // src/resources/funding.ts
 var FundingResource = class {
-  constructor(http, basePath = "/v1") {
+  constructor(http, basePath = "/v1", coinTransform = (c) => c.toUpperCase()) {
     this.http = http;
     this.basePath = basePath;
+    this.coinTransform = coinTransform;
   }
   /**
    * Get funding rate history for a coin with cursor-based pagination
@@ -982,7 +987,7 @@ var FundingResource = class {
    */
   async history(coin, params) {
     const response = await this.http.get(
-      `${this.basePath}/funding/${coin.toUpperCase()}`,
+      `${this.basePath}/funding/${this.coinTransform(coin)}`,
       params,
       this.http.validationEnabled ? FundingRateArrayResponseSchema : void 0
     );
@@ -999,7 +1004,7 @@ var FundingResource = class {
    */
   async current(coin) {
     const response = await this.http.get(
-      `/v1/funding/${coin.toUpperCase()}/current`,
+      `${this.basePath}/funding/${this.coinTransform(coin)}/current`,
       void 0,
       this.http.validationEnabled ? FundingRateResponseSchema : void 0
     );
@@ -1009,9 +1014,10 @@ var FundingResource = class {
 
 // src/resources/openinterest.ts
 var OpenInterestResource = class {
-  constructor(http, basePath = "/v1") {
+  constructor(http, basePath = "/v1", coinTransform = (c) => c.toUpperCase()) {
     this.http = http;
     this.basePath = basePath;
+    this.coinTransform = coinTransform;
   }
   /**
    * Get open interest history for a coin with cursor-based pagination
@@ -1022,7 +1028,7 @@ var OpenInterestResource = class {
    */
   async history(coin, params) {
     const response = await this.http.get(
-      `${this.basePath}/openinterest/${coin.toUpperCase()}`,
+      `${this.basePath}/openinterest/${this.coinTransform(coin)}`,
       params,
       this.http.validationEnabled ? OpenInterestArrayResponseSchema : void 0
     );
@@ -1039,7 +1045,7 @@ var OpenInterestResource = class {
    */
   async current(coin) {
     const response = await this.http.get(
-      `/v1/openinterest/${coin.toUpperCase()}/current`,
+      `${this.basePath}/openinterest/${this.coinTransform(coin)}/current`,
       void 0,
       this.http.validationEnabled ? OpenInterestResponseSchema : void 0
     );
@@ -1173,7 +1179,7 @@ var DataQualityResource = class {
   /**
    * Get data coverage for a specific exchange
    *
-   * @param exchange - Exchange name ('hyperliquid' or 'lighter')
+   * @param exchange - Exchange name ('hyperliquid', 'lighter', or 'hip3')
    * @returns ExchangeCoverage with coverage info for all data types on this exchange
    *
    * @example
@@ -1193,8 +1199,8 @@ var DataQualityResource = class {
    * Includes gap detection, empirical data cadence, and hour-level historical coverage.
    * Supports optional time bounds for gap detection (default: last 30 days).
    *
-   * @param exchange - Exchange name ('hyperliquid' or 'lighter')
-   * @param symbol - Symbol name (e.g., 'BTC', 'ETH')
+   * @param exchange - Exchange name ('hyperliquid', 'lighter', or 'hip3')
+   * @param symbol - Symbol name (e.g., 'BTC', 'ETH', or HIP3 coins like 'xyz:XYZ100')
    * @param options - Optional time bounds for gap detection window
    * @returns SymbolCoverageResponse with per-data-type coverage including gaps, cadence, and historical coverage
    *
@@ -1346,6 +1352,10 @@ var HyperliquidClient = class {
    * Liquidation events (May 2025+)
    */
   liquidations;
+  /**
+   * HIP-3 builder-deployed perpetuals (Pro+ only, February 2026+)
+   */
+  hip3;
   constructor(http) {
     const basePath = "/v1/hyperliquid";
     this.orderbook = new OrderBookResource(http, basePath);
@@ -1355,6 +1365,33 @@ var HyperliquidClient = class {
     this.openInterest = new OpenInterestResource(http, basePath);
     this.candles = new CandlesResource(http, basePath);
     this.liquidations = new LiquidationsResource(http, basePath);
+    this.hip3 = new Hip3Client(http);
+  }
+};
+var Hip3Client = class {
+  /**
+   * Order book snapshots (February 2026+)
+   */
+  orderbook;
+  /**
+   * Trade/fill history
+   */
+  trades;
+  /**
+   * Funding rates
+   */
+  funding;
+  /**
+   * Open interest
+   */
+  openInterest;
+  constructor(http) {
+    const basePath = "/v1/hyperliquid/hip3";
+    const coinTransform = (c) => c;
+    this.orderbook = new OrderBookResource(http, basePath, coinTransform);
+    this.trades = new TradesResource(http, basePath, coinTransform);
+    this.funding = new FundingResource(http, basePath, coinTransform);
+    this.openInterest = new OpenInterestResource(http, basePath, coinTransform);
   }
 };
 var LighterClient = class {
@@ -2037,6 +2074,7 @@ var OxArchiveWs = class {
   FundingRateArrayResponseSchema,
   FundingRateResponseSchema,
   FundingRateSchema,
+  Hip3Client,
   HyperliquidClient,
   InstrumentArrayResponseSchema,
   InstrumentResponseSchema,