Type Alias MetadataV1DeprecatedData

Type declaration

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

  • Optionalx-cmc_pro_api_key?: string

    Provide your API Key here

• Optionalquery?: {
      address?: string;
      aux?: string;
      id?: string;
      skip_invalid?: string;
      slug?: string;
      symbol?: string;
  }

  • Optionaladdress?: string

    Alternatively pass in a contract address. Example: "0xc40af1e4fecfa05ce6bab79dcd8b373d2e436c4e"

  • Optionalaux?: string

    Optionally specify a comma-separated list of supplemental data fields to return. Pass urls,logo,description,tags,platform,date_added,notice,status to include all auxiliary fields.

  • Optionalid?: string

    One or more comma-separated CoinMarketCap cryptocurrency IDs. Example: "1,2"

  • Optionalskip_invalid?: string

    Pass true to relax request validation rules. When requesting records on multiple cryptocurrencies an error is returned if any invalid cryptocurrencies are requested or a cryptocurrency does not have matching records in the requested timeframe. If set to true, invalid lookups will be skipped allowing valid cryptocurrencies to still be returned.

  • Optionalslug?: string

    Alternatively pass a comma-separated list of cryptocurrency slugs. Example: "bitcoin,ethereum"

  • Optionalsymbol?: string

    Alternatively pass one or more comma-separated cryptocurrency symbols. Example: "BTC,ETH". At least one "id" or "slug" or "symbol" is required for this request. Please note that starting in the v2 endpoint, due to the fact that a symbol is not unique, if you request by symbol each data response will contain an array of objects containing all of the coins that use each requested symbol. The v1 endpoint will still return a single object, the highest ranked coin using that symbol.