Type Alias QuotesHistoricalData

QuotesHistoricalData: {
    headers?: {
        x-cmc_pro_api_key?: string;
    };
    query?: {
        convert?: string;
        convert_id?: string;
        count?: string;
        id?: string;
        interval?: string;
        slug?: 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?: {
        convert?: string;
        convert_id?: string;
        count?: string;
        id?: string;
        interval?: string;
        slug?: string;
        time_end?: string;
        time_start?: string;
    }
    • 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 exchange CoinMarketCap ids. Example: "24,270"

    • Optionalinterval?: string

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

    • Optionalslug?: string

      Alternatively, one or more comma-separated exchange names in URL friendly shorthand "slug" format (all lowercase, spaces replaced with hyphens). Example: "binance,kraken". At least one "id" or "slug" is required.

    • 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