Token Info

Get tokens by field

get

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

Authorizations

ApiKeyAuth

x-api-keystringRequired

API Key Authentication

All endpoints require a valid API key in the x-api-key header.

How to get your API key:

1. Contact the Hyperbola team at [e-mail]
2. Provide your use case and expected API usage
3. Receive your unique API key via secure email

Using with Scalar/GitBook:

• Click the "Test Request" button on any endpoint
• In the Authentication section, enter your API key
• The key will be automatically added to all requests

Example:

x-api-key: your-actual-api-key-here

Security:

• Keep your API key secure and never expose it in client-side code
• API keys are rate-limited and monitored for abuse
• Contact support immediately if you suspect your key is compromised

Path parameters

fieldstring · enumRequired

The field to search by. Choose from available options:

• slug: Unique token identifier (recommended)
• symbol: Token ticker (e.g., BTC, ETH)
• name: Full token name

Example: {"summary":"Search by slug","value":"slug"}Possible values:

valuestring · min: 1 · max: 100Required

The value to search for in the specified field.

Examples by field:

• slug: "bitcoin", "ethereum"
• symbol: "BTC", "ETH"
• name: "Bitcoin", "Ethereum"

Example: {"summary":"Bitcoin slug","value":"bitcoin"}

Responses

200

Complete token information

application/json

Comprehensive information about a cryptocurrency token including metadata, contracts, and URLs

namestringRequired

Full name of the cryptocurrency token

Example: Bitcoin

symbolstringRequired

Token symbol/ticker (usually uppercase)

Example: BTC

logostring · uriRequired

URL to the token's official logo image

Example: https://cryptologos.cc/logos/bitcoin-btc-logo.png

slugstringRequired

Unique slug identifier for the token (URL-friendly)

Example: bitcoin

dateLaunchedstring · date · nullableRequired

Date when the token was launched (ISO 8601 format)

Example: 2009-01-03

dateAddedstring · dateRequired

Date when the token was added to the database (ISO 8601 format)

Example: 2013-04-28

infiniteSupplybooleanRequired

Whether the token has an infinite supply

Example: false

selfReportedCirculatingSupplynumber · nullableRequired

Self-reported circulating supply by the project

Example: 19500000

selfReportedTagsstring[] · nullableRequired

Self-reported tags/categories by the project

Example: ["cryptocurrency","store-of-value"]

selfReportedMarketCapnumber · nullableRequired

Self-reported market capitalization by the project

Example: 850000000000

400

Bad request - invalid parameters

application/json

401

Authentication required or invalid API key

text/plain

404

Resource not found

application/json

429

Rate limit exceeded

application/json

500

Internal server error

application/json

get

/token/by/{field}/{value}

HTTPcURLJavaScriptPython

GET /token/by/{field}/{value} HTTP/1.1
Host: cell0.hyperbola.network
x-api-key: YOUR_API_KEY
Accept: */*

{
  "name": "Bitcoin",
  "symbol": "BTC",
  "logo": "https://cryptologos.cc/logos/bitcoin-btc-logo.png",
  "slug": "bitcoin",
  "contracts": [
    {
      "address": "0x0000000000000000000000000000000000000000",
      "network": "ethereum"
    }
  ],
  "urls": {
    "website": [
      "https://bitcoin.org"
    ],
    "twitter": [
      "https://twitter.com/bitcoin"
    ],
    "messageBoard": [
      "https://bitcointalk.org"
    ],
    "chat": [],
    "facebook": [],
    "explorer": [
      "https://blockstream.info/"
    ],
    "reddit": [
      "https://reddit.com/r/Bitcoin"
    ],
    "technicalDoc": [
      "https://bitcoin.org/bitcoin.pdf"
    ],
    "sourceCode": [
      "https://github.com/bitcoin/bitcoin"
    ],
    "announcement": []
  },
  "dateLaunched": "2009-01-03",
  "dateAdded": "2013-04-28",
  "infiniteSupply": false,
  "selfReportedCirculatingSupply": null,
  "selfReportedTags": [
    "cryptocurrency",
    "store-of-value"
  ],
  "selfReportedMarketCap": null
}