Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ocignis/tradezap
⚡ Get Binance trading data in a zap
https://github.com/ocignis/tradezap
binance binance-dataset bunjs cli kline trade-bot trading trading-datasets typescript
Last synced: 3 days ago
JSON representation
⚡ Get Binance trading data in a zap
- Host: GitHub
- URL: https://github.com/ocignis/tradezap
- Owner: ocignis
- License: mit
- Created: 2023-06-18T16:41:11.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-15T16:14:25.000Z (about 1 month ago)
- Last Synced: 2024-12-09T09:25:54.020Z (13 days ago)
- Topics: binance, binance-dataset, bunjs, cli, kline, trade-bot, trading, trading-datasets, typescript
- Language: TypeScript
- Homepage:
- Size: 46.9 MB
- Stars: 29
- Watchers: 2
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TradeZap
[![npm version][npm-badge]][npm-url]
[![npm downloads][downloads-badge]][npm-url]
[![CI][ci-badge]][ci-url]
[![TypeScript][typescript-badge]][typescript-url]
_⚡ Get trading data in a zap_
Easily define which trading data to download 🚀
[](https://github.com/ocignis/tradezap)
## Usage
- `npm i --save-dev tradezap`
- Define which trading data you want in `tradezap.config.ts` file ([example](example/tradezap.config.ts))
- Run `npx tradezap`
- Trading data are ready to use 📈
## Grab Trading Data 🚀
Easily define which trading data to download in `tradezap.config.ts` file ([example](example/tradezap.config.ts))
```ts
// Download ETH-BUSD daily spot trades for 1st and 2nd of January 2021, 2022 and 2023
{
tradingPair: 'ETH-BUSD',
asset: 'spot',
assetType: 'trades',
timeSpans: [
{
period: 'daily',
years: [2021, 2022, 2023],
months: [1],
days: [1, 2],
},
],
},
// Download AVAX-BUSD monthly spot trades for August and September 2023
{
tradingPair: 'AVAX-BUSD',
asset: 'spot',
assetType: 'trades',
timeSpans: [
{
period: 'monthly',
years: [2023],
months: [8, 9],
},
],
},
...
```
TradeZap CLI tool keeps your trading data up to date.
[](https://github.com/ocignis/tradezap)
## Options Available
```sh
tradezap [options]
Options:
-c, --config Config file (default: tradezap.config.ts)
--redownload Download and overwrite data again even if they already exist (default: false)
--verbose Verbose output (default: false)
-h, --help Display help
-v, --version Display version number
```
## Data Providers
Currently supported data providers:
- [Binance](https://www.binance.com/)
## Development
Requirement - [Bun v1.1.34+](https://bun.sh)
_Easily set up a local development environment!_
- clone
- `bun i`
- `bun run dev`
_Start coding!_
## Contributing
All contributions are welcome!
[npm-url]: https://www.npmjs.com/package/tradezap
[npm-badge]: https://img.shields.io/npm/v/tradezap.svg
[downloads-badge]: https://img.shields.io/npm/dm/tradezap.svg?color=blue
[ci-badge]: https://github.com/ocignis/tradezap/actions/workflows/main.yml/badge.svg
[ci-url]: https://github.com/ocignis/tradezap/actions/workflows/main.yml
[typescript-badge]: https://badges.frapsoft.com/typescript/code/typescript.svg?v=101
[typescript-url]: https://github.com/microsoft/TypeScript