Instrument Information

Subscribe to detailed instrument information updates.

Subscribe Request

{
  "id": 3,
  "method": "SUBSCRIBE",
  "params": {
    "chainId": 143,
    "instrument": "0x73ada1ea346cc3908f41cf67a040f0acd7808be0",
    "expiry": 4294967295,
    "type": "instrument"
  }
}

Unsubscribe Request

{
  "id": 3,
  "method": "UNSUBSCRIBE",
  "params": {
    "chainId": 143,
    "instrument": "0x73ada1ea346cc3908f41cf67a040f0acd7808be0",
    "expiry": 4294967295,
    "type": "instrument"
  }
}

Parameter Description

• chainId (required): Chain ID

• instrument (required): Instrument address (lowercase)

• expiry (required): Expiry timestamp

• type (required): Must be "instrument"

Data Stream Message

{
  "stream": "instrument",
  "chainId": 143,
  "instrument": "0x73ada1ea346cc3908f41cf67a040f0acd7808be0",
  "expiry": 4294967295,
  "data": {
    "instrumentAddr": "0x73ada1ea346cc3908f41cf67a040f0acd7808be0",
    "handler": "0x...",
    "symbol": "ETH/USD",
    "market": {
      "info": {
        "addr": "0x...",
        "type": "perp",
        "beacon": "0x..."
      },
      "config": {
        "dailyInterestRate": 1000,
        "feederSource": [
          {
            "baseSymbol": "ETH",
            "quoteSymbol": "USD",
            "ftype": 1,
            "aggregator0": "0x...",
            "heartBeat0": 3600,
            "aggregator1": "0x...",
            "heartBeat1": 3600
          }
        ]
      },
      "feeder": {
        "ftype": 1,
        "scaler0": "1.0",
        "aggregator0": "0x...",
        "heartBeat0": 3600,
        "scaler1": "1.0",
        "aggregator1": "0x...",
        "heartBeat1": 3600
      }
    },
    "condition": 1,
    "setting": {
      "initialMarginRatio": 1000,
      "maintenanceMarginRatio": 500,
      "quoteParam": {
        "minMarginAmount": "1000000000000000000",
        "tradingFeeRatio": 30,
        "protocolFeeRatio": 10,
        "qtype": 1,
        "tip": "0"
      }
    },
    "spotPrice": "2000.00",
    "amms": [
      {
        "expiry": 4294967295,
        "timestamp": 1699000000,
        "status": 1,
        "tick": 1000,
        "sqrtPX96": "1234567890123456789012345",
        "liquidity": "1000000000000000000",
        "totalLiquidity": "1000000000000000000",
        "totalShort": "500000000000000000",
        "openInterests": "1000000000000000000",
        "totalLong": "500000000000000000",
        "involvedFund": "2000000000000000000",
        "feeIndex": "1000000000000000000",
        "protocolFee": "100000000000000000",
        "longSocialLossIndex": "0",
        "shortSocialLossIndex": "0",
        "longFundingIndex": "1000000000000000000",
        "shortFundingIndex": "1000000000000000000",
        "insuranceFund": "1000000000000000000",
        "settlementPrice": "2000.00",
        "instrumentAddr": "0x73ada1ea346cc3908f41cf67a040f0acd7808be0",
        "markPrice": "2000.50",
        "blockInfo": {
          "height": 12345678,
          "timestamp": 1699000000
        },
        "fairPrice": "2000.30"
      }
    ],
    "base": {
      "symbol": "ETH",
      "address": "0x...",
      "decimals": 18,
      "name": "Ethereum"
    },
    "quote": {
      "symbol": "USD",
      "address": "0x...",
      "decimals": 18,
      "name": "USD Coin"
    },
    "blockInfo": {
      "height": 12345678,
      "timestamp": 1699000000
    },
    "placePaused": false,
    "fundingHour": 24,
    "disableOrderRebate": false,
    "instrumentType": 1,
    "marketType": "perp",
    "minTradeValue": "100000000000000000",
    "minOrderValue": "100000000000000000",
    "minRangeValue": "100000000000000000",
    "displayBase": {
      "symbol": "ETH",
      "address": "0x...",
      "decimals": 18,
      "name": "Ethereum"
    },
    "displayQuote": {
      "symbol": "USD",
      "address": "0x...",
      "decimals": 18,
      "name": "USD Coin"
    },
    "minTickDelta": 1
  }
}

Instrument Information Data Structure

• instrumentAddr: Instrument address

• symbol: Trading pair symbol

• market: Market information

• amms: Array of AMM states, containing:

  • expiry: Expiry timestamp

  • markPrice: Mark price

  • fairPrice: Fair price

  • openInterests: Open interest

  • totalLong: Total long positions

  • totalShort: Total short positions

  • liquidity: Liquidity

  • Other AMM-related fields

• base: Base token information

• quote: Quote token information

• blockInfo: Block information

• placePaused: Whether placing orders is paused

• fundingHour: Funding hour

• disableOrderRebate: Whether order rebate is disabled

• instrumentType: Instrument type

• marketType: Market type (e.g., "perp")

• minTradeValue: Minimum trade value

• minOrderValue: Minimum order value

• minRangeValue: Minimum range value

• displayBase: Display base token information

• displayQuote: Display quote token information

• minTickDelta: Minimum tick delta