Skip to main content

Midgard Public API

Project description

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 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

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:

import xchainpy2_midgard 

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import xchainpy2_midgard

Getting Started

Please follow the installation procedure and then run the following:

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 GET /v2/doc Documentation
SpecificationApi get_swagger GET /v2/swagger.json Swagger File
DefaultApi get_actions GET /v2/actions Actions List
DefaultApi get_balance GET /v2/balance/{address} Current balance for an address
DefaultApi get_borrower_detail GET /v2/borrower/{address} Borrower Details
DefaultApi get_borrowers_addresses GET /v2/borrowers Borrowers List
DefaultApi get_churns GET /v2/churns Churns List
DefaultApi get_depth_history GET /v2/history/depths/{pool} Depth and Price History
DefaultApi get_earnings_history GET /v2/history/earnings Earnings History
DefaultApi get_health GET /v2/health Health Info
DefaultApi get_known_pools GET /v2/knownpools Known Pools List
DefaultApi get_liquidity_history GET /v2/history/liquidity_changes Liquidity Changes History
DefaultApi get_member_detail GET /v2/member/{address} Member Details
DefaultApi get_members_adresses GET /v2/members Members List
DefaultApi get_network_data GET /v2/network Network Data
DefaultApi get_nodes GET /v2/nodes Nodes List
DefaultApi get_pool GET /v2/pool/{asset} Details of a Pool
DefaultApi get_pool_stats GET /v2/pool/{asset}/stats Pool Statistics
DefaultApi get_pools GET /v2/pools Pools List
DefaultApi get_saver_detail GET /v2/saver/{address} Saver Details
DefaultApi get_savers_history GET /v2/history/savers/{pool} Savers Units and Depth History
DefaultApi get_stats GET /v2/stats Global Stats
DefaultApi get_swap_history GET /v2/history/swaps Swaps History
DefaultApi get_thor_name_detail GET /v2/thorname/lookup/{name} THORName Details
DefaultApi 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 GET /v2/thorname/owner/{address} THORName owner
DefaultApi get_tvl_history GET /v2/history/tvl Total Value Locked History

Documentation For Models

Documentation For Authorization

All endpoints do not require authorization.

Author

devs@thorchain.org

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

xchainpy2-midgard-2.20.1.tar.gz (75.7 kB view hashes)

Uploaded Source

Built Distribution

xchainpy2_midgard-2.20.1-py3-none-any.whl (200.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page