Get Token Events

Returns transactions for a pair.

Endpoint: getTokenEvents

Method: POST

Arguments

NameTypeDescription
cursorString

The cursor to use for pagination.

directionRankingDirection

The order to receive the token events. Can be DESC (default) or ASC.

limitInt

The maximum number of transactions to return.

queryEventsQueryInput!

The query filters to apply to the results.

Required

NameTypeDescription
addressString!

The pair contract address to filter by.

Required
amountNonLiquidityTokenNumberFilter

The amount of quoteToken involved in the swap.

eventDisplayType[EventDisplayType]

The list of event display types to filter by.

eventTypeEventType

The specific event type to filter by.

makerString

The specific wallet address to filter by.

networkIdInt!

The network ID to filter by.

Required
priceBaseTokenNumberFilter

The price per quoteToken at the time of the swap in the network's base token.

priceBaseTokenTotalNumberFilter

The total amount of quoteToken involved in the swap in the network's base token (amountNonLiquidityToken x priceBaseToken).

priceUsdNumberFilter

The price per quoteToken at the time of the swap in USD.

priceUsdTotalNumberFilter

The total amount of quoteToken involved in the swap in USD (amountNonLiquidityToken x priceUsd).

quoteTokenQuoteToken

The token of interest. Can be token0 or token1.

timestampEventQueryTimestampInput

The time range to filter by.

Response

NameTypeDescription
cursorStringA cursor for use in pagination.
items[Event]A list of transactions for a token's top pair.

NameTypeDescription
addressString!The contract address of the token's top pair.
baseTokenPriceStringThe price of the network's base token.
blockHashString!The hash of the block where the transaction occurred.
blockNumberInt!The block number for the transaction.
dataEventDataThe event-specific data for the transaction. Can be BurnEventData or MintEventData or SwapEventData.
eventDisplayTypeEventDisplayTypeA more specific breakdown of eventType. Splits Swap into Buy or Sell.
eventTypeEventType!The type of transaction event. Can be Burn, Mint, Swap, Sync, Collect, or CollectProtocol.
idString!The ID of the event (address:networkId). For example, 0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2:1.
labelsLabelsForEventLabels attributed to the event.
liquidityTokenStringThe contract address of the token with higher liquidity in the token's top pair.
logIndexInt!The index of the log in the block.
makerStringThe wallet address that performed the transaction.
networkIdInt!The network ID that the token is deployed on.
quoteTokenQuoteTokenThe token of interest within the token's top pair. Can be token0 or token1.
timestampInt!The unix timestamp for when the transaction occurred.
token0PoolValueUsdStringThe updated price of token0 in USD, calculated after the transaction.
token0SwapValueUsdStringThe price of token0 paid/received in USD, including any fees.
token0ValueBaseStringThe price of token0 paid/received in the network's base token, including fees.
token1PoolValueUsdStringThe updated price of token1 in USD, calculated after the transaction.
token1SwapValueUsdStringThe price of token1 paid/received in USD, including any fees.
token1ValueBaseStringThe price of token1 paid/received in the network's base token, including fees.
transactionHashString!The unique hash for the transaction.
transactionIndexInt!The index of the transaction within the block.

πŸ“˜

Reverse the order in which token events are returned using direction: ASC to find the initial liquidity event. Filtering early events by maker can help with the detection of scams and price manipulation.

Explore

πŸ‘‹

Join our Discord

Ask questions, share what you're working on and request new features :two-men-holding-hands::two-women-holding-hands: