sir-kayode / kay_data_coinmarketcap_api Goto Github PK

Introduction: This is a Python program that retrieves data from CoinMarketCap via their API. It allows users to view real-time data on cryptocurrency prices, market caps, and other relevant information. What is CoinMarketCap? CoinMarketCap is a popular website that provides cryptocurrency market data, such as prices, market capitalizations, trading volumes, and other metrics for over 10,000 cryptocurrencies. It is one of the most widely used sources of information for the cryptocurrency industry.

CoinMarketCap was founded in 2013 by Brandon Chez as a simple tool to track the prices of Bitcoin and a few other cryptocurrencies. Over time, it has grown into a comprehensive platform that provides detailed information on a wide range of cryptocurrencies, including historical data and real-time market updates.

Requirements: This program requires Python 3.x, as well as the requests libraries. You can install these libraries by running the following command: pip install requests

Installation: To install this program, simply clone this repository to your local machine:git clone https://github.com/Sir-kayode/Kay_Data_CoinMarketCap_API.git. Then, navigate to the directory where you cloned the repository and install the dependencies:pip install requests.

Configuration: To connect to the CoinMarketCap API, you will need an API key. You can obtain a key by signing up for an account on the CoinMarketCap website.

Once you have your API key, create a file named .env in the root directory of the project and add the following line: API_KEY=your_api_key_here This will allow your program to access the API using your personal key.

Usage: To use this program, simply run the main.py script from the command line:python MainKDCAPI.py This will retrieve the latest data from CoinMarketCap and display it in the terminal.

Examples: Here are some examples of how to use this program: MainKDCAPI.py --limit 10 This will retrieve data for the top 10 cryptocurrencies by market cap. MainKDCAPI.py --convert EUR This will retrieve data in Euros instead of US dollars. MainKDCAPI.py --sort rank This will sort the data by rank instead of by market cap.

Contributing: If you would like to contribute to this project, please submit a pull request with your changes. Be sure to include a description of the changes and any relevant documentation or tests. If you encounter any bugs or issues with the program, please submit a bug report in the Issues section of the repository.

License: This program is released under the MIT License. (The MIT License is a permissive free software license that allows users to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of a software program or its derivatives, subject to certain conditions.)

Contact: If you have any questions or feedback about this program, feel free to contact me at [email protected] or https://github.com/Sir-kayode.

Note that this program uses the CoinMarketCap Pro API, which requires an API key for access. You will need to sign up for a CoinMarketCap account and obtain an API key in order to use this program

Co-Collaborators : Mrs Ofomiaju Elizerbet, Mrs Damilola Olufisayo, Ms Susan and Mr. Bolurin

Time Line April 10, 2023 to April 16, 2023 Project Name:Kay_Data_CoinMarketCap_API