Input Objects

input BalancesInput {
  """The wallet address to filter by."""
  walletAddress: String
  """The network IDs to filter by."""
  networks: [Int!]
  """The token IDs (`address:networkId`) or addresses to request the balance for. Requires a list of `networks` if only passing addresses. Include native network balances using `native` as the token address. Only applied when using `walletAddress` (not `walletId`). Max 200 tokens."""
  tokens: [String!]
  """Whether to include native network balances in the response (ID will be native:<networkId>). Requires a list of `networks`. Does not apply when using `tokens`."""
  includeNative: Boolean
  """The maximum number of holdings to return. Does not apply when using `tokens`."""
  limit: Int
  """A cursor for use in pagination."""
  cursor: String
  """Whether to remove scam tokens from the response."""
  removeScams: Boolean
  """The ID of the wallet (`walletAddress:networkId`)."""
  walletId: String @deprecated(reason: "Use walletAddress and networkId instead")
  """Optional token specifically request the balance for. Only works with `walletId`."""
  filterToken: String @deprecated(reason: "Use tokens list instead")
}

"""Input options for the chart image."""
input ChartImageOptions {
  """The expiry time of the image in seconds. Max: 172800 (2 days). Default: 900 (15 minutes)."""
  expirationSeconds: Int
  """The width of the image in pixels. Max: 1200. Default: 800."""
  width: Int
  """The height of the image in pixels. Max: 1200. Default: 450."""
  height: Int
}

"""Input type of `chartUrls`."""
input ChartInput {
  """The input required to fetch a pair chart."""
  pair: PairChartInput
}

"""Filters for community notes."""
input CommunityNotesFilter {
  """The contract address of the contract."""
  address: String
  contractType: ContractType
  """The network ID the contract is deployed on."""
  networkId: [Int]
  """The type of the proposal."""
  proposalType: CommunityNoteType
}

"""Input type of `getCommunityNotes`."""
input CommunityNotesInput {
  """A set of filters to apply"""
  filter: CommunityNotesFilter
  """The maximum number of community notes to return."""
  limit: Int
  """The cursor to use for pagination."""
  cursor: String
}

"""Input for comparison operators."""
input ComparisonOperatorInput {
  """Greater than."""
  gt: String
  """Greater than or equal."""
  gte: String
  """Less than."""
  lt: String
  """Less than or equal."""
  lte: String
  """Equal to."""
  eq: String
}

input CreateApiTokensInput {
  """Number of tokens to create, default is 1"""
  count: Int
  """Number of requests allowed per token, represented as a string, default is 5000"""
  requestLimit: String
  """Number of seconds until the token expires, defaults to 1 hour (3600)"""
  expiresIn: Int
}

"""Input for creating a market cap webhook."""
input CreateMarketCapWebhookArgs {
  """The name of the webhook (max 128 characters)."""
  name: String!
  """The url to which the webhook message should be sent."""
  callbackUrl: String!
  """A string value to hash along with `deduplicationId` using SHA-256. Included in the webhook message for added security."""
  securityToken: String!
  """The recurrence of the webhook. Can be `INDEFINITE` or `ONCE`."""
  alertRecurrence: AlertRecurrence!
  """A webhook group ID (max 64 characters). Can be used to group webhooks so that their messages are kept in order as a group rather than by individual webhook."""
  groupId: String
  """The conditions which must be met in order for the webhook to send a message."""
  conditions: MarketCapEventWebhookConditionInput!
  """The settings for retrying failed webhook messages."""
  retrySettings: RetrySettingsInput
  """An optional bucket ID (max 64 characters). Can be used to query for subgroups of webhooks (useful if you have a large number of webhooks)."""
  bucketId: String
  """An optional bucket sort key (max 64 characters). Can be used to query for subgroups of webhooks (useful if you have a large number of webhooks)."""
  bucketSortkey: String
  """The type of publishing for the webhook. If not set, it defaults to `SINGLE`."""
  publishingType: PublishingType
  """If enabled, new webhooks won't be created if a webhook with the same parameters already exists. If callbackUrl, conditions, publishingType, and alertRecurrence all match, then we return the existing webhook."""
  deduplicate: Boolean
}

"""Input for creating market cap webhooks."""
input CreateMarketCapWebhooksInput {
  """A list of market cap webhooks to create."""
  webhooks: [CreateMarketCapWebhookArgs!]!
}

"""Input for creating an NFT event webhook."""
input CreateNftEventWebhookArgs {
  """The name of the webhook (max 128 characters)."""
  name: String!
  """The url to which the webhook message should be sent."""
  callbackUrl: String!
  """A string value to hash along with `deduplicationId` using SHA-256. Included in the webhook message for added security."""
  securityToken: String!
  """The recurrence of the webhook. Can be `INDEFINITE` or `ONCE`."""
  alertRecurrence: AlertRecurrence!
  """A webhook group ID (max 64 characters). Can be used to group webhooks so that their messages are kept in order as a group rather than by individual webhook."""
  groupId: String
  """The conditions which must be met in order for the webhook to send a message."""
  conditions: NftEventWebhookConditionInput!
  """The settings for retrying failed webhook messages."""
  retrySettings: RetrySettingsInput
  """An optional bucket ID (max 64 characters). Can be used to query for subgroups of webhooks (useful if you have a large number of webhooks)."""
  bucketId: String
  """An optional bucket sort key (max 64 characters). Can be used to query for subgroups of webhooks (useful if you have a large number of webhooks)."""
  bucketSortkey: String
  """The type of publishing for the webhook. If not set, it defaults to `SINGLE`."""
  publishingType: PublishingType
  """If enabled, new webhooks won't be created if a webhook with the same parameters already exists. If callbackUrl, conditions, publishingType, and alertRecurrence all match, then we return the existing webhook."""
  deduplicate: Boolean
}

"""Input for creating NFT event webhooks."""
input CreateNftEventWebhooksInput {
  """A list of NFT event webhooks to create."""
  webhooks: [CreateNftEventWebhookArgs!]!
}

"""Input for creating a price webhook."""
input CreatePriceWebhookArgs {
  """The name of the webhook (max 128 characters)."""
  name: String!
  """The url to which the webhook message should be sent."""
  callbackUrl: String!
  """A string value to hash along with `deduplicationId` using SHA-256. Included in the webhook message for added security."""
  securityToken: String!
  """The recurrence of the webhook. Can be `INDEFINITE` or `ONCE`."""
  alertRecurrence: AlertRecurrence!
  """A webhook group ID (max 64 characters). Can be used to group webhooks so that their messages are kept in order as a group rather than by individual webhook."""
  groupId: String
  """The conditions which must be met in order for the webhook to send a message."""
  conditions: PriceEventWebhookConditionInput!
  """The settings for retrying failed webhook messages."""
  retrySettings: RetrySettingsInput
  """An optional bucket ID (max 64 characters). Can be used to query for subgroups of webhooks (useful if you have a large number of webhooks)."""
  bucketId: String
  """An optional bucket sort key (max 64 characters). Can be used to query for subgroups of webhooks (useful if you have a large number of webhooks)."""
  bucketSortkey: String
  """The type of publishing for the webhook. If not set, it defaults to `SINGLE`."""
  publishingType: PublishingType
  """If enabled, new webhooks won't be created if a webhook with the same parameters already exists. If callbackUrl, conditions, publishingType, and alertRecurrence all match, then we return the existing webhook."""
  deduplicate: Boolean
}

"""Input for creating price webhooks."""
input CreatePriceWebhooksInput {
  """A list of price webhooks to create."""
  webhooks: [CreatePriceWebhookArgs!]!
}

"""Input for creating a Raw Transaction webhook."""
input CreateRawTransactionWebhookArgs {
  """The name of the webhook (max 128 characters)."""
  name: String!
  """The url to which the webhook message should be sent."""
  callbackUrl: String!
  """A string value to hash along with `deduplicationId` using SHA-256. Included in the webhook message for added security."""
  securityToken: String!
  """The recurrence of the webhook. Can be `INDEFINITE` or `ONCE`."""
  alertRecurrence: AlertRecurrence!
  """A webhook group ID (max 64 characters). Can be used to group webhooks so that their messages are kept in order as a group rather than by individual webhook."""
  groupId: String
  """The conditions which must be met in order for the webhook to send a message."""
  conditions: RawTransactionWebhookConditionInput!
  """The settings for retrying failed webhook messages."""
  retrySettings: RetrySettingsInput
  """An optional bucket ID (max 64 characters). Can be used to query for subgroups of webhooks (useful if you have a large number of webhooks)."""
  bucketId: String
  """An optional bucket sort key (max 64 characters). Can be used to query for subgroups of webhooks (useful if you have a large number of webhooks)."""
  bucketSortkey: String
  """The type of publishing for the webhook. If not set, it defaults to `SINGLE`."""
  publishingType: PublishingType
  """If enabled, new webhooks won't be created if a webhook with the same parameters already exists. If callbackUrl, conditions, publishingType, and alertRecurrence all match, then we return the existing webhook."""
  deduplicate: Boolean
}

"""Input for creating Raw Transaction webhooks."""
input CreateRawTransactionWebhooksInput {
  """A list of Raw Transaction webhooks to create."""
  webhooks: [CreateRawTransactionWebhookArgs!]!
}

"""Input for creating a token pair event webhook."""
input CreateTokenPairEventWebhookArgs {
  """The name of the webhook (max 128 characters)."""
  name: String!
  """The url to which the webhook message should be sent."""
  callbackUrl: String!
  """A string value to hash along with `deduplicationId` using SHA-256. Included in the webhook message for added security."""
  securityToken: String!
  """The recurrence of the webhook. Can be `INDEFINITE` or `ONCE`."""
  alertRecurrence: AlertRecurrence!
  """A webhook group ID (max 64 characters). Can be used to group webhooks so that their messages are kept in order as a group rather than by individual webhook."""
  groupId: String
  """The conditions which must be met in order for the webhook to send a message."""
  conditions: TokenPairEventWebhookConditionInput!
  """The settings for retrying failed webhook messages."""
  retrySettings: RetrySettingsInput
  """An optional bucket ID (max 64 characters). Can be used to query for subgroups of webhooks (useful if you have a large number of webhooks)."""
  bucketId: String
  """An optional bucket sort key (max 64 characters). Can be used to query for subgroups of webhooks (useful if you have a large number of webhooks)."""
  bucketSortkey: String
  """The type of publishing for the webhook. If not set, it defaults to `SINGLE`."""
  publishingType: PublishingType
  """If enabled, new webhooks won't be created if a webhook with the same parameters already exists. If callbackUrl, conditions, publishingType, and alertRecurrence all match, then we return the existing webhook."""
  deduplicate: Boolean
}

"""Input for creating token pair event webhooks."""
input CreateTokenPairEventWebhooksInput {
  """A list of token pair event webhooks to create."""
  webhooks: [CreateTokenPairEventWebhookArgs!]!
}

"""Input for creating webhooks."""
input CreateWebhooksInput {
  """Input for creating price webhooks."""
  priceWebhooksInput: CreatePriceWebhooksInput
  """Input for creating token pair event webhooks."""
  tokenPairEventWebhooksInput: CreateTokenPairEventWebhooksInput
  """Input for creating NFT event webhooks."""
  nftEventWebhooksInput: CreateNftEventWebhooksInput
  """Input for creating raw transaction webhooks."""
  rawTransactionWebhooksInput: CreateRawTransactionWebhooksInput
  """Input for creating market cap webhooks."""
  marketCapWebhooksInput: CreateMarketCapWebhooksInput
}

"""Input for deleting webhooks."""
input DeleteWebhooksInput {
  """A list of webhook IDs to delete."""
  webhookIds: [String!]!
}

"""The input for detailed wallet stats."""
input DetailedWalletStatsInput {
  """The wallet address"""
  walletAddress: String!
  """The network ID"""
  networkId: Int
  """The timestamp to get stats for"""
  timestamp: Int
  """Whether to include network breakdown stats"""
  includeNetworkBreakdown: Boolean
}

"""Input type of `EventQueryTimestamp`."""
input EventQueryTimestampInput {
  """The unix timestamp for the start of the requested range."""
  from: Int!
  """The unix timestamp for the end of the requested range."""
  to: Int!
}

"""Input type of `EventsQuery`."""
input EventsQueryInput {
  """The pair contract address to filter by. If you pass a token address in here, it will instead find the top pair for that token and use that."""
  address: String!
  """The token of interest. Can be `token0` or `token1`."""
  quoteToken: QuoteToken
  """The amount of `quoteToken` involved in the swap."""
  amountNonLiquidityToken: NumberFilter
  """The list of event display types to filter by."""
  eventDisplayType: [EventDisplayType]
  """The specific event type to filter by."""
  eventType: EventType
  """The specific wallet address to filter by."""
  maker: String
  """The network ID to filter by."""
  networkId: Int!
  """The time range to filter by."""
  timestamp: EventQueryTimestampInput
  """The price per `quoteToken` at the time of the swap in the network's base token."""
  priceBaseToken: NumberFilter
  """The total amount of `quoteToken` involved in the swap in the network's base token (`amountNonLiquidityToken` x `priceBaseToken`)."""
  priceBaseTokenTotal: NumberFilter
  """The price per `quoteToken` at the time of the swap in USD."""
  priceUsd: NumberFilter
  """The total amount of `quoteToken` involved in the swap in USD (`amountNonLiquidityToken` x `priceUsd`)."""
  priceUsdTotal: NumberFilter
  """Specify the type of symbol you want to fetch values for (TOKEN | POOL)"""
  symbolType: SymbolType
}

"""Input type of `ExchangeFilters`."""
input ExchangeFilters {
  """The number of transactions on the exchange in the past hour."""
  txnCount1: StringFilter
  """The number of transactions on the exchange in the past 4 hours."""
  txnCount4: StringFilter
  """The number of transactions on the exchange in the past 12 hours."""
  txnCount12: StringFilter
  """The number of transactions on the exchange in the past 24 hours."""
  txnCount24: StringFilter
  """The trade volume in USD in the past hour."""
  volumeUSD1: StringFilter
  """The trade volume in USD in the past 4 hours."""
  volumeUSD4: StringFilter
  """The trade volume in USD in the past 12 hours."""
  volumeUSD12: StringFilter
  """The trade volume in USD in the past 24 hours."""
  volumeUSD24: StringFilter
  """The trade volume in the network's base token in the past hour."""
  volumeNBT1: StringFilter
  """The trade volume in the network's base token in the past 4 hours."""
  volumeNBT4: StringFilter
  """The trade volume in the network's base token in the past 12 hours."""
  volumeNBT12: StringFilter
  """The trade volume in the network's base token in the past 24 hours."""
  volumeNBT24: StringFilter
  """The total unique daily active users."""
  dailyActiveUsers: NumberFilter
  """The total unique monthly active users (30 days)."""
  monthlyActiveUsers: NumberFilter
  """The list of exchange contract addresses to filter by."""
  address: [String]
  """The list of network IDs to filter by."""
  network: [Int]
  """Scope to only verified exchanges"""
  verified: Boolean
}

"""Input type of `ExchangeRanking`."""
input ExchangeRanking {
  """The attribute to rank exchanges by."""
  attribute: ExchangeRankingAttribute
  """The direction to apply to the ranking attribute."""
  direction: RankingDirection
}

"""Filter for fillsource based NFT stats."""
input FillsourceStatsFilter {
  """The fillsource to target for the current window."""
  fillsource: String!
  """The total value for the current window."""
  current: NumberFilter
  """The total value for the previous window."""
  previous: NumberFilter
  """The percent change between the `current` and `previous`."""
  change: NumberFilter
}

"""The input for filtering wallets for a network."""
input FilterNetworkWalletsInput {
  """The network ID to filter wallets for"""
  networkId: Int!
  """A set of filters to apply."""
  filters: WalletNetworkFilters
  """A list of wallet addresses to filter by."""
  wallets: [String]
  """Exclude wallets with these labels. See [`WalletLabel`](/api-reference/enums/index#walletlabel) for possible values."""
  excludeLabels: [String]
  """Include wallets with these labels. See [`WalletLabel`](/api-reference/enums/index#walletlabel) for possible values."""
  includeLabels: [String]
  """A list of ranking attributes to apply."""
  rankings: [WalletNetworkRanking]
  """The maximum number of wallets to return."""
  limit: Int
  """Where in the list the server should start when returning items. Use `count`+`offset` from the previous query to request the next page of results."""
  offset: Int
}

"""The input for filtering wallets for a token."""
input FilterTokenWalletsInput {
  """The ID of the token to filter wallets for"""
  tokenId: String
  """The wallet address to filter wallets for"""
  walletAddress: String @deprecated(reason: "Use wallets instead")
  """A list of wallet addresses to filter wallets for"""
  wallets: [String]
  """The network ID to filter wallets for"""
  networkId: Int
  """A set of filters to apply"""
  filters: WalletTokenFilters @deprecated(reason: "Use filtersV2 instead")
  """A set of filters to apply"""
  filtersV2: WalletTokenFiltersV2
  """A phrase to search for in token symbol and name"""
  phrase: String
  """A list of ranking attributes to apply"""
  rankings: [WalletTokenRanking]
  """Exclude wallets with these labels. See [`WalletLabel`](/api-reference/enums/index#walletlabel) for possible values."""
  excludeLabels: [String]
  """Include wallets with these labels. See [`WalletLabel`](/api-reference/enums/index#walletlabel) for possible values."""
  includeLabels: [String]
  """The maximum number of wallets to return"""
  limit: Int
  """Where in the list the server should start when returning items"""
  offset: Int
}

"""The input for filtering wallets."""
input FilterWalletsInput {
  """A set of filters to apply."""
  filters: WalletFilters
  """A list of wallet addresses to filter by."""
  wallets: [String]
  """Exclude wallets with these labels. See [`WalletLabel`](/api-reference/enums/index#walletlabel) for possible values."""
  excludeLabels: [String]
  """Include wallets with these labels. See [`WalletLabel`](/api-reference/enums/index#walletlabel) for possible values."""
  includeLabels: [String]
  """A list of ranking attributes to apply."""
  rankings: [WalletRanking]
  """The maximum number of wallets to return."""
  limit: Int
  """Where in the list the server should start when returning items. Use `count`+`offset` from the previous query to request the next page of results."""
  offset: Int
}

"""Input type of `getDetailedPairsStats`."""
input GetDetailedPairsStatsInput {
  """The contract address of the pair."""
  pairAddress: String!
  """The network ID the pair is deployed on."""
  networkId: Int!
  """The token of interest used to calculate token-specific stats for the pair. Can be `token0` or `token1`."""
  tokenOfInterest: TokenOfInterest
  """The unix timestamp for the stats. Defaults to current."""
  timestamp: Int
  """The list of durations to get detailed pair stats for."""
  durations: [DetailedPairStatsDuration]
  """The number of aggregated values to receive. Note: Each duration has predetermined bucket sizes. The first n-1 buckets are historical. The last bucket is a snapshot of current data. duration `day1`: 6 buckets (4 hours each) plus 1 partial bucket duration `hour12`: 12 buckets (1 hour each) plus 1 partial bucket duration `hour4`: 8 buckets (30 min each) plus 1 partial bucket duration `hour1`: 12 buckets (5 min each) plus 1 partial bucket duration `min5`: 5 buckets (1 min each) plus 1 partial bucket For example, requesting 11 buckets for a `min5` duration will return the last 10 minutes worth of data plus a snapshot for the current minute."""
  bucketCount: Int
  """The type of statistics returned. Can be `FILTERED` or `UNFILTERED`"""
  statsType: TokenPairStatisticsType
}

"""Input type of `getTokenPrices`."""
input GetPriceInput {
  """The contract address of the token."""
  address: String!
  """The network ID the token is deployed on."""
  networkId: Int!
  """The unix timestamp for the price."""
  timestamp: Int
  """The address of the pool, when omitted the top pool is used."""
  poolAddress: String
  """The maximum number of deviations from the token's Liquidity-Weighted Mean Price. This is used to mitigate low liquidity pairs producing prices that are not representative of reality. Default is `1`."""
  maxDeviations: Float @deprecated(reason: "This isn't taken into account anymore.")
}

"""Input type of `getTokensInfo`."""
input GetTokensInfoInput {
  """The contract address of the token."""
  address: String!
  """The network ID the token is deployed on."""
  networkId: Int!
}

input HoldersInput {
  """The ID of the token (`tokenAddress:networkId`)."""
  tokenId: String!
  """The maximum number of holders to return. Default is 50, maximum is 200."""
  limit: Int
  """A cursor for use in pagination."""
  cursor: String
  """The attribute to sort the list on"""
  sort: HoldersInputSort
}

input HoldersInputSort {
  """The attribute to sort the list on"""
  attribute: HoldersSortAttribute
  """The direction to apply to the ranking attribute."""
  direction: RankingDirection
}

"""Input for integer equals condition."""
input IntEqualsConditionInput {
  """The integer to equal."""
  eq: Int!
}

input MakerEventsQueryInput {
  """The specific wallet address to filter by."""
  maker: String!
  """The time range to filter by."""
  timestamp: EventQueryTimestampInput
  """The network ID to filter by."""
  networkId: Int
  """The total amount of `quoteToken` involved in the swap in USD (`amountNonLiquidityToken` x `priceUsd`)."""
  priceUsdTotal: NumberFilter
  """The specific event type to filter by."""
  eventType: EventType
  """The token involved in the event."""
  tokenAddress: String
}

"""Input conditions for a market cap event webhook."""
input MarketCapEventWebhookConditionInput {
  """The contract address of the token to listen for."""
  tokenAddress: StringEqualsConditionInput!
  """The network ID to listen on."""
  networkId: IntEqualsConditionInput!
  """The price conditions to listen for."""
  fdvMarketCapUsd: ComparisonOperatorInput
  """The circulating market cap conditions to listen for."""
  circulatingMarketCapUsd: ComparisonOperatorInput
  """The contract address of the pair to listen for."""
  pairAddress: StringEqualsConditionInput
}

"""Input filters for `filterNftCollections`."""
input NftCollectionFilters {
  """The total supply of the NFT collection."""
  totalSupply: NumberFilter
  """The unix timestamp for the last event."""
  lastEventTimestamp: NumberFilter
  """The list of token standards to filter by."""
  ercType: [NftContractErcType]
  """The list of network IDs to filter by."""
  network: [Int]
  """Stats for the past hour."""
  stats1h: NftStatsWindowFilter
  """Stats for the past 4 hours."""
  stats4h: NftStatsWindowFilter
  """Stats for the past 12 hours."""
  stats12h: NftStatsWindowFilter
  """Stats for the past 24 hours."""
  stats24h: NftStatsWindowFilter
}

"""Input type of `NftCollectionRanking`."""
input NftCollectionRanking {
  """The attribute to rank NFT collections by."""
  attribute: NftCollectionRankingAttribute
  """The direction to apply to the ranking attribute."""
  direction: RankingDirection
}

"""Input type of `getNftContracts`."""
input NftContractInput {
  """The NFT contract address."""
  address: String!
  """The network ID the NFT collection is deployed on."""
  networkId: Int!
}

"""Input for NFT event fill source condition."""
input NftEventFillSourceConditionInput {
  """The list of NFT marketplace to equal."""
  oneOf: [WebhookNftEventFillSource!]!
}

"""Input for NFT event type."""
input NftEventTypeConditionInput {
  """The NFT event type to equal."""
  eq: WebhookNftEventType!
}

"""Input conditions for an NFT event webhook."""
input NftEventWebhookConditionInput {
  """A list of network IDs to listen on."""
  networkId: OneOfNumberConditionInput
  """The maker wallet address to listen for."""
  maker: StringEqualsConditionInput
  """The NFT collection contract address to listen for."""
  contractAddress: StringEqualsConditionInput
  """The exchange contract address to listen for."""
  exchangeAddress: StringEqualsConditionInput
  """The token ID to listen for."""
  tokenId: StringEqualsConditionInput
  """The NFT event type to listen for."""
  eventType: NftEventTypeConditionInput
  """The NFT marketplaces to listen for."""
  fillSource: NftEventFillSourceConditionInput
  """Option to ignore all nft transfer events"""
  ignoreTransfers: Boolean
}

input NftHoldersInput {
  """The address of the collection contract."""
  collectionAddress: String!
  """The network ID the collection is deployed on."""
  networkId: Int!
  """A cursor for use in pagination."""
  cursor: String
}