cei-crawler 💸

Crawler para ler dados do Canal Eletrônico do Investidor

Descrição

O cei-crawler utiliza o puppeteer para fazer o scrapping das informações do usuário. Para isso, basta criar uma instância do CeiCrawler e chamar os métodos necessários.

Instalação

Basta instalar utilizando o NPM:

npm install --save cei-crawler

Utilização

Crie uma instância do CeiCrawler passando os parametros necessários e invoque o método desejado:

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 é:

[
    {
        institution: 'Banco Inter',
        account: 12345,
        stockHistory: [
            {
                date: "2019-06-12T03:00:00.000Z",
                operation: "C", // C (Compra) ou V (Venda),
                market: "Mercado a Vista",
                expiration: "",
                code: "BTOW3",
                name: "B2W DIGITAL ON NM",
                quantity: 200,
                price: 32.2,
                totalValue: 6440,
                cotation: 1
            }
        ]
    }
]

Options

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
puppeteerLaunch	Object	{}	Esse objeto é passado ao método `launch` do `Puppeteer`. As opções estão listadas aqui.
capEndDate	Boolean	false	Se `true`, a data de fim de busca do histórico será limitada à data máxima do CEI, impedindo que ocorra um erro caso o usuário passe uma data maior.
capStartDate	Boolean	false	Se `true`, a data de início de busca do histórico será limitada à data mínima do CEI, impedindo que ocorra um erro caso o usuário passe uma data menor.
trace	Boolean	false	Printa mensagens de debug no log. Útil para desenvolvimento.

Exemplo:

const ceiCrawlerOptions = {
    puppeteerLaunch: {
        headless: false,
        timeout: 0
    },
    trace: false,
    capEndDate: true
};

let ceiCrawler = new CeiCrawler('username', 'password', ceiCrawlerOptions);

Features

Histórico de ações
Tesouro Direto

Licença

MIT