Coins

Cryptocurrency metadata including descriptions, images, categories, market cap rankings, and multi-chain network information.

Coin metadata is sourced from CoinGecko and normalized into the Bitcompare API. Use this endpoint to resolve coin identifiers for use with rates, charts, and prices.

The coin model

Properties

  • Name
    id
    Type
    string
    Description

    Unique coin identifier (e.g., "bitcoin", "ethereum").

  • Name
    symbol
    Type
    string
    Description

    The ticker symbol (e.g., "btc", "eth").

  • Name
    name
    Type
    string
    Description

    Full coin name.

  • Name
    description
    Type
    string
    Description

    Coin description text.

  • Name
    homepage
    Type
    string
    Description

    Project homepage URL.

  • Name
    imageUrl
    Type
    string
    Description

    URL to the coin's logo image.

  • Name
    marketCapRank
    Type
    integer
    Description

    Current market cap ranking.

  • Name
    categories
    Type
    string[]
    Description

    Categories the coin belongs to (e.g., ["Cryptocurrency", "Layer 1"]).

  • Name
    platforms
    Type
    object
    Description

    Map of blockchain platform to contract address.

  • Name
    marketCap
    Type
    number
    Description

    Current market capitalization in USD.

  • Name
    currentPrice
    Type
    number
    Description

    Current price in USD.

  • Name
    priceChange24h
    Type
    number
    Description

    Price change in USD over the last 24 hours.

  • Name
    priceChangePercentage24h
    Type
    number
    Description

    Price change percentage over the last 24 hours.

  • Name
    totalVolume
    Type
    number
    Description

    24-hour trading volume in USD.

  • Name
    circulatingSupply
    Type
    number
    Description

    Coins currently in circulation.

  • Name
    totalSupply
    Type
    number
    Description

    Total supply of coins.

  • Name
    maxSupply
    Type
    number
    Description

    Maximum possible supply (null if unlimited).

GET/api/v1/coins/:coinId

Get coin by ID

Retrieve full metadata for a coin by its identifier.

Path parameters

  • Name
    coinId
    Type
    string
    Description

    Coin identifier (e.g., "bitcoin", "ethereum").

Request

GET
/api/v1/coins/bitcoin
curl https://api.bitcompare.net/api/v1/coins/bitcoin

Response

{
  "data": {
    "id": "bitcoin",
    "symbol": "btc",
    "name": "Bitcoin",
    "description": "Bitcoin is the first...",
    "homepage": "https://bitcoin.org",
    "imageUrl": "https://...",
    "marketCapRank": 1,
    "categories": ["Cryptocurrency", "Layer 1"],
    "platforms": {
      "ethereum": "0x..."
    },
    "marketCap": 900000000000,
    "currentPrice": 45000.50,
    "priceChange24h": 1000.00,
    "priceChangePercentage24h": 2.27,
    "totalVolume": 30000000000,
    "circulatingSupply": 19500000,
    "totalSupply": 21000000,
    "maxSupply": 21000000,
    "createdAt": "2025-10-29T14:00:00Z",
    "updatedAt": "2025-10-29T14:00:00Z"
  }
}
GET/api/v1/coins

Search coins

Search or list coins. When no search parameters are provided, returns a paginated list of all coins sorted by market cap rank.

Optional attributes

  • Name
    q
    Type
    string
    Description

    Search query matching name or symbol (e.g., "bitcoin", "btc").

  • Name
    symbol
    Type
    string
    Description

    Exact symbol match (e.g., "btc").

  • Name
    page
    Type
    integer
    Description

    Page number for pagination. Defaults to 1.

  • Name
    limit
    Type
    integer
    Description

    Results per page. Defaults to 20, max 500.

  • Name
    sort
    Type
    string
    Description

    Sort field: market_cap_rank, name, or symbol. Defaults to market_cap_rank.

  • Name
    order
    Type
    string
    Description

    Sort direction: asc or desc. Defaults to asc.

  • Name
    category
    Type
    string
    Description

    Filter by coin category.

  • Name
    has_rates
    Type
    boolean
    Description

    Filter to coins that have rate data available.

Request

GET
/api/v1/coins?q=bitcoin
curl -G https://api.bitcompare.net/api/v1/coins \
  -d q=bitcoin

Response

{
  "data": [
    {
      "id": "bitcoin",
      "symbol": "btc",
      "name": "Bitcoin",
      "marketCapRank": 1
    }
  ],
  "meta": {
    "total": 1,
    "query": { "q": "bitcoin" }
  }
}
GET/api/v1/coins/:coinId/networks

Get coin networks

Get the blockchain networks and contract addresses for a coin.

Request

GET
/api/v1/coins/bitcoin/networks
curl https://api.bitcompare.net/api/v1/coins/bitcoin/networks

Response

{
  "data": {
    "coinId": "bitcoin",
    "networks": [
      {
        "platform": "ethereum",
        "address": "0x..."
      }
    ],
    "count": 1
  }
}
GET/api/v1/coins/stats

Coin stats

Get the total number of coins available.

Request

GET
/api/v1/coins/stats
curl https://api.bitcompare.net/api/v1/coins/stats

Response

{
  "data": {
    "totalCoins": 15000,
    "timestamp": "2025-10-29T14:00:00Z"
  }
}
GET/api/v1/coins/top

Top coins

Get the top coins by market cap rank. Cached for 5 minutes.

Optional attributes

  • Name
    limit
    Type
    integer
    Description

    Number of coins to return. Defaults to 100, max 500.

Request

GET
/api/v1/coins/top
curl -G https://api.bitcompare.net/api/v1/coins/top \
  -d limit=10
GET/api/v1/coins/:coinId/market-data

Market data

Get comprehensive market statistics for a specific coin. Cached for 15 minutes.

Path parameters

  • Name
    coinId
    Type
    string
    Description

    Coin identifier (e.g., "bitcoin").

Request

GET
/api/v1/coins/bitcoin/market-data
curl https://api.bitcompare.net/api/v1/coins/bitcoin/market-data
GET/api/v1/coins/markets

Coins with market data

Get paginated market data for a crypto comparison table. Includes prices, volume, sparklines, and market cap data. Cached for 5 minutes.

Optional attributes

  • Name
    page
    Type
    integer
    Description

    Page number. Defaults to 1.

  • Name
    per_page
    Type
    integer
    Description

    Results per page. Defaults to 100.

  • Name
    sparkline
    Type
    boolean
    Description

    Include 7-day sparkline data. Defaults to false.

  • Name
    order
    Type
    string
    Description

    Sort field (e.g., market_cap_rank).

  • Name
    order_dir
    Type
    string
    Description

    Sort direction: asc or desc.

  • Name
    category
    Type
    string
    Description

    Filter by coin category.

  • Name
    search
    Type
    string
    Description

    Search by name or symbol.

Request

GET
/api/v1/coins/markets
curl -G https://api.bitcompare.net/api/v1/coins/markets \
  -d per_page=10 \
  -d sparkline=true
GET/api/v1/coins/featured

Get featured coins — includes provider-associated coins and top market cap coins. Cached for 5 minutes.

Optional attributes

  • Name
    limit
    Type
    integer
    Description

    Max results. Defaults to 20, max 100.

Request

GET
/api/v1/coins/featured
curl https://api.bitcompare.net/api/v1/coins/featured
GET/api/v1/coins/trending

Get trending coins sorted by 24-hour price change. Cached for 5 minutes.

Optional attributes

  • Name
    limit
    Type
    integer
    Description

    Max results. Defaults to 20, max 100.

Request

GET
/api/v1/coins/trending
curl https://api.bitcompare.net/api/v1/coins/trending
GET/api/v1/coins/recent

Recently added

Get recently added coins. Cached for 5 minutes.

Optional attributes

  • Name
    limit
    Type
    integer
    Description

    Max results. Defaults to 20, max 100.

Request

GET
/api/v1/coins/recent
curl https://api.bitcompare.net/api/v1/coins/recent
GET/api/v1/coins/categories

Categories

Get all distinct coin categories with counts. Cached for 1 hour.

Request

GET
/api/v1/coins/categories
curl https://api.bitcompare.net/api/v1/coins/categories
GET/api/v1/coins/:coinId/similar

Similar coins

Get coins similar to the specified coin based on shared categories. Cached for 15 minutes.

Path parameters

  • Name
    coinId
    Type
    string
    Description

    Coin identifier.

Optional attributes

  • Name
    limit
    Type
    integer
    Description

    Max results. Defaults to 10, max 50.

Request

GET
/api/v1/coins/bitcoin/similar
curl https://api.bitcompare.net/api/v1/coins/bitcoin/similar
GET/api/v1/coins/with-rates

Coins with rates

Get coins that have rates in a specific category. Useful for showing coins available for lending, staking, etc. Cached for 5 minutes.

Required attributes

  • Name
    category
    Type
    string
    Description

    Rate category: lending, borrowing, or staking.

Optional attributes

  • Name
    coinCategory
    Type
    string
    Description

    Filter by coin category.

  • Name
    limit
    Type
    integer
    Description

    Max results. Defaults to 6, max 50.

Request

GET
/api/v1/coins/with-rates?category=lending
curl -G https://api.bitcompare.net/api/v1/coins/with-rates \
  -d category=lending
GET/api/v1/coins/slugs

Coin slugs

Get all coin slugs, useful for generating sitemaps. Cached for 1 hour.

Optional attributes

  • Name
    featured
    Type
    boolean
    Description

    If true, return only featured coin slugs.

Request

GET
/api/v1/coins/slugs
curl https://api.bitcompare.net/api/v1/coins/slugs

Was this page helpful?