> 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/token-info.md).

# Token Info

## Get tokens by field

> Retrieve complete token information by a specific field (slug, symbol, or name).\
> This endpoint returns full TokenInfo objects with all metadata.<br>

````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":{"TokenField":{"name":"field","in":"path","required":true,"description":"The field to search by. Choose from available options:\n- **slug**: Unique token identifier (recommended)\n- **symbol**: Token ticker (e.g., BTC, ETH)\n- **name**: Full token name\n","schema":{"type":"string","enum":["slug","symbol","name"]}},"TokenValue":{"name":"value","in":"path","required":true,"description":"The value to search for in the specified field.\n\n**Examples by field:**\n- slug: \"bitcoin\", \"ethereum\"\n- symbol: \"BTC\", \"ETH\" \n- name: \"Bitcoin\", \"Ethereum\"\n","schema":{"type":"string","minLength":1,"maxLength":100}}},"schemas":{"TokenInfo":{"type":"object","title":"Complete Token Information","description":"Comprehensive information about a cryptocurrency token including metadata, contracts, and URLs","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)"},"contracts":{"type":"array","description":"Array of contract addresses across different blockchain networks","items":{"$ref":"#/components/schemas/TokenContract"}},"urls":{"type":"object","description":"Collection of official URLs and social media links for the token","properties":{"website":{"type":"array","items":{"type":"string","format":"uri"},"description":"Official website URLs"},"twitter":{"type":"array","items":{"type":"string","format":"uri"},"description":"Official Twitter/X profile URLs"},"messageBoard":{"type":"array","items":{"type":"string","format":"uri"},"description":"Official message board/forum URLs"},"chat":{"type":"array","items":{"type":"string","format":"uri"},"description":"Official chat/Discord URLs"},"facebook":{"type":"array","items":{"type":"string","format":"uri"},"description":"Official Facebook page URLs"},"explorer":{"type":"array","items":{"type":"string","format":"uri"},"description":"Blockchain explorer URLs"},"reddit":{"type":"array","items":{"type":"string","format":"uri"},"description":"Official Reddit community URLs"},"technicalDoc":{"type":"array","items":{"type":"string","format":"uri"},"description":"Technical documentation URLs"},"sourceCode":{"type":"array","items":{"type":"string","format":"uri"},"description":"Source code repository URLs"},"announcement":{"type":"array","items":{"type":"string","format":"uri"},"description":"Official announcement URLs"}},"required":["website","twitter","messageBoard","chat","facebook","explorer","reddit","technicalDoc","sourceCode","announcement"]},"dateLaunched":{"type":"string","format":"date","nullable":true,"description":"Date when the token was launched (ISO 8601 format)"},"dateAdded":{"type":"string","format":"date","description":"Date when the token was added to the database (ISO 8601 format)"},"infiniteSupply":{"type":"boolean","description":"Whether the token has an infinite supply"},"selfReportedCirculatingSupply":{"type":"number","nullable":true,"description":"Self-reported circulating supply by the project"},"selfReportedTags":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Self-reported tags/categories by the project"},"selfReportedMarketCap":{"type":"number","nullable":true,"description":"Self-reported market capitalization by the project"}},"required":["name","symbol","logo","slug","contracts","urls","dateLaunched","dateAdded","infiniteSupply","selfReportedCirculatingSupply","selfReportedTags","selfReportedMarketCap"],"additionalProperties":false},"TokenContract":{"type":"object","title":"Token Contract Information","description":"Contract address and network information for a cryptocurrency token","properties":{"address":{"type":"string","description":"Smart contract address on the blockchain"},"network":{"type":"string","description":"Blockchain network name"}},"required":["address","network"],"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"}}}},"NotFoundError":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"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/by/{field}/{value}":{"get":{"summary":"Get tokens by field","description":"Retrieve complete token information by a specific field (slug, symbol, or name).\nThis endpoint returns full TokenInfo objects with all metadata.\n","operationId":"getTokensByField","tags":["Tokens"],"parameters":[{"$ref":"#/components/parameters/TokenField"},{"$ref":"#/components/parameters/TokenValue"}],"responses":{"200":{"description":"Complete token information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenInfo"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"404":{"$ref":"#/components/responses/NotFoundError"},"429":{"$ref":"#/components/responses/TooManyRequestsError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}}
````

## The TokenInfo object

```json
{"openapi":"3.0.3","info":{"title":"Hyperbola Mesh API","version":"1.0.0"},"components":{"schemas":{"TokenInfo":{"type":"object","title":"Complete Token Information","description":"Comprehensive information about a cryptocurrency token including metadata, contracts, and URLs","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)"},"contracts":{"type":"array","description":"Array of contract addresses across different blockchain networks","items":{"$ref":"#/components/schemas/TokenContract"}},"urls":{"type":"object","description":"Collection of official URLs and social media links for the token","properties":{"website":{"type":"array","items":{"type":"string","format":"uri"},"description":"Official website URLs"},"twitter":{"type":"array","items":{"type":"string","format":"uri"},"description":"Official Twitter/X profile URLs"},"messageBoard":{"type":"array","items":{"type":"string","format":"uri"},"description":"Official message board/forum URLs"},"chat":{"type":"array","items":{"type":"string","format":"uri"},"description":"Official chat/Discord URLs"},"facebook":{"type":"array","items":{"type":"string","format":"uri"},"description":"Official Facebook page URLs"},"explorer":{"type":"array","items":{"type":"string","format":"uri"},"description":"Blockchain explorer URLs"},"reddit":{"type":"array","items":{"type":"string","format":"uri"},"description":"Official Reddit community URLs"},"technicalDoc":{"type":"array","items":{"type":"string","format":"uri"},"description":"Technical documentation URLs"},"sourceCode":{"type":"array","items":{"type":"string","format":"uri"},"description":"Source code repository URLs"},"announcement":{"type":"array","items":{"type":"string","format":"uri"},"description":"Official announcement URLs"}},"required":["website","twitter","messageBoard","chat","facebook","explorer","reddit","technicalDoc","sourceCode","announcement"]},"dateLaunched":{"type":"string","format":"date","nullable":true,"description":"Date when the token was launched (ISO 8601 format)"},"dateAdded":{"type":"string","format":"date","description":"Date when the token was added to the database (ISO 8601 format)"},"infiniteSupply":{"type":"boolean","description":"Whether the token has an infinite supply"},"selfReportedCirculatingSupply":{"type":"number","nullable":true,"description":"Self-reported circulating supply by the project"},"selfReportedTags":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Self-reported tags/categories by the project"},"selfReportedMarketCap":{"type":"number","nullable":true,"description":"Self-reported market capitalization by the project"}},"required":["name","symbol","logo","slug","contracts","urls","dateLaunched","dateAdded","infiniteSupply","selfReportedCirculatingSupply","selfReportedTags","selfReportedMarketCap"],"additionalProperties":false},"TokenContract":{"type":"object","title":"Token Contract Information","description":"Contract address and network information for a cryptocurrency token","properties":{"address":{"type":"string","description":"Smart contract address on the blockchain"},"network":{"type":"string","description":"Blockchain network name"}},"required":["address","network"],"additionalProperties":false}}}}
```