Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
serkor1 committed Oct 6, 2023
1 parent 7f808ed commit a479efd
Showing 1 changed file with 15 additions and 40 deletions.
55 changes: 15 additions & 40 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,46 +26,6 @@ exchanges will be added in the future.
> different exchange APIs allows. The lowest interval is 1s (Seconds),
> and the highest is 1M (Months)
#### Basic usage

Get USDT denominated ATOM in the spot market from Binance in `30m`
intervals,

``` r
## get perpetual contracts on USDT denominated ATOM
spotPrice <- cryptoQuotes::getQuote(
ticker = 'ATOMUSDT',
source = 'binance',
futures = FALSE,
interval = '30m'
)
```

This `spotPrice` can be passed to the `chartSeries` from `quantmod`
directly to chart it with candlesticks.

``` r
## chart the spotPrice series
## using quantmod
quantmod::chartSeries(
x = spotPrice,
theme = quantmod::chartTheme('black')
)
```

<img src="man/figures/README-chartSeries-1.png" width="100%" />

When the `spotPrice` has been charted, the indicators in `quantmod` is
directly applicable. See for example `addBBands`

``` r
## add bollinger bands
## using quantmod
quantmod::addBBands()
```

<img src="man/figures/README-addBBands-1.png" width="100%" />

#### Installation

**Stable Version**
Expand All @@ -85,3 +45,18 @@ devtools::install_github(
ref = 'development'
)
```

#### Basic usage

Get USDT denominated ATOM in the spot market from Binance in `30m`
intervals,

``` r
## get perpetual contracts on USDT denominated ATOM
spotPrice <- cryptoQuotes::getQuote(
ticker = 'ATOMUSDT',
source = 'binance',
futures = FALSE,
interval = '30m'
)
```

0 comments on commit a479efd

Please sign in to comment.