@0xarchive/sdk 0.8.0 → 0.8.1

package/README.md

@@ -32,9 +32,10 @@ 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');
+// HIP-3 builder perps (February 2026+)
+const hip3Instruments = await client.hyperliquid.hip3.instruments.list();
+const hip3Orderbook = await client.hyperliquid.hip3.orderbook.get('km:US500');
+const hip3Trades = await client.hyperliquid.hip3.trades.recent('km:US500');
 const hip3Funding = await client.hyperliquid.hip3.funding.current('xyz:XYZ100');
 const hip3Oi = await client.hyperliquid.hip3.openInterest.current('xyz:XYZ100');
 
@@ -269,6 +270,28 @@ console.log(`ETH min base amount: ${eth.minBaseAmount}`);
 | Market ID | Not available | `marketId` |
 | Min amounts | Not available | `minBaseAmount`, `minQuoteAmount` |
 
+#### HIP-3 Instruments
+
+HIP-3 instruments are derived from live market data and include mark price, open interest, and mid price:
+
+```typescript
+// List all HIP-3 instruments (no tier restriction)
+const hip3Instruments = await client.hyperliquid.hip3.instruments.list();
+for (const inst of hip3Instruments) {
+  console.log(`${inst.coin} (${inst.namespace}:${inst.ticker}): mark=${inst.markPrice}, OI=${inst.openInterest}`);
+}
+
+// Get specific HIP-3 instrument (case-sensitive)
+const us500 = await client.hyperliquid.hip3.instruments.get('km:US500');
+console.log(`Mark price: ${us500.markPrice}`);
+```
+
+**Available HIP-3 Coins:**
+| Builder | Coins |
+|---------|-------|
+| xyz (Hyperliquid) | `xyz:XYZ100` |
+| km (Kinetiq Markets) | `km:US500`, `km:SMALL2000`, `km:GOOGL`, `km:USBOND`, `km:GOLD`, `km:USTECH`, `km:NVDA`, `km:SILVER`, `km:BABA` |
+
 ### Funding Rates
 
 ```typescript
@@ -660,6 +683,8 @@ const ws = new OxArchiveWs({
 
 ### Available Channels
 
+#### Hyperliquid Channels
+
 | Channel | Description | Requires Coin | Historical Support |
 |---------|-------------|---------------|-------------------|
 | `orderbook` | L2 order book updates | Yes | Yes |
@@ -669,6 +694,23 @@ const ws = new OxArchiveWs({
 | `ticker` | Price and 24h volume | Yes | Real-time only |
 | `all_tickers` | All market tickers | No | Real-time only |
 
+#### HIP-3 Builder Perps Channels
+
+| Channel | Description | Requires Coin | Historical Support |
+|---------|-------------|---------------|-------------------|
+| `hip3_orderbook` | HIP-3 L2 order book snapshots | Yes | Yes |
+| `hip3_trades` | HIP-3 trade/fill updates | Yes | Yes |
+
+> **Note:** HIP-3 coins are case-sensitive (e.g., `km:US500`, `xyz:XYZ100`). Do not uppercase them.
+
+#### Lighter.xyz Channels
+
+| Channel | Description | Requires Coin | Historical Support |
+|---------|-------------|---------------|-------------------|
+| `lighter_orderbook` | Lighter L2 order book (reconstructed) | Yes | Yes |
+| `lighter_trades` | Lighter trade/fill updates | Yes | Yes |
+| `lighter_candles` | Lighter OHLCV candle data | Yes | Yes |
+
 #### Candle Replay/Stream
 
 ```typescript
@@ -696,6 +738,24 @@ ws.replay('lighter_candles', 'BTC', {
 });
 ```
 
+#### HIP-3 Replay/Stream
+
+```typescript
+// Replay HIP-3 orderbook at 50x speed
+ws.replay('hip3_orderbook', 'km:US500', {
+  start: Date.now() - 3600000,
+  end: Date.now(),
+  speed: 50,
+});
+
+// Bulk stream HIP-3 trades
+ws.stream('hip3_trades', 'xyz:XYZ100', {
+  start: Date.now() - 86400000,
+  end: Date.now(),
+  batchSize: 1000,
+});
+```
+
 ### WebSocket Connection States
 
 ```typescript
@@ -756,6 +816,7 @@ import type {
   Candle,
   Instrument,
   LighterInstrument,
+  Hip3Instrument,
   LighterGranularity,
   FundingRate,
   OpenInterest,

package/dist/index.d.mts

@@ -216,6 +216,26 @@ interface LighterInstrument {
     /** Whether the instrument is currently tradeable */
     isActive: boolean;
 }
+/**
+ * HIP-3 Builder Perps instrument with latest market data.
+ * Derived from live open interest data.
+ */
+interface Hip3Instrument {
+    /** Full coin name (e.g., km:US500, xyz:XYZ100) */
+    coin: string;
+    /** Builder namespace (e.g., km, xyz) */
+    namespace: string;
+    /** Ticker within the namespace (e.g., US500, XYZ100) */
+    ticker: string;
+    /** Latest mark price */
+    markPrice?: number;
+    /** Latest open interest */
+    openInterest?: number;
+    /** Latest mid price */
+    midPrice?: number;
+    /** Timestamp of latest data point */
+    latestTimestamp?: string;
+}
 /**
  * Funding rate record
  */
@@ -336,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';
+type WsChannel = 'orderbook' | 'trades' | 'candles' | 'liquidations' | 'ticker' | 'all_tickers' | 'lighter_orderbook' | 'lighter_trades' | 'lighter_candles' | 'hip3_orderbook' | 'hip3_trades';
 /** Subscribe message from client */
 interface WsSubscribe {
     op: 'subscribe';
@@ -1400,6 +1420,41 @@ declare class LighterInstrumentsResource {
      */
     get(coin: string): Promise<LighterInstrument>;
 }
+/**
+ * HIP-3 Builder Perps Instruments API resource
+ *
+ * HIP-3 instruments are derived from live market data and include
+ * mark price, open interest, and mid price context.
+ *
+ * @example
+ * ```typescript
+ * // List all HIP-3 instruments
+ * const instruments = await client.hyperliquid.hip3.instruments.list();
+ *
+ * // Get specific instrument
+ * const us500 = await client.hyperliquid.hip3.instruments.get('km:US500');
+ * console.log(`Mark price: ${us500.markPrice}`);
+ * ```
+ */
+declare class Hip3InstrumentsResource {
+    private http;
+    private basePath;
+    private coinTransform;
+    constructor(http: HttpClient, basePath?: string, coinTransform?: (c: string) => string);
+    /**
+     * List all available HIP-3 instruments with latest market data
+     *
+     * @returns Array of HIP-3 instruments
+     */
+    list(): Promise<Hip3Instrument[]>;
+    /**
+     * Get a specific HIP-3 instrument by coin name
+     *
+     * @param coin - The coin name (e.g., 'km:US500', 'xyz:XYZ100'). Case-sensitive.
+     * @returns HIP-3 instrument details with latest market data
+     */
+    get(coin: string): Promise<Hip3Instrument>;
+}
 
 /**
  * Funding rates API resource
@@ -1842,6 +1897,10 @@ declare class HyperliquidClient {
  * ```
  */
 declare class Hip3Client {
+    /**
+     * HIP-3 instruments with latest market data
+     */
+    readonly instruments: Hip3InstrumentsResource;
     /**
      * Order book snapshots (February 2026+)
      */
@@ -4070,4 +4129,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, 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 };
+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, type Hip3Instrument, 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

@@ -216,6 +216,26 @@ interface LighterInstrument {
     /** Whether the instrument is currently tradeable */
     isActive: boolean;
 }
+/**
+ * HIP-3 Builder Perps instrument with latest market data.
+ * Derived from live open interest data.
+ */
+interface Hip3Instrument {
+    /** Full coin name (e.g., km:US500, xyz:XYZ100) */
+    coin: string;
+    /** Builder namespace (e.g., km, xyz) */
+    namespace: string;
+    /** Ticker within the namespace (e.g., US500, XYZ100) */
+    ticker: string;
+    /** Latest mark price */
+    markPrice?: number;
+    /** Latest open interest */
+    openInterest?: number;
+    /** Latest mid price */
+    midPrice?: number;
+    /** Timestamp of latest data point */
+    latestTimestamp?: string;
+}
 /**
  * Funding rate record
  */
@@ -336,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';
+type WsChannel = 'orderbook' | 'trades' | 'candles' | 'liquidations' | 'ticker' | 'all_tickers' | 'lighter_orderbook' | 'lighter_trades' | 'lighter_candles' | 'hip3_orderbook' | 'hip3_trades';
 /** Subscribe message from client */
 interface WsSubscribe {
     op: 'subscribe';
@@ -1400,6 +1420,41 @@ declare class LighterInstrumentsResource {
      */
     get(coin: string): Promise<LighterInstrument>;
 }
+/**
+ * HIP-3 Builder Perps Instruments API resource
+ *
+ * HIP-3 instruments are derived from live market data and include
+ * mark price, open interest, and mid price context.
+ *
+ * @example
+ * ```typescript
+ * // List all HIP-3 instruments
+ * const instruments = await client.hyperliquid.hip3.instruments.list();
+ *
+ * // Get specific instrument
+ * const us500 = await client.hyperliquid.hip3.instruments.get('km:US500');
+ * console.log(`Mark price: ${us500.markPrice}`);
+ * ```
+ */
+declare class Hip3InstrumentsResource {
+    private http;
+    private basePath;
+    private coinTransform;
+    constructor(http: HttpClient, basePath?: string, coinTransform?: (c: string) => string);
+    /**
+     * List all available HIP-3 instruments with latest market data
+     *
+     * @returns Array of HIP-3 instruments
+     */
+    list(): Promise<Hip3Instrument[]>;
+    /**
+     * Get a specific HIP-3 instrument by coin name
+     *
+     * @param coin - The coin name (e.g., 'km:US500', 'xyz:XYZ100'). Case-sensitive.
+     * @returns HIP-3 instrument details with latest market data
+     */
+    get(coin: string): Promise<Hip3Instrument>;
+}
 
 /**
  * Funding rates API resource
@@ -1842,6 +1897,10 @@ declare class HyperliquidClient {
  * ```
  */
 declare class Hip3Client {
+    /**
+     * HIP-3 instruments with latest market data
+     */
+    readonly instruments: Hip3InstrumentsResource;
     /**
      * Order book snapshots (February 2026+)
      */
@@ -4070,4 +4129,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, 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 };
+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, type Hip3Instrument, 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

@@ -970,6 +970,38 @@ var LighterInstrumentsResource = class {
     return response.data;
   }
 };
+var Hip3InstrumentsResource = class {
+  constructor(http, basePath = "/v1/hyperliquid/hip3", coinTransform) {
+    this.http = http;
+    this.basePath = basePath;
+    this.coinTransform = coinTransform || ((c) => c);
+  }
+  coinTransform;
+  /**
+   * List all available HIP-3 instruments with latest market data
+   *
+   * @returns Array of HIP-3 instruments
+   */
+  async list() {
+    const response = await this.http.get(
+      `${this.basePath}/instruments`
+    );
+    return response.data;
+  }
+  /**
+   * Get a specific HIP-3 instrument by coin name
+   *
+   * @param coin - The coin name (e.g., 'km:US500', 'xyz:XYZ100'). Case-sensitive.
+   * @returns HIP-3 instrument details with latest market data
+   */
+  async get(coin) {
+    coin = this.coinTransform(coin);
+    const response = await this.http.get(
+      `${this.basePath}/instruments/${coin}`
+    );
+    return response.data;
+  }
+};
 
 // src/resources/funding.ts
 var FundingResource = class {
@@ -1369,6 +1401,10 @@ var HyperliquidClient = class {
   }
 };
 var Hip3Client = class {
+  /**
+   * HIP-3 instruments with latest market data
+   */
+  instruments;
   /**
    * Order book snapshots (February 2026+)
    */
@@ -1388,6 +1424,7 @@ var Hip3Client = class {
   constructor(http) {
     const basePath = "/v1/hyperliquid/hip3";
     const coinTransform = (c) => c;
+    this.instruments = new Hip3InstrumentsResource(http, basePath, coinTransform);
     this.orderbook = new OrderBookResource(http, basePath, coinTransform);
     this.trades = new TradesResource(http, basePath, coinTransform);
     this.funding = new FundingResource(http, basePath, coinTransform);