https://github.com/bitcoin-balancer/api
The api is a RESTful service that seamlessly integrates with your configured exchange(s), feeds real-time market data to indicators, and executes your defined trading strategy.
https://github.com/bitcoin-balancer/api
bitcoin dca dollar-cost-averaging investment open-source profit strategy trading trading-strategy value-averaging
Last synced: 6 months ago
JSON representation
The api is a RESTful service that seamlessly integrates with your configured exchange(s), feeds real-time market data to indicators, and executes your defined trading strategy.
- Host: GitHub
- URL: https://github.com/bitcoin-balancer/api
- Owner: bitcoin-balancer
- License: other
- Created: 2024-06-22T15:02:57.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-01T15:26:45.000Z (7 months ago)
- Last Synced: 2025-03-01T16:27:11.947Z (7 months ago)
- Topics: bitcoin, dca, dollar-cost-averaging, investment, open-source, profit, strategy, trading, trading-strategy, value-averaging
- Language: TypeScript
- Homepage: https://balancer.jesusgraterol.dev
- Size: 1.21 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# `api`
The `api` is a RESTful service that seamlessly integrates with your configured exchange(s), feeds real-time market data to indicators, and executes your defined trading strategy. It enables you to:
* **Automate your strategy** – Eliminate the need for constant monitoring and manual trades
* **Trade on any exchange** – Stay flexible by using your preferred exchange platform
* **Effortless configuration** – Manage and fine-tune your strategy’s parameters directly via the [`gui`](https://github.com/bitcoin-balancer/gui)
With the `api`, you can confidently execute a proven trading strategy, optimizing returns while minimizing manual effort.
## Docs
- [Errors](./docs/errors/index.md)
## Docker Image
[jesusgraterol/balancer-api](https://hub.docker.com/r/jesusgraterol/balancer-api)
## Scripts
Build the API
```bash
npm run build
```
## Tests
**Important:** these tests are to be executed from [`cli`](https://github.com/bitcoin-balancer/cli) as they must run in a containerized environment.
```bash
# run the integration tests
npm run test:integration
# run the unit tests
npm run test:unit
# run the benchmarks
npm run test:bench
```
## License
[Apache v2.0](https://www.apache.org/licenses/LICENSE-2.0)