Type Alias CoinmarketcapIdMapData

CoinmarketcapIdMapData: {
    headers?: {
        x-cmc_pro_api_key?: string;
    };
    query?: {
        aux?: string;
        limit?: string;
        listing_status?: string;
        sort?: string;
        start?: string;
        symbol?: string;
    };
}

Type declaration

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

      Provide your API Key here

  • Optionalquery?: {
        aux?: string;
        limit?: string;
        listing_status?: string;
        sort?: string;
        start?: string;
        symbol?: string;
    }
    • Optionalaux?: string

      Optionally specify a comma-separated list of supplemental data fields to return. Pass platform,first_historical_data,last_historical_data,is_active,status to include all auxiliary fields.

    • Optionallimit?: string

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

    • Optionallisting_status?: string

      Only active cryptocurrencies are returned by default. Pass inactive to get a list of cryptocurrencies that are no longer active. Pass untracked to get a list of cryptocurrencies that are listed but do not yet meet methodology requirements to have tracked markets available. You may pass one or more comma-separated values.

    • Optionalsort?: string

      What field to sort the list of cryptocurrencies by.

    • Optionalstart?: string

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

    • Optionalsymbol?: string

      Optionally pass a comma-separated list of cryptocurrency symbols to return CoinMarketCap IDs for. If this option is passed, other options will be ignored.

Settings

Member Visibility