Market Metadata

Hyperliquid

Returns metadata for the perpetual and spot markets available through Notional, including configured HIP-3 perpetuals.

Endpoint

POST /info

Request Body

Parameter	Type	Description
`type`*	string	Must be `"notionalMeta"`

Response

200: OK

{
  "perpMarkets": {
    "00020000": {
      "assetId": "00020000",
      "symbol": "BTC-USDC",
      "venueName": "BTC",
      "venueIndex": 0,
      "marginAsset": "00012710",
      "marketConfig": {
        "maxLeverage": 10,
        "szDecimals": 5,
        "maxOpenInterestUSD": 100000000
      },
      "openInterestCaps": {
        "cap": 100000000,
        "currentTotal": 20000000
      }
    },
    "00050000001e3660": {
      "assetId": "00050000001e3660",
      "symbol": "idx:IDX0-USDC",
      "venueName": "idx:IDX0",
      "venueIndex": 1980000,
      "marginAsset": "00012710",
      "marketConfig": {
        "maxLeverage": 5,
        "szDecimals": 2,
        "maxOpenInterestUSD": 25000000
      },
      "onlyIsolated": true,
      "isDelisted": false,
      "hip3": {
        "dex": "idx",
        "executionPolicy": "exclusive_subaccount_v1",
        "tradingState": "active"
      }
    }
  },
  "assets": {
    "00012710": {
      "assetId": "00012710",
      "symbol": "USDC",
      "displayName": "USDC",
      "assetIndex": "0",
      "tokenId": "0x...",
      "spotMarketIndex": "0",
      "szDecimals": 6,
      "weiDecimals": 6,
      "collateralPolicy": {
        "ltv": 1,
        "haircut": 0,
        "borrowEnabled": true,
        "targetBorrow": 800000000,
        "maxBorrow": 1000000000
      }
    }
  },
  "marginTables": [],
  "spotPairs": {
    "00030001": {
      "pairId": "00030001",
      "name": "HYPE/USDC",
      "tokens": ["0001abcd", "00012710"]
    }
  },
  "twap": {
    "minDurationMinutes": 5,
    "maxDurationMinutes": 1440,
    "minSliceIntervalMs": 10000,
    "maxSliceIntervalMs": 600000
  },
  "earn": {
    "apy": 350,
    "borrowApr": 525,
    "tvl": "1000000.00",
    "available": "800000.00",
    "utilization": 0.2,
    "nextAccrualTimestamp": 1701234567890
  }
}

Perpetual Market Fields

Field	Type	Description
`assetId`	string	Canonical unprefixed AssetId: 8 characters for native perps, 16 for HIP-3 builder perps
`venueName`	string	Hyperliquid market name; HIP-3 names are qualified, for example `"idx:IDX0"`
`venueIndex`	number	Hyperliquid wire index; HIP-3 values are composite builder-dex indices
`onlyIsolated`	boolean	Whether the venue requires isolated margin
`isDelisted`	boolean	Whether the market currently refuses new orders

HIP-3 Market State

Builder markets include a hip3 object. Native perpetuals omit it; onlyIsolated alone does not identify a HIP-3 market.

Field	Type	Description
`hip3.dex`	string	Builder dex prefix, for example `"idx"`
`hip3.executionPolicy`	string	`"exclusive_subaccount_v1"` for assigned execution or `"omnibus_v1"` for shared execution
`hip3.tradingState`	string	`"active"`, `"reduce_only"`, or `"halted"`

Use the qualified venueName, such as "idx:IDX0", for market subscriptions. Assigned execution supports per-user isolated leverage and scope state. Read Market Trading State for that user’s current permissions, leverage, and available capacity. A visible market is not necessarily open for new risk. Check isDelisted, hip3.tradingState, and the user’s isolated.permissions.canOpen; order admission makes the final decision. Registered builder markets remain in metadata when new trading is disabled so clients retain the identifiers needed to close existing positions.

Earn Summary Units

earn.apy and earn.borrowApr are integer basis points: 350 represents 3.5%. earn.utilization is a decimal ratio, and tvl and available are decimal USDC strings. nextAccrualTimestamp is a Unix-millisecond timestamp or null. If pool state is unavailable, the earn summary can contain zero values and a null accrual timestamp. When the pUSD pool is active and readable, the response also includes earnPusd with the same fields, denominated in pUSD. If balance totals cannot be read, earnPusd.tvl is null; its rates, available liquidity, utilization, and accrual timestamp remain available. Treat null TVL as unavailable, not zero. A measured zero is the string "0.00". The entire earnPusd block is omitted only when the pool is inactive or its own state cannot be read or validated. These semantics also apply to the WebSocket metadata stream.

Start Here

Info

Analytics

Exchange

WebSocket

Endpoint

Request Body

Response

Perpetual Market Fields

HIP-3 Market State

Earn Summary Units

​Endpoint

​Request Body

​Response

​Perpetual Market Fields

​HIP-3 Market State

​Earn Summary Units

Endpoint

Request Body

Response

Perpetual Market Fields

HIP-3 Market State

Earn Summary Units