blockfrost-api: API definitions for

[ apache, cardano, library ] [ Propose Tags ]

Core types and Servant API description

[Skip to Readme]


[Index] [Quick Jump]


Manual Flags


Production build

Automatic Flags

Turn off optimizations


Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info


Versions [RSS],,,,,,,,,,,,,,
Change log
Dependencies aeson (>=2.0 && <3.0), base (>=4.7 && <5), bytestring, containers, data-default-class, deriving-aeson, lens (>=5.0 && <5.3), safe-money (>=0.9 && <0.10), servant (>=0.18 && <0.21), servant-docs, servant-multipart-api, template-haskell, text, time, vector [details]
License Apache-2.0
Copyright 2021
Category Cardano
Home page
Source repo head: git clone
Uploaded by srk at 2024-02-16T11:30:27Z
Distributions NixOS:
Reverse Dependencies 4 direct, 0 indirect [details]
Downloads 2565 total (51 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs uploaded by user
Build status unknown [no reports yet]

Readme for blockfrost-api-

[back to package description]


Core types and Servant API definitions.

Exploring data types

All data types have a ToSample instance for servant-docs which can be used to get a sample response in cabal repl:

λ: import Data.Proxy
λ: import Servant.Docs
λ: Just block = toSample (Proxy :: Proxy Block)
λ: _blockHash block
BlockHash "4ea1ba291e8eef538635a53e59fddba7810d1679631cc3aed7c8e6c4091a516a"


Instead of using long record names, it is recommended to use provided lenses and a lens or similar package.

λ: import Control.Lens (^.)
λ: import Blockfrost.Lens
λ: block ^. epoch
Just (Epoch 425)

Monetary values

Ada values and values of assets are represented using Discrete type from safe-money library.

We use a type alias type Lovelaces = Money.Discrete "ADA" "lovelace" for Ada values and SomeDiscrete for asset values. This should allow working with monetary values safely, preventing summing different currencies. See the blog post by the library author.

λ: block ^. fees
Just (Discrete "ADA" 1000000%1 592661)