coinglecko - v0.1.0

coinglecko/nfts

Check CoinGecko NFT collection data.

Types

NftDetail

</>

Detailed NFT collection data.

pub type NftDetail {
  NftDetail(
    id: String,
    contract_address: option.Option(String),
    asset_platform_id: option.Option(String),
    name: String,
    symbol: option.Option(String),
    description: option.Option(String),
    native_currency: option.Option(String),
    floor_price: option.Option(Float),
    market_cap: option.Option(Float),
    volume_24h: option.Option(Float),
    floor_price_24h_percentage_change: option.Option(Float),
    number_of_unique_addresses: option.Option(Int),
    total_supply: option.Option(Int),
  )
}

Constructors

NftListItem

</>

An NFT collection in the list endpoint.

pub type NftListItem {
  NftListItem(
    id: String,
    contract_address: String,
    name: String,
    asset_platform_id: String,
    symbol: String,
  )
}

Constructors 

  • NftListItem(
  id: String,
  contract_address: String,
  name: String,
  asset_platform_id: String,
  symbol: String,
)

NftMarketChartData

</>

NFT market chart data with timestamp-value pairs.

pub type NftMarketChartData {
  NftMarketChartData(
    floor_price_usd: List(#(Float, Float)),
    floor_price_native: List(#(Float, Float)),
    volume_24h_usd: List(#(Float, Float)),
    volume_24h_native: List(#(Float, Float)),
    market_cap_usd: List(#(Float, Float)),
    market_cap_native: List(#(Float, Float)),
  )
}

Constructors 

  • NftMarketChartData(
  floor_price_usd: List(#(Float, Float)),
  floor_price_native: List(#(Float, Float)),
  volume_24h_usd: List(#(Float, Float)),
  volume_24h_native: List(#(Float, Float)),
  market_cap_usd: List(#(Float, Float)),
  market_cap_native: List(#(Float, Float)),
)

Values

decode_nft_detail

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

Decode an NFT detail response from a JSON string.

decode_nft_list

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

Decode an NFT list response from a JSON string.

decode_nft_market_chart

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

Decode an NFT market chart response from a JSON string.

get_by_contract

</> 
pub fn get_by_contract(
  client: client.Client,
  platform_id platform_id: String,
  contract_address contract_address: String,
  send sender: fn(request.Request(String)) -> Result(
    response.Response(String),
    String,
  ),
) -> Result(NftDetail, error.CoinGeckoError)

Get NFT collection data by contract address.

get_by_contract_request

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

Build a request to get NFT collection data by contract address.

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(NftDetail, error.CoinGeckoError)

Get detailed data for an NFT collection by ID.

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 an NFT collection by ID.

list

</> 
pub fn list(
  client: client.Client,
  order order: option.Option(String),
  per_page per_page: option.Option(Int),
  page page: option.Option(Int),
  send sender: fn(request.Request(String)) -> Result(
    response.Response(String),
    String,
  ),
) -> Result(List(NftListItem), error.CoinGeckoError)

Get list of all supported NFT collections.

list_request

</> 
pub fn list_request(
  client: client.Client,
  order order: option.Option(String),
  per_page per_page: option.Option(Int),
  page page: option.Option(Int),
) -> Result(request.Request(String), error.CoinGeckoError)

Build a request to get list of all supported NFT collections.

market_chart

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

Get NFT market chart data.

market_chart_request

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

Build a request to get NFT market chart data.

✨ Search Document