Skip to content

cardano-community/koios-python

Repository files navigation

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
  • Adding Vertical Filtering
  • Adding Async methods

Features

  • Supported REST Services:
    • Network

      • Chain Tip
      • Genesis Info
      • Historical Tokenomic Statistics
      • Param Update Proposals
      • Reserve Withdrawals
      • Treasury Withdrawals
    • Epoch

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

      • Block List
      • Block Information
      • Block Transactions
    • Transactions

      • UTxO Information
      • Transaction Information
      • Transaction UTxOs [Deprecated]
      • Transaction Metadata
      • Transaction Metadata Labels
      • Transaction Submit
      • Transaction Status (Block Confirmations)
    • Stake Account

      • Account List
      • Account Information
      • Account Information Cached
      • UTxOs for Stake Addresses (accounts)
      • Account Transactions
      • Account Rewards
      • Account Updates (History)
      • Account Addresses
      • Account Assets
      • Account History
    • Address

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

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

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

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

      • Query