Metadata-Version: 2.1
Name: brasil-data
Version: 0.10.0
Summary: Fontes de dados do mercado financeiro brasileiro
Home-page: https://github.com/gabrielguarisa/brdata
License: MIT
Keywords: data,dados,brasil,br,brazil,finance,financeiro,mercado
Author: Gabriel Guarisa
Author-email: gabrielguarisa@gmail.com
Requires-Python: >=3.8,<3.11
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Dist: appdirs (>=1.4.4,<2.0.0)
Requires-Dist: beautifulsoup4 (>=4.10.0,<5.0.0)
Requires-Dist: cachier (>=1.5.3,<2.0.0)
Requires-Dist: html5lib (>=1.1,<2.0)
Requires-Dist: importlib_metadata (>=4.5.0,<5.0.0); python_version < "3.8"
Requires-Dist: lxml (>=4.6.4,<5.0.0)
Requires-Dist: pandas (>=1.5.0,<2.0.0)
Requires-Dist: random-user-agent (>=1.0.1,<2.0.0)
Requires-Dist: requests (>=2.23.0,<3.0.0)
Requires-Dist: xlrd (>=2.0.1,<3.0.0)
Project-URL: Repository, https://github.com/gabrielguarisa/brdata
Description-Content-Type: text/markdown

<p align="center">
  <a href="https://github.com/gabrielguarisa/brdata"><img src="https://raw.githubusercontent.com/gabrielguarisa/brdata/0bd34000bf29bd5b93aee011f368bc0385680c58/logo.png?token=GHSAT0AAAAAABPPKYT7BQBOVDJG3NYYQKNOYQ5JIZA" alt="brdata"></a>
</p>
<p align="center">
    <em>Fontes de dados do mercado financeiro brasileiro</em>
</p>

<div align="center">

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Semantic Versions](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--versions-e10079.svg)](https://github.com/gabrielguarisa/brdata/releases)
[![License](https://img.shields.io/github/license/gabrielguarisa/brdata)](https://github.com/gabrielguarisa/brdata/blob/main/LICENSE)

</div>

## Instalação

```shell
pip install brasil-data
```

## Utilização

### XPI

Coletando dados da análise da XPI para uma determinada ação:

```python
from brdata import xpi
xpi.analise("cyre3")
```

### Fundamentus

Coletando tabela do resultado da busca no Fundamentus (equivalenta a página https://www.fundamentus.com.br/resultado.php):

```python
from brdata import fundamentus
fundamentus.resultados()
```

Balanços históricos de uma determinada ação:

```python
balanco, demonstrativo = fundamentus.balanco_historico("mglu3")
```

Detalhes de uma ação:

```python
fundamentus.detalhes("mglu3")
```

### CVM


Importando módulo:

```python
from brdata import cvm
```

Baixando os arquivos de dados:

```python
cvm.download_data("data")
```

Baixando os arquivos de metadados:

```python
cvm.download_metadata("data")
```

#### Formulário Cadastral

Usando dados do [formulário cadastral](https://dados.gov.br/dataset/cia_aberta-doc-fca):

```python
g_fca = cvm.GeralFCA("data")
vm_fca = cvm.ValorMobiliarioFCA("data")
```

Consultando dados para uma determinada companhia:

```python
g_fca.get_cia(cvm_code=14460)
# OU
g_fca.get_cia(cnpj="47.960.950/0001-21")
```

Número de companhias cadastradas por ano:

```python
g_fca.get_num_cias_per_year()
```

Quantidade de empresas cadastradas por setor em cada ano:

```python
g_fca.get_sectors_per_year()
```

#### Formulário de Referência

Usando dados do [formulário de referência](https://dados.gov.br/dataset/cia_aberta-doc-fre):

```python
cvm.DistribuicaoCapitalFRE("data")
```

Consultando dados para uma determinada companhia:

```python
d_fre.get_cia("47.960.950/0001-21")
```

### B3

Importando módulo:

```python
from brdata import b3
```

Índices disponíveis:

```python
b3.indices()
```

Coletando composição de um índice:

```python
b3.portfolio("ibov")
```

Listando empresas disponíveis na B3:

```python
b3.cias()
```

Listando todas as BDRs disponíveis:

```python
b3.bdrs()
```

Detalhamento de uma empresa:

```python
b3.detalhes(cvm_code="25135")
```

### Valor Econômico

Importando módulo:

```python
from brdata import valor
```

Portfólios das instituições financeiras:

```python
valor.portfolios(2, 2022)
```

Carteira Valor:

```python
valor.carteira_valor(2, 2022)
```
