Este é um bot de Telegram para consulta de preços de ações na Bolsa de Valores. Ele utiliza diversas APIs para obter indicadores financeiros, preços de ações e outras informações relevantes.
- Clone o repositório
- Crie um arquivo .env baseado no .env.sample e insira o token do seu bot do Telegram
- Instale as dependências com o comando
npm i - Inicie o bot com
npm start
Se a variável de ambiente for configurada como development, a documentação dos usecases pode ser acessada através de localhost:8080/herbsshelf
O bot oferece os seguintes comandos:
| Comando | Descrição |
|---|---|
/price [código da ação] |
Retorna a cotação e a variação no dia |
/fii [código do fundo] |
Retorna a cotação, a variação no dia e o dividend yield dos últimos 12 meses de acordo com a cotação do dia |
/graham [código da ação] |
Retorna o valor justo de acordo com a fórmula de Graham |
/fechamento |
Responde com o fechamento do dia |
/cadastro |
Permite ao usuário gerenciar seu próprio cadastro |
O bot utiliza a biblioteca HerbsJS para gerenciar funções, chamadas de API e testes unitários. Através do HerbsJs, é possível escrever usecases simples que permitem injeção de dependência. Isso resulta em melhores mocks e testes unitários, além de facilitar a adoção do padrão Domain Driven Design (DDD).
Este bot utiliza MongoDB para o armazenamento de dados.
Este projeto utiliza dados e recursos de diversas fontes de terceiros:
- mFinance: Fornece dados de indicadores financeiros e preços de ações.
- Coinsamba: Fornece informações relevantes de criptomoedas.
- HerbsJS: Biblioteca para gerenciar usecases, e testes unitários.
- axios: Biblioteca utilizada para realizar requisições HTTP.
Você é livre para usar, copiar, modificar, distribuir, fazer uso privado ou comercial deste projeto, desde que dê os devidos créditos aos autores, conforme definido pela licença MIT.