Sankalpcreat/meme_coin_dashboard

Meme Coin API

A simple Flask application that provides an API for fetching information about meme coins, including their details and historical data.

Table of Contents

• Meme Coin API
  • Table of Contents
  • Features
  • Technologies Used
  • Installation
  • Usage
  • API Endpoints
    • Get Meme Coins
    • Get Coin Details
    • Get Coin History
  • Contributing
  • License

Features

• Fetch a list of meme coins.
• Get detailed information about a specific coin.
• Retrieve historical data for a specific coin.

Technologies Used

• Python
• Flask
• Flask-Caching
• Requests

Installation

1. Clone the repository:

   git clone https://github.com/yourusername/meme-coin-api.git
   cd meme-coin-api/backend

2. Create a virtual environment:

   python -m venv venv

3. Activate the virtual environment:

   • On macOS/Linux:

     source venv/bin/activate

   • On Windows:

     venv\Scripts\activate

4. Install the required packages:

   pip install -r requirements.txt

Usage

1. Start the Flask application:

   python run.py

2. The application will run on http://127.0.0.1:5001.

API Endpoints

Get Meme Coins

• Endpoint: /api/meme-coins
• Method: GET
• Description: Fetch a list of meme coins.

Get Coin Details

• Endpoint: /api/coin/<coin_id>
• Method: GET
• Description: Fetch details for a specific coin.
• Parameters:
  • coin_id: The ID of the coin.

Get Coin History

• Endpoint: /api/history/<coin_id>
• Method: GET
• Description: Fetch historical data for a specific coin.
• Parameters:
  • coin_id: The ID of the coin.
  • days: (Optional) Number of days of historical data to fetch (default is 7).

Contributing

Contributions are welcome! Please feel free to submit a pull request or open an issue for any suggestions or improvements.

License

This project is licensed under the MIT License - see the LICENSE file for details.