ca

cardano-api

Promise Wrapper for the Cardano Explorer API

Showing:

Popularity

Downloads/wk

3

GitHub Stars

11

Maintenance

Last Commit

3yrs ago

Contributors

2

Package

Dependencies

1

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Reviews

Average Rating

5.0/51
Read All Reviews

Top Feedback

1Great Documentation
1Easy to Use
1Performant
1Highly Customizable
1Bleeding Edge
1Responsive Maintainers

Readme

cardano-api

Wrapper for the Cardano Explorer API.

const cardano = require('cardano-api')

const address = 'DdzFFzCqrht8iQ2utWYssBnfGvSqkGfM7fxHXZWoB57ormT17td1CY4Eye7bADF6HpeGC57vwV5ZPzmVjiZRQEkAD9Rc4P8LDF7FfYne'

// promise
cardano.address({address})
  .then(data => console.log('promise', data))
  .catch(err => console.log('err', err))

// async/await
const myCardanoFunc = async address => {
  try {
    const data = await cardano.address(address)
    console.log('async/await', data)  
  }
  catch(err) { console.log(err) }
}

myCardanoFunc({address})

Endpoints

cardano.address() - /api/addresses/summary/{address}

// Get summary information about an address
const query = {
    address: 'Ae2tdP...fQwGpm'  // Required, wallet address to check
}

cardano.address(query)
  .then(data => console.log('address', data))

cardano.block() - /api/blocks/summary/{hash}

// Get block's summary information
const query = {
    hash: '52659d...195a70' // Required, block hash to check
}

cardano.block(query)
  .then(data => console.log('block', data))

cardano.blockTransaction() - /api/blocks/txs/{hash}

// Get brief information about transaction based on blocks
// For info on specific transactions use cardano.transaction()
const query = {
    hash: '52659d...195a70',    // Required, block hash to check
    limit: 10,                  // Optional
    offset: 2                   // Optional
}

cardano.blockTransaction(query)
  .then(data => console.log('blockTransaction', data))

cardano.blocksTotal() - /api/blocks/pages/total

// Get the list of total blocks
const query = {
    pageSize: 3 // Optional
}

cardano.blocksTotal(query)
  .then(data => console.log('blocksTotal', data))

cardano.genesisAddress() - /api/genesis/address/pages

const query = {
    page: 1,        // Optional
    pageSize: 3,    // Optional
    redeemed: true  // Optional
}

cardano.genesisAddress(query)
  .then(data => console.log('genesisAddress', data))

cardano.genesisPagesTotal() - /api/genesis/address/pages/total

const query = {
    pageSize: 3,    // Optional
    redeemed: true  // Optional
}

cardano.genesisPagesTotal(query)
  .then(data => console.log('genesisPagesTotal', data))

cardano.genesisSummary() - /api/genesis/summary

cardano.genesisSummary()
  .then(data => console.log('genesisSummary', data))

cardano.epoch() - /api/search/epoch/{epoch}

// Search the blocks by epoch and slot
const query = {
    epoch: 3,   // Required, epoch to check
    slot: 24    // Optional
}

cardano.epoch(query)
  .then(data => console.log('epoch', data))

cardano.transaction() - /api/txs/summary/{txid}

// Get summary information about a transaction
const query = {
    txid: 'f3d468...3ac99b' // Required, transaction to check
}

cardano.transaction(query)
  .then(data => console.log('transaction', data))

cardano.transactionLast() - /api/txs/last

// Get information about the 20 latest transactions
cardano.transactionLast()
  .then(data => console.log('transactionLast', data))

Issues

Something not working? Please open an issue

Test

npm test

Rate & Review

Great Documentation1
Easy to Use1
Performant1
Highly Customizable1
Bleeding Edge1
Responsive Maintainers1
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
TonyThe Milky Way Galaxy13 Ratings0 Reviews
Working on spatially enabled web applications, and React Native.
3 months ago
Great Documentation
Easy to Use
Performant
Highly Customizable
Bleeding Edge
Responsive Maintainers

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial