https://github.com/fastuptime/speedsmm_exchange_api
Welcome to the SpeedSMM Exchange Rate API! This project provides up-to-date exchange rates for various currencies. 🚀
https://github.com/fastuptime/speedsmm_exchange_api
exchange exchange-rates
Last synced: 5 months ago
JSON representation
Welcome to the SpeedSMM Exchange Rate API! This project provides up-to-date exchange rates for various currencies. 🚀
- Host: GitHub
- URL: https://github.com/fastuptime/speedsmm_exchange_api
- Owner: fastuptime
- Created: 2024-07-27T16:40:58.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-27T16:45:32.000Z (about 1 year ago)
- Last Synced: 2025-02-17T08:45:02.500Z (8 months ago)
- Topics: exchange, exchange-rates
- Language: JavaScript
- Homepage:
- Size: 3.91 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# 🌐 SpeedSMM Exchange Rate API
Welcome to the **SpeedSMM Exchange Rate API**! This project provides up-to-date exchange rates for various currencies. 🚀
## 📋 Table of Contents
- [Introduction](#introduction)
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [API Endpoints](#api-endpoints)
- [Contributing](#contributing)
- [License](#license)
- [Screenshots](#screenshots)
## 💡 Introduction
The **SpeedSMM Exchange Rate API** is designed to fetch and serve exchange rate data for multiple currencies. It updates rates regularly and provides a simple interface to access the latest rates.
## ✨ Features
- 📈 Fetch exchange rates for multiple currencies.
- 🕒 Regularly updates rates using cron jobs.
- 🔒 Secure API with key validation.
- 🗃️ Stores rates in a MongoDB database.
- 🌍 Supports a wide range of currencies.
## 🛠️ Installation
To get started with the SpeedSMM Exchange Rate API, follow these steps:
1. **Clone the repository:**
```bash
git clone https://github.com/fastuptime/SpeedSMM_Exchange_API.git
```
2. **Navigate to the project directory:**
```bash
cd SpeedSMM_Exchange_API
```
3. **Install dependencies:**
```bash
npm install
```
4. **Set up your MongoDB connection and API key:**
- Ensure MongoDB is running locally.
- Update the `mongoose.connect` URL in the code if needed.
- Replace `'YOUR_API_KEY'` with your actual API key in the middleware.
## 🚀 Usage
To run the API, use the following command:
```bash
node index.js
```
The API will be accessible at `http://localhost:3000`.
## 📡 API Endpoints
### Get all exchange rates
- **Endpoint:** `/exchange`
- **Method:** GET
- **Description:** Retrieves all exchange rates.
### Get exchange rate for a specific currency
- **Endpoint:** `/exchange/:currency`
- **Method:** GET
- **Description:** Retrieves the exchange rate for the specified currency.
## 🖥️ Screenshots
## 🤝 Contributing
We welcome contributions! Please fork the repository and create a pull request with your changes. Make sure to follow our code of conduct.
## 📜 License
This project is licensed under the MIT License.