📖
Xerberus
xerberus.io
  • APIs
    • Getting Started
    • Risk Ratings API
      • Index Ratings
      • Cardano
      • Ethereum
      • Polygon
      • API Response Signature Headers
  • AI Agent API
    • Introduction
    • Tokens
      • Query: tokens
      • Query: tokensBySimilarSymbol
      • Query: tokensBySimilarAddress
    • Metrics
      • Query: metrics
    • Chains
  • SIREN API
Powered by GitBook
On this page
  1. AI Agent API
  2. Tokens

Query: tokensBySimilarSymbol

Search for tokens by partial or full symbol substring. This performs a case-insensitive match on the token's symbol field and returns a paginated list of matches.

query TokensBySimilarSymbol($symbol: String!, $limit: Int, $offset: Int, $sortBy: String, $sortOrder: String) {
  tokensBySimilarSymbol(symbol: $symbol, limit: $limit, offset: $offset, sortBy: $sortBy, sortOrder: $sortOrder) {
    tokens {
      asset_id
      symbol
      chain
      address
      last_updated
    }
    total_count
  }
}

Arguments

Argument
Type
Description

symbol

String!

Substring to match against token symbols (case-insensitive)

limit

Int

(Default: 10) Maximum number of tokens to return

offset

Int

(Default: 0) Number of records to skip (for pagination)

sortBy

String

(Default: "Symbol") Field to sort by (e.g., symbol, chain, etc.)

sortOrder

String

(Default: "ASC") Sorting order, either ASC (ascending) or DESC

Returns

Returns a TokenPagination object:

TokenPagination

Field
Type
Description

tokens

[Token!]

List of tokens matching the search

total_count

Int

Total number of matches (before paging)


Token Object

Field
Type
Description

asset_id

ID!

Unique internal identifier for the token

symbol

String!

Token symbol (e.g., USDC, ETH)

chain

String!

Blockchain network name (e.g., ETHEREUM, POLYGON)

address

String!

Smart contract address of the token

last_updated

String!

ISO 8601 timestamp of the last metadata update

PreviousQuery: tokensNextQuery: tokensBySimilarAddress

Last updated 1 month ago