Skip to main content

Streaming API Endpoints

Connection Details

  • WebSocket: wss://streaming.goldrushdata.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
  • BSC_MAINNET
  • ETH_MAINNET
  • MEGAETH_MAINNET
  • MONAD_MAINNET
  • POLYGON_MAINNET
  • SOLANA_MAINNET
Note: 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
querystringYesSearch query string - can be token name, symbol, or address. Empty string returns all tokens.
chain_nameChainNameNoOptional chain filter. When provided, only tokens on this chain are returned. Available values: BASE_MAINNET, BSC_MAINNET, ETH_MAINNET, HYPERCORE_MAINNET, HYPEREVM_MAINNET, MEGAETH_MAINNET, MONAD_MAINNET, POLYGON_MAINNET, SOLANA_MAINNET, TEMPO_MAINNET

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).
query {
  searchToken(
    query: "skitten"
    chain_name: BASE_MAINNET
  ) {
    volume
    chain_name
    base_token {
      contract_name
      contract_address
      contract_decimals
      contract_ticker_symbol
    }
    swap_count
    market_cap
    quote_rate
    volume_usd
    quote_token {
      contract_name
      contract_address
      contract_decimals
      contract_ticker_symbol
    }
    quote_rate_usd
    pair_address
  }
}

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
volumefloat24h trading volume for the pair in quote token units
chain_nameChainNameThe blockchain network where the token was created
base_tokenTokenContractMetadataMetadata for the searched token, including address, decimals, name, and ticker symbol
base_token.contract_namestringName of the token contract
base_token.contract_addressstringAddress of the token contract
base_token.contract_decimalsintNumber of decimal places for the token
base_token.contract_ticker_symbolstringTicker symbol of the token
swap_countstringNumber of swaps in the tracking period
market_capfloatEstimated market capitalization in USD for the base token
quote_ratefloatExchange rate between base and quote tokens
volume_usdfloat24h trading volume in USD
quote_tokenTokenContractMetadataMetadata for the paired quote asset
quote_token.contract_namestringName of the token contract
quote_token.contract_addressstringAddress of the token contract
quote_token.contract_decimalsintNumber of decimal places for the token
quote_token.contract_ticker_symbolstringTicker symbol of the token
quote_rate_usdfloatUSD value of the quote rate
pair_addressstringLiquidity pool contract that backs the result token/quote pair

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
  • BSC_MAINNET
  • ETH_MAINNET
  • GNOSIS_MAINNET
  • MEGAETH_MAINNET
  • OPTIMISM_MAINNET
  • POLYGON_MAINNET
Note: 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_nameChainNameUpnlYesChain name to filter events (e.g., BASE_MAINNET, ETH_MAINNET, BSC_MAINNET) Available values: BASE_MAINNET, BSC_MAINNET, ETH_MAINNET, GNOSIS_MAINNET, OPTIMISM_MAINNET, POLYGON_MAINNET, SOLANA_MAINNET
token_addressstringYesThe deployed token contract address to query

Query

You can query the upnlForToken endpoint to retrieve top wallet trading data.
query {
  upnlForToken(
    chain_name: ETH_MAINNET
    token_address: "0x7ABc8A5768E6bE61A6c693a6e4EAcb5B60602C4D"
  ) {
    volume
    wallet_address
    transactions_count
    balance
    contract_metadata {
      contract_name
      contract_address
      contract_decimals
      contract_ticker_symbol
    }
    token_address
    pnl_realized_usd
    pnl_unrealized_usd
    marketcap_usd
    balance_pretty
  }
}

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
volumestringTotal volume of tokens transferred (string to avoid JS precision loss)
wallet_addressstringWallet address of the token holder (lowercase with 0x prefix)
transactions_countintTotal number of transactions
balancestringCurrent token balance (string to avoid JS precision loss)
contract_metadataTokenContractMetadataToken contract metadata
contract_metadata.contract_namestringName of the token contract
contract_metadata.contract_addressstringAddress of the token contract
contract_metadata.contract_decimalsintNumber of decimal places for the token
contract_metadata.contract_ticker_symbolstringTicker symbol of the token
token_addressstringToken contract address (lowercase with 0x prefix)
pnl_realized_usdfloatRealized profit and loss in USD
pnl_unrealized_usdfloatUnrealized profit and loss in USD
marketcap_usdstringMarket capitalization in USD
balance_prettystringHuman-readable token balance with proper decimal places

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
  • BSC_MAINNET
  • ETH_MAINNET
  • GNOSIS_MAINNET
  • MEGAETH_MAINNET
  • OPTIMISM_MAINNET
  • POLYGON_MAINNET
Note: 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_nameChainNameUpnlYesChain name to filter events (e.g., BASE_MAINNET, ETH_MAINNET, BSC_MAINNET) Available values: BASE_MAINNET, BSC_MAINNET, ETH_MAINNET, GNOSIS_MAINNET, OPTIMISM_MAINNET, POLYGON_MAINNET, SOLANA_MAINNET
wallet_addressstringYesThe wallet address to query

Query

You can query the upnlForWallet endpoint to retrieve detailed PnL metrics for a wallet.
query {
  upnlForWallet(
    chain_name: ETH_MAINNET
    wallet_address: "0xfe97b0C517a84F98fc6eDe3CD26B43012d31992a"
  ) {
    cost_basis
    contract_metadata {
      contract_name
      contract_address
      contract_decimals
      contract_ticker_symbol
    }
    net_balance_change
    token_address
    current_price
    pnl_realized_usd
    pnl_unrealized_usd
    marketcap_usd
  }
}

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
cost_basisfloatCost basis per token
contract_metadataTokenContractMetadataToken contract metadata
contract_metadata.contract_namestringName of the token contract
contract_metadata.contract_addressstringAddress of the token contract
contract_metadata.contract_decimalsintNumber of decimal places for the token
contract_metadata.contract_ticker_symbolstringTicker symbol of the token
net_balance_changestringNet token movement (inflow - outflow) in the last 7 days, not the actual on-chain balance
token_addressstringToken contract address (lowercase with 0x prefix)
current_pricefloatCurrent price per token
pnl_realized_usdfloatRealized profit and loss in USD
pnl_unrealized_usdfloatUnrealized profit and loss in USD
marketcap_usdstringMarket capitalization in USD

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, 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
  • BSC_MAINNET
  • ETH_MAINNET
  • HYPEREVM_MAINNET
  • MEGAETH_MAINNET
  • MONAD_MAINNET
  • POLYGON_MAINNET
  • SOLANA_MAINNET
Note: 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_nameChainNameYesChain name to filter events (e.g., BASE_MAINNET, ETH_MAINNET, BSC_MAINNET, SOLANA_MAINNET) Available values: BASE_MAINNET, BSC_MAINNET, ETH_MAINNET, HYPERCORE_MAINNET, HYPEREVM_MAINNET, MEGAETH_MAINNET, MONAD_MAINNET, POLYGON_MAINNET, SOLANA_MAINNET, TEMPO_MAINNET
protocolsUnifiedProtocol[]YesList of protocol name enums to filter events (e.g., [UNISWAP_V2, RAYDIUM_AMM]) Available values: CLANKER_V3, JOE_V2, KUMBAYA_V1, METEORA_DAMM, METEORA_DBC, METEORA_DLMM, MOONSHOT, NAD_FUN, ORCA_WHIRLPOOL, PANCAKESWAP_V2, PANCAKESWAP_V3, PRISM_V1, PROJECT_X, PUMP_FUN, PUMP_FUN_AMM, QUICKSWAP_V2, QUICKSWAP_V3, RAYDIUM_AMM, RAYDIUM_CLMM, RAYDIUM_CPMM, RAYDIUM_LAUNCH_LAB, SHADOW_V2, SHADOW_V3, SUSHISWAP_V2, TEMPO_ORDERBOOK, UNISWAP_V2, UNISWAP_V3, VIRTUALS_V2

Subscription

You can subscribe to the newPairs endpoint to receive events.
subscription {
  newPairs(
    chain_name: BASE_MAINNET
    protocols: [
      UNISWAP_V2
      UNISWAP_V3
    ]
  ) {
    pair {
      contract_name
      contract_address
      contract_decimals
      contract_ticker_symbol
    }
    liquidity
    tx_hash
    supply
    pair_address
    dev_holdings
    base_token {
      contract_name
      contract_address
      contract_decimals
      contract_ticker_symbol
    }
    protocol
    protocol_version
    market_cap
    quote_rate
    quote_token {
      contract_name
      contract_address
      contract_decimals
      contract_ticker_symbol
    }
    quote_rate_usd
    event_name
    block_signed_at
    deployer_address
    chain_name
  }
}

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
pairTokenContractMetadataMetadata for the pair including contract address, decimals, name, and symbol
pair.contract_namestringName of the token contract
pair.contract_addressstringAddress of the token contract
pair.contract_decimalsintNumber of decimal places for the token
pair.contract_ticker_symbolstringTicker symbol of the token
liquidityfloatInitial liquidity amount in USD
tx_hashstringTransaction hash of the pair creation
supplyfloatTotal supply of the pair token
pair_addressstringAddress of the new pair contract
dev_holdingsfloatDeveloper token holdings
base_tokenTokenContractMetadataMetadata for the base token including contract address, decimals, name, and symbol
base_token.contract_namestringName of the token contract
base_token.contract_addressstringAddress of the token contract
base_token.contract_decimalsintNumber of decimal places for the token
base_token.contract_ticker_symbolstringTicker symbol of the token
protocolstringDEX protocol name (e.g., uniswap, pancakeswap)
protocol_versionstringVersion of the DEX protocol
market_capfloatMarket capitalization in USD
quote_ratefloatExchange rate between base and quote tokens
quote_tokenTokenContractMetadataMetadata for the quote token including contract address, decimals, name, and symbol
quote_token.contract_namestringName of the token contract
quote_token.contract_addressstringAddress of the token contract
quote_token.contract_decimalsintNumber of decimal places for the token
quote_token.contract_ticker_symbolstringTicker symbol of the token
quote_rate_usdfloatUSD value of the quote rate
event_namestringName of the contract event (e.g., PoolCreated)
block_signed_atstringTimestamp when the block was signed (ISO-8601)
deployer_addressstringAddress that deployed the pair contract
chain_namestringThe blockchain network where the pair was created

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: 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: - BASE_MAINNET
  • BSC_MAINNET
  • ETH_MAINNET
  • HYPEREVM_MAINNET
  • MEGAETH_MAINNET
  • MONAD_MAINNET
  • POLYGON_MAINNET
  • SOLANA_MAINNET
Note: 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_nameChainNameYesChain name to filter events (e.g. BASE_MAINNET, ETH_MAINNET, BSC_MAINNET, SOLANA_MAINNET) Available values: BASE_MAINNET, BSC_MAINNET, ETH_MAINNET, HYPERCORE_MAINNET, HYPEREVM_MAINNET, MEGAETH_MAINNET, MONAD_MAINNET, POLYGON_MAINNET, SOLANA_MAINNET, TEMPO_MAINNET
pair_addressesarrayYesArray of pair addresses on supported DEXes and chains to track
intervalTimeIntervalYesFrequency of OHLCV data updates, ranging from sub-second to one day Available values: FIFTEEN_MINUTES, FIFTEEN_SECONDS, FIVE_MINUTES, FIVE_SECONDS, FOUR_HOURS, ONE_DAY, ONE_HOUR, ONE_MINUTE, ONE_SECOND
timeframeTimeFrameYesHistorical lookback period for OHLCV data, ranging from one minute to one month Available values: FIFTEEN_MINUTES, FIVE_DAYS, FIVE_MINUTES, FOUR_HOURS, ONE_DAY, ONE_HOUR, ONE_MINUTE, SEVEN_DAYS, THIRTY_DAYS
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.
subscription {
  ohlcvCandlesForPair(
    chain_name: BASE_MAINNET
    pair_addresses: [
      "0x9c087Eb773291e50CF6c6a90ef0F4500e349B903"
      "0x4b0Aaf3EBb163dd45F663b38b6d93f6093EBC2d3"
    ]
    interval: ONE_MINUTE
    timeframe: ONE_HOUR
    limit: 1000
  ) {
    pair_address
    base_token {
      contract_name
      contract_address
      contract_decimals
      contract_ticker_symbol
    }
    volume
    timeframe
    high
    quote_rate
    low
    quote_rate_usd
    quote_token {
      contract_name
      contract_address
      contract_decimals
      contract_ticker_symbol
    }
    interval
    id
    volume_usd
    close
    chain_name
    open
    timestamp
  }
}

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
pair_addressstringThe address of the primary DEX pool with the most liquidity for the token
base_tokenTokenContractMetadataInformation about the queried token
base_token.contract_namestringName of the token contract
base_token.contract_addressstringAddress of the token contract
base_token.contract_decimalsintNumber of decimal places for the token
base_token.contract_ticker_symbolstringTicker symbol of the token
volumefloatTrading volume during the interval
timeframeTimeFrameThe requested timeframe
highfloatHighest price during the interval
quote_ratefloatExchange rate between base and quote tokens
lowfloatLowest price during the interval
quote_rate_usdfloatUSD value of the quote rate
quote_tokenTokenContractMetadataInformation about the paired token of the primary DEX pool
quote_token.contract_namestringName of the token contract
quote_token.contract_addressstringAddress of the token contract
quote_token.contract_decimalsintNumber of decimal places for the token
quote_token.contract_ticker_symbolstringTicker symbol of the token
intervalTimeIntervalThe candle interval
idstringUnique identifier for this candle
volume_usdfloatTrading volume in USD
closefloatClosing price for the interval
chain_nameChainNameThe blockchain network where the token exists
openfloatOpening price for the interval
timestampstringCandle timestamp (ISO-8601)

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: 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: - BASE_MAINNET
  • BSC_MAINNET
  • ETH_MAINNET
  • HYPERCORE_MAINNET
  • HYPEREVM_MAINNET
  • MEGAETH_MAINNET
  • MONAD_MAINNET
  • POLYGON_MAINNET
  • SOLANA_MAINNET
Note: 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_nameChainNameYesChain name to filter events (e.g. BASE_MAINNET, ETH_MAINNET, BSC_MAINNET, SOLANA_MAINNET) Available values: BASE_MAINNET, BSC_MAINNET, ETH_MAINNET, HYPERCORE_MAINNET, HYPEREVM_MAINNET, MEGAETH_MAINNET, MONAD_MAINNET, POLYGON_MAINNET, SOLANA_MAINNET, TEMPO_MAINNET
token_addressesarrayYesArray of token addresses on supported DEXes and chains to track
intervalTimeIntervalYesFrequency of OHLCV data updates, ranging from sub-second to one day Available values: FIFTEEN_MINUTES, FIFTEEN_SECONDS, FIVE_MINUTES, FIVE_SECONDS, FOUR_HOURS, ONE_DAY, ONE_HOUR, ONE_MINUTE, ONE_SECOND
timeframeTimeFrameYesHistorical lookback period for OHLCV data, ranging from one minute to one month Available values: FIFTEEN_MINUTES, FIVE_DAYS, FIVE_MINUTES, FOUR_HOURS, ONE_DAY, ONE_HOUR, ONE_MINUTE, SEVEN_DAYS, THIRTY_DAYS
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.
subscription {
  ohlcvCandlesForToken(
    chain_name: BASE_MAINNET
    token_addresses: ["0x4B6104755AfB5Da4581B81C552DA3A25608c73B8"]
    interval: ONE_MINUTE
    timeframe: ONE_HOUR
    limit: 1000
  ) {
    pair_address
    base_token {
      contract_name
      contract_address
      contract_decimals
      contract_ticker_symbol
    }
    volume
    timeframe
    high
    quote_rate
    low
    quote_rate_usd
    quote_token {
      contract_name
      contract_address
      contract_decimals
      contract_ticker_symbol
    }
    interval
    id
    volume_usd
    close
    chain_name
    open
    timestamp
  }
}

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
pair_addressstringThe address of the primary DEX pool with the most liquidity for the token
base_tokenTokenContractMetadataInformation about the queried token
base_token.contract_namestringName of the token contract
base_token.contract_addressstringAddress of the token contract
base_token.contract_decimalsintNumber of decimal places for the token
base_token.contract_ticker_symbolstringTicker symbol of the token
volumefloatTrading volume during the interval
timeframeTimeFrameThe requested timeframe
highfloatHighest price during the interval
quote_ratefloatExchange rate between base and quote tokens
lowfloatLowest price during the interval
quote_rate_usdfloatUSD value of the quote rate
quote_tokenTokenContractMetadataInformation about the paired token of the primary DEX pool
quote_token.contract_namestringName of the token contract
quote_token.contract_addressstringAddress of the token contract
quote_token.contract_decimalsintNumber of decimal places for the token
quote_token.contract_ticker_symbolstringTicker symbol of the token
intervalTimeIntervalThe candle interval
idstringUnique identifier for this candle
volume_usdfloatTrading volume in USD
closefloatClosing price for the interval
chain_nameChainNameThe blockchain network where the token exists
openfloatOpening price for the interval
timestampstringCandle timestamp (ISO-8601)

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, 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
  • BSC_MAINNET
  • ETH_MAINNET
  • HYPEREVM_MAINNET
  • MEGAETH_MAINNET
  • MONAD_MAINNET
  • POLYGON_MAINNET
  • SOLANA_MAINNET
Note: 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_nameChainNameYesChain name to filter events (e.g. BASE_MAINNET, ETH_MAINNET, BSC_MAINNET, SOLANA_MAINNET) Available values: BASE_MAINNET, BSC_MAINNET, ETH_MAINNET, HYPERCORE_MAINNET, HYPEREVM_MAINNET, MEGAETH_MAINNET, MONAD_MAINNET, POLYGON_MAINNET, SOLANA_MAINNET, TEMPO_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.
subscription {
  updatePairs(
    chain_name: BASE_MAINNET
    pair_addresses: [
      "0x9c087Eb773291e50CF6c6a90ef0F4500e349B903"
      "0x4b0Aaf3EBb163dd45F663b38b6d93f6093EBC2d3"
    ]
  ) {
    trader
    liquidity
    pair_address
    base_token {
      contract_name
      contract_address
      contract_decimals
      contract_ticker_symbol
    }
    last_5m {
      volume {
        previous_value
        pct_change
        current_value
      }
      unique_sellers {
        previous_value
        pct_change
        current_value
      }
      sell_count {
        previous_value
        pct_change
        current_value
      }
      price {
        previous_value
        pct_change
        current_value
      }
      buy_count {
        previous_value
        pct_change
        current_value
      }
      sell_volume {
        previous_value
        pct_change
        current_value
      }
      volume_usd {
        previous_value
        pct_change
        current_value
      }
      buy_volume {
        previous_value
        pct_change
        current_value
      }
      swap_count {
        previous_value
        pct_change
        current_value
      }
      unique_buyers {
        previous_value
        pct_change
        current_value
      }
    }
    last_6hr {
      volume {
        previous_value
        pct_change
        current_value
      }
      unique_sellers {
        previous_value
        pct_change
        current_value
      }
      sell_count {
        previous_value
        pct_change
        current_value
      }
      price {
        previous_value
        pct_change
        current_value
      }
      buy_count {
        previous_value
        pct_change
        current_value
      }
      sell_volume {
        previous_value
        pct_change
        current_value
      }
      volume_usd {
        previous_value
        pct_change
        current_value
      }
      buy_volume {
        previous_value
        pct_change
        current_value
      }
      swap_count {
        previous_value
        pct_change
        current_value
      }
      unique_buyers {
        previous_value
        pct_change
        current_value
      }
    }
    market_cap
    quote_rate
    last_24hr {
      volume {
        previous_value
        pct_change
        current_value
      }
      unique_sellers {
        previous_value
        pct_change
        current_value
      }
      sell_count {
        previous_value
        pct_change
        current_value
      }
      price {
        previous_value
        pct_change
        current_value
      }
      buy_count {
        previous_value
        pct_change
        current_value
      }
      sell_volume {
        previous_value
        pct_change
        current_value
      }
      volume_usd {
        previous_value
        pct_change
        current_value
      }
      buy_volume {
        previous_value
        pct_change
        current_value
      }
      swap_count {
        previous_value
        pct_change
        current_value
      }
      unique_buyers {
        previous_value
        pct_change
        current_value
      }
    }
    last_1hr {
      volume {
        previous_value
        pct_change
        current_value
      }
      unique_sellers {
        previous_value
        pct_change
        current_value
      }
      sell_count {
        previous_value
        pct_change
        current_value
      }
      price {
        previous_value
        pct_change
        current_value
      }
      buy_count {
        previous_value
        pct_change
        current_value
      }
      sell_volume {
        previous_value
        pct_change
        current_value
      }
      volume_usd {
        previous_value
        pct_change
        current_value
      }
      buy_volume {
        previous_value
        pct_change
        current_value
      }
      swap_count {
        previous_value
        pct_change
        current_value
      }
      unique_buyers {
        previous_value
        pct_change
        current_value
      }
    }
    quote_rate_usd
    sender
    quote_token {
      contract_name
      contract_address
      contract_decimals
      contract_ticker_symbol
    }
    id
    chain_name
    direction
    timestamp
  }
}

Response Format

Here’s an example of the response data structure:
{
  "data": {
    "updatePairs": {
      "chain_name": "BASE_MAINNET",
      "pair_address": "0x9c087Eb773291e50CF6c6a90ef0F4500e349B903",
      "timestamp": "2025-08-13T12:34:56Z",
      "quote_rate": 0.0002962,
      "quote_rate_usd": 1.39,
      "market_cap": 1250000.50,
      "liquidity": 850000.25,
      "base_token": {
        "contract_name": "Virtual",
        "contract_ticker_symbol": "VIRTUAL",
        "contract_address": "0x0b3e328455c4059EEb9e3f84b5543F74E24e7E1b",
        "contract_decimals": 18
      },
      "quote_token": {
        "contract_name": "Wrapped Ether",
        "contract_ticker_symbol": "WETH",
        "contract_address": "0x4200000000000000000000000000000000000006",
        "contract_decimals": 18
      },
      "last_5m": {
        "price": {
          "current_value": 1.39,
          "previous_value": 1.37,
          "pct_change": 1.46
        },
        "swap_count": {
          "current_value": 10,
          "previous_value": 8,
          "pct_change": 25.0
        },
        "volume_usd": {
          "current_value": 975.52,
          "previous_value": 820.10,
          "pct_change": 18.95
        }
      },
      "last_1hr": {
        "price": {
          "current_value": 1.39,
          "previous_value": 1.36,
          "pct_change": 2.21
        },
        "swap_count": {
          "current_value": 100,
          "previous_value": 85,
          "pct_change": 17.65
        },
        "volume_usd": {
          "current_value": 12500.00,
          "previous_value": 10200.00,
          "pct_change": 22.55
        }
      }
    }
  }
}

Field Descriptions

FieldTypeDescription
traderstringAddress of the trader who initiated the swap
liquidityfloatTotal liquidity in the pool
pair_addressstringThe address of the DEX pair
base_tokenTokenContractMetadataInformation about the base token in the pair
base_token.contract_namestringName of the token contract
base_token.contract_addressstringAddress of the token contract
base_token.contract_decimalsintNumber of decimal places for the token
base_token.contract_ticker_symbolstringTicker symbol of the token
last_5mTimeframeMetricsAggregated trading metrics for the last 5 minutes
last_5m.volumeMetricValueTotal volume in native/quote token (buy + sell) __RESPONSE_ROW__previous_value float Total value for the previous duration __RESPONSE_ROW__last_5m.pct_change float Percent change between current_value and previous_value __RESPONSE_ROW__last_5m.current_value float Total value for the most recent duration __RESPONSE_ROW__unique_sellers MetricValue Number of unique seller addresses __RESPONSE_ROW__unique_sellers.previous_value float Total value for the previous duration __RESPONSE_ROW__unique_sellers.pct_change float Percent change between current_value and previous_value __RESPONSE_ROW__unique_sellers.current_value float Total value for the most recent duration __RESPONSE_ROW__sell_count MetricValue Number of sell transactions __RESPONSE_ROW__sell_count.previous_value float Total value for the previous duration __RESPONSE_ROW__sell_count.pct_change float Percent change between current_value and previous_value __RESPONSE_ROW__sell_count.current_value float Total value for the most recent duration __RESPONSE_ROW__price MetricValue Price: current_value = current price, previous_value = price at window start __RESPONSE_ROW__price.previous_value float Total value for the previous duration __RESPONSE_ROW__price.pct_change float Percent change between current_value and previous_value __RESPONSE_ROW__price.current_value float Total value for the most recent duration __RESPONSE_ROW__buy_count MetricValue Number of buy transactions __RESPONSE_ROW__buy_count.previous_value float Total value for the previous duration __RESPONSE_ROW__buy_count.pct_change float Percent change between current_value and previous_value __RESPONSE_ROW__buy_count.current_value float Total value for the most recent duration __RESPONSE_ROW__sell_volume MetricValue Total sell volume in USD __RESPONSE_ROW__sell_volume.previous_value float Total value for the previous duration __RESPONSE_ROW__sell_volume.pct_change float Percent change between current_value and previous_value __RESPONSE_ROW__sell_volume.current_value float Total value for the most recent duration __RESPONSE_ROW__volume_usd MetricValue Total volume in USD (buy + sell) __RESPONSE_ROW__volume_usd.previous_value float Total value for the previous duration __RESPONSE_ROW__volume_usd.pct_change float Percent change between current_value and previous_value __RESPONSE_ROW__volume_usd.current_value float Total value for the most recent duration __RESPONSE_ROW__buy_volume MetricValue Total buy volume in USD __RESPONSE_ROW__buy_volume.previous_value float Total value for the previous duration __RESPONSE_ROW__buy_volume.pct_change float Percent change between current_value and previous_value __RESPONSE_ROW__buy_volume.current_value float Total value for the most recent duration __RESPONSE_ROW__swap_count MetricValue Total number of swaps __RESPONSE_ROW__swap_count.previous_value float Total value for the previous duration __RESPONSE_ROW__swap_count.pct_change float Percent change between current_value and previous_value __RESPONSE_ROW__swap_count.current_value float Total value for the most recent duration __RESPONSE_ROW__unique_buyers MetricValue Number of unique buyer addresses __RESPONSE_ROW__unique_buyers.previous_value float Total value for the previous duration __RESPONSE_ROW__unique_buyers.pct_change float Percent change between current_value and previous_value __RESPONSE_ROW__unique_buyers.current_value float Total value for the most recent duration
last_6hrTimeframeMetricsAggregated trading metrics for the last 6 hours
last_6hr.volumeMetricValueTotal volume in native/quote token (buy + sell) __RESPONSE_ROW__previous_value float Total value for the previous duration __RESPONSE_ROW__last_6hr.pct_change float Percent change between current_value and previous_value __RESPONSE_ROW__last_6hr.current_value float Total value for the most recent duration __RESPONSE_ROW__unique_sellers MetricValue Number of unique seller addresses __RESPONSE_ROW__unique_sellers.previous_value float Total value for the previous duration __RESPONSE_ROW__unique_sellers.pct_change float Percent change between current_value and previous_value __RESPONSE_ROW__unique_sellers.current_value float Total value for the most recent duration __RESPONSE_ROW__sell_count MetricValue Number of sell transactions __RESPONSE_ROW__sell_count.previous_value float Total value for the previous duration __RESPONSE_ROW__sell_count.pct_change float Percent change between current_value and previous_value __RESPONSE_ROW__sell_count.current_value float Total value for the most recent duration __RESPONSE_ROW__price MetricValue Price: current_value = current price, previous_value = price at window start __RESPONSE_ROW__price.previous_value float Total value for the previous duration __RESPONSE_ROW__price.pct_change float Percent change between current_value and previous_value __RESPONSE_ROW__price.current_value float Total value for the most recent duration __RESPONSE_ROW__buy_count MetricValue Number of buy transactions __RESPONSE_ROW__buy_count.previous_value float Total value for the previous duration __RESPONSE_ROW__buy_count.pct_change float Percent change between current_value and previous_value __RESPONSE_ROW__buy_count.current_value float Total value for the most recent duration __RESPONSE_ROW__sell_volume MetricValue Total sell volume in USD __RESPONSE_ROW__sell_volume.previous_value float Total value for the previous duration __RESPONSE_ROW__sell_volume.pct_change float Percent change between current_value and previous_value __RESPONSE_ROW__sell_volume.current_value float Total value for the most recent duration __RESPONSE_ROW__volume_usd MetricValue Total volume in USD (buy + sell) __RESPONSE_ROW__volume_usd.previous_value float Total value for the previous duration __RESPONSE_ROW__volume_usd.pct_change float Percent change between current_value and previous_value __RESPONSE_ROW__volume_usd.current_value float Total value for the most recent duration __RESPONSE_ROW__buy_volume MetricValue Total buy volume in USD __RESPONSE_ROW__buy_volume.previous_value float Total value for the previous duration __RESPONSE_ROW__buy_volume.pct_change float Percent change between current_value and previous_value __RESPONSE_ROW__buy_volume.current_value float Total value for the most recent duration __RESPONSE_ROW__swap_count MetricValue Total number of swaps __RESPONSE_ROW__swap_count.previous_value float Total value for the previous duration __RESPONSE_ROW__swap_count.pct_change float Percent change between current_value and previous_value __RESPONSE_ROW__swap_count.current_value float Total value for the most recent duration __RESPONSE_ROW__unique_buyers MetricValue Number of unique buyer addresses __RESPONSE_ROW__unique_buyers.previous_value float Total value for the previous duration __RESPONSE_ROW__unique_buyers.pct_change float Percent change between current_value and previous_value __RESPONSE_ROW__unique_buyers.current_value float Total value for the most recent duration
market_capfloatMarket capitalization of the token pair
quote_ratefloatExchange rate between base and quote tokens
last_24hrTimeframeMetricsAggregated trading metrics for the last 24 hours
last_24hr.volumeMetricValueTotal volume in native/quote token (buy + sell) __RESPONSE_ROW__previous_value float Total value for the previous duration __RESPONSE_ROW__last_24hr.pct_change float Percent change between current_value and previous_value __RESPONSE_ROW__last_24hr.current_value float Total value for the most recent duration __RESPONSE_ROW__unique_sellers MetricValue Number of unique seller addresses __RESPONSE_ROW__unique_sellers.previous_value float Total value for the previous duration __RESPONSE_ROW__unique_sellers.pct_change float Percent change between current_value and previous_value __RESPONSE_ROW__unique_sellers.current_value float Total value for the most recent duration __RESPONSE_ROW__sell_count MetricValue Number of sell transactions __RESPONSE_ROW__sell_count.previous_value float Total value for the previous duration __RESPONSE_ROW__sell_count.pct_change float Percent change between current_value and previous_value __RESPONSE_ROW__sell_count.current_value float Total value for the most recent duration __RESPONSE_ROW__price MetricValue Price: current_value = current price, previous_value = price at window start __RESPONSE_ROW__price.previous_value float Total value for the previous duration __RESPONSE_ROW__price.pct_change float Percent change between current_value and previous_value __RESPONSE_ROW__price.current_value float Total value for the most recent duration __RESPONSE_ROW__buy_count MetricValue Number of buy transactions __RESPONSE_ROW__buy_count.previous_value float Total value for the previous duration __RESPONSE_ROW__buy_count.pct_change float Percent change between current_value and previous_value __RESPONSE_ROW__buy_count.current_value float Total value for the most recent duration __RESPONSE_ROW__sell_volume MetricValue Total sell volume in USD __RESPONSE_ROW__sell_volume.previous_value float Total value for the previous duration __RESPONSE_ROW__sell_volume.pct_change float Percent change between current_value and previous_value __RESPONSE_ROW__sell_volume.current_value float Total value for the most recent duration __RESPONSE_ROW__volume_usd MetricValue Total volume in USD (buy + sell) __RESPONSE_ROW__volume_usd.previous_value float Total value for the previous duration __RESPONSE_ROW__volume_usd.pct_change float Percent change between current_value and previous_value __RESPONSE_ROW__volume_usd.current_value float Total value for the most recent duration __RESPONSE_ROW__buy_volume MetricValue Total buy volume in USD __RESPONSE_ROW__buy_volume.previous_value float Total value for the previous duration __RESPONSE_ROW__buy_volume.pct_change float Percent change between current_value and previous_value __RESPONSE_ROW__buy_volume.current_value float Total value for the most recent duration __RESPONSE_ROW__swap_count MetricValue Total number of swaps __RESPONSE_ROW__swap_count.previous_value float Total value for the previous duration __RESPONSE_ROW__swap_count.pct_change float Percent change between current_value and previous_value __RESPONSE_ROW__swap_count.current_value float Total value for the most recent duration __RESPONSE_ROW__unique_buyers MetricValue Number of unique buyer addresses __RESPONSE_ROW__unique_buyers.previous_value float Total value for the previous duration __RESPONSE_ROW__unique_buyers.pct_change float Percent change between current_value and previous_value __RESPONSE_ROW__unique_buyers.current_value float Total value for the most recent duration
last_1hrTimeframeMetricsAggregated trading metrics for the last 1 hour
last_1hr.volumeMetricValueTotal volume in native/quote token (buy + sell) __RESPONSE_ROW__previous_value float Total value for the previous duration __RESPONSE_ROW__last_1hr.pct_change float Percent change between current_value and previous_value __RESPONSE_ROW__last_1hr.current_value float Total value for the most recent duration __RESPONSE_ROW__unique_sellers MetricValue Number of unique seller addresses __RESPONSE_ROW__unique_sellers.previous_value float Total value for the previous duration __RESPONSE_ROW__unique_sellers.pct_change float Percent change between current_value and previous_value __RESPONSE_ROW__unique_sellers.current_value float Total value for the most recent duration __RESPONSE_ROW__sell_count MetricValue Number of sell transactions __RESPONSE_ROW__sell_count.previous_value float Total value for the previous duration __RESPONSE_ROW__sell_count.pct_change float Percent change between current_value and previous_value __RESPONSE_ROW__sell_count.current_value float Total value for the most recent duration __RESPONSE_ROW__price MetricValue Price: current_value = current price, previous_value = price at window start __RESPONSE_ROW__price.previous_value float Total value for the previous duration __RESPONSE_ROW__price.pct_change float Percent change between current_value and previous_value __RESPONSE_ROW__price.current_value float Total value for the most recent duration __RESPONSE_ROW__buy_count MetricValue Number of buy transactions __RESPONSE_ROW__buy_count.previous_value float Total value for the previous duration __RESPONSE_ROW__buy_count.pct_change float Percent change between current_value and previous_value __RESPONSE_ROW__buy_count.current_value float Total value for the most recent duration __RESPONSE_ROW__sell_volume MetricValue Total sell volume in USD __RESPONSE_ROW__sell_volume.previous_value float Total value for the previous duration __RESPONSE_ROW__sell_volume.pct_change float Percent change between current_value and previous_value __RESPONSE_ROW__sell_volume.current_value float Total value for the most recent duration __RESPONSE_ROW__volume_usd MetricValue Total volume in USD (buy + sell) __RESPONSE_ROW__volume_usd.previous_value float Total value for the previous duration __RESPONSE_ROW__volume_usd.pct_change float Percent change between current_value and previous_value __RESPONSE_ROW__volume_usd.current_value float Total value for the most recent duration __RESPONSE_ROW__buy_volume MetricValue Total buy volume in USD __RESPONSE_ROW__buy_volume.previous_value float Total value for the previous duration __RESPONSE_ROW__buy_volume.pct_change float Percent change between current_value and previous_value __RESPONSE_ROW__buy_volume.current_value float Total value for the most recent duration __RESPONSE_ROW__swap_count MetricValue Total number of swaps __RESPONSE_ROW__swap_count.previous_value float Total value for the previous duration __RESPONSE_ROW__swap_count.pct_change float Percent change between current_value and previous_value __RESPONSE_ROW__swap_count.current_value float Total value for the most recent duration __RESPONSE_ROW__unique_buyers MetricValue Number of unique buyer addresses __RESPONSE_ROW__unique_buyers.previous_value float Total value for the previous duration __RESPONSE_ROW__unique_buyers.pct_change float Percent change between current_value and previous_value __RESPONSE_ROW__unique_buyers.current_value float Total value for the most recent duration
quote_rate_usdfloatExchange rate between base and quote tokens in USD
senderstringAddress that sent the transaction
quote_tokenTokenContractMetadataInformation about the quote token in the pair
quote_token.contract_namestringName of the token contract
quote_token.contract_addressstringAddress of the token contract
quote_token.contract_decimalsintNumber of decimal places for the token
quote_token.contract_ticker_symbolstringTicker symbol of the token
idstringUnique identifier for this swap event
chain_nameChainNameThe blockchain network where the pair exists
directionstringSwap direction: buy or sell
timestampstringTimestamp of the latest swap (ISO-8601)

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, 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
  • BSC_MAINNET
  • ETH_MAINNET
  • HYPERCORE_MAINNET
  • HYPEREVM_MAINNET
  • MEGAETH_MAINNET
  • MONAD_MAINNET
  • POLYGON_MAINNET
Note: 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:
  • ApproveTransaction — Decoded details for a token spending approval
  • BridgeTransaction — Decoded details for a cross-chain bridge transfer
  • DepositTransaction — Decoded details for a token deposit or liquidity addition
  • HypercoreDelegationEvent — Decoded details for a Hypercore staking delegation or undelegation event
  • HypercoreDepositEvent — Decoded details for a Hypercore cross-chain deposit from an external chain
  • HypercoreFillTransaction — Decoded details for a Hypercore perpetuals trade fill
  • HypercoreFundingEvent — Decoded details for a Hypercore funding rate payment between long and short holders
  • HypercoreLedgerEvent — Decoded details for a Hypercore ledger update (withdraw, deposit, transfer, liquidation, etc.)
  • HypercoreWithdrawalEvent — Decoded details for a finalized Hypercore cross-chain withdrawal
  • SwapTransaction — Decoded details for a token swap on a decentralized exchange
  • TransferTransaction — Decoded details for a token transfer between addresses
  • WithdrawTransaction — Decoded details for a token withdrawal or liquidity removal

Parameters

ParameterTypeRequiredDescription
wallet_addressesarrayYesAddresses to track
chain_nameChainNameYesChain name to filter events (e.g. BASE_MAINNET, ETH_MAINNET, BSC_MAINNET) Available values: BASE_MAINNET, BSC_MAINNET, ETH_MAINNET, HYPERCORE_MAINNET, HYPEREVM_MAINNET, MEGAETH_MAINNET, MONAD_MAINNET, POLYGON_MAINNET, SOLANA_MAINNET, TEMPO_MAINNET

Subscription

You can subscribe to the walletTxs endpoint to receive events.
subscription {
  walletTxs(
    wallet_addresses: [
      "0x198ef79f1f515f02dfe9e3115ed9fc07183f02fc"
      "0x4200000000000000000000000000000000000006"
    ]
    chain_name: BASE_MAINNET
  ) {
    decoded_details {
      ... on ApproveTransaction {
        type
        typeString
        amount
        quote_usd
        quote_rate_usd
        spender
        contract_metadata {
          contract_name
          contract_address
          contract_decimals
          contract_ticker_symbol
        }
      }
      ... on BridgeTransaction {
        type
        typeString
        amount
        quote_usd
        quote_rate_usd
        contract_metadata {
          contract_name
          contract_address
          contract_decimals
          contract_ticker_symbol
        }
        from
        to
      }
      ... on DepositTransaction {
        type
        typeString
        amount
        quote_usd
        quote_rate_usd
        contract_metadata {
          contract_name
          contract_address
          contract_decimals
          contract_ticker_symbol
        }
        from
        to
      }
      ... on ErrorDetails {
        message
        typeString
      }
      ... on HypercoreDelegationEvent {
        type
        typeString
        hash
        time
        is_undelegate
        amount
        validator
      }
      ... on HypercoreDepositEvent {
        type
        typeString
        hash
        time
        amount
      }
      ... on HypercoreFillTransaction {
        type
        typeString
        liquidation {
          market_price
          method
          liquidated_user
        }
        twap_id
        builder_fee
        side
        cloid
        closed_pnl
        fee
        fee_token
        oid
        dir
        start_position
        tid
        size
        price
        builder
        time
        crossed
        hash
        coin
      }
      ... on HypercoreFundingEvent {
        type
        typeString
        hash
        time
        szi
        funding_amount
        coin
        funding_rate
      }
      ... on HypercoreLedgerEvent {
        type
        typeString
        hash
        ledger_type
        time
      }
      ... on HypercoreWithdrawalEvent {
        type
        typeString
        hash
        time
        amount
      }
      ... on SwapTransaction {
        type
        typeString
        amount_out
        amount_in
        token_out {
          contract_name
          contract_address
          contract_decimals
          contract_ticker_symbol
        }
        token_in {
          contract_name
          contract_address
          contract_decimals
          contract_ticker_symbol
        }
      }
      ... on TransferTransaction {
        type
        typeString
        amount
        quote_usd
        quote_rate_usd
        contract_metadata {
          contract_name
          contract_address
          contract_decimals
          contract_ticker_symbol
        }
        from
        to
      }
      ... on WithdrawTransaction {
        type
        typeString
        amount
        quote_usd
        quote_rate_usd
        contract_metadata {
          contract_name
          contract_address
          contract_decimals
          contract_ticker_symbol
        }
        from
        to
      }
    }
    gas_used
    block_hash
    to_address
    tx_hash
    block_height
    decoded_type
    miner_address
    tx_offset
    block_signed_at
    from_address
    logs {
      data
      emitter_address
      log_offset
      topics
    }
    value
    chain_name
    successful
  }
}

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
decoded_detailsDecodedDetailsThe decoded event data (varies by event type)
decoded_details.typeTransactionTypeEnum value identifying the transaction type
decoded_details.typeStringstringHuman-readable label for the transaction type
decoded_details.amountstringAmount of tokens approved for spending
decoded_details.quote_usdfloatTotal USD value of the approved amount
decoded_details.quote_rate_usdfloatUSD price per token at time of approval
decoded_details.spenderstringAddress of the approved spender
decoded_details.contract_metadataTokenContractMetadataMetadata for the approved token contract __RESPONSE_ROW__contract_name string Name of the token contract __RESPONSE_ROW__decoded_details.contract_address string Address of the token contract __RESPONSE_ROW__decoded_details.contract_decimals int Number of decimal places for the token __RESPONSE_ROW__decoded_details.contract_ticker_symbol string Ticker symbol of the token Enum value identifying the transaction type
typeStringstringHuman-readable label for the transaction type
amountstringAmount of tokens bridged
quote_usdfloatTotal USD value of the bridged amount
quote_rate_usdfloatUSD price per token at time of bridge
contract_metadataTokenContractMetadataMetadata for the bridged token contract
contract_metadata.contract_namestringName of the token contract
contract_metadata.contract_addressstringAddress of the token contract
contract_metadata.contract_decimalsintNumber of decimal places for the token
contract_metadata.contract_ticker_symbolstringTicker symbol of the token
fromstringSender wallet address
tostringRecipient wallet address
__RESPONSE_ROW__type TransactionType Enum value identifying the transaction type __RESPONSE_ROW__typeString string Human-readable label for the transaction type __RESPONSE_ROW__amount string Amount of tokens deposited __RESPONSE_ROW__quote_usd float Total USD value of the deposited amount __RESPONSE_ROW__quote_rate_usd float USD price per token at time of deposit __RESPONSE_ROW__contract_metadata TokenContractMetadata Metadata for the deposited token contract
FieldTypeDescription
contract_metadata.contract_namestringName of the token contract
contract_metadata.contract_addressstringAddress of the token contract
contract_metadata.contract_decimalsintNumber of decimal places for the token
contract_metadata.contract_ticker_symbolstringTicker symbol of the token
fromstringSender wallet address
tostringRecipient or pool address
__RESPONSE_ROW__message string Error or status message describing the issue __RESPONSE_ROW__typeString string Label identifying this as an error event __RESPONSE_ROW__type TransactionType Enum value identifying the transaction type __RESPONSE_ROW__typeString string Human-readable label for the transaction type __RESPONSE_ROW__hash string Transaction/event hash from the Hypercore L1 __RESPONSE_ROW__time string ISO-8601 timestamp of the delegation event __RESPONSE_ROW__is_undelegate boolean Whether this is an undelegation (true) or delegation (false) __RESPONSE_ROW__amount string Delegation amount __RESPONSE_ROW__validator string Validator address that received or lost the delegation __RESPONSE_ROW__type TransactionType Enum value identifying the transaction type __RESPONSE_ROW__typeString string Human-readable label for the transaction type __RESPONSE_ROW__hash string Transaction/event hash from the Hypercore L1 __RESPONSE_ROW__time string ISO-8601 timestamp of the deposit event __RESPONSE_ROW__amount string Deposit amount in USDC __RESPONSE_ROW__type TransactionType Enum value identifying the transaction type __RESPONSE_ROW__typeString string Human-readable label for the transaction type __RESPONSE_ROW__liquidation HypercoreLiquidation Liquidation details, present only when this fill resulted from a liquidation
FieldTypeDescription
liquidation.market_pricestringMark price at the time of liquidation
liquidation.methodstringLiquidation method: Market or Backstop
liquidation.liquidated_userstringAddress of the user whose position was liquidated
twap_idstringTWAP order ID when this fill was part of a TWAP execution
builder_feestringFee paid to the builder, if a builder was involved
sidestringFill side: BUY, SELL, or UNSPECIFIED
cloidstringClient-supplied order ID for programmatic order tracking
closed_pnlstringRealized PnL from the closed portion of the position
feestringFee charged for this fill
fee_tokenstringToken in which the fee was denominated
oidstringOrder ID that originated this fill
dirstringDirection indicator for the position change
start_positionstringPosition size before this fill executed
tidstringUnique trade ID assigned by the exchange
sizestringFilled quantity
pricestringExecution price per unit
builderstringAddress of the builder that constructed this order
timestringISO-8601 timestamp of the fill
crossedbooleanWhether the order crossed the spread (true = taker, false = maker)
hashstringOn-chain transaction hash
coinstringMarket/coin symbol (e.g. ETH, BTC)
__RESPONSE_ROW__type TransactionType Enum value identifying the transaction type __RESPONSE_ROW__typeString string Human-readable label for the transaction type __RESPONSE_ROW__hash string Transaction/event hash from the Hypercore L1 __RESPONSE_ROW__time string ISO-8601 timestamp of the funding event __RESPONSE_ROW__szi string Position size indicator at the time of funding __RESPONSE_ROW__funding_amount string Funding payment amount in USDC __RESPONSE_ROW__coin string Market/coin symbol (e.g. ETH, BTC) __RESPONSE_ROW__funding_rate string Funding rate applied for this settlement __RESPONSE_ROW__type string Ledger subtype discriminator (e.g. withdraw, deposit, spot_transfer, send) __RESPONSE_ROW__typeString string Human-readable label for the transaction type __RESPONSE_ROW__delta LedgerDelta Subtype-specific ledger delta payload
FieldTypeDescription
delta.destinationstringDestination sub-account address
delta.usdcstringTransfer amount in USDC
delta.userstringSource user address
delta.feestringWithdrawal fee
delta.usdcstringWithdrawal amount in USDC
delta.noncestringWithdrawal nonce
delta.liquidated_ntl_posstringLiquidated notional position value
delta.account_valuestringAccount value at time of liquidation
delta.liquidated_positionsLedgerLiquidatedPosition[]List of positions that were liquidated
delta.leverage_typestringLeverage type (e.g. cross, isolated)
delta.amountstringTransfer amount
delta.usdc_valuestringUSDC equivalent value
delta.native_token_feestringFee in native token
delta.feestringTransfer fee
delta.destinationstringDestination user address
delta.fee_tokenstringToken used for fee payment
delta.noncestringTransfer nonce
delta.userstringSource user address
delta.tokenstringToken identifier
delta.usdcstringCommission amount in USDC
delta.vaultstringVault address
delta.amountstringSend amount
delta.usdc_valuestringUSDC equivalent value
delta.destination_dexstringDestination DEX identifier
delta.native_token_feestringFee in native token
delta.feestringSend fee
delta.destinationstringRecipient address
delta.fee_tokenstringToken used for fee payment
delta.noncestringSend nonce
delta.userstringSender address
delta.source_dexstringSource DEX identifier
delta.tokenstringToken identifier
delta.usdcstringDeposit amount in USDC
delta.userstringDepositor address
delta.vaultstringVault address
delta.feestringTransfer fee
delta.destinationstringDestination user address
delta.usdcstringTransfer amount in USDC
delta.userstringSource user address
delta.amountstringTransfer amount
delta.tokenstringToken identifier
delta.amountstringGas fee amount
delta.tokenstringToken used for gas payment
delta.feestringVault creation fee
delta.usdcstringInitial deposit amount in USDC
delta.vaultstringVault address
delta.amountstringBorrow or lend amount
delta.interest_amountstringAccrued interest amount
delta.operationstringOperation type: borrow or lend
delta.tokenstringToken identifier
delta.usdcstringDeposit amount in USDC
delta.amountstringClaimed rewards amount
delta.amountstringTransfer amount
delta.dexstringDEX identifier
delta.to_perpbooleanWhether transferring to perp (true) or to spot (false)
delta.tokenstringToken identifier
delta.amountstringTransfer amount
delta.is_depositbooleanWhether this is a deposit (true) or withdrawal (false)
delta.tokenstringToken identifier
delta.amountstringGenesis distribution amount
delta.tokenstringToken identifier
delta.amountstringAuction amount
delta.tokenstringToken identifier
delta.usdcstringDistribution amount in USDC
delta.vaultstringVault address
delta.requested_usdstringRequested withdrawal amount in USD
delta.commissionstringCommission charged
delta.basisstringCost basis of the withdrawn share
delta.closing_coststringCost to close positions for withdrawal
delta.userstringWithdrawer address
delta.vaultstringVault address
hashstringTransaction/event hash from the Hypercore L1
ledger_typestringLedger subtype discriminator (e.g. withdraw, deposit, spot_transfer, send)
timestringISO-8601 timestamp of the ledger event
__RESPONSE_ROW__type TransactionType Enum value identifying the transaction type __RESPONSE_ROW__typeString string Human-readable label for the transaction type __RESPONSE_ROW__hash string Transaction/event hash from the Hypercore L1 __RESPONSE_ROW__time string ISO-8601 timestamp of the withdrawal event __RESPONSE_ROW__amount string Withdrawal amount in USDC __RESPONSE_ROW__type TransactionType Enum value identifying the transaction type __RESPONSE_ROW__typeString string Human-readable label for the transaction type __RESPONSE_ROW__amount_out string Amount of tokens received __RESPONSE_ROW__amount_in string Amount of tokens sold __RESPONSE_ROW__token_out TokenContractMetadata Metadata for the token bought
FieldTypeDescription
token_out.contract_namestringName of the token contract
token_out.contract_addressstringAddress of the token contract
token_out.contract_decimalsintNumber of decimal places for the token
token_out.contract_ticker_symbolstringTicker symbol of the token
token_inTokenContractMetadataMetadata for the token sold
token_in.contract_namestringName of the token contract
token_in.contract_addressstringAddress of the token contract
token_in.contract_decimalsintNumber of decimal places for the token
token_in.contract_ticker_symbolstringTicker symbol of the token
__RESPONSE_ROW__type TransactionType Enum value identifying the transaction type __RESPONSE_ROW__typeString string Human-readable label for the transaction type __RESPONSE_ROW__amount string Amount of tokens transferred __RESPONSE_ROW__quote_usd float Total USD value of the transferred amount __RESPONSE_ROW__quote_rate_usd float USD price per token at time of transfer __RESPONSE_ROW__contract_metadata TokenContractMetadata Metadata for the transferred token contract
FieldTypeDescription
contract_metadata.contract_namestringName of the token contract
contract_metadata.contract_addressstringAddress of the token contract
contract_metadata.contract_decimalsintNumber of decimal places for the token
contract_metadata.contract_ticker_symbolstringTicker symbol of the token
fromstringSender wallet address
tostringRecipient wallet address
__RESPONSE_ROW__type TransactionType Enum value identifying the transaction type __RESPONSE_ROW__typeString string Human-readable label for the transaction type __RESPONSE_ROW__amount string Amount of tokens withdrawn __RESPONSE_ROW__quote_usd float Total USD value of the withdrawn amount __RESPONSE_ROW__quote_rate_usd float USD price per token at time of withdrawal __RESPONSE_ROW__contract_metadata TokenContractMetadata Metadata for the withdrawn token contract
FieldTypeDescription
contract_metadata.contract_namestringName of the token contract
contract_metadata.contract_addressstringAddress of the token contract
contract_metadata.contract_decimalsintNumber of decimal places for the token
contract_metadata.contract_ticker_symbolstringTicker symbol of the token
fromstringSource pool or contract address
tostringRecipient wallet address
FieldTypeDescription
gas_usedstringThe amount of gas used by the transaction
block_hashstringThe hash of the block containing the transaction
to_addressstringThe recipient’s address
tx_hashstringThe transaction hash
block_heightintThe block number where the transaction was included
decoded_typestringThe type of decoded event (e.g., SWAP)
miner_addressstringThe address of the block miner
tx_offsetintThe position of the transaction in the block
block_signed_atstringTimestamp when the block containing this transaction was signed (ISO-8601)
from_addressstringThe sender’s address
logsTransactionLog[]Array of event logs emitted during the transaction
logs.datastringABI-encoded log data
logs.emitter_addressstringAddress of the contract that emitted the log
logs.log_offsetintPosition of the log within the transaction
logs.topicsarrayIndexed event parameters (topic[0] is the event signature hash)
valuestringThe transaction value in native currency
chain_namestringThe blockchain network where the transaction occurred
successfulbooleanWhether the transaction was successful

Decoded Events

Note from the Subscription query above, 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 Wallet Activity Stream:

Approve

Decoded details for a token spending approval
Tip: See ApproveTransaction for full field details including nested objects.
FieldTypeDescription
amountstringAmount of tokens approved for spending
quote_usdfloatTotal USD value of the approved amount
quote_rate_usdfloatUSD price per token at time of approval
spenderstringAddress of the approved spender
contract_metadataTokenContractMetadataMetadata for the approved token contract

Bridge

Decoded details for a cross-chain bridge transfer
Tip: See BridgeTransaction for full field details including nested objects.
FieldTypeDescription
amountstringAmount of tokens bridged
quote_usdfloatTotal USD value of the bridged amount
quote_rate_usdfloatUSD price per token at time of bridge
contract_metadataTokenContractMetadataMetadata for the bridged token contract
fromstringSender wallet address
tostringRecipient wallet address

Deposit

Decoded details for a token deposit or liquidity addition
Tip: See DepositTransaction for full field details including nested objects.
FieldTypeDescription
amountstringAmount of tokens deposited
quote_usdfloatTotal USD value of the deposited amount
quote_rate_usdfloatUSD price per token at time of deposit
contract_metadataTokenContractMetadataMetadata for the deposited token contract
fromstringSender wallet address
tostringRecipient or pool address

Hypercore Delegation Event

Decoded details for a Hypercore staking delegation or undelegation event
Tip: See HypercoreDelegationEvent for full field details including nested objects.
FieldTypeDescription
hashstringTransaction/event hash from the Hypercore L1
timestringISO-8601 timestamp of the delegation event
is_undelegatebooleanWhether this is an undelegation (true) or delegation (false)
amountstringDelegation amount
validatorstringValidator address that received or lost the delegation

Hypercore Deposit Event

Decoded details for a Hypercore cross-chain deposit from an external chain
Tip: See HypercoreDepositEvent for full field details including nested objects.
FieldTypeDescription
hashstringTransaction/event hash from the Hypercore L1
timestringISO-8601 timestamp of the deposit event
amountstringDeposit amount in USDC

Hypercore Fill

Decoded details for a Hypercore perpetuals trade fill
Tip: See HypercoreFillTransaction for full field details including nested objects.
FieldTypeDescription
liquidationHypercoreLiquidationLiquidation details, present only when this fill resulted from a liquidation
twap_idstringTWAP order ID when this fill was part of a TWAP execution
builder_feestringFee paid to the builder, if a builder was involved
sidestringFill side: BUY, SELL, or UNSPECIFIED
cloidstringClient-supplied order ID for programmatic order tracking
closed_pnlstringRealized PnL from the closed portion of the position
feestringFee charged for this fill
fee_tokenstringToken in which the fee was denominated
oidstringOrder ID that originated this fill
dirstringDirection indicator for the position change
start_positionstringPosition size before this fill executed
tidstringUnique trade ID assigned by the exchange
sizestringFilled quantity
pricestringExecution price per unit
builderstringAddress of the builder that constructed this order
timestringISO-8601 timestamp of the fill
crossedbooleanWhether the order crossed the spread (true = taker, false = maker)
hashstringOn-chain transaction hash
coinstringMarket/coin symbol (e.g. ETH, BTC)

Hypercore Funding Event

Decoded details for a Hypercore funding rate payment between long and short holders
Tip: See HypercoreFundingEvent for full field details including nested objects.
FieldTypeDescription
hashstringTransaction/event hash from the Hypercore L1
timestringISO-8601 timestamp of the funding event
szistringPosition size indicator at the time of funding
funding_amountstringFunding payment amount in USDC
coinstringMarket/coin symbol (e.g. ETH, BTC)
funding_ratestringFunding rate applied for this settlement

Hypercore Ledger Event

Decoded details for a Hypercore ledger update (withdraw, deposit, transfer, liquidation, etc.)
Tip: See HypercoreLedgerEvent for full field details including nested objects.
FieldTypeDescription
deltaLedgerDeltaSubtype-specific ledger delta payload
hashstringTransaction/event hash from the Hypercore L1
ledger_typestringLedger subtype discriminator (e.g. withdraw, deposit, spot_transfer, send)
timestringISO-8601 timestamp of the ledger event

Hypercore Withdrawal Event

Decoded details for a finalized Hypercore cross-chain withdrawal
Tip: See HypercoreWithdrawalEvent for full field details including nested objects.
FieldTypeDescription
hashstringTransaction/event hash from the Hypercore L1
timestringISO-8601 timestamp of the withdrawal event
amountstringWithdrawal amount in USDC

Swap

Decoded details for a token swap on a decentralized exchange
Tip: See SwapTransaction for full field details including nested objects.
FieldTypeDescription
amount_outstringAmount of tokens received
amount_instringAmount of tokens sold
token_outTokenContractMetadataMetadata for the token bought
token_inTokenContractMetadataMetadata for the token sold

Transfer

Decoded details for a token transfer between addresses
Tip: See TransferTransaction for full field details including nested objects.
FieldTypeDescription
amountstringAmount of tokens transferred
quote_usdfloatTotal USD value of the transferred amount
quote_rate_usdfloatUSD price per token at time of transfer
contract_metadataTokenContractMetadataMetadata for the transferred token contract
fromstringSender wallet address
tostringRecipient wallet address

Withdraw

Decoded details for a token withdrawal or liquidity removal
Tip: See WithdrawTransaction for full field details including nested objects.
FieldTypeDescription
amountstringAmount of tokens withdrawn
quote_usdfloatTotal USD value of the withdrawn amount
quote_rate_usdfloatUSD price per token at time of withdrawal
contract_metadataTokenContractMetadataMetadata for the withdrawn token contract
fromstringSource pool or contract address
tostringRecipient wallet address

Transaction Logs

Event log emitted during a transaction
Tip: See TransactionLog for full field details.
FieldTypeDescription
datastringABI-encoded log data
emitter_addressstringAddress of the contract that emitted the log
log_offsetintPosition of the log within the transaction
topicsarrayIndexed event parameters (topic[0] is the event signature hash)

Error

Decoded details for an unrecognized or failed transaction
Tip: See ErrorDetails for full field details.
FieldTypeDescription
messagestringError or status message describing the issue