coinglecko - v0.1.0

coinglecko/exchanges

Exchange data endpoints.

Types

Exchange

</>

Detailed exchange data.

pub type Exchange {
  Exchange(
    id: String,
    name: String,
    year_established: option.Option(Int),
    country: option.Option(String),
    trust_score: option.Option(Int),
    trust_score_rank: option.Option(Int),
    trade_volume_24h_btc: Float,
  )
}

Constructors

ExchangeListItem

</>

A simple exchange list item (id and name only).

pub type ExchangeListItem {
  ExchangeListItem(id: String, name: String)
}

Constructors 

  • ExchangeListItem(id: String, name: String)

ExchangeTicker

</>

Exchange ticker data.

pub type ExchangeTicker {
  ExchangeTicker(
    base: String,
    target: String,
    coin_id: String,
    target_coin_id: String,
    last: Float,
    volume: Float,
    trust_score: option.Option(String),
  )
}

Constructors 

  • ExchangeTicker(
  base: String,
  target: String,
  coin_id: String,
  target_coin_id: String,
  last: Float,
  volume: Float,
  trust_score: option.Option(String),
)

ExchangeTickersResponse

</>

Exchange tickers response.

pub type ExchangeTickersResponse {
  ExchangeTickersResponse(
    name: String,
    tickers: List(ExchangeTicker),
  )
}

Constructors 

  • ExchangeTickersResponse(
  name: String,
  tickers: List(ExchangeTicker),
)

Values

decode_exchange

</> 
pub fn decode_exchange(
  json_string: String,
) -> Result(Exchange, error.CoinGeckoError)

Decode an exchange detail from a JSON string.

decode_exchange_list

</> 
pub fn decode_exchange_list(
  json_string: String,
) -> Result(List(ExchangeListItem), error.CoinGeckoError)

Decode an exchange list from a JSON string.

decode_exchange_tickers

</> 
pub fn decode_exchange_tickers(
  json_string: String,
) -> Result(ExchangeTickersResponse, error.CoinGeckoError)

Decode exchange tickers from a JSON string.

get_by_id

</> 
pub fn get_by_id(
  client: client.Client,
  id id: String,
  send sender: fn(request.Request(String)) -> Result(
    response.Response(String),
    String,
  ),
) -> Result(Exchange, error.CoinGeckoError)

Get detailed data for a specific exchange.

get_by_id_request

</> 
pub fn get_by_id_request(
  client: client.Client,
  id id: String,
) -> Result(request.Request(String), error.CoinGeckoError)

Build a request to get detailed data for a specific exchange.

list

</> 
pub fn list(
  client: client.Client,
  send sender: fn(request.Request(String)) -> Result(
    response.Response(String),
    String,
  ),
) -> Result(List(ExchangeListItem), error.CoinGeckoError)

Get list of all supported exchanges (id and name only).

list_request

</> 
pub fn list_request(
  client: client.Client,
) -> Result(request.Request(String), error.CoinGeckoError)

Build a request to get list of all supported exchanges.

tickers

</> 
pub fn tickers(
  client: client.Client,
  id id: String,
  coin_ids coin_ids: option.Option(String),
  page page: option.Option(Int),
  order order: option.Option(String),
  depth depth: option.Option(Bool),
  send sender: fn(request.Request(String)) -> Result(
    response.Response(String),
    String,
  ),
) -> Result(ExchangeTickersResponse, error.CoinGeckoError)

Get tickers for a specific exchange.

tickers_request

</> 
pub fn tickers_request(
  client: client.Client,
  id id: String,
  coin_ids coin_ids: option.Option(String),
  page page: option.Option(Int),
  order order: option.Option(String),
  depth depth: option.Option(Bool),
) -> Result(request.Request(String), error.CoinGeckoError)

Build a request to get tickers for a specific exchange.

✨ Search Document