Symbols

Resolve cryptocurrency ticker symbols to canonical identifiers. The API uses multiple resolution strategies to find the best match, returning a confidence score with each result.

The resolution model

Each resolution returns a confidence score and the method used to resolve the symbol.

Properties

Name
resolved
Type
boolean
Description
Whether the symbol was successfully resolved.
Name
coingeckoId
Type
string
Description
The canonical coin identifier (e.g., "bitcoin"). Only present when resolved is true.
Name
confidence
Type
integer
Description
Confidence score from 0–100. Higher is better.
Name
method
Type
string
Description
Resolution strategy used (see below).

Resolution strategies (priority order)

Name
manual_override
Type
100%
Description
Administrator-defined overrides for specific symbol/source pairs.
Name
provider_mapping
Type
85–100%
Description
Provider-specific symbol mappings from the database.
Name
exchange_mapping
Type
85–100%
Description
Exchange-specific symbol mappings.
Name
unique_symbol
Type
90%
Description
Only one coin exists with this symbol.
Name
price_context
Type
85%
Description
Disambiguates by matching symbol to known price.
Name
coin_database
Type
80–90%
Description
Direct database lookup by symbol.
Name
market_cap_ranking
Type
70–100%
Description
Ranked by market cap when multiple matches exist.
Name
coingecko_search
Type
65–80%
Description
External CoinGecko search — slowest fallback.

GET/api/v1/symbols/resolve

Resolve a symbol (GET)

Resolve a symbol to its canonical identifier using query parameters.

Required attributes

Name
symbol
Type
string
Description
The ticker symbol to resolve (e.g., "BTC", "ETH").

Optional attributes

Name
source
Type
string
Description
Provider source for context (e.g., "binance", "coinbase"). Defaults to "general".
Name
price
Type
number
Description
Current price for disambiguation when multiple coins share a symbol.
Name
context
Type
object
Description
Additional context object for resolution hints.

Request

GET

/api/v1/symbols/resolve

curl -G https://api.bitcompare.net/api/v1/symbols/resolve \
  -d symbol=BTC \
  -d source=binance

Response

{
  "data": {
    "resolved": true,
    "coingeckoId": "bitcoin",
    "confidence": 95,
    "method": "exchange_mapping"
  }
}

POST/api/v1/symbols/resolve

Resolve a symbol (POST)

Resolve a symbol using a JSON request body.

Required attributes

Name
symbol
Type
string
Description
The ticker symbol to resolve.
Name
source
Type
string
Description
Provider source for context (e.g., "binance", "coinbase").

Optional attributes

Name
context
Type
object
Description
Additional context (e.g., { "price": 45000 }).

Request

POST

/api/v1/symbols/resolve

curl https://api.bitcompare.net/api/v1/symbols/resolve \
  -H "Content-Type: application/json" \
  -d '{"symbol": "BTC", "source": "binance", "context": {"price": 45000}}'

Response

{
  "data": {
    "resolved": true,
    "coingeckoId": "bitcoin",
    "confidence": 95,
    "method": "exchange_mapping"
  }
}

POST/api/v1/symbols/resolve/batch

Batch resolve

Resolve up to 100 symbols in a single request. Each symbol is resolved independently and results are keyed by the input symbol.

Required attributes

Name
symbols
Type
string[]
Description
Array of ticker symbols to resolve (max 100).
Name
source
Type
string
Description
Provider source applied to all symbols (e.g., "binance").

Optional attributes

Name
context
Type
object
Description
Shared context object.

Request

POST

/api/v1/symbols/resolve/batch

curl https://api.bitcompare.net/api/v1/symbols/resolve/batch \
  -H "Content-Type: application/json" \
  -d '{"symbols": ["BTC", "ETH", "USDT"], "source": "binance"}'

Response

{
  "data": {
    "resolved": {
      "BTC": {
        "resolved": true,
        "coingeckoId": "bitcoin",
        "confidence": 95,
        "method": "exchange_mapping"
      },
      "ETH": {
        "resolved": true,
        "coingeckoId": "ethereum",
        "confidence": 95,
        "method": "exchange_mapping"
      },
      "USDT": {
        "resolved": true,
        "coingeckoId": "tether",
        "confidence": 90,
        "method": "unique_symbol"
      }
    },
    "source": "binance",
    "count": 3,
    "timestamp": "2025-10-29T14:00:00Z"
  }
}

GET/api/v1/symbols/mappings

List mappings

Retrieve recent symbol resolution mappings.

Optional attributes

Name
limit
Type
integer
Description
Maximum number of mappings to return. Defaults to 100.

Request

GET

/api/v1/symbols/mappings

curl -G https://api.bitcompare.net/api/v1/symbols/mappings \
  -d limit=5

Response

{
  "data": {
    "mappings": [
      {
        "source": "binance",
        "symbol": "BTC",
        "coingeckoId": "bitcoin",
        "confidence": 95,
        "createdAt": "2025-10-29T14:00:00Z"
      }
    ],
    "count": 1,
    "timestamp": "2025-10-29T14:00:00Z"
  }
}