/koios-python

Python API Library for Cardano Koios RESTful

Primary LanguagePythonMIT LicenseMIT

Logo-Python-Koios

Koios Python PyPI - Python Version PyPI - Python Version

Overview

Koios Python is Python wrapper which allow interacting with all information and parameters stored on the Cardano blockchain using Koios REST API

What is Koios Python?

Koios Python is a library based on Koios Elastic Query Layer for Cardano Node by Cardano Community Guild Operators.
Koios is best described as a Decentralized and Elastic RESTful query layer for exploring data on Cardano blockchain to consume within applications/wallets/explorers/etc.

Koios is really useful for developers because resource and maintenance requirements for Cardano blockchain components (e.g. cardano-node, cardano-db-sync) are ever-growing. It also simplifies how to query complex information from the blockchain.

This library allows getting data from the Cardano Blockchain using a simple syntaxis in your Python code. All the querys follow Koios API REST operations.

Required Python Modules

Installation PyPI Latest Release

pip install koios_python

Upgrade to the last Version

pip install --upgrade koios_python

Usage

Import to your python file this library:

import koios_python

You can read all info about how works this library in our Wiki

TODO

  • Managing errors
  • Inside functions
  • Pagination (most functions have it added)
  • User Inputs
  • Timeouts
  • Ordering (added to assets)
  • Adding Vertical Filtering
  • Adding Async methods

Features

  • Supported REST Services:

    • Network

      • Chain Tip
      • Genesis Info
      • Historical Tokenomic Statistics

    • Epoch

      • Epoch Information
      • Epoch's Protocol Parameters
      • Epoch Blocks Protocol

    • Block

      • Block List
      • Block Information
      • Block Transactions

    • Transactions

      • Transaction Information
      • Transaction UTxOs
      • Transaction Metadata
      • Transaction Metadata Labels
      • Transaction Submission
      • Transaction Status (Block Confirmations)

    • Address

      • Address Information
      • Address Transactions
      • Transactions from Payment Credentials
      • Address Assets

    • Account

      • Account List
      • Account Information
      • Account Information Cached
      • Account Rewards
      • Account Updates (History)
      • Account Addresses
      • Account Assets
      • Account History

    • Asset

      • Asset List
      • Asset Token Registry
      • Asset Addresses
      • Asset Address List [DEPRECATED]
      • NFT Address
      • Asset Information
      • Asset Information (Bulk)
      • Asset History
      • Policy Asset Address List
      • Policy Asset Information
      • Asset Policy Information [DEPRECATED]
      • Policy Asset List
      • Asset Summary
      • Asset Transaction (History)

    • Pool

      • Pool List
      • Pool Information
      • Stake Snapshot
      • Pool Delegators List
      • Pool Blocks
      • Pool Stake, Block and Reward History
      • Pool Updates (History)
      • Pool Relays
      • Pool Metadata

    • Script

      • Native Script List
      • Plutus Script List
      • Script Redeemers
      • Datum Information