Class CoinGeckoClient

The wrap client to access all api on coin gecko

Index

Coin

coinId

coinId(input): Promise<CoinFullInfo>
Get current data (name, price, market, ... including exchange tickers) for a coin IMPORTANT: Ticker object is limited to 100 items, to get more tickers, use /coins/{id}/tickers Ticker is_stale is true when ticker that has not been updated/unchanged from the exchange for a while. Ticker is_anomaly is true if ticker’s price is outliered by our system. You are responsible for managing how you want to display these information (e.g. footnote, different background, change opacity, hide)
Parameters
- input: {
      community_data?: boolean;
      developer_data?: boolean;
      id: string;
      localization?: boolean;
      market_data?: boolean;
      sparkline?: boolean;
      tickers?: boolean;
  }
  - Optionalcommunity_data?: boolean
    Include community_data data (true/false) [default: true]
  - Optionaldeveloper_data?: boolean
    Include developer_data data (true/false) [default: true]
  - id: string
    pass the coin id (can be obtained from /coins) eg. bitcoin
  - Optionallocalization?: boolean
    Include all localized languages in response (true/false)
  - Optionalmarket_data?: boolean
    Include market_data (true/false) [default: true]
  - Optionalsparkline?: boolean
    Include sparkline 7 days data (eg. true, false)
  - Optionaltickers?: boolean
    nclude tickers data (true/false) [default: true]
Returns Promise<CoinFullInfo>
- Defined in CoinGeckoClient.ts:267

coinIdHistory

coinIdHistory(input): Promise<CoinHistoryResponse>
Get historical data (name, price, market, stats) at a given date for a coin
Parameters
- input: {
      date: string;
      id: string;
      localization?: boolean;
  }
  - date: string
    The date of data snapshot in dd-mm-yyyy eg. 30-12-2017
  - id: string
    pass the coin id (can be obtained from /coins) eg. bitcoin
  - Optionallocalization?: boolean
    Set to false to exclude localized languages in response
Returns Promise<CoinHistoryResponse>
- Defined in CoinGeckoClient.ts:315

coinIdMarketChart

coinIdMarketChart(input): Promise<CoinMarketChartResponse>
Get historical market data include price, market cap, and 24h volume (granularity auto) Minutely data will be used for duration within 1 day, Hourly data will be used for duration between 1 day and 90 days, Daily data will be used for duration above 90 days.
Parameters
- input: {
      days: number | "max";
      id: string;
      interval?: string;
      vs_currency: string;
  }
  - days: number | "max"
    Data up to number of days ago (eg. 1,14,30,max)
  - id: string
    pass the coin id (can be obtained from /coins) eg. bitcoin
  - Optionalinterval?: string
    Data interval. Possible value: daily
  - vs_currency: string
    The target currency of market data (usd, eur, jpy, etc.)
Returns Promise<CoinMarketChartResponse>
- Defined in CoinGeckoClient.ts:337

coinIdMarketChartRange

coinIdMarketChartRange(input): Promise<CoinMarketChartResponse>
Get historical market data include price, market cap, and 24h volume within a range of timestamp (granularity auto) Minutely data will be used for duration within 1 day, Hourly data will be used for duration between 1 day and 90 days, Daily data will be used for duration above 90 days.
Parameters
- input: {
      from: number;
      id: string;
      to: number;
      vs_currency: string;
  }
  - from: number
    From date in UNIX Timestamp (eg. 1392577232)
  - id: string
    pass the coin id (can be obtained from /coins) eg. bitcoin
  - to: number
    To date in UNIX Timestamp (eg. 1618716149)
  - vs_currency: string
    The target currency of market data (usd, eur, jpy, etc.)
Returns Promise<CoinMarketChartResponse>
- Defined in CoinGeckoClient.ts:360

coinIdOHLC

coinIdOHLC(input): Promise<number[][]>
Get coin's OHLC (Beta)
```
Candle’s body:
1 - 2 days: 30 minutes
3 - 30 days: 4 hours
31 and before: 4 days
```
Parameters
- input: {
      days: number | "max";
      id: string;
      vs_currency: string;
  }
  - days: number | "max"
    Data up to number of days ago (1/7/14/30/90/180/365/max)
  - id: string
    pass the coin id (can be obtained from /coins) eg. bitcoin
  - vs_currency: string
    The target currency of market data (usd, eur, jpy, etc.)
Returns Promise<number[][]>
Sample output
```
[
 [
   1618113600000,
   79296.36,
   79296.36,
   79279.94,
   79279.94
  ]
. ... ... . .. . .. . . . . .
]
```
See
https://www.coingecko.com/api/documentations/v3#/coins/get_coins__id__ohlc
- Defined in CoinGeckoClient.ts:419

coinIdTickers

coinIdTickers(input): Promise<CoinTickerResponse>
Get coin tickers (paginated to 100 items)

IMPORTANT: Ticker is_stale is true when ticker that has not been updated/unchanged from the exchange for a while. Ticker is_anomaly is true if ticker’s price is outliered by our system. You are responsible for managing how you want to display these information (e.g. footnote, different background, change opacity, hide)
Parameters
- input: {
      depth?: boolean;
      exchange_ids?: string;
      id: string;
      include_exchange_logo?: boolean;
      order?: "volume_desc" | "trust_score_desc" | "trust_score_asc";
      page?: number;
  }
  - Optionaldepth?: boolean
    flag to show 2% orderbook depth. valid values: true, false
  - Optionalexchange_ids?: string
    filter results by exchange_ids (ref: v3/exchanges/list)
  - id: string
    pass the coin id (can be obtained from /coins) eg. bitcoin
  - Optionalinclude_exchange_logo?: boolean
    flag to show exchange_logo
  - Optionalorder?: "volume_desc" | "trust_score_desc" | "trust_score_asc"
    valid values: trust_score_desc (default), trust_score_asc and volume_desc
  - Optionalpage?: number
    Page through results
Returns Promise<CoinTickerResponse>
- Defined in CoinGeckoClient.ts:295

coinList

coinList(input): Promise<CoinListResponseItem[]>
List all supported coins id, name and symbol (no pagination required) Use this to obtain all the coins’ id in order to make API calls
Parameters
- input: {
  include_platform?: boolean;
  }
  - Optionalinclude_platform?: boolean
    flag to include platform contract addresses (eg. 0x… for Ethereum based tokens). valid values: true, false
Returns Promise<CoinListResponseItem[]>
- Defined in CoinGeckoClient.ts:210

coinMarket

coinMarket(input): Promise<CoinMarket[]>
List all supported coins price, market cap, volume, and market related data
Parameters
- input: {
      category?: "decentralized_finance_defi" | "stablecoins";
      ids?: string;
      order?:
          | "market_cap_desc"
          | "gecko_desc"
          | "gecko_asc"
          | "market_cap_asc"
          | "volume_asc"
          | "volume_desc"
          | "id_asc"
          | "id_desc";
      page?: number;
      per_page?: number;
      price_change_percentage?: string;
      sparkline?: boolean;
      vs_currency: string;
  }
  - Optionalcategory?: "decentralized_finance_defi" | "stablecoins"
    filter by coin category, only decentralized_finance_defi and stablecoins are supported at the moment
  - Optionalids?: string
    The ids of the coin, comma separated crytocurrency symbols (base). refers to /coins/list. When left empty, returns numbers the coins observing the params limit and start
  - Optionalorder?:
        | "market_cap_desc"
        | "gecko_desc"
        | "gecko_asc"
        | "market_cap_asc"
        | "volume_asc"
        | "volume_desc"
        | "id_asc"
        | "id_desc"
    valid values: market_cap_desc, gecko_desc, gecko_asc, market_cap_asc, market_cap_desc, volume_asc, volume_desc, id_asc, id_desc
  - Optionalpage?: number
    Page through results
  - Optionalper_page?: number
    Total results per page (valid values: 1…250)
  - Optionalprice_change_percentage?: string
  - Optionalsparkline?: boolean
    Include sparkline 7 days data (eg. true, false)
  - vs_currency: string
    The target currency of market data (usd, eur, jpy, etc.)
Returns Promise<CoinMarket[]>
- Defined in CoinGeckoClient.ts:229

Contract

contract

contract(input): Promise<CoinFullInfo>
Get historical market data include price, market cap, and 24h volume (granularity auto) from a contract address
Parameters
- input: {
  contract_address: string;
  id: PLATFORMS;
  }
  - contract_address: string
    Token’s contract address
  - id: PLATFORMS
    Asset platform (only ethereum is supported at this moment)
Returns Promise<CoinFullInfo>
current data for a coin

See
https://www.coingecko.com/api/documentations/v3#/contract/get_coins__id__contract__contract_address_
- Defined in CoinGeckoClient.ts:531

contractMarketChart

contractMarketChart(input): Promise<CoinMarketChartResponse>
Get historical market data include price, market cap, and 24h volume (granularity auto)
Parameters
- input: {
      contract_address: string;
      days: number | "max";
      id: PLATFORMS;
      vs_currency: string;
  }
  - contract_address: string
    Token’s contract address
  - days: number | "max"
    Data up to number of days ago (eg. 1,14,30,max)
  - id: PLATFORMS
    Asset platform (only ethereum is supported at this moment)
  - vs_currency: string
    The target currency of market data (usd, eur, jpy, etc.)
Returns Promise<CoinMarketChartResponse>
current data for a coin

See
https://www.coingecko.com/api/documentations/v3#/contract/get_coins__id__contract__contract_address__market_chart_
- Defined in CoinGeckoClient.ts:546

contractMarketChartRange

contractMarketChartRange(input): Promise<CoinMarketChartResponse>
Get historical market data include price, market cap, and 24h volume within a range of timestamp (granularity auto) from a contract address
Parameters
- input: {
      contract_address: string;
      from?: number;
      id: PLATFORMS;
      to: number;
      vs_currency: string;
  }
  - contract_address: string
    Token’s contract address
  - Optionalfrom?: number
    From date in UNIX Timestamp (eg. 1392577232)
  - id: PLATFORMS
    Asset platform (only ethereum is supported at this moment)
  - to: number
    From date in UNIX Timestamp (eg. 1618716149)
  - vs_currency: string
    The target currency of market data (usd, eur, jpy, etc.)
Returns Promise<CoinMarketChartResponse>
current data for a coin

See
https://www.coingecko.com/api/documentations/v3#/contract/get_coins__id__contract__contract_address__market_chart_range
- Defined in CoinGeckoClient.ts:570

Derivatives

derivatives

derivatives(input): Promise<Derivative[]>
List all derivative tickers
Parameters
- input: {
  include_tickers?: "all" | "unexpired";
  }
  - Optionalinclude_tickers?: "all" | "unexpired"
    'all’, ‘unexpired’] - expired to show unexpired tickers, all to list all tickers, defaults to unexpired
Returns Promise<Derivative[]>
See
https://www.coingecko.com/api/documentations/v3#/derivatives_(beta)/get_derivatives
- Defined in CoinGeckoClient.ts:773

derivativesExchanges

derivativesExchanges(input): Promise<DerivativeExchange[]>
List all derivative tickers
Parameters
- input: {
      order?:
          | "name_asc"
          | "name_desc"
          | "open_interest_btc_asc"
          | "open_interest_btc_desc"
          | "trade_volume_24h_btc_asc"
          | "trade_volume_24h_btc_desc";
      page?: number;
      per_page?: number;
  }
  - Optionalorder?:
        | "name_asc"
        | "name_desc"
        | "open_interest_btc_asc"
        | "open_interest_btc_desc"
        | "trade_volume_24h_btc_asc"
        | "trade_volume_24h_btc_desc"
    order results using following params name_asc，name_desc，open_interest_btc_asc，open_interest_btc_desc，trade_volume_24h_btc_asc，trade_volume_24h_btc_desc
  - Optionalpage?: number
    Page through results
  - Optionalper_page?: number
    Total results per page
Returns Promise<DerivativeExchange[]>
See
https://www.coingecko.com/api/documentations/v3#/derivatives_(beta)/get_derivatives_exchanges
- Defined in CoinGeckoClient.ts:786

derivativesExchangesId

derivativesExchangesId(input): Promise<DerivativeExchange>
show derivative exchange data
Parameters
- input: {
  id: string;
  include_tickers?: "all" | "unexpired";
  }
  - id: string
    pass the exchange id (can be obtained from derivatives/exchanges/list) eg. bitmex
  - Optionalinclude_tickers?: "all" | "unexpired"
    ['all’, ‘unexpired’] - expired to show unexpired tickers, all to list all tickers, leave blank to omit tickers data in response
Returns Promise<DerivativeExchange>
See
https://www.coingecko.com/api/documentations/v3#/derivatives_(beta)/get_derivatives_exchanges__id_
- Defined in CoinGeckoClient.ts:813

derivativesExchangesList

derivativesExchangesList(): Promise<NameIdPair[]>
List all derivative exchanges name and identifier

Returns Promise<NameIdPair[]>
See
https://www.coingecko.com/api/documentations/v3#/derivatives_(beta)/get_derivatives_exchanges_list
- Defined in CoinGeckoClient.ts:829

Exchange

exchangeId

exchangeId(id): Promise<ExchangeId>

List all supported markets id and name (no pagination required)

Parameters

id: string
the exchange id (can be obtained from /exchanges/list) eg. binance

Returns Promise<ExchangeId>

Use this to obtain all the markets’ id in order to make API calls

IMPORTANT:
Ticker object is limited to 100 items, to get more tickers, use /exchanges/{id}/tickers
Ticker is_stale is true when ticker that has not been updated/unchanged from the exchange for a while.
Ticker is_anomaly is true if ticker’s price is outliered by our system.
You are responsible for managing how you want to display these information (e.g. footnote, different background, change opacity, hide)

See

https://www.coingecko.com/api/documentations/v3#/exchanges_(beta)/get_exchanges__id_

exchangeIdTickers

exchangeIdTickers(input): Promise<ExchangeIdTickerResponse>
Get exchange tickers (paginated, 100 tickers per page)
Parameters
- input: {
      coin_ids?: string;
      depth?: string;
      id: string;
      include_exchange_logo?: boolean;
      order?: "volume_desc" | "trust_score_desc" | "trust_score_asc";
      page?: number;
  }
  - Optionalcoin_ids?: string
    filter tickers by coin_ids (ref: v3/coins/list)
  - Optionaldepth?: string
    flag to show 2% orderbook depth i.e., cost_to_move_up_usd and cost_to_move_down_usd
  - id: string
    pass the exchange id (can be obtained from /exchanges/list) eg. binance
  - Optionalinclude_exchange_logo?: boolean
    flag to show exchange_logo
  - Optionalorder?: "volume_desc" | "trust_score_desc" | "trust_score_asc"
  - Optionalpage?: number
    Page through results
Returns Promise<ExchangeIdTickerResponse>
Use this to obtain all the markets’ id in order to make API calls
```
IMPORTANT:
Ticker object is limited to 100 items, to get more tickers, use /exchanges/{id}/tickers
Ticker is_stale is true when ticker that has not been updated/unchanged from the exchange for a while.
Ticker is_anomaly is true if ticker’s price is outliered by our system.
You are responsible for managing how you want to display these information (e.g. footnote, different background, change opacity, hide)
```
See
https://www.coingecko.com/api/documentations/v3#/exchanges_(beta)/get_exchanges__id__tickers
- Defined in CoinGeckoClient.ts:645

exchangeIdVolumeChart

exchangeIdVolumeChart(input): Promise<number[][]>
Get status updates for a given exchange (beta)
Parameters
- input: {
  days: number;
  id: string;
  }
  - days: number
    Data up to number of days ago (eg. 1,14,30)
  - id: string
    pass the exchange id (can be obtained from /exchanges/list) eg. binance
Returns Promise<number[][]>
Get status updates for a given exchange

See
https://www.coingecko.com/api/documentations/v3#/exchanges_(beta)/get_exchanges__id__volume_chart
- Defined in CoinGeckoClient.ts:687

exchangeList

exchangeList(): Promise<NameIdPair[]>
List all supported markets id and name (no pagination required)

Returns Promise<NameIdPair[]>
Use this to obtain all the markets’ id in order to make API calls

See
https://www.coingecko.com/api/documentations/v3#/exchanges_(beta)/get_exchanges_list
- Defined in CoinGeckoClient.ts:603

exchanges

exchanges(input): Promise<Exchange[]>
List all exchanges
Parameters
- input: {
  page?: number;
  per_page?: number;
  }
  - Optionalpage?: number
    Page through results
  - Optionalper_page?: number
    Total results per page (valid values: 1…250)
Returns Promise<Exchange[]>
List all exchanges

See
https://www.coingecko.com/api/documentations/v3#/exchanges_(beta)/get_exchanges
- Defined in CoinGeckoClient.ts:592

Exchange Rates

exchangeRates

exchangeRates(): Promise<ExchangeRatesResponse>
Get BTC-to-Currency exchange rates

Returns Promise<ExchangeRatesResponse>
See
https://www.coingecko.com/api/documentations/v3#/exchange_rates/get_exchange_rates
- Defined in CoinGeckoClient.ts:841

Finance

financePlatforms

financePlatforms(input?): Promise<FinancePlatform[]>
List all finance platforms
Parameters
- Optionalinput: {
  page?: number;
  per_page?: number;
  }
  - Optionalpage?: number
    Data up to number of days ago (eg. 1,14,30)
  - Optionalper_page?: number
    Total results per page
Returns Promise<FinancePlatform[]>
See
https://www.coingecko.com/api/documentations/v3#/finance_(beta)/get_finance_platforms
- Defined in CoinGeckoClient.ts:702

Global

global

global(): Promise<GlobalResponse>
Get cryptocurrency global data

Returns Promise<GlobalResponse>
Get global data - total_volume, total_market_cap, ongoing icos etc

See
https://www.coingecko.com/api/documentations/v3#/global/get_global
- Defined in CoinGeckoClient.ts:851

globalDefi

globalDefi(): Promise<GlobalDefiResponse>
Get cryptocurrency global decentralized finance(defi) data

Returns Promise<GlobalDefiResponse>
Get Top 100 Cryptocurrency Global Eecentralized Finance(defi) data

See
https://www.coingecko.com/api/documentations/v3#/global/get_global
- Defined in CoinGeckoClient.ts:861

Indexes

indexes

indexes(input?): Promise<IndexItem[]>
List all market indexes
Parameters
- Optionalinput: {
  page?: number;
  per_page?: number;
  }
  - Optionalpage?: number
    Data up to number of days ago (eg. 1,14,30)
  - Optionalper_page?: number
    Total results per page
Returns Promise<IndexItem[]>
See
https://www.coingecko.com/api/documentations/v3#/indexes_(beta)/get_indexes
- Defined in CoinGeckoClient.ts:735

indexesList

indexesList(): Promise<NameIdPair[]>
list market indexes id and name

Returns Promise<NameIdPair[]>
See
https://www.coingecko.com/api/documentations/v3#/indexes_(beta)/get_indexes_list
- Defined in CoinGeckoClient.ts:762

indexesMarketId

indexesMarketId(input?): Promise<IndexItem[]>
get market index by market id and index id
Parameters
- Optionalinput: {
      id?: number;
      market_id?: number;
      path_id?: number;
  }
  - Optionalid?: number
    pass the index id (can be obtained from /indexes/list)
  - Optionalmarket_id?: number
    pass the market id (can be obtained from /exchanges/list)
  - Optionalpath_id?: number
    pass the index id (can be obtained from /indexes/list)
Returns Promise<IndexItem[]>
See
https://www.coingecko.com/api/documentations/v3#/indexes_(beta)/get_indexes__market_id___id_
- Defined in CoinGeckoClient.ts:748

Other

constructor

new CoinGeckoClient(options?, apiKey?): CoinGeckoClient
Constructor
Parameters
- Optionaloptions: Options
  the options passed for client library, at the moment only timeout are support
- OptionalapiKey: string
Returns CoinGeckoClient
- Defined in CoinGeckoClient.ts:55

`Optional`apiKey

apiKey?: string

baseURL

baseURL: string

options

options: Options = ...

ping

ping(): Promise<PingResponse>
Check API server status

Returns Promise<PingResponse>
- Defined in CoinGeckoClient.ts:180

search

search(input): Promise<SearchResponse>
Search for coins, categories and markets listed on CoinGecko ordered by largest Market Cap first.
Parameters
- input: {
  query?: string;
  }
  - Optionalquery?: string
    your search query.
Returns Promise<SearchResponse>
- Defined in CoinGeckoClient.ts:189

Simple

simplePrice

simplePrice(input): Promise<SimplePriceResponse>
Get the current price of any cryptocurrencies in any other supported currencies that you need.
Parameters
- input: {
      ids: string;
      include_24hr_change?: boolean;
      include_24hr_vol?: boolean;
      include_last_updated_at?: boolean;
      include_market_cap?: boolean;
      vs_currencies: string;
  }
  - ids: string
    The ids of the coin, comma separated crytocurrency symbols (base). refers to /coins/list. When left empty, returns numbers the coins observing the params limit and start
  - Optionalinclude_24hr_change?: boolean
  - Optionalinclude_24hr_vol?: boolean
  - Optionalinclude_last_updated_at?: boolean
  - Optionalinclude_market_cap?: boolean
  - vs_currencies: string
    vs_currency of coins, comma-separated if querying more than 1 vs_currency. *refers to simple/supported_vs_currencies
Returns Promise<SimplePriceResponse>
Default
```
false
```
- Defined in CoinGeckoClient.ts:460

simpleSupportedCurrencies

simpleSupportedCurrencies(): Promise<string[]>
Get list of supported_vs_currencies.

Returns Promise<string[]>
list of supported_vs_currencies
- Defined in CoinGeckoClient.ts:518

simpleTokenPrice

simpleTokenPrice(input): Promise<TokenPriceResponse>
Get current price of tokens (using contract addresses) for a given platform in any other currency that you need.
Parameters
- input: {
      contract_addresses: string;
      id: "ethereum";
      include_24hr_change?: boolean;
      include_24hr_vol?: boolean;
      include_last_updated_at?: boolean;
      include_market_cap?: boolean;
      vs_currencies: string;
  }
  - contract_addresses: string
    The contract address of tokens, comma separated
  - id: "ethereum"
    The id of the platform issuing tokens (Only ethereum is supported for now)
  - Optionalinclude_24hr_change?: boolean
  - Optionalinclude_24hr_vol?: boolean
  - Optionalinclude_last_updated_at?: boolean
  - Optionalinclude_market_cap?: boolean
  - vs_currencies: string
    vs_currency of coins, comma-separated if querying more than 1 vs_currency. *refers to simple/supported_vs_currencies
Returns Promise<TokenPriceResponse>
The dictionary of price pair with details
- Example output
```
{
   "0x8207c1ffc5b6804f6024322ccf34f29c3541ae26": {
     "btc": 0.00003754,
     "btc_market_cap": 7914.297728099776,
     "btc_24h_vol": 2397.477480037078,
     "btc_24h_change": 3.7958858800037834,
     "eth": 0.0009474,
     "eth_market_cap": 199730.22336519035,
     "eth_24h_vol": 60504.258122696505,
     "eth_24h_change": 2.8068351977135007,
     "last_updated_at": 1618664199
  }
}
```
- Defined in CoinGeckoClient.ts:498

Class CoinGeckoClient

Index

Category

Coin

Contract

Derivatives

Exchange

Exchange Rates

Finance

Global

Indexes

Other

Simple

Category

coinCategoriesList

Returns Promise<Category[]>

See

coinCategoriesListWithMarketData

Parameters

Optionalorder?: | "market_cap_desc" | "market_cap_asc" | "name_asc" | "name_desc" | "market_cap_change_24h_asc" | "market_cap_change_24h_desc"

Returns Promise<CategoryWithMarketData[]>

See

Coin

coinId

Parameters

Optionalcommunity_data?: boolean

Optionaldeveloper_data?: boolean

id: string

Optionallocalization?: boolean

Optionalmarket_data?: boolean

Optionalsparkline?: boolean

Optionaltickers?: boolean

Returns Promise<CoinFullInfo>

coinIdHistory

Parameters

date: string

id: string

Optionallocalization?: boolean

Returns Promise<CoinHistoryResponse>

coinIdMarketChart

Parameters

days: number | "max"

id: string

Optionalinterval?: string

vs_currency: string

Returns Promise<CoinMarketChartResponse>

coinIdMarketChartRange

Parameters

from: number

id: string

to: number

vs_currency: string

Returns Promise<CoinMarketChartResponse>

coinIdOHLC

Parameters

days: number | "max"

id: string

vs_currency: string

Returns Promise<number[][]>

See

coinIdTickers

Parameters

Optionaldepth?: boolean

Optionalexchange_ids?: string

id: string

Optionalinclude_exchange_logo?: boolean

Optionalorder?: "volume_desc" | "trust_score_desc" | "trust_score_asc"

Optionalpage?: number

Returns Promise<CoinTickerResponse>

coinList

Parameters

Optionalinclude_platform?: boolean

Returns Promise<CoinListResponseItem[]>

coinMarket

Parameters

Optionalcategory?: "decentralized_finance_defi" | "stablecoins"

Optionalids?: string

Optionalorder?: | "market_cap_desc" | "gecko_desc" | "gecko_asc" | "market_cap_asc" | "volume_asc" | "volume_desc" | "id_asc" | "id_desc"

Optionalpage?: number

Optionalper_page?: number

`Optional`order?:
| "market_cap_desc"
| "market_cap_asc"
| "name_asc"
| "name_desc"
| "market_cap_change_24h_asc"
| "market_cap_change_24h_desc"

`Optional`community_data?: boolean

`Optional`developer_data?: boolean

`Optional`localization?: boolean

`Optional`market_data?: boolean

`Optional`sparkline?: boolean

`Optional`tickers?: boolean

`Optional`localization?: boolean

`Optional`interval?: string

`Optional`depth?: boolean

`Optional`exchange_ids?: string

`Optional`include_exchange_logo?: boolean

`Optional`order?: "volume_desc" | "trust_score_desc" | "trust_score_asc"

`Optional`page?: number

`Optional`include_platform?: boolean

`Optional`category?: "decentralized_finance_defi" | "stablecoins"

`Optional`ids?: string

`Optional`order?:
| "market_cap_desc"
| "gecko_desc"
| "gecko_asc"
| "market_cap_asc"
| "volume_asc"
| "volume_desc"
| "id_asc"
| "id_desc"

`Optional`page?: number

`Optional`per_page?: number

`Optional`price_change_percentage?: string

`Optional`sparkline?: boolean

`Optional`from?: number

`Optional`include_tickers?: "all" | "unexpired"

`Optional`order?:
| "name_asc"
| "name_desc"
| "open_interest_btc_asc"
| "open_interest_btc_desc"
| "trade_volume_24h_btc_asc"
| "trade_volume_24h_btc_desc"

`Optional`page?: number

`Optional`per_page?: number

`Optional`include_tickers?: "all" | "unexpired"

`Optional`coin_ids?: string

`Optional`depth?: string

`Optional`include_exchange_logo?: boolean

`Optional`order?: "volume_desc" | "trust_score_desc" | "trust_score_asc"

`Optional`page?: number