Skip to content

ocignis/tradezap

Repository files navigation

TradeZap

npm version npm downloads CI TypeScript

⚡ Get trading data in a zap

Easily define which trading data to download 🚀

Usage

  • npm i --save-dev tradezap
  • Define which trading data you want in tradezap.config.ts file (example)
  • 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)

// 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.

Options Available

tradezap [options]

Options:
  -c, --config <filename>  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:

Development

Requirement - Bun v1.1.34+

Easily set up a local development environment!

  • clone
  • bun i
  • bun run dev

Start coding!

Contributing

All contributions are welcome!