The Pair Price and Volume API offers a RESTful interface for managing price and volume data for trading pairs. Built using MongoDB Atlas and Node.js with Express.js, it provides CRUD operations with validation and error handling for efficient data interaction. Ideal for developers, traders, and analysts needing seamless access to pair data.
- CRUD operations for pairs
- MongoDB Atlas integration
- Error and response handling and validation
- MongoDB
- Node.js
- Express.js
- Mongoose
Provide instructions on how to install and set up your project locally. Include any prerequisites and steps necessary to get the project up and running.
git clone https://github.com/arpitjaiswal12/ScaleX_Task_backend.git
npm install
npm run dev
List and describe the available API endpoints, along with their functionality and any required parameters.
{{SERVER}} :: http://localhost:8000/ or hosted server url
- GET {{SERVER}}/api/v1/get/pairs : Retrieve all pairs from the database. (This endpoint retrieves all pairs stored in the database. It allows clients to fetch the entire list of trading pairs )
- GET {{SERVER}}/get-price-volume/:pairID : fetch price and volume data from Pair dataset
- POST {{SERVER}}/api/v1/create/pair : Create a new pair. (This endpoint creates a new pair in the database. Clients can use this endpoint to add a new trading pair)
- PUT {{SERVER}}/api/v1/upadate/:pairID : Update a specific pair. (This endpoint updates a specific pair in the database based on its ID. Clients can use this endpoint to modify the price and volume data of an existing trading pair.)
- DELETE {{SERVER}}/api/v1/delete/:pairID : Delete a specific pair. (This endpoint deletes a specific pair from the database based on its ID. Clients can use this endpoint to remove a trading pair that is no longer needed.)