Type Alias ListingsHistoricalData

Type declaration

• Optionalheaders?: {
      x-cmc_pro_api_key?: string;
  }

  • Optionalx-cmc_pro_api_key?: string

    Provide your API Key here

• Optionalquery?: {
      aux?: string;
      convert?: string;
      convert_id?: string;
      cryptocurrency_type?: string;
      date?: string;
      limit?: string;
      sort?: string;
      sort_dir?: string;
      start?: string;
  }

  • Optionalaux?: string

    Optionally specify a comma-separated list of supplemental data fields to return. Pass platform,tags,date_added,circulating_supply,total_supply,max_supply,cmc_rank,num_market_pairs to include all auxiliary fields.

  • Optionalconvert?: string

    Optionally calculate market quotes in up to 120 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols. Each additional convert option beyond the first requires an additional call credit. A list of supported fiat options can be found here. Each conversion is returned in its own "quote" object.

  • Optionalconvert_id?: string

    Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to convert outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when convert is used.

  • Optionalcryptocurrency_type?: string

    The type of cryptocurrency to include.

  • Optionaldate?: string

    (Required) date (Unix or ISO 8601) to reference day of snapshot.

  • Optionallimit?: string

    Optionally specify the number of results to return. Use this parameter and the "start" parameter to determine your own pagination size.

  • Optionalsort?: string

    What field to sort the list of cryptocurrencies by.

  • Optionalsort_dir?: string

    The direction in which to order cryptocurrencies against the specified sort.

  • Optionalstart?: string

    Optionally offset the start (1-based index) of the paginated list of items to return.