Skip to content

Crypto Data API is a RESTful API that provides access to cryptocurrency data, including coin details, news articles, top gainers and losers, and more. It scrapes data from various websites to generate data and serves them in their respective endpoints.

Notifications You must be signed in to change notification settings

Arghya721/crypto-data-scrapper

Repository files navigation

Crypto Data API

Project Logo

Crypto Data API is a RESTful API that provides access to cryptocurrency data, including coin details, news articles, top gainers and losers, and more.

Table of Contents

Features

  • Get details of a specific coin
  • Retrieve news articles related to cryptocurrencies
  • Get the list of top gainers and losers
  • Get list of top 100 coins

Installation

  1. Clone the repository: git clone https://github.com/your-username/crypto-data-api.git
  2. Install dependencies: npm install
  3. Configure the API settings and API keys in the appropriate configuration file.
  4. Start the server: npm start

Usage

To use the Crypto Data API, send HTTP requests to the appropriate endpoints as described below.

API Endpoints

To explore the API endpoints and their detailed descriptions, follow these steps:

  1. Start the server by running the command: npm start.
  2. Once the server is running, open your web browser.
  3. Visit http://localhost:3000/api-docs to access the Swagger documentation.
  4. The Swagger documentation provides comprehensive information about each API endpoint, including descriptions, request parameters, and example responses.

Make sure to have the server running before accessing the Swagger documentation. If the server is running on a different port or URL, replace localhost:3000 with the appropriate URL where your API is hosted.

Contributing

Contributions to the Crypto Data API are welcome! If you find any issues or have suggestions for improvement, please feel free to submit a pull request or open an issue in the repository.

About

Crypto Data API is a RESTful API that provides access to cryptocurrency data, including coin details, news articles, top gainers and losers, and more. It scrapes data from various websites to generate data and serves them in their respective endpoints.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published