https://github.com/ksysoev/deriv-api-bff-example
Example of usage for Deriv API BFF service
https://github.com/ksysoev/deriv-api-bff-example
api bff deriv websocket
Last synced: 14 days ago
JSON representation
Example of usage for Deriv API BFF service
- Host: GitHub
- URL: https://github.com/ksysoev/deriv-api-bff-example
- Owner: ksysoev
- License: mit
- Created: 2024-11-05T14:11:14.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-15T15:01:05.000Z (over 1 year ago)
- Last Synced: 2025-03-03T09:29:18.688Z (over 1 year ago)
- Topics: api, bff, deriv, websocket
- Language: JavaScript
- Homepage:
- Size: 21.5 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Deriv API BFF Example
This repository provides an example configuration for the Deriv API Backend for Frontend (BFF) service. It offers a simple way to start working with this service, including setup instructions and configuration management.
## Getting Started
### Start the Service Locally
To start the service locally using Docker Compose, run the following command:
```sh
docker compose up
```
### Update Configuration
If you need to update the API configuration, you can upload the new configuration without restarting the service. Use the following command:
```sh
docker compose run upload-api-config
```
### Example API Call
You can test the API using a WebSocket client. Here is an example of how to call the API:
```sh
wsget 'ws://localhost:8080?app_id=1089&l=en'
```
Use Enter to input the request and send it, and Ctrl+C to exit.
Example request:
```json
{
"method": "aggregate",
"params": {
"country": "ru"
}
}
```