https://github.com/hebertcisco/node-bvmf

A web scraping library for extracting real-time stock information from the Brazilian stock exchange using Node.js.
https://github.com/hebertcisco/node-bvmf

brazilian brazilian-portuguese exchange stock stock-data stock-market stock-prices stocks

Last synced: 20 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/hebertcisco/node-bvmf
• Owner: hebertcisco
• License: mit
• Created: 2021-07-18T19:06:18.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2025-03-12T12:19:22.000Z (7 months ago)
• Last Synced: 2025-04-12T07:17:45.763Z (6 months ago)
• Topics: brazilian, brazilian-portuguese, exchange, stock, stock-data, stock-market, stock-prices, stocks
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/bvmf
• Size: 2.04 MB
• Stars: 1
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          


 

 
:package: bvmf

 




  


 

      

    

    

      

    

     

      

    

    

      

    

    

      

    

    


    


  Report Bug

  Request Feature

  


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

[![Running Code Coverage](https://github.com/hebertcisco/node-bvmf/actions/workflows/coverage.yml/badge.svg)](https://github.com/hebertcisco/node-bvmf/actions/workflows/coverage.yml)

[![CircleCI](https://dl.circleci.com/status-badge/img/gh/hebertcisco/node-bvmf/tree/main.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/hebertcisco/node-bvmf/tree/main) [![codecov](https://codecov.io/gh/hebertcisco/node-bvmf/branch/main/graph/badge.svg?token=SLBRQS3CWJ)](https://codecov.io/gh/hebertcisco/node-bvmf)

## Installation

```bash

npm i bvmf

```

### Usage

#### Import

```ts

//using ES6

import bvmf from 'bvmf';

//or using ES5

const bvmf  = require("bvmf")

```

#### Using

```ts

//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

```json

{

  "bvmf": "itsa4",

  "total": 1,

  "stock": [

    {

      "currentValue": 11.11,

      "dailyLiquidity": 391.965,

      "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](https://github.com/bencompton/jest-cucumber)

Example:

```feature

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](issues).

## Show your support

Give a ⭐️ if this project helped you!

Or buy me a coffee 🙌🏾



    



Or

**BTC WALLET**: `3P4oVEdSP8CPdFZZwS2dboRyLFXLSTE7Gq`

## 📝 License

Copyright © 2023 [Hebert F Barros](https://github.com/hebertcisco).


This project is [MIT](LICENSE) licensed.