Skip to content

Latest commit

 

History

History
168 lines (134 loc) · 7.1 KB

README.md

File metadata and controls

168 lines (134 loc) · 7.1 KB
Raw

Bitcoin Price Analysis and Real-Time Data API

As a Data Scientist with 3 years of experience, I am expanding my skill set to include FastAPI, a modern web framework for building APIs with Python. This repository serves as my first project based on my previous work on Bitcoin Price Analysis Before the 2024 Halving. This comprehensive API provides both historical and real-time Bitcoin price analysis, designed to be a valuable resource for developers, traders and analysts. The project is built with a focus on efficiency, scalability, and reliability, using FastAPI, PostgreSQL and real-time data integration with multiple cryptocurrency exchanges.

If you find this project useful, kindly consider giving it a star ⭐ on GitHub. Contributions are also welcome as it is intended for open-source collaboration!

alt text

Table of Contents

Overview

The Bitcoin Price Analysis and Real-Time Data API offers a comprehensive solution for accessing both historical and real-time Bitcoin prices. The API is built with FastAPI, leveraging its speed and ease of use and integrates multiple cryptocurrency exchanges to provide up-to-date market data.

Features

  • Historical Data Retrieval: Fetch daily Bitcoin prices for any year between 2013 and 2024.
  • Real-Time Data Access: Get the latest Bitcoin prices from major exchanges like CoinGecko, Coincap, Binance and Kraken.
  • API Endpoints: A range of endpoints for accessing Bitcoin prices, including those around halving events.
  • Scalable and Efficient: Built with FastAPI and PostgreSQL to handle large datasets and provide fast responses.

Technologies Used

  • FastAPI: For building the RESTful API.
  • SQLAlchemy: For database ORM and query management.
  • PostgreSQL: For storing Bitcoin price data.
  • Uvicorn: ASGI server for running the FastAPI application.

Getting Started

alt text

Prerequisites

  • Python 3.8 or later
  • PostgreSQL database
  • Git

Installation

  1. Clone the repository:
git clone https://github.com/your-username/Bitcoin-Price-Analysis-API.git
  1. Navigate to the project directory:
cd Bitcoin-Price-Analysis-API
  1. Set up the virtual environment and activate it:
python -m venv BTC_Price_API
source BTC_Price_API/bin/activate  # For Linux/MacOS
BTC_Price_API\Scripts\activate     # For Windows
  1. Install the dependencies:
pip install -r requirements.txt
  1. Set up the PostgreSQL database:
  • Create a PostgreSQL database for the project.
  • Update the DATABASE_URL in the .env file with your PostgreSQL connection string.

Usage: Running the API

  1. Start the FastAPI server:
uvicorn main:app --reload
  1. Access the API documentation: Open your browser and navigate to http://127.0.0.1:8000/docs to see the interactive Swagger UI documentation.

API Endpoints

  1. Historical Data Endpoints:
- **GET /root/**
  - Description: Provides an overview of the API including a list of available endpoints and their descriptions.
  - Route: `/api/0.1.0/root/`

- **GET /prices/**
  - Description: Retrieves all historical Bitcoin prices from the PostgreSQL database.
  - Route: `/api/prices/`

- **GET /prices/{year}**
  - Description: Fetches Bitcoin prices for a specific year by providing the year as a parameter in the URL.
  - Route: `/api/prices/{year}`

- **GET /prices/halving/{halving_number}**
  - Description: Provides Bitcoin price data around specific halving events.
  - Route: `/api/prices/halving/{halving_number}`

- **GET /historical/prices/statistics**
  - Description: Provides statistical analysis of Bitcoin prices (e.g., average, highest, lowest).
  - Route: `/api/historical/prices/statistics`
  1. Real-Time Data Endpoints:
- **GET /coingecko**
  - Description: Fetches the current Bitcoin price from the CoinGecko platform.
  - Route: `/api/coingecko`

- **GET /coincap**
  - Description: Fetches the latest Bitcoin price from CoinCap.
  - Route: `/api/coincap`

- **GET /prices/binance**
  - Description: Retrieves the most recent Bitcoin price from the Binance exchange.
  - Route: `/api/prices/binance`

- **GET /kraken**
  - Description: Fetches the most recent Bitcoin price from the Kraken exchange.
  - Route: `/api/kraken`

Database Setup

  • Data Acquisition: Historical Bitcoin price data is sourced from Yahoo Finance and saved as a CSV file. This data is cleaned and validated for accuracy.
  • Database Initialisation: A PostgreSQL database is set up to store the historical data, enabling efficient querying and analysis.
  • Database Population: Use scripts to populate the database with historical data.

Real-Time Data Integration

The API integrates with multiple cryptocurrency exchanges (Bybit, Binance, Kucoin and Coinbase) to provide real-time Bitcoin prices. This allows for up-to-date market analysis and decision-making.

API Implementation and Deployment

  • FastAPI: Chosen for its speed and ease of use, supporting asynchronous programming, automatic documentation and data validation.
  • PostgreSQL: Serves as the robust database for historical data storage ensuring data integrity and scalability.

Benefits and Applications

  • Trading: Access to historical and real-time Bitcoin data for trading strategies, backtesting and alerts.
  • Data Analysis: Tools for researchers and analysts to study Bitcoin price trends and build predictive models.
  • Application Development: Supports the development of cryptocurrency-related applications such as wallets and price tracking tools.

Future Enhancements

  • Additional Exchange Integrations: Expanding data sources for broader market coverage.
  • Advanced Analytics: Adding features like moving averages, volatility calculations and technical indicators.
  • Real-Time Charts and Visualisations: Enhancing user experience with interactive charts.
  • Machine Learning Integration: Implementing models for price prediction and sentiment analysis.

Contributing

Contributions are welcome! Please read the contributing guidelines for details on how to contribute.

- Fork the repository.
- Create a new feature branch (git checkout -b feature-name).
- Commit your changes (git commit -m 'Add some feature').
- Push to the branch (git push origin feature-name).
- Open a pull request.

License

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

Contact

For any inquiries or feedback please contact me at https://nafisalawalidris.github.io/13/.