> For the complete documentation index, see [llms.txt](https://effortless-labs.gitbook.io/hyperbola/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://effortless-labs.gitbook.io/hyperbola/apis-refrences/token-search.md).
# Token Search
## Search tokens
> Search for cryptocurrency tokens by name, symbol, or other attributes.\
> Uses intelligent search with fuzzy matching and ranking based on relevance.\
> \
> The search algorithm performs:\
> \- Exact matches (highest priority)\
> \- Prefix matches\
> \- Substring matches\
> \- Fuzzy matches with Levenshtein distance
````json
{"openapi":"3.0.3","info":{"title":"Hyperbola Mesh API","version":"1.0.0"},"tags":[{"name":"Tokens","description":"🪙 **Cryptocurrency Token Operations**\n\nAccess comprehensive cryptocurrency token data including metadata, descriptions, and links.\n\n{% hint style=\"success\" %}\n**Popular Tokens**: Try searching for `bitcoin`, `ethereum`, `solana`, or `cardano` to get started.\n{% endhint %}\n\n{% tabs %}\n{% tab title=\"Search Tokens\" %}\nUse intelligent search with fuzzy matching to find tokens by name, symbol, or description.\n\n**Features:**\n- Exact matches (highest priority)\n- Prefix matching\n- Substring matching \n- Fuzzy matching with Levenshtein distance\n{% endtab %}\n\n{% tab title=\"Lookup by Field\" %}\nGet tokens by specific fields like slug, symbol, or name for exact lookups.\n\n**Supported Fields:**\n- `slug`: Unique identifier (e.g., \"bitcoin\")\n- `symbol`: Token ticker (e.g., \"BTC\") \n- `name`: Full name (e.g., \"Bitcoin\")\n{% endtab %}\n{% endtabs %}\n\n{% openapi-schemas spec=\"index\" schemas=\"SearchToken\" grouped=\"false\" %}\n**Token Object Structure**\n\nThe SearchToken object contains essential information returned in search results.\n{% endopenapi-schemas %}\n"}],"servers":[{"url":"https://cell0.hyperbola.network","description":"🌟 Production Server (Recommended)"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","description":"**API Key Authentication**\n\nAll endpoints require a valid API key in the `x-api-key` header.\n\n**How to get your API key:**\n1. Contact the Hyperbola team at support@hyperbola.network\n2. Provide your use case and expected API usage\n3. Receive your unique API key via secure email\n\n**Using with Scalar/GitBook:**\n- Click the \"Test Request\" button on any endpoint\n- In the Authentication section, enter your API key\n- The key will be automatically added to all requests\n\n**Example:**\n```\nx-api-key: your-actual-api-key-here\n```\n\n**Security:**\n- Keep your API key secure and never expose it in client-side code\n- API keys are rate-limited and monitored for abuse\n- Contact support immediately if you suspect your key is compromised\n"}},"parameters":{"SearchQuery":{"name":"query","in":"query","required":true,"description":"Search query string for cryptocurrency tokens.\n\n**Tip**: Try searching for popular tokens like \"bitcoin\", \"ethereum\", or \"solana\"\n","schema":{"type":"string","minLength":1,"maxLength":100}}},"schemas":{"SearchToken":{"type":"object","title":"Basic Token Information","description":"Essential token information returned in search results","properties":{"name":{"type":"string","description":"Full name of the cryptocurrency token"},"symbol":{"type":"string","description":"Token symbol/ticker (usually uppercase)"},"logo":{"type":"string","format":"uri","description":"URL to the token's official logo image"},"slug":{"type":"string","description":"Unique slug identifier for the token (URL-friendly)"}},"required":["name","symbol","logo","slug"],"additionalProperties":false},"ValidationError":{"type":"object","title":"Validation Error Response","description":"Error response for request validation failures","properties":{"error":{"type":"object","description":"Validation error details","properties":{"message":{"type":"string","description":"General validation error message"},"fieldErrors":{"type":"object","description":"Field-specific validation errors","additionalProperties":{"type":"array","items":{"type":"string","maxLength":200}}}},"required":["fieldErrors"]}},"required":["error"],"additionalProperties":false},"Error":{"type":"object","title":"API Error Response","description":"Standard error response format","properties":{"error":{"type":"string","description":"Human-readable error message","maxLength":500},"code":{"type":"string","description":"Machine-readable error code"},"details":{"type":"object","description":"Additional error context and debugging information","additionalProperties":true}},"required":["error"],"additionalProperties":false}},"responses":{"BadRequestError":{"description":"Bad request - invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"UnauthorizedError":{"description":"Authentication required or invalid API key","content":{"text/plain":{"schema":{"type":"string"}}}},"TooManyRequestsError":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"InternalServerError":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/token/search":{"get":{"summary":"Search tokens","description":"Search for cryptocurrency tokens by name, symbol, or other attributes.\nUses intelligent search with fuzzy matching and ranking based on relevance.\n\nThe search algorithm performs:\n- Exact matches (highest priority)\n- Prefix matches\n- Substring matches\n- Fuzzy matches with Levenshtein distance\n","operationId":"searchTokens","tags":["Tokens"],"parameters":[{"$ref":"#/components/parameters/SearchQuery"}],"responses":{"200":{"description":"List of matching tokens","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SearchToken"}}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"429":{"$ref":"#/components/responses/TooManyRequestsError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}}
````
## Search tokens with pricing
> Search for cryptocurrency tokens and include current pricing data.\
> Combines the token search functionality with real-time price information.\
> \
> This endpoint performs the same intelligent search as \`/token/search\` but enriches \
> the results with current market pricing data for each token.
````json
{"openapi":"3.0.3","info":{"title":"Hyperbola Mesh API","version":"1.0.0"},"tags":[{"name":"Tokens","description":"🪙 **Cryptocurrency Token Operations**\n\nAccess comprehensive cryptocurrency token data including metadata, descriptions, and links.\n\n{% hint style=\"success\" %}\n**Popular Tokens**: Try searching for `bitcoin`, `ethereum`, `solana`, or `cardano` to get started.\n{% endhint %}\n\n{% tabs %}\n{% tab title=\"Search Tokens\" %}\nUse intelligent search with fuzzy matching to find tokens by name, symbol, or description.\n\n**Features:**\n- Exact matches (highest priority)\n- Prefix matching\n- Substring matching \n- Fuzzy matching with Levenshtein distance\n{% endtab %}\n\n{% tab title=\"Lookup by Field\" %}\nGet tokens by specific fields like slug, symbol, or name for exact lookups.\n\n**Supported Fields:**\n- `slug`: Unique identifier (e.g., \"bitcoin\")\n- `symbol`: Token ticker (e.g., \"BTC\") \n- `name`: Full name (e.g., \"Bitcoin\")\n{% endtab %}\n{% endtabs %}\n\n{% openapi-schemas spec=\"index\" schemas=\"SearchToken\" grouped=\"false\" %}\n**Token Object Structure**\n\nThe SearchToken object contains essential information returned in search results.\n{% endopenapi-schemas %}\n"}],"servers":[{"url":"https://cell0.hyperbola.network","description":"🌟 Production Server (Recommended)"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","description":"**API Key Authentication**\n\nAll endpoints require a valid API key in the `x-api-key` header.\n\n**How to get your API key:**\n1. Contact the Hyperbola team at support@hyperbola.network\n2. Provide your use case and expected API usage\n3. Receive your unique API key via secure email\n\n**Using with Scalar/GitBook:**\n- Click the \"Test Request\" button on any endpoint\n- In the Authentication section, enter your API key\n- The key will be automatically added to all requests\n\n**Example:**\n```\nx-api-key: your-actual-api-key-here\n```\n\n**Security:**\n- Keep your API key secure and never expose it in client-side code\n- API keys are rate-limited and monitored for abuse\n- Contact support immediately if you suspect your key is compromised\n"}},"parameters":{"SearchQuery":{"name":"query","in":"query","required":true,"description":"Search query string for cryptocurrency tokens.\n\n**Tip**: Try searching for popular tokens like \"bitcoin\", \"ethereum\", or \"solana\"\n","schema":{"type":"string","minLength":1,"maxLength":100}}},"schemas":{"SearchTokenWithPrice":{"type":"object","title":"Basic Token Information with Price","description":"Essential token information with current price data for search results","allOf":[{"$ref":"#/components/schemas/SearchToken"},{"type":"object","properties":{"price":{"type":"number","format":"float","description":"Current price in USD","minimum":0}},"required":["price"]}],"additionalProperties":false},"SearchToken":{"type":"object","title":"Basic Token Information","description":"Essential token information returned in search results","properties":{"name":{"type":"string","description":"Full name of the cryptocurrency token"},"symbol":{"type":"string","description":"Token symbol/ticker (usually uppercase)"},"logo":{"type":"string","format":"uri","description":"URL to the token's official logo image"},"slug":{"type":"string","description":"Unique slug identifier for the token (URL-friendly)"}},"required":["name","symbol","logo","slug"],"additionalProperties":false},"ValidationError":{"type":"object","title":"Validation Error Response","description":"Error response for request validation failures","properties":{"error":{"type":"object","description":"Validation error details","properties":{"message":{"type":"string","description":"General validation error message"},"fieldErrors":{"type":"object","description":"Field-specific validation errors","additionalProperties":{"type":"array","items":{"type":"string","maxLength":200}}}},"required":["fieldErrors"]}},"required":["error"],"additionalProperties":false},"Error":{"type":"object","title":"API Error Response","description":"Standard error response format","properties":{"error":{"type":"string","description":"Human-readable error message","maxLength":500},"code":{"type":"string","description":"Machine-readable error code"},"details":{"type":"object","description":"Additional error context and debugging information","additionalProperties":true}},"required":["error"],"additionalProperties":false}},"responses":{"BadRequestError":{"description":"Bad request - invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"UnauthorizedError":{"description":"Authentication required or invalid API key","content":{"text/plain":{"schema":{"type":"string"}}}},"TooManyRequestsError":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"InternalServerError":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/token/search/price":{"get":{"summary":"Search tokens with pricing","description":"Search for cryptocurrency tokens and include current pricing data.\nCombines the token search functionality with real-time price information.\n\nThis endpoint performs the same intelligent search as `/token/search` but enriches \nthe results with current market pricing data for each token.\n","operationId":"searchTokensWithPrice","tags":["Tokens"],"parameters":[{"$ref":"#/components/parameters/SearchQuery"}],"responses":{"200":{"description":"List of matching tokens with pricing data","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SearchTokenWithPrice"}}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"429":{"$ref":"#/components/responses/TooManyRequestsError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}}
````
## The SearchTokenWithPrice object
```json
{"openapi":"3.0.3","info":{"title":"Hyperbola Mesh API","version":"1.0.0"},"components":{"schemas":{"SearchTokenWithPrice":{"type":"object","title":"Basic Token Information with Price","description":"Essential token information with current price data for search results","allOf":[{"$ref":"#/components/schemas/SearchToken"},{"type":"object","properties":{"price":{"type":"number","format":"float","description":"Current price in USD","minimum":0}},"required":["price"]}],"additionalProperties":false},"SearchToken":{"type":"object","title":"Basic Token Information","description":"Essential token information returned in search results","properties":{"name":{"type":"string","description":"Full name of the cryptocurrency token"},"symbol":{"type":"string","description":"Token symbol/ticker (usually uppercase)"},"logo":{"type":"string","format":"uri","description":"URL to the token's official logo image"},"slug":{"type":"string","description":"Unique slug identifier for the token (URL-friendly)"}},"required":["name","symbol","logo","slug"],"additionalProperties":false}}}}
```
## The SearchToken object
```json
{"openapi":"3.0.3","info":{"title":"Hyperbola Mesh API","version":"1.0.0"},"components":{"schemas":{"SearchToken":{"type":"object","title":"Basic Token Information","description":"Essential token information returned in search results","properties":{"name":{"type":"string","description":"Full name of the cryptocurrency token"},"symbol":{"type":"string","description":"Token symbol/ticker (usually uppercase)"},"logo":{"type":"string","format":"uri","description":"URL to the token's official logo image"},"slug":{"type":"string","description":"Unique slug identifier for the token (URL-friendly)"}},"required":["name","symbol","logo","slug"],"additionalProperties":false}}}}
```