Skip to main content

Streaming API Endpoints

Connection Details

  • WebSocket: wss://gr-staging-v2.streaming.covalenthq.com/graphql
  • Protocol: graphql-transport-ws
  • Auth: GOLDRUSH_API_KEY in connection_init payload

Token Search Query

Operation Identity:
  • Operation ID: searchToken
  • GraphQL graphql-query → field: searchToken
Role: primary | API Type: graphql-query | Status: Beta Use Cases: defi-dashboards, trading-intelligence, market-analytics Chains: base-mainnet, eth-mainnet, bsc-mainnet, solana-mainnet, monad-mainnet, matic-mainnet, megaeth-mainnet This GraphQL query lets you discover actively traded tokens that match a keyword or ticker symbol. Each result includes pricing, volume marketcap, and base/quote metadata. Use it to build comprehensive token search features. Credit Cost: TBD Supported Chains: - BASE_MAINNET
  • ETH_MAINNET
  • BSC_MAINNET
  • SOLANA_MAINNET
  • MONAD_MAINNET
  • POLYGON_MAINNET
  • MEGAETH_MAINNET
This query is currently in Beta. It is stable for testing and evaluation but may undergo changes in schema or behavior as we continue to improve it. No API credits are currently charged. We welcome your feedback so please reach out to us directly to report issues or request features.

Parameters

ParameterTypeRequiredDescription
querystringYesFree-form search string that matches token names or ticker symbols (case-insensitive) or token or pair contract address
chain_nameenumNoFilter results to a specific chain.

Query

You can query the searchToken endpoint with:
  • Free text (e.g. "skitten")
  • Token contract address (e.g. 0x4B6104755AfB5Da4581B81C552DA3A25608c73B8)
  • Token pair address (e.g. 0xa46d5090499eFB9c5dD7d95F7ca69F996b9Fb761)
The response is sorted in descending order by volume (in USD).

Basic Query

query {
  searchToken(query: "skitten") {
    pair_address
    chain_name
    quote_rate_usd
    volume_usd
    market_cap
  }
}

Complete Query

query {
  searchToken(query: "skitten", chain_name: BASE_MAINNET) {
    pair_address
    chain_name
    quote_rate
    quote_rate_usd
    volume
    volume_usd
    market_cap
    base_token {
      contract_name
      contract_ticker_symbol
      contract_address
      contract_decimals
    }
    quote_token {
      contract_name
      contract_ticker_symbol
      contract_address
      contract_decimals
    }
  }
}

Response Format

Here’s an example of the response data structure:
{
  "data": {
    "searchToken": [
      {
        "pair_address": "0xa46d5090499efb9c5dd7d95f7ca69f996b9fb761",
        "chain_name": "BASE_MAINNET",
        "quote_rate": 2.3637041719e-7,
        "quote_rate_usd": 0.0007961152019156508,
        "volume": 19888966.385959223,
        "volume_usd": 15833.908490251517,
        "market_cap": 786165.7030043972,
        "base_token": {
          "contract_name": "Ski Mask Kitten",
          "contract_ticker_symbol": "SKITTEN",
          "contract_address": "0x4b6104755afb5da4581b81c552da3a25608c73b8",
          "contract_decimals": 18
        },
        "quote_token": {
          "contract_name": "Wrapped Ether",
          "contract_ticker_symbol": "WETH",
          "contract_address": "0x4200000000000000000000000000000000000006",
          "contract_decimals": 18
        }
      }
    ]
  }
}

Field Descriptions

FieldTypeDescription
pair_addressstringLiquidity pool contract that backs the result token/quote pair
chain_nameenumThe blockchain network where the token was created
quote_ratefloatExchange rate between base and quote tokens
quote_rate_usdfloatUSD value of the quote rate
volumefloat24h trading volume for the pair in quote token units
volume_usdfloat24h trading volume in USD.
market_capfloatEstimated market capitalization in USD for the base token
base_tokenobjectMetadata for the searched token, including address, decimals, name, and ticker symbol
quote_tokenobjectMetadata for the paired quote asset

Top Trader Wallets for Token Query

Operation Identity:
  • Operation ID: upnlForToken
  • GraphQL graphql-query → field: upnlForToken
Role: specialized | API Type: graphql-query | Status: Beta Use Cases: defi-dashboards, trading-intelligence, market-analytics, automation-and-agents Chains: base-mainnet, eth-mainnet, bsc-mainnet, matic-mainnet, gnosis-mainnet, optimism-mainnet, megaeth-mainnet This GraphQL query provides a list of wallets with the highest trading volume for a specific token over the last 30 days, along with detailed information about their holdings, transaction activity, realized and unrealized profit/loss metrics. Credit Cost: TBD Supported Chains: - BASE_MAINNET
  • ETH_MAINNET
  • BSC_MAINNET
  • POLYGON_MAINNET
  • GNOSIS_MAINNET
  • OPTIMISM_MAINNET
  • MEGAETH_MAINNET
This query is currently in Beta. It is stable for testing and evaluation but may undergo changes in schema or behavior as we continue to improve it. No API credits are currently charged. We welcome your feedback so please reach out to us directly to report issues or request features.

Parameters

ParameterTypeRequiredDescription
chain_nameenumYesChain name to filter events (e.g., BASE_MAINNET, ETH_MAINNET, BSC_MAINNET)
token_addressstringYesThe deployed token contract address to query

Query

You can query the upnlForToken endpoint to retrieve top wallet trading data.

Basic Query

query {
 upnlForToken(
    chain_name: ETH_MAINNET
    token_address: "0x7ABc8A5768E6bE61A6c693a6e4EAcb5B60602C4D"
  ) {
    token_address
    wallet_address
    volume
    balance
    pnl_realized_usd
    pnl_unrealized_usd
  }
}

Complete Query

query {
 upnlForToken(
    chain_name: ETH_MAINNET
    token_address: "0x7ABc8A5768E6bE61A6c693a6e4EAcb5B60602C4D"
  ) {
    token_address
    wallet_address
    volume
    transactions_count
    pnl_realized_usd
    balance
    balance_pretty
    pnl_unrealized_usd
    contract_metadata {
      contract_address
      contract_name
      contract_ticker_symbol
      contract_decimals
    }
  }
}

Response Format

Here’s an example of the response data structure:
{
  "data": {
    "upnlForToken": [
      {
        "token_address": "0x7abc8a5768e6be61a6c693a6e4eacb5b60602c4d",
        "wallet_address": "0x91d40e4818f4d4c57b4578d9eca6afc92ac8debe",
        "volume": "56708716",
        "transactions_count": 554,
        "pnl_realized_usd": -43239.81,
        "balance": "32944375440228563000000000",
        "balance_pretty": "32944375.4402",
        "pnl_unrealized_usd": 535182,
        "contract_metadata": {
          "contract_address": "0x7ABc8A5768E6bE61A6c693a6e4EAcb5B60602C4D",
          "contract_name": "Covalent X Token",
          "contract_ticker_symbol": "CXT",
          "contract_decimals": 18
        }
      },
      {
        "token_address": "0x7abc8a5768e6be61a6c693a6e4eacb5b60602c4d",
        "wallet_address": "0xfe97b0c517a84f98fc6ede3cd26b43012d31992a",
        "volume": "39102028",
        "transactions_count": 241,
        "pnl_realized_usd": 8799.58,
        "balance": "323138960338677960000000000",
        "balance_pretty": "323138960.3387",
        "pnl_unrealized_usd": 6417132,
        "contract_metadata": {
          "contract_address": "0x7ABc8A5768E6bE61A6c693a6e4EAcb5B60602C4D",
          "contract_name": "Covalent X Token",
          "contract_ticker_symbol": "CXT",
          "contract_decimals": 18
        }
      }
    ]
  }
}

Field Descriptions

FieldTypeDescription
token_addressstringToken contract address (lowercase, 0x-prefixed)
wallet_addressstringWallet address of the trader (lowercase, 0x-prefixed)
volumestringTotal token volume transferred in the past 30 days
transactions_countintegerTransaction count for this wallet and token (past 30 days)
pnl_realized_usdfloatRealized PnL in USD from completed trades
balancestringCurrent token balance in raw format
balance_prettystringHuman-readable balance (4 decimal places)
pnl_unrealized_usdfloatUnrealized PnL in USD at the current token price
contract_metadataobjectToken contract metadata

Wallet PnL by Token Query

Operation Identity:
  • Operation ID: upnlForWallet
  • GraphQL graphql-query → field: upnlForWallet
Role: specialized | API Type: graphql-query | Status: Beta Use Cases: trading-intelligence, accounting-tax-reporting, portfolio-tracking Chains: base-mainnet, eth-mainnet, bsc-mainnet, matic-mainnet, gnosis-mainnet, optimism-mainnet, megaeth-mainnet This GraphQL query provides detailed financial metrics, including unrealized and realized profit and loss (PnL), current balance, and transaction insights for each token held by a specific wallet address. Credit Cost: TBD Supported Chains: - BASE_MAINNET
  • ETH_MAINNET
  • BSC_MAINNET
  • POLYGON_MAINNET
  • GNOSIS_MAINNET
  • OPTIMISM_MAINNET
  • MEGAETH_MAINNET
This query is currently in Beta. It is stable for testing and evaluation but may undergo changes in schema or behavior as we continue to improve it. No API credits are currently charged. We welcome your feedback so please reach out to us directly to report issues or request features.

Parameters

ParameterTypeRequiredDescription
chain_nameenumYesChain name to filter events (e.g., BASE_MAINNET, ETH_MAINNET, BSC_MAINNET)
wallet_addressstringYesThe wallet address to query

Query

You can query the upnlForWallet endpoint to retrieve detailed PnL metrics for a wallet.

Basic Query

query {
 upnlForWallet(
    chain_name: ETH_MAINNET
    wallet_address: "0xfe97b0C517a84F98fc6eDe3CD26B43012d31992a"
  ) {
    token_address
    cost_basis
    current_price
    pnl_realized_usd
    pnl_unrealized_usd
    net_balance_change
  }
}

Complete Query

query{
upnlForWallet(
    chain_name:ETH_MAINNET,
    wallet_address:"0xfe97b0C517a84F98fc6eDe3CD26B43012d31992a"
  ) {
    token_address
    cost_basis
    current_price
    pnl_realized_usd
    pnl_unrealized_usd
    net_balance_change
    marketcap_usd
    contract_metadata {
      contract_address
      contract_name
      contract_ticker_symbol
      contract_decimals
    }
  }
}

Response Format

Here’s an example of the response data structure:
{
  "data": {
    "upnlForWallet": [
      {
        "token_address": "0x7abc8a5768e6be61a6c693a6e4eacb5b60602c4d",
        "cost_basis": 0.03219392,
        "current_price": 0.032418,
        "pnl_realized_usd": null,
        "pnl_unrealized_usd": 318.22842,
        "net_balance_change": "1420158",
        "marketcap_usd": "32418001.4431",
        "contract_metadata": {
          "contract_address": "0x7abc8a5768e6be61a6c693a6e4eacb5b60602c4d",
          "contract_name": "Covalent X Token",
          "contract_ticker_symbol": "CXT",
          "contract_decimals": 18
        }
      }
    ]
  }
}

Field Descriptions

FieldTypeDescription
token_addressstringToken contract address (lowercase, 0x-prefixed)
cost_basisfloatAverage cost basis per token in USD
current_pricefloatCurrent market price per token in USD
pnl_realized_usdfloatRealized PnL in USD from completed trades
pnl_unrealized_usdfloatUnrealized PnL in USD at the latest price
net_balance_changestringNet token movement (inflow minus outflow, past 7 days)
marketcap_usdstringEstimated market capitalization in USD
contract_metadataobjectToken contract metadata

New DEX Pairs Stream

Operation Identity:
  • Operation ID: newPairs
  • GraphQL graphql-subscription → field: newPairs
  • SDK: StreamingService.subscribeToNewPairs()
Role: primary | API Type: graphql-subscription | Status: Beta Use Cases: trading-intelligence, price-discovery-feeds, defi-dashboards, automation-and-agents Chains: base-mainnet, eth-mainnet, bsc-mainnet, sonic-mainnet, solana-mainnet, monad-mainnet, hyperevm-mainnet, matic-mainnet, megaeth-mainnet The New DEX Pairs stream provides real-time updates when new liquidity pairs are created on decentralized exchanges (DEXes). This documentation follows our standard streaming API structure. Credit Cost: TBD Supported Chains: - BASE_MAINNET
  • ETH_MAINNET
  • BSC_MAINNET
  • SONIC_MAINNET
  • SOLANA_MAINNET
  • MONAD_MAINNET
  • HYPEREVM_MAINNET
  • POLYGON_MAINNET
  • MEGAETH_MAINNET
This stream is currently in Beta. It is stable for testing and evaluation but may undergo changes in schema or behavior as we continue to improve it. No API credits are currently charged. We welcome your feedback so please reach out to us directly to report issues or request features.

Parameters

ParameterTypeRequiredDescription
chain_nameenumYesChain name to filter events (e.g., BASE_MAINNET, ETH_MAINNET, BSC_MAINNET, SOLANA_MAINNET)
protocolsarrayYesList of protocol name enums to filter events (e.g.,[UNISWAP_V2, RAYDIUM_AMM]); see supported DEXes for the full list.

Subscription

You can subscribe to the newPairs endpoint to receive events.

Basic Subscription Query

subscription {
  newPairs(chain_name: BASE_MAINNET, protocols: [UNISWAP_V2, UNISWAP_V3]) {
    chain_name
    protocol
    protocol_version
    tx_hash
    block_signed_at
  }
}

Complete Subscription Query

subscription {
  newPairs(chain_name: BASE_MAINNET, protocols: [UNISWAP_V2, UNISWAP_V3]) {
    chain_name
    protocol
    protocol_version
    pair_address
    deployer_address
    tx_hash
    block_signed_at
    liquidity
    supply
    market_cap
    event_name
    quote_rate
    quote_rate_usd
    base_token {
      contract_address
      contract_decimals
      contract_name
      contract_ticker_symbol
    }
    pair {
      contract_address
      contract_decimals
      contract_name
      contract_ticker_symbol
    }
    quote_token {
      contract_address
      contract_decimals
      contract_name
      contract_ticker_symbol
    }
  }
}

Response Format

Here’s an example of the response data structure:
{
  "data": {
    "newPairs": [
      {
        "chain_name": "base",
        "protocol": "uniswap",
        "protocol_version": "3",
        "pair_address": "0xa7dfb58a6e0d675c19f76dfd3b8b80a3a4814728",
        "deployer_address": "0x33128a8fc17869897dce68ed026d694621f6fdfd",
        "tx_hash": "0x5374c0182580ff2b3e868f58bdce697f3e4256baebc6f6e8db008fadb32d6253",
        "block_signed_at": "2025-05-28T22:01:41Z",
        "liquidity": 177.50267302070574,
        "supply": 1000000000,
        "market_cap": 6153.261270529,
        "event_name": "PoolCreated",
        "quote_rate": 0.000006153261270529,
        "quote_rate_usd": 0.000006153261270529,
        "base_token": {
          "contract_address": "0x8ac05571b525dd555320df58a40a0c0ab6d807c7",
          "contract_decimals": 18,
          "contract_name": "GOAT",
          "contract_ticker_symbol": "GOAT"
        },
        "quote_token": {
          "contract_address": "0x1111111111166b7fe7bd91427724b487980afc69",
          "contract_decimals": 18,
          "contract_name": "Zora",
          "contract_ticker_symbol": "ZORA"
        },
        "pair": {
          "contract_address": "0xa7dfb58a6e0d675c19f76dfd3b8b80a3a4814728",
          "contract_decimals": 18,
          "contract_name": "GOAT-ZORA Pool",
          "contract_ticker_symbol": "GOAT-ZORA"
        }
      }
    ]
  }
}

Field Descriptions

FieldTypeDescription
chain_namestringThe blockchain network where the pair was created
protocolstringDEX protocol name (e.g., “uniswap”, “pancakeswap”)
protocol_versionstringVersion of the DEX protocol
pair_addressstringAddress of the new pair contract
deployer_addressstringAddress that deployed the pair contract
tx_hashstringTransaction hash of the pair creation
block_signed_atstringISO timestamp of when the block was signed
liquidityfloatInitial liquidity amount (in USD)
supplyintegerTotal supply of the pair token
market_capfloatMarket capitalization in USD
event_namestringName of the contract event (e.g., “PoolCreated”)
quote_ratefloatExchange rate between base and quote tokens
quote_rate_usdfloatUSD value of the quote rate
base_tokenobjectMetadata for the base token including contract address, decimals, name, and symbol
quote_tokenobjectMetadata for the quote token including contract address, decimals, name, and symbol
pairobjectMetadata for the pair including contract address, decimals, name, and symbol

OHLCV Pairs Stream

Operation Identity:
  • Operation ID: ohlcvCandlesForPair
  • GraphQL graphql-subscription → field: ohlcvCandlesForPair
  • SDK: StreamingService.subscribeToOHLCVPairs()
Role: primary | API Type: graphql-subscription | Status: Beta Use Cases: price-discovery-feeds, trading-intelligence, automation-and-agents Chains: sonic-mainnet, base-mainnet, bsc-mainnet, eth-mainnet, solana-mainnet, monad-mainnet, hyperevm-mainnet, matic-mainnet, megaeth-mainnet The OHLCV Pairs stream provides real-time updates on the Open, High, Low, Close prices and Volume of ** one or many token pairs** at configurable intervals. This documentation follows our standard streaming API structure. Credit Cost: TBD Supported Chains: - SONIC_MAINNET
  • BASE_MAINNET
  • BSC_MAINNET
  • ETH_MAINNET
  • SOLANA_MAINNET
  • MONAD_MAINNET
  • HYPEREVM_MAINNET
  • POLYGON_MAINNET
  • MEGAETH_MAINNET
This stream is currently in Beta. It is stable for testing and evaluation but may undergo changes in schema or behavior as we continue to improve it. No API credits are currently charged. We welcome your feedback so please reach out to us directly to report issues or request features.

Parameters

ParameterTypeRequiredDescription
chain_nameenumYesChain name to filter events (e.g. BASE_MAINNET, ETH_MAINNET, BSC_MAINNET, SOLANA_MAINNET)
pair_addressesarrayYesArray of pair addresses on supported DEXes and chains to track
intervalenumYesFrequency of OHLCV data updates, ranging from sub-second to one day
timeframeenumYesHistorical lookback period for OHLCV data, ranging from one minute to one month
limitintNoMaximum number of items returned per stream message to control payload size

Subscription

You can subscribe to the ohlcvCandlesForPair endpoint to receive the pricing events.

Basic Subscription Query

subscription {
  ohlcvCandlesForPair(
    chain_name: BASE_MAINNET
    pair_addresses: ["0x9c087Eb773291e50CF6c6a90ef0F4500e349B903"]
    interval: ONE_MINUTE
    timeframe: ONE_HOUR
  ) {
    chain_name
    pair_address
    interval
    timeframe
    timestamp
    open
    high
    low
    close
    volume
    volume_usd
    quote_rate
    quote_rate_usd
  }
}

Complete Subscription Query

subscription {
  ohlcvCandlesForPair(
    chain_name: BASE_MAINNET
    pair_addresses: [
      "0x9c087Eb773291e50CF6c6a90ef0F4500e349B903"
      "0x4b0Aaf3EBb163dd45F663b38b6d93f6093EBC2d3"
    ]
    interval: ONE_MINUTE
    timeframe: ONE_HOUR
    limit: 1000
  ) {
    chain_name
    pair_address
    interval
    timeframe
    timestamp
    open
    high
    low
    close
    volume
    volume_usd
    quote_rate
    quote_rate_usd
    base_token {
      contract_name
      contract_address
      contract_decimals
      contract_ticker_symbol
    }
    quote_token {
      contract_name
      contract_address
      contract_decimals
      contract_ticker_symbol
    }
  }
}

Response Format

Here’s an example of the response data structure:
{
  "data": {
    "ohlcvCandlesForPair": [
      {
        "chain_name": "BASE_MAINNET",
        "pair_address": "0x4b0Aaf3EBb163dd45F663b38b6d93f6093EBC2d3",
        "interval": "ONE_MINUTE",
        "timeframe": "ONE_HOUR",
        "timestamp": "2025-05-29T19:53:00Z",
        "open": 4113151.389790023,
        "high": 4196665.022060752,
        "low": 4113151.389790023,
        "close": 4196665.022060752,
        "volume": 325.7615900713698,
        "volume_usd": 0.2079461510855417,
        "quote_rate": 4196665.022060752,
        "quote_rate_usd": 0.0006319231563715365,
        "quote_token": {
          "contract_name": "Wrapped Ether",
          "contract_symbol": "WETH",
          "contract_address": "0x4200000000000000000000000000000000000006",
          "contract_decimals": 18
        },
        "base_token": {
          "contract_name": "Toshi",
          "contract_symbol": "TOSHI",
          "contract_address": "0xac1bd2486aaf3b5c0fc3fd868558b082a531b2b4",
          "contract_decimals": 18
        }
      }
    ]
  }
}

Field Descriptions

FieldTypeDescription
chain_namestringThe blockchain network where the pair exists
pair_addressstringThe address of the DEX pair
intervalenumThe candle interval
timeframeenumThe requested timeframe
timestampstringISO timestamp for the candle
openfloatOpening price for the interval
highfloatHighest price during the interval
lowfloatLowest price during the interval
closefloatClosing price for the interval
volumefloatTrading volume during the interval
volume_usdfloatTrading volume in USD
quote_ratefloatExchange rate between base and quote tokens
quote_rate_usdfloatUSD value of the quote rate
base_tokenobjectInformation about the base token in the pair
quote_tokenobjectInformation about the quote token in the pair

OHLCV Tokens Stream

Operation Identity:
  • Operation ID: ohlcvCandlesForToken
  • GraphQL graphql-subscription → field: ohlcvCandlesForToken
  • SDK: StreamingService.subscribeToOHLCVTokens()
Role: primary | API Type: graphql-subscription | Status: Beta Use Cases: price-discovery-feeds, trading-intelligence, automation-and-agents Chains: sonic-mainnet, base-mainnet, bsc-mainnet, eth-mainnet, solana-mainnet, monad-mainnet, hypercore-mainnet, hyperevm-mainnet, matic-mainnet, megaeth-mainnet The OHLCV Tokens stream provides real-time updates on the Open, High, Low, Close prices and Volume of one or many tokens at configurable intervals. This documentation follows our standard streaming API structure. Credit Cost: TBD Supported Chains: - SONIC_MAINNET
  • BASE_MAINNET
  • BSC_MAINNET
  • ETH_MAINNET
  • SOLANA_MAINNET
  • MONAD_MAINNET
  • HYPERCORE_MAINNET
  • HYPEREVM_MAINNET
  • POLYGON_MAINNET
  • MEGAETH_MAINNET
This stream is currently in Beta. It is stable for testing and evaluation but may undergo changes in schema or behavior as we continue to improve it. No API credits are currently charged. We welcome your feedback so please reach out to us directly to report issues or request features.

Supported Token Price Feeds

In addition to DEX-sourced prices, this stream supports institutional-grade price feeds from the following providers:
ProviderDescription
Redstone BoltUltra-low-latency CEX price feeds updated every 2.4 ms (~400 updates/sec). Bolt nodes are co-located with chain sequencer infrastructure and aggregate prices from Binance, Coinbase, OKX, Bitget, and Kraken.
Pass the feed name in the token_addresses array with chain_name set to the feed’s chain name.
Feed NameAssetChain Name
REDSTONE-BTCBitcoinMEGAETH_MAINNET
REDSTONE-ETHEthereumMEGAETH_MAINNET
REDSTONE-SOLSolanaMEGAETH_MAINNET
REDSTONE-BNBBNBMEGAETH_MAINNET
REDSTONE-XRPXRPMEGAETH_MAINNET
REDSTONE-ADACardanoMEGAETH_MAINNET
REDSTONE-DOGEDogecoinMEGAETH_MAINNET
REDSTONE-USDTTetherMEGAETH_MAINNET
REDSTONE-USDCUSD CoinMEGAETH_MAINNET

Parameters

ParameterTypeRequiredDescription
chain_nameenumYesChain name to filter events (e.g. BASE_MAINNET, ETH_MAINNET, BSC_MAINNET, SOLANA_MAINNET)
token_addressesarrayYesArray of token addresses on supported DEXes and chains to track
intervalenumYesFrequency of OHLCV data updates, ranging from sub-second to one day
timeframeenumYesHistorical lookback period for OHLCV data, ranging from one minute to one month
limitintNoMaximum number of items returned per stream message to control payload size

Subscription

You can subscribe to the ohlcvCandlesForToken endpoint to receive the pricing events.

Basic Subscription Query

subscription {
  ohlcvCandlesForToken(
    chain_name: BASE_MAINNET
    token_addresses: ["0x4B6104755AfB5Da4581B81C552DA3A25608c73B8"]
    interval: ONE_MINUTE
    timeframe: ONE_HOUR
  ) {
    chain_name
    interval
    timeframe
    timestamp
    open
    high
    low
    close
    volume
    volume_usd
    quote_rate
    quote_rate_usd
    base_token {
      contract_name
      contract_address
      contract_decimals
      contract_ticker_symbol
    }
  }
}

Complete Subscription Query

subscription {
  ohlcvCandlesForToken(
    chain_name: BASE_MAINNET
    token_addresses: [
      "0x4B6104755AfB5Da4581B81C552DA3A25608c73B8"
    ]
    interval: ONE_MINUTE
    timeframe: ONE_HOUR
    limit: 1000
  ) {
    chain_name
    pair_address
    interval
    timeframe
    timestamp
    open
    high
    low
    close
    volume
    volume_usd
    quote_rate
    quote_rate_usd
    base_token {
      contract_name
      contract_address
      contract_decimals
      contract_ticker_symbol
    }
    quote_token {
      contract_name
      contract_address
      contract_decimals
      contract_ticker_symbol
    }
  }
}

Response Format

Here’s an example of the response data structure:
{
  "data": {
    "ohlcvCandlesForToken": [
      {
        "chain_name": "BASE_MAINNET",
        "interval": "ONE_MINUTE",
        "timeframe": "ONE_HOUR",
        "timestamp": "2025-06-27T22:24:00Z",
        "open": 0.000604418526534047,
        "high": 0.000604638206820701,
        "low": 0.000604013151624892,
        "close": 0.000604638206820701,
        "volume": 1.4980526133065126,
        "volume_usd": 6004669.256018968,
        "quote_rate": 0.000604638206820701,
        "quote_rate_usd": 4007551.6142841205,
        "base_token": {
          "contract_name": "Virtual Protocol",
          "contract_address": "0x0b3e328455c4059eeb9e3f84b5543f74e24e7e1b",
          "contract_decimals": 18,
          "contract_ticker_symbol": "VIRTUAL"
        }
      }
    ]
  }
}

Field Descriptions

FieldTypeDescription
chain_namestringThe blockchain network where the token exists
pair_addressstringThe address of the primary DEX pool with the most liquidity for the token
intervalenumThe candle interval
timeframeenumThe requested timeframe
timestampstringISO timestamp for the candle
openfloatOpening price for the interval
highfloatHighest price during the interval
lowfloatLowest price during the interval
closefloatClosing price for the interval
volumefloatTrading volume during the interval
volume_usdfloatTrading volume in USD
quote_ratefloatExchange rate between base and quote tokens
quote_rate_usdfloatUSD value of the quote rate
base_tokenobjectInformation about the queried token
quote_tokenobjectInformation about the paired token of the primary DEX pool

Update Pairs Stream

Operation Identity:
  • Operation ID: updatePairs
  • GraphQL graphql-subscription → field: updatePairs
  • SDK: StreamingService.subscribeToUpdatePairs()
Role: primary | API Type: graphql-subscription | Status: Beta Use Cases: price-discovery-feeds, trading-intelligence, defi-dashboards, automation-and-agents Chains: base-mainnet, eth-mainnet, bsc-mainnet, sonic-mainnet, solana-mainnet, monad-mainnet, hyperevm-mainnet, matic-mainnet, megaeth-mainnet The Update Pairs stream provides real-time updates on the prices, volumes, market cap and liquidity of ** one or many token pairs**. This documentation follows our standard streaming API structure. Credit Cost: TBD Supported Chains: - BASE_MAINNET
  • ETH_MAINNET
  • BSC_MAINNET
  • SONIC_MAINNET
  • SOLANA_MAINNET
  • MONAD_MAINNET
  • HYPEREVM_MAINNET
  • POLYGON_MAINNET
  • MEGAETH_MAINNET
This stream is currently in Beta. It is stable for testing and evaluation but may undergo changes in schema or behavior as we continue to improve it. No API credits are currently charged. We welcome your feedback so please reach out to us directly to report issues or request features.

Parameters

ParameterTypeRequiredDescription
chain_nameenumYesChain name to filter events (e.g. BASE_MAINNET, ETH_MAINNET, BSC_MAINNET, SOLANA_MAINNET)
pair_addressesarrayYesArray of pair addresses on supported DEXes and chains to track

Subscription

You can subscribe to the updatePairs endpoint to receive the events.

Basic Subscription Query

subscription {
  updatePairs(
    chain_name: BASE_MAINNET
    pair_addresses: ["0x9c087Eb773291e50CF6c6a90ef0F4500e349B903"]
  ) {
    chain_name
    pair_address
    timestamp
    quote_rate
    quote_rate_usd
    volume
    volume_usd
    market_cap
    liquidity
  }
}

Complete Subscription Query

subscription {
  updatePairs(
    chain_name: BASE_MAINNET
    pair_addresses: [
      "0x9c087Eb773291e50CF6c6a90ef0F4500e349B903"
      "0x4b0Aaf3EBb163dd45F663b38b6d93f6093EBC2d3"
    ]
  ) {
    chain_name
    pair_address
    timestamp
    quote_rate
    quote_rate_usd
    volume
    volume_usd
    market_cap
    liquidity
    base_token {
      contract_name
      contract_address
      contract_decimals
      contract_ticker_symbol
    }
    quote_token {
      contract_name
      contract_address
      contract_decimals
      contract_ticker_symbol
    }
    price_deltas {
      last_5m
      last_1hr
      last_6hr
      last_24hr
    }
    swap_counts {
      last_5m
      last_1hr
      last_6hr
      last_24hr
    }
  }
}

Response Format

Here’s an example of the response data structure:
{
  "data": {
    "updatePairs": [
      {
        "chain_name": "BASE_MAINNET",
        "pair_address": "0x9c087Eb773291e50CF6c6a90ef0F4500e349B903",
        "quote_rate": 0.0002962,
        "quote_rate_usd": 1.39,
        "volume": 0.2079461510855417,
        "volume_usd": 975.515187,
        "quote_token": {
          "contract_name": "Wrapped Ether",
          "contract_symbol": "WETH",
          "contract_address": "0x4200000000000000000000000000000000000006",
          "contract_decimals": 18
        },
        "base_token": {
          "contract_name": "Virtual",
          "contract_symbol": "VIRTUAL",
          "contract_address": "0x0b3e328455c4059EEb9e3f84b5543F74E24e7E1b",
          "contract_decimals": 18
        },
        "swap_counts": {
          "last_5m": 10,
          "last_1hr": 100,
          "last_6hr": 1000,
          "last_24hr": 10000
        },
        "price_deltas": {
          "last_5m": 1.2,
          "last_1hr": 1.9,
          "last_6hr": 2.7,
          "last_24hr": -9.1
        }
      }
    ]
  }
}

Field Descriptions

FieldTypeDescription
chain_namestringThe blockchain network where the pair exists
pair_addressstringThe address of the DEX pair
quote_ratefloatExchange rate between base and quote tokens
quote_rate_usdfloatExchange rate between base and quote tokens in USD
volumefloatTrading volume during the interval
volume_usdfloatTrading volume in USD
base_tokenobjectInformation about the base token in the pair
quote_tokenobjectInformation about the quote token in the pair
swap_countsobjectSwap counts for last 5m, 1hr, 6hr, 24hr
price_deltasobjectPrice deltas for last 5m, 1hr, 6hr, 24hr

Wallet Activity Stream

Operation Identity:
  • Operation ID: walletTxs
  • GraphQL graphql-subscription → field: walletTxs
  • SDK: StreamingService.subscribeToWalletActivity()
Role: primary | API Type: graphql-subscription | Status: Beta Use Cases: trading-intelligence, automation-and-agents, onchain-gaming-infrastructure, defi-dashboards Chains: base-mainnet, eth-mainnet, bsc-mainnet, sonic-mainnet, monad-mainnet, hypercore-mainnet, hyperevm-mainnet, matic-mainnet, megaeth-mainnet The Wallet Activity stream provides real-time updates on wallet **transactions, token transfers, and interactions with smart contracts **. This documentation follows our standard Streaming API structure. Credit Cost: TBD Supported Chains: - BASE_MAINNET
  • ETH_MAINNET
  • BSC_MAINNET
  • SONIC_MAINNET
  • MONAD_MAINNET
  • HYPERCORE_MAINNET
  • HYPEREVM_MAINNET
  • POLYGON_MAINNET
  • MEGAETH_MAINNET
This stream is currently in Beta. It is stable for testing and evaluation but may undergo changes in schema or behavior as we continue to improve it. No API credits are currently charged. We welcome your feedback so please reach out to us directly to report issues or request features.

Supported Actions

All transactions are returned as raw data, but the following transaction types are decoded:
  • Transfer
  • Swap
  • Bridge
  • Deposit
  • Withdraw
  • Approve

Parameters

ParameterTypeRequiredDescription
chain_nameenumYesChain name to filter events (e.g. BASE_MAINNET, ETH_MAINNET, BSC_MAINNET)
wallet_addressesarrayYesAddresses to track

Subscription

You can subscribe to the walletTxs endpoint to receive events.

Basic Subscription Query

subscription {
  walletTxs(
    chain_name: BASE_MAINNET,
    wallet_addresses: [
        "0x4200000000000000000000000000000000000006",
        "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913"
    ]) {
        block_signed_at
        block_height
        tx_hash
        tx_offset
        successful
        decoded_type
  }
}

Complete Subscription Query

subscription {
  walletTxs(
    chain_name: BASE_MAINNET,
    wallet_addresses: [
      "0x198ef79f1f515f02dfe9e3115ed9fc07183f02fc",
      "0x4200000000000000000000000000000000000006"
    ]
  ) {
    tx_hash
    from_address
    to_address
    value
    chain_name
    block_signed_at
    block_height
    block_hash
    miner_address
    gas_used
    tx_offset
    successful
    decoded_type

    decoded_details {
      ... on TransferTransaction {
        from
        to
        amount
        quote_usd
        quote_rate_usd
        contract_metadata {
          contract_name
          contract_address
          contract_decimals
          contract_ticker_symbol
        }
      }
      ... on SwapTransaction {
        token_in {
          contract_address
          contract_decimals
          contract_ticker_symbol
        }
        token_out {
          contract_address
          contract_decimals
          contract_ticker_symbol
        }
        amount_in
        amount_out
      }
      ... on BridgeTransaction {
        type
        typeString
        from
        to
        amount
        quote_usd
        quote_rate_usd
        contract_metadata {
          contract_name
          contract_address
          contract_decimals
          contract_ticker_symbol
        }
      }
      ... on DepositTransaction {
        from
        to
        amount
        quote_usd
        quote_rate_usd
        contract_metadata {
          contract_name
          contract_address
          contract_decimals
          contract_ticker_symbol
        }
      }
      ... on WithdrawTransaction {
        from
        to
        amount
        quote_usd
        quote_rate_usd
        contract_metadata {
          contract_name
          contract_address
          contract_decimals
          contract_ticker_symbol
        }
      }
      ... on ApproveTransaction {
        spender
        amount
        quote_usd
        quote_rate_usd
        contract_metadata {
          contract_name
          contract_address
          contract_decimals
          contract_ticker_symbol
        }
      }
      ... on ErrorDetails {
        message
      }
    }

    logs {
      emitter_address
      log_offset
      data
      topics
    }
  }
}

Response Format

Here’s an example of the response data structure:
{
  "data": {
    "walletTxs": [
      {
        "tx_hash": "0x23a4f9710c23678a8c6ae25d7e3aa75a82866231e9bd541114046c5a710a8355",
        "from_address": "0xd2216ed62a5c84f285a051839e808902fe8fc90b",
        "to_address": "0x198ef79f1f515f02dfe9e3115ed9fc07183f02fc",
        "value": 0,
        "chain_name": "base-mainnet",
        "block_signed_at": "2025-05-29T19:27:25Z",
        "block_height": 30878749,
        "block_hash": "0x2435aec7c20678ee82ae251ab1066e15ed3dac7ff0ea086c44ee8476a721abde",
        "miner_address": "0x4200000000000000000000000000000000000011",
        "gas_used": 195861,
        "tx_offset": 118,
        "successful": true,
        "decoded_type": "SWAP",
        "decoded": {
          "token_in": {
            "contract_address": "0x4200000000000000000000000000000000000006",
            "contract_decimals": 18,
            "contract_ticker_symbol": "WETH"
          },
          "token_out": {
            "contract_address": "0x14b2f229097df3c92b43ea871860e3fae08d7f06",
            "contract_decimals": 18,
            "contract_ticker_symbol": "EXAMPLE"
          },
          "amount_in": "258844786659364206700114",
          "amount_out": "66094025142553271"
        },
        "logs": [
          {
            "emitter": "0x4200000000000000000000000000000000000006",
            "topics": [
              "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",
              "0x000000000000000000000000286f3add5dd41ba6e208f9f9a68533107fd0d0fa",
              "0x000000000000000000000000198ef79f1f515f02dfe9e3115ed9fc07183f02fc"
            ]
          },
          {
            "emitter": "0x14b2f229097df3c92b43ea871860e3fae08d7f06",
            "topics": [
              "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",
              "0x000000000000000000000000d2216ed62a5c84f285a051839e808902fe8fc90b",
              "0x000000000000000000000000286f3add5dd41ba6e208f9f9a68533107fd0d0fa"
            ]
          },
          {
            "emitter": "0x286f3add5dd41ba6e208f9f9a68533107fd0d0fa",
            "topics": [
              "0xc42079f94a6350d7e6235f29174924f928cc2ac818eb64fed8004e115fbcca67",
              "0x000000000000000000000000198ef79f1f515f02dfe9e3115ed9fc07183f02fc",
              "0x000000000000000000000000198ef79f1f515f02dfe9e3115ed9fc07183f02fc"
            ]
          },
          {
            "emitter": "0x4200000000000000000000000000000000000006",
            "topics": [
              "0x7fcf532c15f0a6db0bd6d0e038bea71d30d808c7d98cb3bf7268a95bf5081b65",
              "0x000000000000000000000000198ef79f1f515f02dfe9e3115ed9fc07183f02fc"
            ]
          }
        ]
      }
    ]
  }
}

Field Descriptions

FieldTypeDescription
tx_hashstringThe transaction hash
from_addressstringThe sender’s address
to_addressstringThe recipient’s address
valueintegerThe transaction value in native currency
chain_namestringThe blockchain network where the transaction occurred
block_signed_atstringISO timestamp of when the block was signed
block_heightintegerThe block number where the transaction was included
block_hashstringThe hash of the block containing the transaction
miner_addressstringThe address of the block miner
gas_usedintegerThe amount of gas used by the transaction
tx_offsetintegerThe position of the transaction in the block
successfulbooleanWhether the transaction was successful
decoded_typestringThe type of decoded event (e.g., “SWAP”)
decodedobjectThe decoded event data (varies by event type)
logsarrayArray of event logs emitted during the transaction

Decoded Events

Note from the Complete Subscription Query, this stream decodes events which you can fetch with fragment spreads. See the full schema of available decoded events.

Decoded Events

The following events are decoded in the GoldRush Streaming API:

Transfer Event

FieldTypeDescription
fromstringThe source address
tostringThe destination address
amountstringUnscaled token amount (scale by metadata.contract_decimals)
quote_rate_usdstringExchange rate of the token in USD
quote_usdstringThe quote amount of the token in USD
contract_metadataobjectContract details including contract_name, contract_address, contract_decimals, and contract_ticker_symbol

Swap Event

FieldTypeDescription
token_inobjectThe input token details including contract_address, contract_decimals, and contract_ticker_symbol
token_outobjectThe output token details including contract_address, contract_decimals, and contract_ticker_symbol
amount_instringThe amount of input tokens
amount_outstringThe amount of output tokens

Bridge Event

FieldTypeDescription
typestringThe bridge transaction type
typeStringstringHuman-readable bridge transaction type
fromstringThe source address
tostringThe destination address
amountstringUnscaled token amount (scale by metadata.contract_decimals)
quote_rate_usdstringExchange rate of the token in USD
quote_usdstringThe quote amount of the token in USD
contract_metadataobjectContract details including contract_name, contract_address, contract_decimals, and contract_ticker_symbol

Deposit Event

FieldTypeDescription
fromstringThe source address
tostringThe destination address
amountstringUnscaled token amount (scale by metadata.contract_decimals)
quote_rate_usdstringExchange rate of the token in USD
quote_usdstringThe quote amount of the token in USD
contract_metadataobjectContract details including contract_name, contract_address, contract_decimals, and contract_ticker_symbol

Withdraw Event

FieldTypeDescription
fromstringThe source address
tostringThe destination address
amountstringUnscaled token amount (scale by metadata.contract_decimals)
quote_rate_usdstringExchange rate of the token in USD
quote_usdstringThe quote amount of the token in USD
contract_metadataobjectContract details including contract_name, contract_address, contract_decimals, and contract_ticker_symbol

Approve Event

FieldTypeDescription
spenderstringThe address approved to spend tokens
amountstringUnscaled token amount (scale by metadata.contract_decimals)
quote_rate_usdstringExchange rate of the token in USD
quote_usdstringThe quote amount of the token in USD
contract_metadataobjectContract details including contract_name, contract_address, contract_decimals, and contract_ticker_symbol

Transaction Logs

FieldTypeDescription
emitter_addressstringThe address that emitted the log
log_offsetintegerThe offset of the log in the transaction
datastringThe raw log data
topicsarrayArray of log topics

Error Details

FieldTypeDescription
messagestringError message describing what went wrong