Files
OpenBB/openbb_terminal/cryptocurrency/coinpaprika_helpers.py
teh_coderer 59d8b36bb0 [IMPROVE] Fix Docstring formatting/Fix missing, incomplete type hints (#3412)
* Fixes

* Update stocks_helper.py

* update git-actions set-output to new format

* Update stocks_helper.py

* Update terminal_helper.py

* removed LineAnnotateDrawer from qa_view

* lint

* few changes

* updates

* sdk auto gen modules done

* Update stocks_helper.py

* updates to changed imports, and remove first sdk_modules

* Update generate_sdk.py

* Update generate_sdk.py

* pylint

* revert stocks_helper

* Update generate_sdk.py

* Update sdk.py

* Update generate_sdk.py

* full auto generation, added sdk.py/controllers creation

* missed enable forecasting

* added running black in subprocess after sdk files generation completes

* removed deleted sdk_arg_logger

* comment out tests

* property doc fix

* clean up

* Update generate_sdk.py

* make trailmap classes useable for doc generation

* Update generate_sdk.py

* added lineon to trailmap class for linking to func in markdown

* changed lineon to dict

* added full_path to trailmap for linking in docs

* updated portfolio

* feat: initial files

* feat: added meta head

* feat: added funcdef

* added func_def to trailmap attributes for markdown in docs, added missing type hints to covid functions

* feat: added view and merged with jaun

* Update generate_sdk.py

* Update generate_sdk.py

* Update generate_sdk.py

* Update generate_sdk.py

* init

* fix returns

* fix: random stuff

* fix: random

* fixed encoding issue on windows

* fix: generate tabs

* update

* Update generate_sdk_markdown.py

* Create .pydocstyle.ini

* added type hint classes for views

* fixes

* alt, ba

* alt-economy

* Update finviz_compare_model.py

* fixs

* Update substack_model.py

* Update generate_sdk.py

* last of my section

* porfolio

* po

* Update optimizer_model.py

* fixing more things

* few more

* keys done

* update

* fixes

* Update generate_sdk_markdown.py

* Update generate_sdk_markdown.py

* mypy forecast fix

* Update generate_sdk_markdown.py

* Update generate_sdk_markdown.py

* Update generate_sdk_markdown.py

* fixes

* forecast fixes

* one more fix

* Update coinbase_model.py

* Update generate_sdk_markdown.py

Co-authored-by: Colin Delahunty <72827203+colin99d@users.noreply.github.com>
Co-authored-by: James Maslek <jmaslek11@gmail.com>
Co-authored-by: jose-donato <zmcdonato@gmail.com>
Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
2022-11-15 16:37:49 -05:00

63 lines
2.1 KiB
Python

"""CoinPaprika helpers"""
__docformat__ = "numpy"
from typing import Any, Optional
import requests
from requests.adapters import HTTPAdapter
class PaprikaSession:
PAPRIKA_BASE_URL = "https://api.coinpaprika.com/v1"
ENDPOINTS = {
"global": "/global",
"coin": "/coins/{}",
"coins": "/coins",
"coin_tweeter": "/coins/{}/twitter",
"coin_events": "/coins/{}/events",
"coin_exchanges": "/coins/{}/exchanges",
"coin_markets": "/coins/{}/markets",
"ohlcv": "/coins/{}/ohlcv/latest",
"ohlcv_hist": "/coins/{}/ohlcv/historical",
"people": "/people/{}",
"tickers": "/tickers",
"ticker_info": "/tickers/{}",
"exchanges": "/exchanges",
"exchange_info": "/exchanges/{}",
"exchange_markets": "/exchanges/{}/markets",
"contract_platforms": "/contracts",
"contract_platform_addresses": "/contracts/{}",
"search": "/search",
}
def __init__(self, max_retries: int = 5):
self.session = requests.Session()
self.session.mount(self.PAPRIKA_BASE_URL, HTTPAdapter(max_retries=max_retries))
def make_request(
self, endpoint: str, payload: Optional[Any] = None, **kwargs: Any
) -> dict:
"""Helper method that handles request for coinpaprika api.
It prepares URL for given endpoint and payload if it's part of requests
Parameters
----------
endpoint: str,
it's an endpoint that we want to query. e.g. to get twitter data for given coin we need to use:
https://api.coinpaprika.com/v1/coins/{}/twitter
payload: dict
the body of your request. Contains the data send to the CoinPaprika API when making an API request
kwargs:
additional parameters that will be added to payload
Returns
----------
dict with response data
"""
url = f"{self.PAPRIKA_BASE_URL}{endpoint}/"
if payload is None:
payload = {}
if kwargs:
payload.update(kwargs)
return self.session.get(url, params=payload).json()