Type Alias MarketPairsLatestV1DeprecatedData

MarketPairsLatestV1DeprecatedData: {
    headers?: {
        x-cmc_pro_api_key?: string;
    };
    query?: {
        aux?: string;
        category?: string;
        convert?: string;
        convert_id?: string;
        fee_type?: string;
        id?: string;
        limit?: string;
        matched_id?: string;
        matched_symbol?: string;
        slug?: string;
        sort?: string;
        sort_dir?: 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;
        category?: string;
        convert?: string;
        convert_id?: string;
        fee_type?: string;
        id?: string;
        limit?: string;
        matched_id?: string;
        matched_symbol?: string;
        slug?: string;
        sort?: string;
        sort_dir?: string;
        start?: string;
        symbol?: string;
    }
    • Optionalaux?: string

      Optionally specify a comma-separated list of supplemental data fields to return. Pass num_market_pairs,category,fee_type,market_url,currency_name,currency_slug,price_quote,notice,cmc_rank,effective_liquidity,market_score,market_reputation to include all auxiliary fields.

    • Optionalcategory?: string

      The category of trading this market falls under. Spot markets are the most common but options include derivatives and OTC.

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

    • Optionalfee_type?: string

      The fee type the exchange enforces for this market.

    • Optionalid?: string

      A cryptocurrency or fiat currency by CoinMarketCap ID to list market pairs for. Example: "1"

    • Optionallimit?: string

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

    • Optionalmatched_id?: string

      Optionally include one or more fiat or cryptocurrency IDs to filter market pairs by. For example ?id=1&matched_id=2781 would only return BTC markets that matched: "BTC/USD" or "USD/BTC". This parameter cannot be used when matched_symbol is used.

    • Optionalmatched_symbol?: string

      Optionally include one or more fiat or cryptocurrency symbols to filter market pairs by. For example ?symbol=BTC&matched_symbol=USD would only return BTC markets that matched: "BTC/USD" or "USD/BTC". This parameter cannot be used when matched_id is used.

    • Optionalslug?: string

      Alternatively pass a cryptocurrency by slug. Example: "bitcoin"

    • Optionalsort?: string

      Optionally specify the sort order of markets returned. By default we return a strict sort on 24 hour reported volume. Pass cmc_rank to return a CMC methodology based sort where markets with excluded volumes are returned last.

    • Optionalsort_dir?: string

      Optionally specify the sort direction of markets returned.

    • Optionalstart?: string

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

    • Optionalsymbol?: string

      Alternatively pass a cryptocurrency by symbol. Fiat currencies are not supported by this field. Example: "BTC". A single cryptocurrency "id", "slug", or "symbol" is required.

Settings

Member Visibility