https://github.com/cardano-community/koios-python
Python API Library for Cardano Koios RESTful
https://github.com/cardano-community/koios-python
api cardano cardano-community explorer koios python rest restful
Last synced: 6 months ago
JSON representation
Python API Library for Cardano Koios RESTful
- Host: GitHub
- URL: https://github.com/cardano-community/koios-python
- Owner: cardano-community
- License: mit
- Created: 2022-05-01T23:00:21.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-03-02T18:34:46.000Z (over 2 years ago)
- Last Synced: 2025-09-28T09:18:38.897Z (9 months ago)
- Topics: api, cardano, cardano-community, explorer, koios, python, rest, restful
- Language: Python
- Homepage:
- Size: 856 KB
- Stars: 19
- Watchers: 4
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Koios Python  [](https://pypi.org/project/koios-python/)
## Overview
**Koios Python** is Python wrapper which allow interacting with all information and parameters stored on the Cardano blockchain using [Koios REST API](https://api.koios.rest/)
## What is Koios Python?
**Koios Python** is a library based on [Koios](https://www.koios.rest/) Elastic Query Layer for [Cardano Node](https://github.com/input-output-hk/cardano-node/) by [Cardano Community Guild Operators](https://github.com/cardano-community).
**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
--------------
* https://pypi.python.org/pypi/requests
## Installation [](https://pypi.org/project/koios-python/)
```python
pip install koios_python
```
## Upgrade to the last Version
```python
pip install --upgrade koios_python
```
## Usage
Import to your python file this library:
```python
import koios_python
```
You can read all info about how works this library in our [Wiki](https://github.com/cardano-community/koios-python/wiki)
## TODO
- [x] Managing errors
- [x] Inside functions
- [x] Pagination (most functions have it added)
- [x] User Inputs
- [x] Timeouts
- [x] Ordering
- [ ] Adding Vertical Filtering
- [ ] Adding Async methods
## Features
- Supported REST Services:
- [x] Network
- Chain Tip
- Genesis Info
- Historical Tokenomic Statistics
- Param Update Proposals
- Reserve Withdrawals
- Treasury Withdrawals
- [x] Epoch
- Epoch Information
- Epoch's Protocol Parameters
- Epoch Blocks Protocol
- [x] Block
- Block List
- Block Information
- Block Transactions
- [x] Transactions
- UTxO Information
- Transaction Information
- Transaction UTxOs [Deprecated]
- Transaction Metadata
- Transaction Metadata Labels
- Transaction Submit
- Transaction Status (Block Confirmations)
- [x] 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
- [x] Address
- Address Information
- Address UTxOs
- Address Transactions
- Transactions from Payment Credentials
- Address Assets
- [x] 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]
- [x] 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
- [x] Script
- Script Information
- Native Script List
- Plutus Script List
- Script Redeemers
- Script UTxOs
- Datum Information
- [x] Ogmios
- Query