candle

OHLCV candle data — seconds, minutes, days, weeks, months, years.

Types

Candle

OHLCV candle data.

pub type Candle {
  Candle(
    market: String,
    candle_date_time_utc: String,
    candle_date_time_kst: String,
    opening_price: Float,
    high_price: Float,
    low_price: Float,
    trade_price: Float,
    timestamp: Int,
    candle_acc_trade_price: Float,
    candle_acc_trade_volume: Float,
    prev_closing_price: option.Option(Float),
    change_price: option.Option(Float),
    change_rate: option.Option(Float),
    converted_trade_price: option.Option(Float),
    unit: option.Option(Int),
  )
}

Constructors

Candle(
  market: String,
  candle_date_time_utc: String,
  candle_date_time_kst: String,
  opening_price: Float,
  high_price: Float,
  low_price: Float,
  trade_price: Float,
  timestamp: Int,
  candle_acc_trade_price: Float,
  candle_acc_trade_volume: Float,
  prev_closing_price: option.Option(Float),
  change_price: option.Option(Float),
  change_rate: option.Option(Float),
  converted_trade_price: option.Option(Float),
  unit: option.Option(Int),
)

MinuteUnit

Minute candle unit.

pub type MinuteUnit {
  Min1
  Min3
  Min5
  Min10
  Min15
  Min30
  Min60
  Min240
}

Constructors

```
Min1
```
```
Min3
```
```
Min5
```
```
Min10
```
```
Min15
```
```
Min30
```
```
Min60
```
```
Min240
```

Values

candle_decoder

pub fn candle_decoder() -> decode.Decoder(Candle)

Decoder for Candle JSON object.

get_days

pub fn get_days(
  c: client.PublicClient,
  market market: types.Market,
  to to: option.Option(String),
  count count: option.Option(Int),
) -> Result(types.ApiResponse(List(Candle)), types.ApiError)

GET /candles/days

get_minutes

pub fn get_minutes(
  c: client.PublicClient,
  unit unit: MinuteUnit,
  market market: types.Market,
  to to: option.Option(String),
  count count: option.Option(Int),
) -> Result(types.ApiResponse(List(Candle)), types.ApiError)

GET /candles/minutes/{unit}

get_months

pub fn get_months(
  c: client.PublicClient,
  market market: types.Market,
  to to: option.Option(String),
  count count: option.Option(Int),
) -> Result(types.ApiResponse(List(Candle)), types.ApiError)

GET /candles/months

get_seconds

pub fn get_seconds(
  c: client.PublicClient,
  market market: types.Market,
  to to: option.Option(String),
  count count: option.Option(Int),
) -> Result(types.ApiResponse(List(Candle)), types.ApiError)

GET /candles/seconds

get_weeks

pub fn get_weeks(
  c: client.PublicClient,
  market market: types.Market,
  to to: option.Option(String),
  count count: option.Option(Int),
) -> Result(types.ApiResponse(List(Candle)), types.ApiError)

GET /candles/weeks

get_years

pub fn get_years(
  c: client.PublicClient,
  market market: types.Market,
  to to: option.Option(String),
  count count: option.Option(Int),
) -> Result(types.ApiResponse(List(Candle)), types.ApiError)

GET /candles/years