Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/khachatur/financialpriceservice
A .NET 8.0 Web API and WebSocket service that provides real-time financial instrument prices sourced from Binance. The service efficiently handles over 1,000 WebSocket subscribers and supports multiple instruments like BTCUSD, ETHUSD, and EURUSD. It features endpoints for fetching current prices and subscribing to live price updates.
https://github.com/khachatur/financialpriceservice
aspnet-core binance dotnet financial real-time webapi websocket
Last synced: about 1 month ago
JSON representation
A .NET 8.0 Web API and WebSocket service that provides real-time financial instrument prices sourced from Binance. The service efficiently handles over 1,000 WebSocket subscribers and supports multiple instruments like BTCUSD, ETHUSD, and EURUSD. It features endpoints for fetching current prices and subscribing to live price updates.
- Host: GitHub
- URL: https://github.com/khachatur/financialpriceservice
- Owner: khachatur
- Created: 2024-06-20T16:19:42.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-06-26T16:01:15.000Z (6 months ago)
- Last Synced: 2024-06-26T19:31:53.103Z (6 months ago)
- Topics: aspnet-core, binance, dotnet, financial, real-time, webapi, websocket
- Language: C#
- Homepage:
- Size: 14.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Financial Price Service
This project provides REST API and WebSocket endpoints for live financial instrument prices sourced from Binance. It supports efficiently handling over 1,000 subscribers.
This implementation supports dynamic handling of multiple financial instruments.
## Prerequisites
- [.NET 8.0 SDK](https://dotnet.microsoft.com/download/dotnet/8.0)
- A code editor (e.g., [Visual Studio Code](https://code.visualstudio.com/))
## Setup and Run
1. **Clone the repository:**
```sh
git clone https://github.com/khachatur/FinancialPriceService.git
cd FinancialPriceService
```
2. **Restore the dependencies:**
```sh
dotnet restore
```
3. **Build the project:**
```sh
dotnet build
```
4. **Run the application:**
```sh
dotnet run
```
5. **Open the sample client:**
Open `wwwroot/index.html` in a web browser to see real-time price updates.
## Endpoints
### REST API
- **Get List of Instruments:**
`GET /api/prices/instruments`
Returns the list of available financial instruments.
Example response:
```json
["BTCUSD", "ETHUSD", "EURUSD"]
```
- **Get Current Price:**
`GET /api/prices/currentprice/{instrument}`
Returns the current price of the specified financial instrument.
Example response:
```json
{
"Instrument": "BTCUSD",
"Price": 66315.15
}
```
## WebSocket
- **Subscribe to Live Price Updates:**
Connect to `ws://localhost:5273/ws` using a WebSocket client to receive live updates for BTCUSD from Binance.
## Project Structure
- **Program.cs:** Main entry point of the application, configures services, and sets up endpoints.
- **WebSocketConnectionManager.cs:** Manages WebSocket connections and broadcasting messages.
- **PriceStore.cs:** Stores and updates the latest prices.
- **Controllers/PricesController.cs:** Handles REST API requests for financial instrument prices.
- **Services/BinanceWebSocketService.cs:** Background service that connects to Binance WebSocket and updates prices.
- **Hubs/PriceHub.cs:** Defines the SignalR hub that clients can connect to for receiving real-time updates.
- **wwwroot/:** Contains static files for the project, including a sample client (index.html) to test SignalR connections.
## Logging
The application logs important events and errors to the console. Ensure you check the console output for real-time logging information.
## Notes
- The application subscribes to the Binance WebSocket stream for BTCUSD price updates. You can modify the code to subscribe to additional instruments if needed.
- The application is designed to handle over 1,000 WebSocket subscribers efficiently.
## Troubleshooting
If you encounter any issues, please check the following:
- Ensure you have .NET 8.0 SDK installed and properly set up on your machine.
- Check the console logs for any error messages.
- Ensure you have a stable internet connection to connect to Binance WebSocket.