Referência da API¶
Documentação completa da API pública do Global-Data-Finance.
Módulo globaldatafinance.brazil¶
FundamentalStocksDataCVM¶
Interface para download de documentos CVM.
Métodos¶
__init__()
def __init__(self) -> None
Inicializa o cliente CVM com configurações padrão.
download()
def download(
self,
destination_path: str,
list_docs: Optional[List[str]] = None,
initial_year: Optional[int] = None,
last_year: Optional[int] = None,
automatic_extractor: bool = False,
) -> None
Baixa documentos CVM.
Parâmetros:
destination_path(str): Diretório de destinolist_docs(List[str], opcional): Tipos de documentosinitial_year(int, opcional): Ano iniciallast_year(int, opcional): Ano finalautomatic_extractor(bool): Extrair para Parquet
get_available_docs()
def get_available_docs(self) -> Dict[str, str]
Retorna tipos de documentos disponíveis.
get_available_years()
def get_available_years(self) -> Dict[str, int]
Retorna informações sobre anos disponíveis.
HistoricalQuotesB3¶
Interface para extração de cotações B3.
Métodos¶
__init__()
def __init__(self) -> None
Inicializa o cliente B3.
extract()
def extract(
self,
path_of_docs: str,
assets_list: List[str],
initial_year: Optional[int] = None,
last_year: Optional[int] = None,
destination_path: Optional[str] = None,
output_filename: str = "cotahist_extracted",
processing_mode: str = "fast",
) -> Dict[str, Any]
Extrai cotações históricas.
Parâmetros:
path_of_docs(str): Diretório com ZIPs COTAHISTassets_list(List[str]): Classes de ativosinitial_year(int, opcional): Ano iniciallast_year(int, opcional): Ano finaldestination_path(str, opcional): Diretório de saídaoutput_filename(str): Nome do arquivoprocessing_mode(str): “fast” ou “slow”
Retorno: Dicionário com chaves success, total_records, output_file, etc.
get_available_assets()
def get_available_assets(self) -> List[str]
Retorna classes de ativos disponíveis.
get_available_years()
def get_available_years(self) -> Dict[str, int]
Retorna intervalo de anos disponível.
Veja também: