CoinsImp..::..GetCoinMarketsAsync Method
Use this to obtain all the coins market data (price, market cap, volume).
Namespace:
CoinGeckoAPI.ImpsAssembly: CoinGeckoAPI (in CoinGeckoAPI.dll)
Syntax
public Task<IEnumerable<CoinsMarketItem>> GetCoinMarketsAsync( string vs_currency, IEnumerable<string> ids, string category, MarketsOrderBy order, uint per_page, uint page, bool sparkline, MarketPriceChangePercentage price_change_percentage )
Public Function GetCoinMarketsAsync ( _ vs_currency As String, _ ids As IEnumerable(Of String), _ category As String, _ order As MarketsOrderBy, _ per_page As UInteger, _ page As UInteger, _ sparkline As Boolean, _ price_change_percentage As MarketPriceChangePercentage _ ) As Task(Of IEnumerable(Of CoinsMarketItem))
Parameters
- vs_currency
- Type: String
The target currency of market data (usd, eur, jpy, etc.).
- ids
- Type: IEnumerable<(Of <(<'String>)>)>
The ids of the coin cryptocurrency symbols (base). See GetCoinsListAsync(Boolean).
- category
- Type: String
Filter by coin category.
- order
- Type: CoinGeckoAPI.Types..::..MarketsOrderBy
The order of the results (sort MarketsOrderBy).
- per_page
- Type: UInt32
Total results per page. Default value: 100.
- page
- Type: UInt32
Page through results. Default value: 1.
- sparkline
- Type: Boolean
Set to true to include sparkline 7 days data in the response.
- price_change_percentage
- Type: CoinGeckoAPI.Types..::..MarketPriceChangePercentage
Include price change percentage. These are flags so you can set as many as needed.
Return Value
A Task<IEnumerable<CoinsMarketItem>> representing the asynchronous operation.Exceptions
| Exception | Condition |
|---|---|
| ArgumentNullException | vs_currency - Invalid value. Value must be a valid target currency of market data (usd, eur, jpy, etc.) |
| ArgumentOutOfRangeException | per_page - Must be a valid integer from 1 through 250. |
| ArgumentOutOfRangeException | page - Must be a valid page index starting from 1. |