Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/project-nv/nvjs-data-gen
Data generator for NightVision charts
https://github.com/project-nv/nvjs-data-gen
Last synced: 3 days ago
JSON representation
Data generator for NightVision charts
- Host: GitHub
- URL: https://github.com/project-nv/nvjs-data-gen
- Owner: project-nv
- Created: 2022-11-13T07:35:19.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2022-12-18T08:52:46.000Z (about 2 years ago)
- Last Synced: 2024-08-08T19:14:55.295Z (5 months ago)
- Language: JavaScript
- Size: 416 KB
- Stars: 2
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Data generator for NightVision charts
## Install
`npm i @nvjs/data-gen`
## Use
```js
import Degen from '@nvjs/data-gen'
async function main() {
let degen = new Degen()
let data = await degen.get('APEUSDT', '15m', 420)
console.log(data)
}
main()
```
## Examples
```js
// returns a simple ochlv dataset
get('APEUSDT', '1h', 4200)
// Text-based data constructor
get(`
indexBased;
$Candles {
name=Ape Tether US Binance | data=@(APEUSDT, 1h, 420)
}
+ Spline {name=EMA, 10 | data=ema(close, 10)}
+ Spline {name=EMA, 20 | data=ema(close, 20)};
Spline {
name=RSI, 14 |
data=rsi(close, 14) |
settings={ precision: 2 }
};
#pane0 { scales: { A: { precision: 2 } } };
`)
```
- `indexBased` sets the index-based mode
- `$` means that `Candles` is the main overlay.
- `@` loads data from Binance
- `rsi()`, `ema()` calculate TA with [ta.js](https://github.com/Bitvested/ta.js) lib
- `#` is for the pane settings
Lines should be separated with `;`. Each line is either:
- Overlay1 + Overlay2 + ... + OverlayN
- indexBased flag
- pane settings descriptor
Overlay props are separated with `|`:
```js
Spline { name = EMA, 20 | data = ema(close, 20) }
```
## Advanced Examples
```js
// You can filter the main data to only one component:
get(`
Spline {
name=Ape Tether US Binance |
data=@(APEUSDT, 1h, 420, close)
};
`)
// Or you can get a separate component of OHLCV as
// an overlay data:
get(`
$Candles {
name=Ape Tether US Binance |
data=@(APEUSDT, 1h, 420) |
}
+ Volume {
name = Vol |
data = volume
};
`)
// If that is not enough, you are able to build data
// element-by-element with iter() function:
get(`
$Candles {
name=Ape Tether US Binance | data=@(APEUSDT, 1h, 420) |
settings={ precision: 2 }
}
+ Volume {
name = Vol |
data = iter(i => {
if (close[i] > open[i]) {
return [volume[i], 1] // Volume Up
} else {
return [volume[i], -1] // Volume Down
}
})
};
`)
// Add scripts (use `!` prefix):
get(`
$Candles {
name=Ape Tether US Binance | data=@(APEUSDT, 1h, 420) |
settings={ precision: 2 }
}
+ !EMA {
props = {
length: 12
}
};
`)
```