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.31.0
  • Package version: 2.31.0
  • 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_affiliate_history GET /v2/history/affiliate Affiliate History
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_reserve_history GET /v2/history/reserve Reserve income and expenses over bucketed history
DefaultApi get_rune_pool_detail GET /v2/runepool/{address} RUNEPool Details
DefaultApi get_rune_pool_history GET /v2/history/runepool RUNEPool total members and units History
DefaultApi get_rune_price_history GET /v2/history/rune Rune price history in USD
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
DefaultApi get_votes GET /v2/votes Current Protocol Voting

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.31.0.tar.gz (95.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

xchainpy2_midgard-2.31.0-py3-none-any.whl (279.0 kB view details)

Uploaded Python 3

File details

Details for the file xchainpy2_midgard-2.31.0.tar.gz.

File metadata

  • Download URL: xchainpy2_midgard-2.31.0.tar.gz
  • Upload date:
  • Size: 95.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for xchainpy2_midgard-2.31.0.tar.gz
Algorithm Hash digest
SHA256 de8f2e032e1238473d508ce832333b389da45ff4dfc62cdac226478c4ba7e017
MD5 127a7a3d12148b7119632d61d656a459
BLAKE2b-256 4cc1495c5c5313824cede42beb60ec1108ec3e2dddd37e7564a7fc3ee4eba977

See more details on using hashes here.

File details

Details for the file xchainpy2_midgard-2.31.0-py3-none-any.whl.

File metadata

File hashes

Hashes for xchainpy2_midgard-2.31.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3178a21c1535cef435713ae4b11a17cc8e5552262ff48c7b013974dd0f561bf0
MD5 40830665707574380e54fa523132f3f1
BLAKE2b-256 8d5b385f4f4193736d32983a514017572357aabe2fd104ce86a007e35c8db386

See more details on using hashes here.

Supported by

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