onPairMetadataUpdated

This endpoint requires a Growth or Enterprise plan. Learn more.

Returns

PairMetadata

See PairMetadata

Show Properties

String

The exchange contract ID.

Int

The exchange fee for swaps.

String!

The ID for the pair (address:networkId).

QuoteToken

The token of interest within the pair. Can be token0 or token1. See QuoteToken

Int

The network ID the pair is deployed on.

String!

The total liquidity in the pair.

String

The token with higher liquidity within the pair. Can be token0 or token1.

String

The token with lower liquidity within the pair. Can be token0 or token1.

String!

The contract address of the pair.

TokenPairStatisticsType!

The type of statistics returned. Can be FILTERED or UNFILTERED. See TokenPairStatisticsType

String!

The quote token price in USD.

String!

The non-quote token price in USD.

Float

The percent price change in the past 5 minutes. Decimal format.

Float

The percent price change in the past hour. Decimal format.

Float

The percent price change in the past 4 hours. Decimal format.

Float

The percent price change in the past 12 hours. Decimal format.

Float

The percent price change in the past 24 hours. Decimal format.

Int

The amount of required tick separation. Only applicable for pairs on UniswapV3.

PairMetadataToken!

Pair metadata for the first token in the pair. See PairMetadataToken

PairMetadataToken!

Pair metadata for the second token in the pair. See PairMetadataToken

String

The trade volume in USD in the past hour.

String

The trade volume in USD in the past 4 hours.

String

The trade volume in USD in the past 12 hours.

String

The trade volume in USD in the past 24 hours.

String

The trade volume in USD in the past 5 minutes.

String

The highest price in USD in the past 5 minutes.

String

The highest price in USD in the past hour.

String

The highest price in USD in the past 4 hours.

String

The highest price in USD in the past 12 hours.

String

The highest price in USD in the past 24 hours.

String

The lowest price in USD in the past 5 minutes.

String

The lowest price in USD in the past hour.

String

The lowest price in USD in the past 12 hours.

String

The lowest price in USD in the past 24 hours.

String

The lowest price in USD in the past 4 hours.

EnhancedToken

Token metadata for the first token in the pair. See EnhancedToken

EnhancedToken

Token metadata for the second token in the pair. See EnhancedToken

TokenWalletActivity

Wallet pattern data for the quote token, if available. Only populated for launchpad tokens. See TokenWalletActivity

Int

The unix timestamp for the creation of the pair.

Float

The percentage of total supply held by the top 10 holders.

Float

deprecated

The percent price change in the past week. Decimal format.

This field is deprecated. Inaccurate

String

deprecated

The trade trade volume in USD in the past week.

This field is deprecated. Inaccurate

String

deprecated

The highest price in USD in the past week.

This field is deprecated. Inaccurate

String

deprecated

The lowest price in USD in the past week.

This field is deprecated. Inaccurate

Arguments

String

The ID of the pair (address:networkId).

QuoteToken

The token of interest within the pair. Can be token0 or token1. If not specified, returns data for both tokens. See QuoteToken

Show Properties

enum

Boolean

If true, automatically selects the non-liquidity token as the quoteToken. Ignored if quoteToken is explicitly specified.

Example Subscription

Test this query in the Explorer →

subscription {
  onPairMetadataUpdated(
    id: "0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640:1"
  ) {
    id
    pairAddress
    networkId
    liquidity
    statsType
    price
    priceNonQuoteToken
    priceChange5m
    priceChange1
    priceChange24
    volume5m
    volume1
    volume24
    token0 {
      address
      name
      symbol
      price
      pooled
      networkId
    }
    token1 {
      address
      name
      symbol
      price
      pooled
      networkId
    }
  }
}

Example Response

{
  "data": {
    "onPairMetadataUpdated": {
      "id": "0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640:1",
      "pairAddress": "0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640",
      "networkId": 1,
      "liquidity": "150000000",
      "statsType": "UNFILTERED",
      "price": "3245.67",
      "priceNonQuoteToken": "0.000308",
      "priceChange5m": 0.0012,
      "priceChange1": 0.0089,
      "priceChange24": -0.0234,
      "volume5m": "125000",
      "volume1": "2500000",
      "volume24": "45000000",
      "token0": {
        "address": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
        "name": "USD Coin",
        "symbol": "USDC",
        "price": "1.00",
        "pooled": "75000000",
        "networkId": 1
      },
      "token1": {
        "address": "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2",
        "name": "Wrapped Ether",
        "symbol": "WETH",
        "price": "3245.67",
        "pooled": "23100",
        "networkId": 1
      }
    }
  }
}

Usage Guidelines

Subscribe using the pair ID in format pairAddress:networkId (e.g., 0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640:1)
Use quoteToken parameter (token0 or token1) to specify which token’s perspective to use for price data
Use useNonLiquidityTokenAsQuoteToken: true to automatically select the non-liquidity token as the quote token
Updates are pushed in real-time as trades occur on the pair
Price change fields (priceChange5m, priceChange1, etc.) are in decimal format (0.01 = 1%)
Volume fields represent USD value traded in the specified time window
Use statsType to see if stats are FILTERED (bot-filtered) or UNFILTERED

Troubleshooting Tips

How do I get the pair ID for a token?

Use the filterPairs or listPairsForToken query to find the pair address and network ID for your token. The subscription ID format is pairAddress:networkId.

Why am I not receiving updates?

Updates are only pushed when trades occur on the pair. Low-activity pairs may have infrequent updates. Ensure your WebSocket connection is properly established and you’re subscribed to an active pair.

What's the difference between token0 and token1?

Token ordering is determined by the pair contract. Use the quoteToken parameter to specify which token you want as the base for price calculations, or use useNonLiquidityTokenAsQuoteToken: true to automatically select the non-stable/non-major token.

How do I handle WebSocket reconnections?

Implement reconnection logic in your client. When reconnecting, you’ll need to re-subscribe to the pairs you were monitoring. Consider using a library like graphql-ws that handles reconnections automatically.

Detailed Token Page: Build a comprehensive token detail page with price, holders, trades, and real-time updates

API Documentation

Queries

Mutations

Subscriptions

Types

onPairMetadataUpdated

Returns

Arguments

Example Subscription

Example Response

Usage Guidelines

Troubleshooting Tips

​Returns

​Arguments

​Example Subscription

​Example Response

​Usage Guidelines

​Troubleshooting Tips

​Related Recipes

Returns

Arguments

Example Subscription

Example Response

Usage Guidelines

Troubleshooting Tips

Related Recipes