Type Alias CoinmarketcapIdMap1Data

CoinmarketcapIdMap1Data: {
    headers?: {
        x-cmc_pro_api_key?: string;
    };
    query?: {
        aux?: string;
        crypto_id?: string;
        limit?: string;
        listing_status?: string;
        slug?: string;
        sort?: string;
        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;
        crypto_id?: string;
        limit?: string;
        listing_status?: string;
        slug?: string;
        sort?: string;
        start?: string;
    }
    • Optionalaux?: string

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

    • Optionalcrypto_id?: string

      Optionally include one fiat or cryptocurrency IDs to filter market pairs by. For example ?crypto_id=1 would only return exchanges that have BTC.

    • 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 exchanges are returned by default. Pass inactive to get a list of exchanges that are no longer active. Pass untracked to get a list of exchanges that are registered but do not currently meet methodology requirements to have active markets tracked. You may pass one or more comma-separated values.

    • Optionalslug?: string

      Optionally pass a comma-separated list of exchange slugs (lowercase URL friendly shorthand name with spaces replaced with dashes) to return CoinMarketCap IDs for. If this option is passed, other options will be ignored.

    • Optionalsort?: string

      What field to sort the list of exchanges by.

    • Optionalstart?: string

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