bvmf: A TypeScript repository from favelado-web

📦 bvmf

Did you like the project? Please, considerate a donation to help improve!

A web scraping library for extracting real-time stock information from the Brazilian stock exchange using Node.js.✨

Getting started

Installation

npm i bvmf

Usage

Import

//using ES6
import bvmf from 'bvmf';
//or using ES5
const bvmf  = require("bvmf")

Using

//using ES6
import bvmf from 'bvmf';

async function returnQuote(bvmf) {
    const result = await bvmf(
      {
        bvmf: bvmf
      });
    return(result);
 }
 try{
  console.log(returnQuote("itsa4"));
 }catch(err){
  console.error(err);
 }

Returns

{
  "bvmf": "itsa4",
  "total": 1,
  "stock": [
    {
      "currentValue": "11,11",
      "dailyLiquidity": "391.965.857,19",
      "yield": "2,67",
      "min2Weeks": "8,57",
      "max2Weeks": "12,05",
      "logo": "https://cdn-statsinvest.azeedge.net/img/company/cove/345.jpg",
      "name": "ITAUSA INVESTIMENTOS ITAU S.A.",
      "site": "http://www.itausa.com.br"
    }
  ]
}

Testing

I used jest-cucumber

Example:

Feature: Retrieve stock information

Scenario: Retrieving stock data
    Given I want to retrieve stock data
    When I call the stock function with the bvmf code
    Then I should receive an object with the stock data

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!

Or buy me a coffee 🙌🏾

BTC WALLET: 3P4oVEdSP8CPdFZZwS2dboRyLFXLSTE7Gq

favelado-web/bvmf