# 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). <br>
**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. <p>
**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
Raw data
{
"_id": null,
"home_page": "https://github.com/QuixoteSystems",
"name": "koios-python",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "koios,blockchain,cardano,API,REST,RESTful",
"author": "Quixote Stake Pool",
"author_email": "quixotepool@proton.me",
"download_url": "https://files.pythonhosted.org/packages/f6/c5/2bf71005aa0ba33df7b2cf2b490d44944703c6d9138954560c7f1f16d8c0/koios-python-2.0.0.tar.gz",
"platform": null,
"description": "\n\n\n\n# Koios Python  [](https://pypi.org/project/koios-python/)\n\n## Overview\n**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/)\n\n\n## What is Koios Python? \n**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). <br>\n**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. <p>\n**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.\n \nThis library allows getting data from the Cardano Blockchain using a simple syntaxis in your Python code. All the querys follow Koios API REST operations.\n\nRequired Python Modules\n--------------\n* https://pypi.python.org/pypi/requests\n\n## Installation [](https://pypi.org/project/koios-python/)\n```python\npip install koios_python\n```\n \n## Upgrade to the last Version\n```python\npip install --upgrade koios_python\n```\n \n## Usage\nImport to your python file this library:\n \n```python\nimport koios_python\n```\n\nYou can read all info about how works this library in our [Wiki](https://github.com/cardano-community/koios-python/wiki)\n \n## TODO\n- [x] Managing errors \n- [x] Inside functions \n- [x] Pagination (most functions have it added)\n- [x] User Inputs\n- [x] Timeouts\n- [x] Ordering\n- [ ] Adding Vertical Filtering\n- [ ] Adding Async methods\n\n\n\n## Features \n- Supported REST Services:\n - [x] Network\n - Chain Tip\n - Genesis Info\n - Historical Tokenomic Statistics\n - Param Update Proposals\n - Reserve Withdrawals\n - Treasury Withdrawals\n \n - [x] Epoch\n - Epoch Information\n - Epoch's Protocol Parameters\n - Epoch Blocks Protocol\n \n - [x] Block\n - Block List\n - Block Information\n - Block Transactions\n \n - [x] Transactions\n - UTxO Information\n - Transaction Information\n - Transaction UTxOs [Deprecated]\n - Transaction Metadata\n - Transaction Metadata Labels\n - Transaction Submit\n - Transaction Status (Block Confirmations)\n \n - [x] Stake Account\n - Account List\n - Account Information\n - Account Information Cached\n - UTxOs for Stake Addresses (accounts)\n - Account Transactions\n - Account Rewards\n - Account Updates (History)\n - Account Addresses\n - Account Assets\n - Account History\n\n - [x] Address\n - Address Information\n - Address UTxOs\n - Address Transactions\n - Transactions from Payment Credentials\n - Address Assets\n \n - [x] Asset\n - Asset List\n - Policy Asset List\n - Asset Token Registry\n - Asset Information (Bulk)\n - Asset Information\n - Asset UTxOs\n - Asset History\n - Asset Addresses\n - NFT Address\n - Policy Asset Address List\n - Policy Asset Information\n - Asset Summary\n - Asset Transactions\n - Asset Policy Information [DEPRECATED]\n - Asset Address List [DEPRECATED]\n\n - [x] Pool\n - Pool List\n - Pool Information\n - Pool Stake Snapshot\n - Pool Delegators List\n - Pool Delegators History\n - Pool Blocks\n - Pool Stake, Block and Reward History\n - Pool Updates (History)\n - Pool Registrations\n - Pool Retirements\n - Pool Relays\n - Pool Metadata\n \n - [x] Script\n - Script Information\n - Native Script List\n - Plutus Script List\n - Script Redeemers\n - Script UTxOs\n - Datum Information\n\n - [x] Ogmios\n - Query\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python wrapper Library using Koios API for accessing information stored on the Cardano Blockchain",
"version": "2.0.0",
"project_urls": {
"Homepage": "https://github.com/QuixoteSystems"
},
"split_keywords": [
"koios",
"blockchain",
"cardano",
"api",
"rest",
"restful"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6102fa88622f5cb59f123d5dc94b4db47794b15d6710883b9024acd83394850a",
"md5": "df3858c382df7ec2f1c33717a817a56c",
"sha256": "702e068c4360a3a59c3b9dd84817d19ab301cb704dc8f62f0d95c18d0f6ce7db"
},
"downloads": -1,
"filename": "koios_python-2.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "df3858c382df7ec2f1c33717a817a56c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 20573,
"upload_time": "2024-03-02T18:24:57",
"upload_time_iso_8601": "2024-03-02T18:24:57.320630Z",
"url": "https://files.pythonhosted.org/packages/61/02/fa88622f5cb59f123d5dc94b4db47794b15d6710883b9024acd83394850a/koios_python-2.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f6c52bf71005aa0ba33df7b2cf2b490d44944703c6d9138954560c7f1f16d8c0",
"md5": "99e85380bbaffbc94b5e43e116a71fef",
"sha256": "9ed1e77fb6cf573b80d24bba552b57fe765526492acdb10033e9a34036df56cd"
},
"downloads": -1,
"filename": "koios-python-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "99e85380bbaffbc94b5e43e116a71fef",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 16801,
"upload_time": "2024-03-02T18:24:58",
"upload_time_iso_8601": "2024-03-02T18:24:58.641994Z",
"url": "https://files.pythonhosted.org/packages/f6/c5/2bf71005aa0ba33df7b2cf2b490d44944703c6d9138954560c7f1f16d8c0/koios-python-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-02 18:24:58",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "koios-python"
}
JSON