Skip to content

Commit

Permalink
update readme with new method data
Browse files Browse the repository at this point in the history
  • Loading branch information
thiagodds committed Apr 1, 2020
1 parent 3d373d8 commit 1ddd2b6
Showing 1 changed file with 40 additions and 4 deletions.
44 changes: 40 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,15 @@ Crie uma instância do `CeiCrawler` passando os parametros necessários e invoqu

```javascript
let ceiCrawler = new CeiCrawler('username', 'password', {/* options */});
let stockHistory = await ceiCrawler.getStockHistory(startDate, endDate); // Se nenhuma data for passada, irá trazer o histórico inteiro
```

Um exemplo de retorno do método acima é:

### Métodos disponíveis
#### getStockHistory
Método que processa o histórico de compra e venda de ações. O retorno será um uma lista com todas operações de compra ou venda efetuadas dentro do período informado, se nenhuma data for passada o método retornará todo o histórico disponível.
```javascript
let stockHistory = await ceiCrawler.getStockHistory(startDate, endDate);
```
Resultado:
```javascript
[
{
Expand All @@ -46,8 +50,40 @@ Um exemplo de retorno do método acima é:
}
]
```
#### getStockHistory
Método que processa todos os dados disponíveis sobre proventos recebidos em um período e retorna como uma lista. Usualmente os proventos disponíveis na página do CEI são os creditados no mês atual e os já anunciados pela empresas com e sem data definida. Registros com date igual a 2001-01-01 são de proventos anunciados mas sem data definida de pagamento.
```javascript
let dividends = await ceiCrawler.getDividends();
```
Resultado:
```javascript
[
[
{
stockType: 'ON NM',
code: 'EGIE3',
date: 2001-01-01T02:00:00.000Z,
type: 'JUROS SOBRE CAPITAL PRÓPRIO',
quantity: 70,
factor: 1,
grossValue: 30.03,
netValue: 20.58
},
{
stockType: 'PN EDJ N1',
code: 'ITSA4',
date: 2020-04-01T03:00:00.000Z,
type: 'DIVIDENDO',
quantity: 450,
factor: 1,
grossValue: 9.9,
netValue: 9.9
}
]
```


## Options
## Opções
Na criação de um `CeiCrawler` é possivel especificar alguns valores para o parâmetro `options` que modificam a forma que o crawler funciona. As opções são:

| Propriedade | Tipo | Default | Descrição |
Expand Down

0 comments on commit 1ddd2b6

Please sign in to comment.