Skip to content

Latest commit

 

History

History
78 lines (54 loc) · 1.87 KB

PYPI_README.md

File metadata and controls

78 lines (54 loc) · 1.87 KB

Python Cardano Explorer PyPI - Python Version PyPI - Python Version

Python wrapper for accessing and processing information stored on the Cardano blockchain using Blockfrost API.

Install

pip install cardano_explorer

Usage

from cardano_explorer import blockfrost_api

Api Key

If you have an API key, you can either set it as environment variable BLOCKFROST_API_KEY or set it manually.

mainnet = blockfrost_api.Auth()
#or
mainnet = blockfrost_api.Auth(api_key=api_key)

Using With Proxy

proxies = {
 "http": "http://user:password@server:port",
 "https": "https://user:password@server:portt",
}

cardano_mainnet = blockfrost_api.Auth(proxies=proxies)

Network

You can specify the cardano network with the class parameter network.

mainnet = blockfrost_api.Auth() # mainnet by default
#or
preprod = blockfrost_api.Auth(network='preprod')
#or
preview = blockfrost_api.Auth(network='preview')
#or
legacy = blockfrost_api.Auth(network='testnet')

Quickstart

Return detailed about the network.

mainnet.network_info()
{'supply': {'max': '45000000000000000',
  'total': '33206309572085375',
  'circulating': '32854605043085013',
  'locked': '11030148142156',
  'treasury': '630037263793143',
  'reserves': '11793690427914625'},
 'stake': {'live': '23374530755001598', 'active': '23395112387185878'}}

Documentation

The official documentation is hosted on GitHub.

Credit

Disclaimer

The project is still under development, If you find bugs or want additional features, open an issue and/or create a pull request.