Type Alias QuotesHistoricalV2Data

QuotesHistoricalV2Data: {
    headers?: {
        x-cmc_pro_api_key?: string;
    };
    query?: {
        aux?: string;
        convert?: string;
        convert_id?: string;
        count?: string;
        id?: string;
        interval?: string;
        skip_invalid?: string;
        symbol?: string;
        time_end?: string;
        time_start?: string;
    };
}

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;
        count?: string;
        id?: string;
        interval?: string;
        skip_invalid?: string;
        symbol?: string;
        time_end?: string;
        time_start?: string;
    }
    • Optionalaux?: string

      Optionally specify a comma-separated list of supplemental data fields to return. Pass price,volume,market_cap,circulating_supply,total_supply,quote_timestamp,is_active,is_fiat,search_interval to include all auxiliary fields.

    • Optionalconvert?: string

      By default market quotes are returned in USD. Optionally calculate market quotes in up to 3 other fiat currencies or cryptocurrencies.

    • 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.

    • Optionalcount?: string

      The number of interval periods to return results for. Optional, required if both "time_start" and "time_end" aren't supplied. The default is 10 items. The current query limit is 10000.

    • Optionalid?: string

      One or more comma-separated CoinMarketCap cryptocurrency IDs. Example: "1,2"

    • Optionalinterval?: string

      Interval of time to return data points for. See details in endpoint description.

    • Optionalskip_invalid?: string

      Pass true to relax request validation rules. When requesting records on multiple cryptocurrencies an error is returned if no match is found for 1 or more requested cryptocurrencies. If set to true, invalid lookups will be skipped allowing valid cryptocurrencies to still be returned.

    • Optionalsymbol?: string

      Alternatively pass one or more comma-separated cryptocurrency symbols. Example: "BTC,ETH". At least one "id" or "symbol" is required for this request.

    • Optionaltime_end?: string

      Timestamp (Unix or ISO 8601) to stop returning quotes for (inclusive). Optional, if not passed, we'll default to the current time. If no "time_start" is passed, we return quotes in reverse order starting from this time.

    • Optionaltime_start?: string

      Timestamp (Unix or ISO 8601) to start returning quotes for. Optional, if not passed, we'll return quotes calculated in reverse from "time_end".

Settings

Member Visibility