Type Alias CategoryData

CategoryData: {
    headers?: {
        x-cmc_pro_api_key?: string;
    };
    query?: {
        convert?: string;
        convert_id?: string;
        id?: string;
        limit?: string;
        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;
        id?: string;
        limit?: string;
        start?: string;
    }
    • 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.

    • Optionalid?: string

      (Required) The Category ID. This can be found using the Categories API.

    • Optionallimit?: string

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

    • Optionalstart?: string

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