Documentation

Fields

• projectEnv :: Env
   
• projectId :: Text
   

Fields

• _address :: route :- (Summary "List metadata about specific address" :> (Description "List metadata about specific address" :> (Capture "address" Address :> Get '[JSON] NutlinkAddress)))
   
• _listAddressTickers :: route :- (Summary "List tickers for a specific metadata oracle" :> (Description "List tickers for a specific metadata oracle" :> (Capture "address" Address :> ("tickers" :> (Pagination :> (Sorting :> Get '[JSON] [NutlinkAddressTicker]))))))
   
• _addressTickers :: route :- (Summary "List of records of a specific ticker" :> (Description "List of records of a specific ticker" :> (Capture "address" Address :> ("tickers" :> (Capture "ticker" Text :> (Pagination :> (Sorting :> Get '[JSON] [NutlinkTicker])))))))
   
• _tickers :: route :- (Summary "List of records of a specific ticker" :> (Description "List of records of a specific ticker" :> ("tickers" :> (Capture "ticker" Text :> (Pagination :> (Sorting :> Get '[JSON] [(Address, NutlinkTicker)]))))))
   

Fields

• _tx :: route :- (Summary "Specific transaction" :> (Description "Return content of the requested transaction." :> (Capture "hash" TxHash :> Get '[JSON] Transaction)))
   
• _txUtxos :: route :- (Summary "Transaction UTXOs" :> (Description "Return the inputs and UTXOs of the specific transaction." :> (Capture "hash" TxHash :> ("utxos" :> Get '[JSON] TransactionUtxos))))
   
• _txRedeemers :: route :- (Summary "Transaction redeemers" :> (Description "Obtain the transaction redeemers." :> (Capture "hash" TxHash :> ("redeemers" :> Get '[JSON] [TransactionRedeemer]))))
   
• _txStakes :: route :- (Summary "Transaction stake addresses certificates " :> (Description "Obtain information about (de)registration of stake addresses within a transaction." :> (Capture "hash" TxHash :> ("stakes" :> Get '[JSON] [TransactionStake]))))
   
• _txDelegations :: route :- (Summary "Transaction delegation certificates" :> (Description "Obtain information about delegation certificates of a specific transaction." :> (Capture "hash" TxHash :> ("delegations" :> Get '[JSON] [TransactionDelegation]))))
   
• _txWithdrawals :: route :- (Summary "Transaction withdrawal" :> (Description "Obtain information about withdrawals of a specific transaction." :> (Capture "hash" TxHash :> ("withdrawals" :> Get '[JSON] [TransactionWithdrawal]))))
   
• _txMirs :: route :- (Summary "Transaction MIRs" :> (Description "Obtain information about Move Instantaneous Rewards (MIRs) of a specific transaction." :> (Capture "hash" TxHash :> ("mirs" :> Get '[JSON] [TransactionMir]))))
   
• _txPoolUpdates :: route :- (Summary "Transaction stake pool registration and update certificates" :> (Description "Obtain information about stake pool registration and update certificates of a specific transaction." :> (Capture "hash" TxHash :> ("pool_updates" :> Get '[JSON] [TransactionPoolUpdate]))))
   
• _txPoolRetiring :: route :- (Summary "Transaction stake pool retirement certificates" :> (Description "Obtain information about stake pool retirements within a specific transaction." :> (Capture "hash" TxHash :> ("pool_retires" :> Get '[JSON] [TransactionPoolRetiring]))))
   
• _txMetadataJSON :: route :- (Summary "Transaction metadata" :> (Description "Obtain the transaction metadata." :> (Capture "hash" TxHash :> ("metadata" :> Get '[JSON] [TransactionMetaJSON]))))
   
• _txCBOR :: route :- (Summary "Transaction in CBOR" :> (Description "Obtain the CBOR serialized transaction." :> (Capture "hash" TxHash :> ("cbor" :> Get '[JSON] TransactionCBOR))))
   
• _txMetadataCBOR :: route :- (Summary "Transaction metadata in CBOR" :> (Description "Obtain the transaction metadata in CBOR." :> (Capture "hash" TxHash :> ("metadata" :> ("cbor" :> Get '[JSON] [TransactionMetaCBOR])))))
   

Fields

• _networkInfo :: route :- (Summary "Network information" :> (Description "Return detailed network information." :> Get '[JSON] Network))
   
• _networkEras :: route :- (Summary "Query summary of blockchain eras" :> (Description "Returns start and end of each era along with parameters that can vary between hard forks." :> ("eras" :> Get '[JSON] [NetworkEraSummary])))
   

Fields

• _genesis :: route :- (Summary "Blockchain genesis" :> (Description "Return the information about blockchain genesis." :> Get '[JSON] Genesis))
   

Fields

• _deriveAddr :: route :- (Summary "Derive an address" :> (Description "Derive Shelley address from an xpub." :> ("addresses" :> ("xpub" :> (Capture "xpub" Text :> (Capture "role" Integer :> (Capture "index" Integer :> Get '[JSON] DerivedAddress)))))))
   
• _txEvaluate :: route :- (Summary "Submit a transaction for execution units evaluation" :> (Description "Submit an already serialized transaction to evaluate how much execution units it requires." :> ("txs" :> ("evaluate" :> (ReqBody '[CBOR] CBORString :> Post '[JSON] TxEval)))))
   
• _txEvaluateUTXOs :: route :- (Summary "Submit a transaction for execution units evaluation (additional UTXO set)" :> (Description "Submit a JSON payload with transaction CBOR and additional UTXO set to evaluate how much execution units it requires." :> ("txs" :> ("evaluate" :> ("utxos" :> (ReqBody '[JSON] TxEvalInput :> Post '[JSON] TxEval))))))
   

Fields

• _listScripts :: route :- (Summary "Scripts" :> (Description "List of scripts." :> (Pagination :> (Sorting :> Get '[JSON] ScriptHashList))))
   
• _getScript :: route :- (Summary "Specific scripts" :> (Description "Information about a specific script." :> (Capture "script_hash" ScriptHash :> Get '[JSON] Script)))
   
• _getScriptRedeemers :: route :- (Summary "Redeemers of a specific script" :> (Description "List of redeemers of a specific script." :> (Capture "script_hash" ScriptHash :> (Pagination :> (Sorting :> ("redeemers" :> Get '[JSON] [ScriptRedeemer]))))))
   
• _getScriptDatum :: route :- (Summary "Datum value" :> (Description "Query JSON value of a datum by its hash" :> ("datum" :> (Capture "datum_hash" DatumHash :> Get '[JSON] ScriptDatum))))
   
• _getScriptDatumCBOR :: route :- (Summary "Datum CBOR value" :> (Description "Query CBOR serialised datum by its hash" :> ("datum" :> (Capture "datum_hash" DatumHash :> ("cbor" :> Get '[JSON] ScriptDatumCBOR)))))
   
• _getScriptJSON :: route :- (Summary "Script JSON" :> (Description "JSON representation of a `timelock` script" :> (Capture "script_hash" ScriptHash :> ("json" :> Get '[JSON] ScriptJSON))))
   
• _getScriptCBOR :: route :- (Summary "Script CBOR" :> (Description "CBOR representation of a `plutus` script" :> (Capture "script_hash" ScriptHash :> ("cbor" :> Get '[JSON] ScriptCBOR))))
   

Fields

• _listPools :: route :- (Summary "List of stake pools" :> (Description "List of registered stake pools." :> (Pagination :> (Sorting :> Get '[JSON] [PoolId]))))
   
• _listPoolsExtended :: route :- (Summary "List of stake pools with additional information" :> (Description "List of registered stake pools with additional information." :> ("extended" :> (Pagination :> (Sorting :> Get '[JSON] [Pool])))))
   
• _listRetiredPools :: route :- (Summary "List of retired stake pools" :> (Description "List of already retired stake pools." :> ("retired" :> (Pagination :> (Sorting :> Get '[JSON] [PoolEpoch])))))
   
• _listRetiringPools :: route :- (Summary "List of retiring stake pools" :> (Description "List of stake pools retiring in the upcoming epochs" :> ("retiring" :> (Pagination :> (Sorting :> Get '[JSON] [PoolEpoch])))))
   
• _getPool :: route :- (Summary "Specific stake pool" :> (Description "Pool information." :> (Capture "pool_id" PoolId :> Get '[JSON] PoolInfo)))
   
• _getPoolHistory :: route :- (Summary "Stake pool history" :> (Description "History of stake pool parameters over epochs." :> (Capture "pool_id" PoolId :> ("history" :> (Pagination :> (Sorting :> Get '[JSON] [PoolHistory]))))))
   
• _getPoolMetadata :: route :- (Summary "Stake pool metadata" :> (Description "Stake pool registration metadata." :> (Capture "pool_id" PoolId :> ("metadata" :> Get '[JSON] PoolMetadataResponse))))
   
• _getPoolRelays :: route :- (Summary "Stake pool relays" :> (Description "Relays of a stake pool." :> (Capture "pool_id" PoolId :> ("relays" :> Get '[JSON] [PoolRelay]))))
   
• _getPoolDelegators :: route :- (Summary "Stake pool delegators" :> (Description "List of current stake pools delegators." :> (Capture "pool_id" PoolId :> ("delegators" :> (Pagination :> (Sorting :> Get '[JSON] [PoolDelegator]))))))
   
• _getPoolBlocks :: route :- (Summary "Stake pool blocks" :> (Description "List of stake pool blocks." :> (Capture "pool_id" PoolId :> ("blocks" :> (Pagination :> (Sorting :> Get '[JSON] [BlockHash]))))))
   
• _getPoolUpdates :: route :- (Summary "Stake pool updates" :> (Description "List of certificate updates to the stake pool." :> (Capture "pool_id" PoolId :> ("updates" :> (Pagination :> (Sorting :> Get '[JSON] [PoolUpdate]))))))
   

Fields

• _txMetadataLabels :: route :- (Summary "Transaction metadata labels" :> (Description "List of all used transaction metadata labels." :> ("txs" :> ("labels" :> (Pagination :> (Sorting :> Get '[JSON] [TxMeta]))))))
   
• _txMetadataByLabelJSON :: route :- (Summary "Transaction metadata content in JSON" :> (Description "Transaction metadata per label." :> ("txs" :> ("labels" :> (Capture "label" Text :> (Pagination :> (Sorting :> Get '[JSON] [TxMetaJSON])))))))
   
• _txMetadataByLabelCBOR :: route :- (Summary "Transaction metadata content in CBOR" :> (Description "Transaction metadata per label." :> ("txs" :> ("labels" :> (Capture "label" Text :> ("cbor" :> (Pagination :> (Sorting :> Get '[JSON] [TxMetaCBOR]))))))))
   

Fields

• _mempoolTransactions :: route :- (Summary "Transactions in Mempool." :> (Description "Tx hash list of all transactions that are currently stored in the mempool." :> (Pagination :> (Sorting :> Get '[JSON] [TxHashObject]))))
   
• _specificTransaction :: route :- (Summary "Transaction in mempoool." :> (Description "Content of a specific transaction in the mempool." :> (Capture "hash" TxHash :> Get '[JSON] MempoolTransaction)))
   
• _specificAddress :: route :- (Summary "Transactions involving an address in mempool." :> (Description "List of transactions in the mempool that involves a specific address." :> ("addresses" :> (Capture "address" Address :> (Pagination :> (Sorting :> Get '[JSON] [TxHashObject]))))))
   

Fields

• _dreps :: route :- (Summary "Delegate Representatives (DReps)" :> (Description "Return the information about Delegate Representatives (DReps)." :> ("dreps" :> (Pagination :> (Sorting :> Get '[JSON] [DRep])))))
   
• _drep :: route :- (Summary "Specific DRep" :> (Description "DRep information." :> ("dreps" :> (Capture "drep_id" DRepId :> Get '[JSON] DRepInfo))))
   
• _drepDelegators :: route :- (Summary "DRep delegators" :> (Description "List of Drep delegators." :> ("dreps" :> (Capture "drep_id" DRepId :> ("delegators" :> (Pagination :> (Sorting :> Get '[JSON] [DRepDelegator])))))))
   
• _drepMetadata :: route :- (Summary "DRep metadata" :> (Description "DRep metadata information." :> ("dreps" :> (Capture "drep_id" DRepId :> ("metadata" :> Get '[JSON] DRepMeta)))))
   
• _drepUpdates :: route :- (Summary "DRep updates" :> (Description "List of certificate updates to the DRep." :> ("dreps" :> (Capture "drep_id" DRepId :> ("updates" :> (Pagination :> (Sorting :> Get '[JSON] [DRepUpdate])))))))
   
• _drepVotes :: route :- (Summary "DRep votes" :> (Description "History of DReps votes." :> ("dreps" :> (Capture "drep_id" DRepId :> ("votes" :> (Pagination :> (Sorting :> Get '[JSON] [DRepVote])))))))
   
• _proposals :: route :- (Summary "Proposals" :> (Description "List of proposals." :> ("proposals" :> (Pagination :> (Sorting :> Get '[JSON] [Proposal])))))
   
• _proposal :: route :- (Summary "Specific proposal" :> (Description "Proposal details." :> ("proposals" :> (Capture "hash" TxHash :> (Capture "cert_index" Integer :> Get '[JSON] ProposalInfo)))))
   
• _paramProposal :: route :- (Summary "Specific parameters proposal" :> (Description "Parameter proposal details." :> ("proposals" :> (Capture "hash" TxHash :> (Capture "cert_index" Integer :> ("parameters" :> Get '[JSON] ParamProposal))))))
   
• _withdrawalProposal :: route :- (Summary "Specific withdrawals proposal" :> (Description "Withdrawals proposal details." :> ("proposals" :> (Capture "hash" TxHash :> (Capture "cert_index" Integer :> ("withdrawals" :> Get '[JSON] [WithdrawalProposal]))))))
   
• _proposalVotes :: route :- (Summary "Proposal votes" :> (Description "History of proposal votes." :> ("proposals" :> (Capture "hash" TxHash :> (Capture "cert_index" Integer :> ("votes" :> (Pagination :> (Sorting :> Get '[JSON] [ProposalVote]))))))))
   
• _proposalMeta :: route :- (Summary "Specific proposal metadata" :> (Description "Proposal metadata information." :> ("proposals" :> (Capture "hash" TxHash :> (Capture "cert_index" Integer :> ("metadata" :> Get '[JSON] ProposalMeta))))))
   

Fields

• _latestEpoch :: route :- (Summary "Latest epoch" :> (Description "Return the information about the latest, therefore current, epoch." :> ("latest" :> Get '[JSON] EpochInfo)))
   
• _latestEpochProtocolParams :: route :- (Summary "Latest epoch protocol parameters" :> (Description "Return the protocol parameters for the latest epoch." :> ("latest" :> ("parameters" :> Get '[JSON] ProtocolParams))))
   
• _getEpoch :: route :- (Summary "Specific epoch" :> (Description "Return the content of the requested epoch." :> (Capture "epoch_number" Epoch :> Get '[JSON] EpochInfo)))
   
• _getNextEpochs :: route :- (Summary "List of next epochs" :> (Description "Return the list of epochs following a specific epoch." :> (Capture "epoch_number" Epoch :> ("next" :> (Pagination :> Get '[JSON] [EpochInfo])))))
   
• _getPreviousEpochs :: route :- (Summary "List of previous epochs" :> (Description "Return the list of epochs preceding a specific epoch." :> (Capture "epoch_number" Epoch :> ("previous" :> (Pagination :> Get '[JSON] [EpochInfo])))))
   
• _getEpochStake :: route :- (Summary "Stake distribution" :> (Description "Return the active stake distribution for the specified epoch." :> (Capture "epoch_number" Epoch :> ("stakes" :> (Pagination :> Get '[JSON] [StakeDistribution])))))
   
• _getEpochStakeByPool :: route :- (Summary "Stake distribution by pool" :> (Description "Return the active stake distribution for the epoch specified by stake pool." :> (Capture "epoch_number" Epoch :> ("stakes" :> (Capture "pool_id" PoolId :> (Pagination :> Get '[JSON] [PoolStakeDistribution]))))))
   
• _getEpochBlocks :: route :- (Summary "Block distribution" :> (Description "Return the blocks minted for the epoch specified." :> (Capture "epoch_number" Epoch :> ("blocks" :> (Pagination :> (Sorting :> Get '[JSON] [BlockHash]))))))
   
• _getEpochBlocksByPool :: route :- (Summary "Block distribution by pool" :> (Description "Return the block minted for the epoch specified by stake pool." :> (Capture "epoch_number" Epoch :> ("blocks" :> (Capture "pool_id" PoolId :> (Pagination :> (Sorting :> Get '[JSON] [BlockHash])))))))
   
• _getEpochProtocolParams :: route :- (Summary "Protocol parameters" :> (Description "Return the protocol parameters for the specified epoch." :> (Capture "epoch_number" Epoch :> ("parameters" :> Get '[JSON] ProtocolParams))))