cmc-client
v1.1.2
Published
Fetch current and historical data(up to 6 month) for BTC and other coins
Readme
CoinMarketCap Data Module (cmcClient.js)
A lightweight Node.js module for fetching real‑time and historical cryptocurrency market data from the CoinMarketCap Pro API.
Designed for trading bots, analytics dashboards, research tools, and alert systems.
Key Features
- Get the latest quote (price, volume, market cap, etc.) for any supported symbol (e.g., BTC, ETH).
- Fetch historical OHLCV (open, high, low, close, volume) data up to 6 months back (depending on your CMC plan).
- Simple, promise‑based API using
axios. - Clean, easily extensible code structure for advanced use cases.
Who Is This For?
For customers (non‑developers)
- You want a bot or app that:
- Tracks live prices from CoinMarketCap.
- Looks at past price movements to decide when to buy/sell.
- Uses reputable, standardized market data instead of random sources.
- This module is the data engine behind that: it gives your application accurate, structured market data so your strategies can run safely and consistently.
You don’t have to touch the code yourself—your developer/team can plug this module into your system.
For developers
- You need a reusable Node.js wrapper for the CoinMarketCap Pro API.
- You want to:
- Pull latest quotes by symbol.
- Pull historical OHLCV data for backtesting and signal generation.
- The module is intentionally minimal and idiomatic, so you can:
- Extend it with more endpoints.
- Swap it into existing projects.
- Integrate it into microservices, workers, or cron jobs.
Prerequisites
- Node.js: v16+ recommended.
- A CoinMarketCap Pro API key (free or paid plan).
Sign up and obtain an API key from the CoinMarketCap Developer Portal.
Installation
- Add the required dependencies to your project:
npm install axios dotenv