mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-02 07:23:25 +00:00
cebf454cdf
* Added flake8-simplify * Update linting.yml * update. left 1 for you colin * Fix that one * Missed * Fix * mypy --------- Co-authored-by: james <jmaslek11@gmail.com>
77 lines
1.9 KiB
Python
77 lines
1.9 KiB
Python
"""Terra Engineer model"""
|
|
__docformat__ = "numpy"
|
|
|
|
import logging
|
|
|
|
import pandas as pd
|
|
|
|
from openbb_terminal.decorators import log_start_end
|
|
from openbb_terminal.helper_funcs import request
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
api_url = "https://terra.engineer/en"
|
|
|
|
ASSETS = ["ust", "luna", "sdt"]
|
|
|
|
|
|
@log_start_end(log=logger)
|
|
def get_history_asset_from_terra_address(
|
|
asset: str = "ust", address: str = "terra1tmnqgvg567ypvsvk6rwsga3srp7e3lg6u0elp8"
|
|
) -> pd.DataFrame:
|
|
"""Returns historical data of an asset in a certain terra address
|
|
[Source: https://terra.engineer/]
|
|
|
|
Parameters
|
|
----------
|
|
asset : str
|
|
Terra asset {ust,luna,sdt}
|
|
address : str
|
|
Terra address. Valid terra addresses start with 'terra'
|
|
|
|
Returns
|
|
-------
|
|
pd.DataFrame
|
|
historical data
|
|
"""
|
|
|
|
if asset.lower() not in ASSETS:
|
|
raise Exception(f"Select a valid asset from {', '.join(ASSETS)}") # noqa: S608
|
|
|
|
if not address.startswith("terra"):
|
|
raise Exception(
|
|
"Select a valid address. Valid terra addresses start with 'terra'"
|
|
)
|
|
|
|
response = request(
|
|
f"{api_url}/terra_addresses/{address}/show_snapshot_data.json?asset={asset.lower()}"
|
|
)
|
|
if response.status_code != 200:
|
|
raise Exception(f"Status code: {response.status_code}. Reason: {response.text}")
|
|
|
|
data = response.json()
|
|
if data[0]["data"]:
|
|
df = pd.DataFrame(data[0]["data"])
|
|
df["x"] = pd.to_datetime(df["x"])
|
|
else:
|
|
df = pd.DataFrame()
|
|
|
|
return df
|
|
|
|
|
|
@log_start_end(log=logger)
|
|
def get_anchor_yield_reserve() -> pd.DataFrame:
|
|
"""Displays the 30-day history of the Anchor Yield Reserve.
|
|
[Source: https://terra.engineer/]
|
|
|
|
Returns
|
|
-------
|
|
pd.DataFrame
|
|
Dataframe containing historical data
|
|
"""
|
|
|
|
df = get_history_asset_from_terra_address(
|
|
address="terra1tmnqgvg567ypvsvk6rwsga3srp7e3lg6u0elp8"
|
|
)
|
|
return df
|