# xchainpy2-midgard
The Midgard Public API queries THORChain and any chains linked via the Bifröst and prepares information about the network to be readily available for public users. The API parses transaction event data from THORChain and stores them in a time-series database to make time-dependent queries easy. Midgard does not hold critical information. To interact with THORChain protocol, users should query THORNode directly.
This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
- API version: 2.20.1
- Package version: 2.20.1
- Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen
## Requirements.
Python 2.7 and 3.4+
## Installation & Usage
### pip install
If the python package is hosted on Github, you can install directly from Github
```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
Then import the package:
```python
import xchainpy2_midgard
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import xchainpy2_midgard
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
from __future__ import print_function
import time
import xchainpy2_midgard
from xchainpy2_midgard.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = xchainpy2_midgard.SpecificationApi(xchainpy2_midgard.ApiClient(configuration))
try:
# Documentation
api_instance.get_docs()
except ApiException as e:
print("Exception when calling SpecificationApi->get_docs: %s\n" % e)
# create an instance of the API class
api_instance = xchainpy2_midgard.SpecificationApi(xchainpy2_midgard.ApiClient(configuration))
try:
# Swagger File
api_instance.get_swagger()
except ApiException as e:
print("Exception when calling SpecificationApi->get_swagger: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to */*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*SpecificationApi* | [**get_docs**](docs/SpecificationApi.md#get_docs) | **GET** /v2/doc | Documentation
*SpecificationApi* | [**get_swagger**](docs/SpecificationApi.md#get_swagger) | **GET** /v2/swagger.json | Swagger File
*DefaultApi* | [**get_actions**](docs/DefaultApi.md#get_actions) | **GET** /v2/actions | Actions List
*DefaultApi* | [**get_balance**](docs/DefaultApi.md#get_balance) | **GET** /v2/balance/{address} | Current balance for an address
*DefaultApi* | [**get_borrower_detail**](docs/DefaultApi.md#get_borrower_detail) | **GET** /v2/borrower/{address} | Borrower Details
*DefaultApi* | [**get_borrowers_addresses**](docs/DefaultApi.md#get_borrowers_addresses) | **GET** /v2/borrowers | Borrowers List
*DefaultApi* | [**get_churns**](docs/DefaultApi.md#get_churns) | **GET** /v2/churns | Churns List
*DefaultApi* | [**get_depth_history**](docs/DefaultApi.md#get_depth_history) | **GET** /v2/history/depths/{pool} | Depth and Price History
*DefaultApi* | [**get_earnings_history**](docs/DefaultApi.md#get_earnings_history) | **GET** /v2/history/earnings | Earnings History
*DefaultApi* | [**get_health**](docs/DefaultApi.md#get_health) | **GET** /v2/health | Health Info
*DefaultApi* | [**get_known_pools**](docs/DefaultApi.md#get_known_pools) | **GET** /v2/knownpools | Known Pools List
*DefaultApi* | [**get_liquidity_history**](docs/DefaultApi.md#get_liquidity_history) | **GET** /v2/history/liquidity_changes | Liquidity Changes History
*DefaultApi* | [**get_member_detail**](docs/DefaultApi.md#get_member_detail) | **GET** /v2/member/{address} | Member Details
*DefaultApi* | [**get_members_adresses**](docs/DefaultApi.md#get_members_adresses) | **GET** /v2/members | Members List
*DefaultApi* | [**get_network_data**](docs/DefaultApi.md#get_network_data) | **GET** /v2/network | Network Data
*DefaultApi* | [**get_nodes**](docs/DefaultApi.md#get_nodes) | **GET** /v2/nodes | Nodes List
*DefaultApi* | [**get_pool**](docs/DefaultApi.md#get_pool) | **GET** /v2/pool/{asset} | Details of a Pool
*DefaultApi* | [**get_pool_stats**](docs/DefaultApi.md#get_pool_stats) | **GET** /v2/pool/{asset}/stats | Pool Statistics
*DefaultApi* | [**get_pools**](docs/DefaultApi.md#get_pools) | **GET** /v2/pools | Pools List
*DefaultApi* | [**get_saver_detail**](docs/DefaultApi.md#get_saver_detail) | **GET** /v2/saver/{address} | Saver Details
*DefaultApi* | [**get_savers_history**](docs/DefaultApi.md#get_savers_history) | **GET** /v2/history/savers/{pool} | Savers Units and Depth History
*DefaultApi* | [**get_stats**](docs/DefaultApi.md#get_stats) | **GET** /v2/stats | Global Stats
*DefaultApi* | [**get_swap_history**](docs/DefaultApi.md#get_swap_history) | **GET** /v2/history/swaps | Swaps History
*DefaultApi* | [**get_thor_name_detail**](docs/DefaultApi.md#get_thor_name_detail) | **GET** /v2/thorname/lookup/{name} | THORName Details
*DefaultApi* | [**get_thor_names_by_address**](docs/DefaultApi.md#get_thor_names_by_address) | **GET** /v2/thorname/rlookup/{address} | Gives a list of THORNames by reverse lookup
*DefaultApi* | [**get_thor_names_owner_by_address**](docs/DefaultApi.md#get_thor_names_owner_by_address) | **GET** /v2/thorname/owner/{address} | THORName owner
*DefaultApi* | [**get_tvl_history**](docs/DefaultApi.md#get_tvl_history) | **GET** /v2/history/tvl | Total Value Locked History
## Documentation For Models
- [Action](docs/Action.md)
- [ActionMeta](docs/ActionMeta.md)
- [AddLiquidityMetadata](docs/AddLiquidityMetadata.md)
- [Balance](docs/Balance.md)
- [BlockRewards](docs/BlockRewards.md)
- [BondMetrics](docs/BondMetrics.md)
- [BorrowerDetails](docs/BorrowerDetails.md)
- [BorrowerPool](docs/BorrowerPool.md)
- [Borrowers](docs/Borrowers.md)
- [ChurnItem](docs/ChurnItem.md)
- [Churns](docs/Churns.md)
- [Coin](docs/Coin.md)
- [Coins](docs/Coins.md)
- [DepthHistory](docs/DepthHistory.md)
- [DepthHistoryIntervals](docs/DepthHistoryIntervals.md)
- [DepthHistoryItem](docs/DepthHistoryItem.md)
- [DepthHistoryItemPool](docs/DepthHistoryItemPool.md)
- [DepthHistoryMeta](docs/DepthHistoryMeta.md)
- [EarningsHistory](docs/EarningsHistory.md)
- [EarningsHistoryIntervals](docs/EarningsHistoryIntervals.md)
- [EarningsHistoryItem](docs/EarningsHistoryItem.md)
- [EarningsHistoryItemPool](docs/EarningsHistoryItemPool.md)
- [GenesisInf](docs/GenesisInf.md)
- [Health](docs/Health.md)
- [HeightTS](docs/HeightTS.md)
- [InlineResponse200](docs/InlineResponse200.md)
- [KnownPools](docs/KnownPools.md)
- [LiquidityHistory](docs/LiquidityHistory.md)
- [LiquidityHistoryIntervals](docs/LiquidityHistoryIntervals.md)
- [LiquidityHistoryItem](docs/LiquidityHistoryItem.md)
- [MemberDetails](docs/MemberDetails.md)
- [MemberPool](docs/MemberPool.md)
- [Members](docs/Members.md)
- [Metadata](docs/Metadata.md)
- [Network](docs/Network.md)
- [NetworkFees](docs/NetworkFees.md)
- [Node](docs/Node.md)
- [Nodes](docs/Nodes.md)
- [PoolDetail](docs/PoolDetail.md)
- [PoolDetails](docs/PoolDetails.md)
- [PoolStatsDetail](docs/PoolStatsDetail.md)
- [RefundMetadata](docs/RefundMetadata.md)
- [ReverseTHORNames](docs/ReverseTHORNames.md)
- [SaverDetails](docs/SaverDetails.md)
- [SaverPool](docs/SaverPool.md)
- [SaversHistory](docs/SaversHistory.md)
- [SaversHistoryIntervals](docs/SaversHistoryIntervals.md)
- [SaversHistoryItem](docs/SaversHistoryItem.md)
- [SaversHistoryMeta](docs/SaversHistoryMeta.md)
- [StatsData](docs/StatsData.md)
- [StreamingSwapMeta](docs/StreamingSwapMeta.md)
- [SwapHistory](docs/SwapHistory.md)
- [SwapHistoryIntervals](docs/SwapHistoryIntervals.md)
- [SwapHistoryItem](docs/SwapHistoryItem.md)
- [SwapMetadata](docs/SwapMetadata.md)
- [THORNameDetails](docs/THORNameDetails.md)
- [THORNameEntry](docs/THORNameEntry.md)
- [TVLHistory](docs/TVLHistory.md)
- [TVLHistoryIntervals](docs/TVLHistoryIntervals.md)
- [TVLHistoryItem](docs/TVLHistoryItem.md)
- [Transaction](docs/Transaction.md)
- [WithdrawMetadata](docs/WithdrawMetadata.md)
## Documentation For Authorization
All endpoints do not require authorization.
## Author
devs@thorchain.org
Raw data
{
"_id": null,
"home_page": null,
"name": "xchainpy2-midgard",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "Swagger, Midgard Public API",
"author": null,
"author_email": "devs@thorchain.org",
"download_url": "https://files.pythonhosted.org/packages/c1/3c/0d420ffb12c58e8d303ba13655fe54a3d46f99bf8952de755aeba0cad48f/xchainpy2-midgard-2.20.1.tar.gz",
"platform": null,
"description": "# xchainpy2-midgard\nThe Midgard Public API queries THORChain and any chains linked via the Bifr\u00f6st and prepares information about the network to be readily available for public users. The API parses transaction event data from THORChain and stores them in a time-series database to make time-dependent queries easy. Midgard does not hold critical information. To interact with THORChain protocol, users should query THORNode directly.\n\nThis Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:\n\n- API version: 2.20.1\n- Package version: 2.20.1\n- Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen\n\n## Requirements.\n\nPython 2.7 and 3.4+\n\n## Installation & Usage\n### pip install\n\nIf the python package is hosted on Github, you can install directly from Github\n\n```sh\npip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)\n\nThen import the package:\n```python\nimport xchainpy2_midgard \n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport xchainpy2_midgard\n```\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\nfrom __future__ import print_function\nimport time\nimport xchainpy2_midgard\nfrom xchainpy2_midgard.rest import ApiException\nfrom pprint import pprint\n\n# create an instance of the API class\napi_instance = xchainpy2_midgard.SpecificationApi(xchainpy2_midgard.ApiClient(configuration))\n\ntry:\n # Documentation\n api_instance.get_docs()\nexcept ApiException as e:\n print(\"Exception when calling SpecificationApi->get_docs: %s\\n\" % e)\n\n# create an instance of the API class\napi_instance = xchainpy2_midgard.SpecificationApi(xchainpy2_midgard.ApiClient(configuration))\n\ntry:\n # Swagger File\n api_instance.get_swagger()\nexcept ApiException as e:\n print(\"Exception when calling SpecificationApi->get_swagger: %s\\n\" % e)\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to */*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*SpecificationApi* | [**get_docs**](docs/SpecificationApi.md#get_docs) | **GET** /v2/doc | Documentation\n*SpecificationApi* | [**get_swagger**](docs/SpecificationApi.md#get_swagger) | **GET** /v2/swagger.json | Swagger File\n*DefaultApi* | [**get_actions**](docs/DefaultApi.md#get_actions) | **GET** /v2/actions | Actions List\n*DefaultApi* | [**get_balance**](docs/DefaultApi.md#get_balance) | **GET** /v2/balance/{address} | Current balance for an address\n*DefaultApi* | [**get_borrower_detail**](docs/DefaultApi.md#get_borrower_detail) | **GET** /v2/borrower/{address} | Borrower Details\n*DefaultApi* | [**get_borrowers_addresses**](docs/DefaultApi.md#get_borrowers_addresses) | **GET** /v2/borrowers | Borrowers List\n*DefaultApi* | [**get_churns**](docs/DefaultApi.md#get_churns) | **GET** /v2/churns | Churns List\n*DefaultApi* | [**get_depth_history**](docs/DefaultApi.md#get_depth_history) | **GET** /v2/history/depths/{pool} | Depth and Price History\n*DefaultApi* | [**get_earnings_history**](docs/DefaultApi.md#get_earnings_history) | **GET** /v2/history/earnings | Earnings History\n*DefaultApi* | [**get_health**](docs/DefaultApi.md#get_health) | **GET** /v2/health | Health Info\n*DefaultApi* | [**get_known_pools**](docs/DefaultApi.md#get_known_pools) | **GET** /v2/knownpools | Known Pools List\n*DefaultApi* | [**get_liquidity_history**](docs/DefaultApi.md#get_liquidity_history) | **GET** /v2/history/liquidity_changes | Liquidity Changes History\n*DefaultApi* | [**get_member_detail**](docs/DefaultApi.md#get_member_detail) | **GET** /v2/member/{address} | Member Details\n*DefaultApi* | [**get_members_adresses**](docs/DefaultApi.md#get_members_adresses) | **GET** /v2/members | Members List\n*DefaultApi* | [**get_network_data**](docs/DefaultApi.md#get_network_data) | **GET** /v2/network | Network Data\n*DefaultApi* | [**get_nodes**](docs/DefaultApi.md#get_nodes) | **GET** /v2/nodes | Nodes List\n*DefaultApi* | [**get_pool**](docs/DefaultApi.md#get_pool) | **GET** /v2/pool/{asset} | Details of a Pool\n*DefaultApi* | [**get_pool_stats**](docs/DefaultApi.md#get_pool_stats) | **GET** /v2/pool/{asset}/stats | Pool Statistics\n*DefaultApi* | [**get_pools**](docs/DefaultApi.md#get_pools) | **GET** /v2/pools | Pools List\n*DefaultApi* | [**get_saver_detail**](docs/DefaultApi.md#get_saver_detail) | **GET** /v2/saver/{address} | Saver Details\n*DefaultApi* | [**get_savers_history**](docs/DefaultApi.md#get_savers_history) | **GET** /v2/history/savers/{pool} | Savers Units and Depth History\n*DefaultApi* | [**get_stats**](docs/DefaultApi.md#get_stats) | **GET** /v2/stats | Global Stats\n*DefaultApi* | [**get_swap_history**](docs/DefaultApi.md#get_swap_history) | **GET** /v2/history/swaps | Swaps History\n*DefaultApi* | [**get_thor_name_detail**](docs/DefaultApi.md#get_thor_name_detail) | **GET** /v2/thorname/lookup/{name} | THORName Details\n*DefaultApi* | [**get_thor_names_by_address**](docs/DefaultApi.md#get_thor_names_by_address) | **GET** /v2/thorname/rlookup/{address} | Gives a list of THORNames by reverse lookup\n*DefaultApi* | [**get_thor_names_owner_by_address**](docs/DefaultApi.md#get_thor_names_owner_by_address) | **GET** /v2/thorname/owner/{address} | THORName owner\n*DefaultApi* | [**get_tvl_history**](docs/DefaultApi.md#get_tvl_history) | **GET** /v2/history/tvl | Total Value Locked History\n\n## Documentation For Models\n\n - [Action](docs/Action.md)\n - [ActionMeta](docs/ActionMeta.md)\n - [AddLiquidityMetadata](docs/AddLiquidityMetadata.md)\n - [Balance](docs/Balance.md)\n - [BlockRewards](docs/BlockRewards.md)\n - [BondMetrics](docs/BondMetrics.md)\n - [BorrowerDetails](docs/BorrowerDetails.md)\n - [BorrowerPool](docs/BorrowerPool.md)\n - [Borrowers](docs/Borrowers.md)\n - [ChurnItem](docs/ChurnItem.md)\n - [Churns](docs/Churns.md)\n - [Coin](docs/Coin.md)\n - [Coins](docs/Coins.md)\n - [DepthHistory](docs/DepthHistory.md)\n - [DepthHistoryIntervals](docs/DepthHistoryIntervals.md)\n - [DepthHistoryItem](docs/DepthHistoryItem.md)\n - [DepthHistoryItemPool](docs/DepthHistoryItemPool.md)\n - [DepthHistoryMeta](docs/DepthHistoryMeta.md)\n - [EarningsHistory](docs/EarningsHistory.md)\n - [EarningsHistoryIntervals](docs/EarningsHistoryIntervals.md)\n - [EarningsHistoryItem](docs/EarningsHistoryItem.md)\n - [EarningsHistoryItemPool](docs/EarningsHistoryItemPool.md)\n - [GenesisInf](docs/GenesisInf.md)\n - [Health](docs/Health.md)\n - [HeightTS](docs/HeightTS.md)\n - [InlineResponse200](docs/InlineResponse200.md)\n - [KnownPools](docs/KnownPools.md)\n - [LiquidityHistory](docs/LiquidityHistory.md)\n - [LiquidityHistoryIntervals](docs/LiquidityHistoryIntervals.md)\n - [LiquidityHistoryItem](docs/LiquidityHistoryItem.md)\n - [MemberDetails](docs/MemberDetails.md)\n - [MemberPool](docs/MemberPool.md)\n - [Members](docs/Members.md)\n - [Metadata](docs/Metadata.md)\n - [Network](docs/Network.md)\n - [NetworkFees](docs/NetworkFees.md)\n - [Node](docs/Node.md)\n - [Nodes](docs/Nodes.md)\n - [PoolDetail](docs/PoolDetail.md)\n - [PoolDetails](docs/PoolDetails.md)\n - [PoolStatsDetail](docs/PoolStatsDetail.md)\n - [RefundMetadata](docs/RefundMetadata.md)\n - [ReverseTHORNames](docs/ReverseTHORNames.md)\n - [SaverDetails](docs/SaverDetails.md)\n - [SaverPool](docs/SaverPool.md)\n - [SaversHistory](docs/SaversHistory.md)\n - [SaversHistoryIntervals](docs/SaversHistoryIntervals.md)\n - [SaversHistoryItem](docs/SaversHistoryItem.md)\n - [SaversHistoryMeta](docs/SaversHistoryMeta.md)\n - [StatsData](docs/StatsData.md)\n - [StreamingSwapMeta](docs/StreamingSwapMeta.md)\n - [SwapHistory](docs/SwapHistory.md)\n - [SwapHistoryIntervals](docs/SwapHistoryIntervals.md)\n - [SwapHistoryItem](docs/SwapHistoryItem.md)\n - [SwapMetadata](docs/SwapMetadata.md)\n - [THORNameDetails](docs/THORNameDetails.md)\n - [THORNameEntry](docs/THORNameEntry.md)\n - [TVLHistory](docs/TVLHistory.md)\n - [TVLHistoryIntervals](docs/TVLHistoryIntervals.md)\n - [TVLHistoryItem](docs/TVLHistoryItem.md)\n - [Transaction](docs/Transaction.md)\n - [WithdrawMetadata](docs/WithdrawMetadata.md)\n\n## Documentation For Authorization\n\n All endpoints do not require authorization.\n\n\n## Author\n\ndevs@thorchain.org\n",
"bugtrack_url": null,
"license": null,
"summary": "Midgard Public API",
"version": "2.20.1",
"project_urls": null,
"split_keywords": [
"swagger",
" midgard public api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f8b7db098e1e2123c5010fc3ac98241c8632f0fa60afd0c5de1550205f3f0bfa",
"md5": "6fe1afa975b9abd36344b64ffae3348f",
"sha256": "bc483027b6098d1d27b30b841a1451a78c39d1d974e4703bcc1e2accb07a2a76"
},
"downloads": -1,
"filename": "xchainpy2_midgard-2.20.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6fe1afa975b9abd36344b64ffae3348f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 200498,
"upload_time": "2024-04-01T11:01:33",
"upload_time_iso_8601": "2024-04-01T11:01:33.808559Z",
"url": "https://files.pythonhosted.org/packages/f8/b7/db098e1e2123c5010fc3ac98241c8632f0fa60afd0c5de1550205f3f0bfa/xchainpy2_midgard-2.20.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c13c0d420ffb12c58e8d303ba13655fe54a3d46f99bf8952de755aeba0cad48f",
"md5": "a927ce059eb37e95b4b706b745ecb01d",
"sha256": "244e2957548b8d7ec464e7625053630e26721d3b8aac257d2a9fa6b099aff98e"
},
"downloads": -1,
"filename": "xchainpy2-midgard-2.20.1.tar.gz",
"has_sig": false,
"md5_digest": "a927ce059eb37e95b4b706b745ecb01d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 75690,
"upload_time": "2024-04-01T11:01:39",
"upload_time_iso_8601": "2024-04-01T11:01:39.944353Z",
"url": "https://files.pythonhosted.org/packages/c1/3c/0d420ffb12c58e8d303ba13655fe54a3d46f99bf8952de755aeba0cad48f/xchainpy2-midgard-2.20.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-01 11:01:39",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "xchainpy2-midgard"
}
JSON