Skip to main content

Endpoint

POST /info

Request Body

ParameterTypeDescription
type*stringMust be "notionalMeta"

Response

{
  "perpMarkets": {
    "0x00": {
      "assetId": "0x00",
      "name": "BTC",
      "venueName": "BTC",
      "szDecimals": 5,
      "marginAsset": "0xusdc",
      "maxLeverage": 10
    }
  },
  "assets": {
    "0xusdc": {
      "assetId": "0xusdc",
      "symbol": "USDC",
      "displayName": "USDC",
      "assetIndex": "0",
      "tokenId": "0xtoken",
      "collateralPolicy": {
        "ltv": 1.0,
        "haircut": 0.0,
        "borrowEnabled": true,
        "targetBorrow": 800000000,
        "maxBorrow": 1000000000,
        "maxDeposit": 5000000000
      }
    }
  },
  "marginTables": {
    "initial": [...],
    "maintenance": [...]
  }
}

Response Fields

FieldTypeDescription
perpMarketsobjectMap of perpetual markets by asset ID
assetsobjectMap of spot assets by asset ID
marginTablesobjectInitial and maintenance margin tables
perpMarkets.{assetId}.assetIdstringHex asset identifier
perpMarkets.{assetId}.namestringMarket name (e.g., “BTC”)
perpMarkets.{assetId}.venueNamestringVenue-specific name
perpMarkets.{assetId}.szDecimalsnumberSize decimal precision
perpMarkets.{assetId}.marginAssetstringCollateral asset ID
perpMarkets.{assetId}.maxLeveragenumberMaximum allowed leverage
assets.{assetId}.assetIdstringHex asset identifier
assets.{assetId}.symbolstringAsset symbol (e.g., “USDC”)
assets.{assetId}.displayNamestringHuman-readable name
assets.{assetId}.assetIndexstringAsset index in contract
assets.{assetId}.tokenIdstringERC-20 token address
assets.{assetId}.collateralPolicy.ltvnumberLoan-to-value ratio (1.0 = 100%)
assets.{assetId}.collateralPolicy.haircutnumberHaircut applied (0.0 = 0%)
assets.{assetId}.collateralPolicy.borrowEnabledbooleanCan be used as collateral
assets.{assetId}.collateralPolicy.targetBorrownumberTarget borrow cap
assets.{assetId}.collateralPolicy.maxBorrownumberMaximum borrow cap
assets.{assetId}.collateralPolicy.maxDepositnumberMaximum deposit cap
marginTables.initialarrayInitial margin requirements
marginTables.maintenancearrayMaintenance margin requirements

Example Request

curl -X POST https://api.notional.xyz/info \
  -H "Content-Type: application/json" \
  -d '{
    "type": "notionalMeta"
  }'

Notes

  • Asset IDs are hex strings for JSON serialization
  • LTV = 1 - haircut
  • Use this endpoint once on app initialization