anotação de tipo de dados devolvidos pelas chamadas de API

This commit is contained in:
2024-06-16 12:23:10 +01:00
parent 7ed284f09f
commit b73057e806

View File

@ -13,8 +13,8 @@ headers = {
url_raiz_API = 'https://api.coingecko.com/api/v3/' url_raiz_API = 'https://api.coingecko.com/api/v3/'
# chamada API geral # chamada API geral
def API(api_endpoint: str = '', api_parameters_dict: dict[str, str] = {}) -> tuple: def API(api_endpoint: str = '', api_parameters_dict: dict[str, str] = {}) -> tuple[str, int, dict]:
'''função genérica para fazer uma consulta a API CoinGecko''' '''função genérica para fazer uma chamada a API CoinGecko'''
# validar parametros # validar parametros
# api_endpoint # api_endpoint
if not isinstance(api_endpoint, str): if not isinstance(api_endpoint, str):
@ -39,7 +39,7 @@ def API(api_endpoint: str = '', api_parameters_dict: dict[str, str] = {}) -> tup
return url_pedido, resposta.status_code, resposta.json() return url_pedido, resposta.status_code, resposta.json()
def ping() -> tuple: def ping() -> tuple[str, int, dict]:
'''https://docs.coingecko.com/v3.0.1/reference/ping-server '''https://docs.coingecko.com/v3.0.1/reference/ping-server
função para verificar o estado do servidor API CoinGecko''' função para verificar o estado do servidor API CoinGecko'''
@ -60,7 +60,7 @@ def coin_price_by_ids(
include_24hr_change: bool = False, include_24hr_change: bool = False,
include_last_updated_at: bool = False, include_last_updated_at: bool = False,
precision: int | str = '' precision: int | str = ''
) -> tuple: ) -> tuple[str, int, dict]:
'''https://docs.coingecko.com/v3.0.1/reference/simple-price '''https://docs.coingecko.com/v3.0.1/reference/simple-price
consultar preço de um ou mais moedas usando o seu ID de Moeda consultar preço de um ou mais moedas usando o seu ID de Moeda
@ -153,7 +153,7 @@ def coin_price_by_token_addresses(
include_24hr_change: bool = False, include_24hr_change: bool = False,
include_last_updated_at: bool = False, include_last_updated_at: bool = False,
precision: int | str = '' precision: int | str = ''
) -> tuple: ) -> tuple[str, int, dict]:
'''https://docs.coingecko.com/v3.0.1/reference/simple-token-price '''https://docs.coingecko.com/v3.0.1/reference/simple-token-price
consultar preco de tokens usando os endereços de contrato dos tokens consultar preco de tokens usando os endereços de contrato dos tokens
@ -246,7 +246,7 @@ def coin_price_by_token_addresses(
# print(f'erro {codigo}: {dados}') # print(f'erro {codigo}: {dados}')
def supported_currencies_list() -> tuple: def supported_currencies_list() -> tuple[str, int, dict]:
'''https://docs.coingecko.com/v3.0.1/reference/simple-supported-currencies '''https://docs.coingecko.com/v3.0.1/reference/simple-supported-currencies
este endpoint permite consultar quais as moedas de referencia suportadas pela CoinGecko''' este endpoint permite consultar quais as moedas de referencia suportadas pela CoinGecko'''
@ -263,7 +263,7 @@ def supported_currencies_list() -> tuple:
# print(f'erro {codigo}: {dados}') # print(f'erro {codigo}: {dados}')
def coins_list(include_platform: bool = False) -> tuple: def coins_list(include_platform: bool = False) -> tuple[str, int, dict]:
'''https://docs.coingecko.com/v3.0.1/reference/coins-list '''https://docs.coingecko.com/v3.0.1/reference/coins-list
obter todas as moedas suportadas em CoinGecko com IDs, nome, obter todas as moedas suportadas em CoinGecko com IDs, nome,
@ -323,7 +323,7 @@ def coins_list_with_market_data(
price_change_percentage: str = '', price_change_percentage: str = '',
locale: str = '', locale: str = '',
precision: int | str = '' precision: int | str = ''
) -> tuple: ) -> tuple[str, int, dict]:
''' '''
https://docs.coingecko.com/v3.0.1/reference/coins-markets https://docs.coingecko.com/v3.0.1/reference/coins-markets
@ -434,7 +434,7 @@ def coin_data_by_id(
community_data: bool = True, community_data: bool = True,
developer_data: bool = True, developer_data: bool = True,
sparkline: bool = False, sparkline: bool = False,
) -> tuple: ) -> tuple[str, int, dict]:
'''https://docs.coingecko.com/v3.0.1/reference/coins-id '''https://docs.coingecko.com/v3.0.1/reference/coins-id
este endpoint permite fazer uma consulta a todos os dados de uma moeda este endpoint permite fazer uma consulta a todos os dados de uma moeda
@ -508,7 +508,7 @@ def coin_tickers_by_id(
page: int = -1, page: int = -1,
order: str = '', order: str = '',
depth: bool = False depth: bool = False
) -> tuple: ) -> tuple[str, int, dict]:
'''https://docs.coingecko.com/v3.0.1/reference/coins-id-tickers '''https://docs.coingecko.com/v3.0.1/reference/coins-id-tickers
este endpoint permite fazer uma consulta de tickers tanto em este endpoint permite fazer uma consulta de tickers tanto em
@ -576,7 +576,7 @@ def coin_historical_data_by_id(
id_criptomoeda: str = '', id_criptomoeda: str = '',
date: str = '', date: str = '',
localization: bool = True localization: bool = True
) -> tuple: ) -> tuple[str, int, dict]:
'''https://docs.coingecko.com/v3.0.1/reference/coins-id-history '''https://docs.coingecko.com/v3.0.1/reference/coins-id-history
este endpoint permite fazer consulta de dados historicos (preco, cap mercado, volume 24h, este endpoint permite fazer consulta de dados historicos (preco, cap mercado, volume 24h,
@ -627,7 +627,7 @@ def coin_historical_chart_data_by_id(
days: str = '', days: str = '',
interval: str = '', interval: str = '',
precision: int | str = 'full' precision: int | str = 'full'
) -> tuple: ) -> tuple[str, int, dict]:
'''https://docs.coingecko.com/v3.0.1/reference/coins-id-market-chart '''https://docs.coingecko.com/v3.0.1/reference/coins-id-market-chart
este endpoint permite fazer consulta para obter dados historicos graficos que este endpoint permite fazer consulta para obter dados historicos graficos que
@ -699,7 +699,7 @@ def coin_historical_chart_data_within_time_range_by_id(
from_unix: int = -1, from_unix: int = -1,
to_unix: int = -1, to_unix: int = -1,
precision: str | int = 'full' precision: str | int = 'full'
) -> tuple: ) -> tuple[str, int, dict]:
'''https://docs.coingecko.com/v3.0.1/reference/coins-id-market-chart-range '''https://docs.coingecko.com/v3.0.1/reference/coins-id-market-chart-range
este endpoint permite obter dados historicos graficos compreendidos num periodo de tempo este endpoint permite obter dados historicos graficos compreendidos num periodo de tempo
@ -770,7 +770,7 @@ def coin_ohlc_chart_by_id(
vs_currency: str = '', vs_currency: str = '',
days: str = '', days: str = '',
precision: str | int = 'full' precision: str | int = 'full'
) -> tuple: ) -> tuple[str, int, dict]:
'''https://docs.coingecko.com/v3.0.1/reference/coins-id-ohlc '''https://docs.coingecko.com/v3.0.1/reference/coins-id-ohlc
este endpoint permite fazer consulta ao gráfico OHLC (Open, High, Low, Close) este endpoint permite fazer consulta ao gráfico OHLC (Open, High, Low, Close)
@ -835,7 +835,7 @@ def coin_ohlc_chart_by_id(
def coin_data_by_token_address( def coin_data_by_token_address(
id_platform: str = '', id_platform: str = '',
contract_address: str = '' contract_address: str = ''
) -> tuple: ) -> tuple[str, int, dict]:
'''https://docs.coingecko.com/v3.0.1/reference/coins-contract-address '''https://docs.coingecko.com/v3.0.1/reference/coins-contract-address
este endpoint permite consultar todos os dados de uma moeda (nome, preço, mercado... este endpoint permite consultar todos os dados de uma moeda (nome, preço, mercado...
@ -881,7 +881,7 @@ def coin_historical_chart_data_by_token_address(
days: str = '', days: str = '',
interval: str = '', interval: str = '',
precision: str | int = 'full' precision: str | int = 'full'
) -> tuple: ) -> tuple[str, int, dict]:
'''https://docs.coingecko.com/v3.0.1/reference/contract-address-market-chart '''https://docs.coingecko.com/v3.0.1/reference/contract-address-market-chart
este endpoint permite consultar dados historicos graficos incluindo tempo UNIX, este endpoint permite consultar dados historicos graficos incluindo tempo UNIX,
@ -956,7 +956,7 @@ def coin_historical_chart_data_by_token_address(
# print(f'erro {codigo}: {dados}') # print(f'erro {codigo}: {dados}')
def coin_historical_chart_data_within_time_range_by_token_address() -> tuple: def coin_historical_chart_data_within_time_range_by_token_address() -> tuple[str, int, dict]:
pass pass
@ -969,7 +969,7 @@ def coin_historical_chart_data_within_time_range_by_token_address() -> tuple:
# else: # else:
# print(f'erro {codigo}: {dados}') # print(f'erro {codigo}: {dados}')
def assets_platforms_list() -> tuple: def assets_platforms_list() -> tuple[str, int, dict]:
pass pass
@ -982,7 +982,7 @@ def assets_platforms_list() -> tuple:
# else: # else:
# print(f'erro {codigo}: {dados}') # print(f'erro {codigo}: {dados}')
def coins_categories_list() -> tuple: def coins_categories_list() -> tuple[str, int, dict]:
pass pass
@ -995,7 +995,7 @@ def coins_categories_list() -> tuple:
# else: # else:
# print(f'erro {codigo}: {dados}') # print(f'erro {codigo}: {dados}')
def coins_categories_list_with_market_data() -> tuple: def coins_categories_list_with_market_data() -> tuple[str, int, dict]:
pass pass
@ -1008,7 +1008,7 @@ def coins_categories_list_with_market_data() -> tuple:
# else: # else:
# print(f'erro {codigo}: {dados}') # print(f'erro {codigo}: {dados}')
def exchanges_list_with_data() -> tuple: def exchanges_list_with_data() -> tuple[str, int, dict]:
pass pass
@ -1021,7 +1021,7 @@ def exchanges_list_with_data() -> tuple:
# else: # else:
# print(f'erro {codigo}: {dados}') # print(f'erro {codigo}: {dados}')
def exchanges_list() -> tuple: def exchanges_list() -> tuple[str, int, dict]:
pass pass
@ -1034,7 +1034,7 @@ def exchanges_list() -> tuple:
# else: # else:
# print(f'erro {codigo}: {dados}') # print(f'erro {codigo}: {dados}')
def exchange_data_by_id() -> tuple: def exchange_data_by_id() -> tuple[str, int, dict]:
pass pass
@ -1047,7 +1047,7 @@ def exchange_data_by_id() -> tuple:
# else: # else:
# print(f'erro {codigo}: {dados}') # print(f'erro {codigo}: {dados}')
def exchange_tickers_by_id() -> tuple: def exchange_tickers_by_id() -> tuple[str, int, dict]:
pass pass
@ -1060,7 +1060,7 @@ def exchange_tickers_by_id() -> tuple:
# else: # else:
# print(f'erro {codigo}: {dados}') # print(f'erro {codigo}: {dados}')
def exchange_colume_chart_by_id() -> tuple: def exchange_colume_chart_by_id() -> tuple[str, int, dict]:
pass pass
@ -1073,7 +1073,7 @@ def exchange_colume_chart_by_id() -> tuple:
# else: # else:
# print(f'erro {codigo}: {dados}') # print(f'erro {codigo}: {dados}')
def derivatives_tickers_list() -> tuple: def derivatives_tickers_list() -> tuple[str, int, dict]:
pass pass
@ -1086,7 +1086,7 @@ def derivatives_tickers_list() -> tuple:
# else: # else:
# print(f'erro {codigo}: {dados}') # print(f'erro {codigo}: {dados}')
def derivatives_exchange_list_with_data() -> tuple: def derivatives_exchange_list_with_data() -> tuple[str, int, dict]:
pass pass
@ -1099,7 +1099,7 @@ def derivatives_exchange_list_with_data() -> tuple:
# else: # else:
# print(f'erro {codigo}: {dados}') # print(f'erro {codigo}: {dados}')
def derivatives_exchange_data_by_id() -> tuple: def derivatives_exchange_data_by_id() -> tuple[str, int, dict]:
pass pass
@ -1112,7 +1112,7 @@ def derivatives_exchange_data_by_id() -> tuple:
# else: # else:
# print(f'erro {codigo}: {dados}') # print(f'erro {codigo}: {dados}')
def derivatives_exchanges_list() -> tuple: def derivatives_exchanges_list() -> tuple[str, int, dict]:
pass pass
@ -1125,7 +1125,7 @@ def derivatives_exchanges_list() -> tuple:
# else: # else:
# print(f'erro {codigo}: {dados}') # print(f'erro {codigo}: {dados}')
def nfts_list() -> tuple: def nfts_list() -> tuple[str, int, dict]:
pass pass
@ -1138,7 +1138,7 @@ def nfts_list() -> tuple:
# else: # else:
# print(f'erro {codigo}: {dados}') # print(f'erro {codigo}: {dados}')
def nfts_collection_data_by_id() -> tuple: def nfts_collection_data_by_id() -> tuple[str, int, dict]:
pass pass
@ -1151,7 +1151,7 @@ def nfts_collection_data_by_id() -> tuple:
# else: # else:
# print(f'erro {codigo}: {dados}') # print(f'erro {codigo}: {dados}')
def nfts_collection_data_by_contrat_address() -> tuple: def nfts_collection_data_by_contrat_address() -> tuple[str, int, dict]:
pass pass
@ -1164,7 +1164,7 @@ def nfts_collection_data_by_contrat_address() -> tuple:
# else: # else:
# print(f'erro {codigo}: {dados}') # print(f'erro {codigo}: {dados}')
def btc_to_curency_exchange_rates() -> tuple: def btc_to_curency_exchange_rates() -> tuple[str, int, dict]:
pass pass
@ -1177,7 +1177,7 @@ def btc_to_curency_exchange_rates() -> tuple:
# else: # else:
# print(f'erro {codigo}: {dados}') # print(f'erro {codigo}: {dados}')
def search_queries() -> tuple: def search_queries() -> tuple[str, int, dict]:
pass pass
@ -1190,7 +1190,7 @@ def search_queries() -> tuple:
# else: # else:
# print(f'erro {codigo}: {dados}') # print(f'erro {codigo}: {dados}')
def trending_search_list() -> tuple: def trending_search_list() -> tuple[str, int, dict]:
pass pass
@ -1203,7 +1203,7 @@ def trending_search_list() -> tuple:
# else: # else:
# print(f'erro {codigo}: {dados}') # print(f'erro {codigo}: {dados}')
def crypto_global_market_data() -> tuple: def crypto_global_market_data() -> tuple[str, int, dict]:
pass pass
@ -1216,7 +1216,7 @@ def crypto_global_market_data() -> tuple:
# else: # else:
# print(f'erro {codigo}: {dados}') # print(f'erro {codigo}: {dados}')
def global_defi_market_data() -> tuple: def global_defi_market_data() -> tuple[str, int, dict]:
pass pass
@ -1229,7 +1229,7 @@ def global_defi_market_data() -> tuple:
# else: # else:
# print(f'erro {codigo}: {dados}') # print(f'erro {codigo}: {dados}')
def public_companies_holdings() -> tuple: def public_companies_holdings() -> tuple[str, int, dict]:
pass pass