BrFinance: Node.JS
💡 Description🚀 Getting Started Tutorial✨ Features📌 Requirements📚 Usage & Examples🏭 Related Repositories📣 Feedback & Contact
💡 Description
brFinance is Node.JS web scraping package to simplify access to financial data. It provides data from various sources such as CVM (brazilian equivalent of SEC), B3 (Brazilian stock exchange), Banco Central (brazilian equivalent of FED), ANBIMA, etc.
🚀 Getting Started Tutorial
- Install the package
or
yarn add brfinance
npm install brfinance
✨ Features
- Index Composition - Composition of B3 listed indexes see list
- Banco central PTAX - Average trade price for currencies in BRL
- ANBIMA IMA Index - Brazilian bonds index
- COTA Investment Fund - Brazilian Investment Funds performance history
- Derivatives - Stats for Derivatives (Futures & Options) see list
- Industry Classification - Companies Sector, subsector & segment )
📌 Requirements
Currently, Node 14+ is supported. We support the LTS versions of Node.
📚 Usage & Examples
- Index Composition:
const brFinance = require('brfinance')
async function main() {
const data = await brFinance.getIndexComposition('IFNC')
console.table(data.carteira.slice(-5))
}
main()
- PTAX:
const brFinance = require('brfinance')
async function main() {
const ptax = await brFinance.ptax(20210501, 20210510)
console.table(ptax)
}
main()
- ANBIMA Index:
const brFinance = require('brfinance')
async function main() {
const indices = await brFinance.indicesAnbima(20210701, 20210705)
console.table(
indices.slice(-3).map((e) =>
(({ Indice, VariacaoDiaria, VariacaonoMes, VariacaonoAno }) => ({
Indice,
VariacaoDiaria,
VariacaonoMes,
VariacaonoAno,
}))(e),
),
)
}
main()
- COTA Investment Fund:
const brFinance = require('brfinance')
async function main() {
const cota = await cotaFundo('09143435000160')
console.table(cota.slice(-5))
}
main()
- Derivatives: List with all available symbols
const brFinance = require('brfinance')
async function main() {
const dollar = await derivativeStats(20210720, 'DOL')
console.table(dollar.futures)
}
main()
- Industry Classification: Get all active sector, subsetor & segmento and their corresponding companies
const brFinance = require('brfinance')
async function main() {
const industries = await getIndustryClassification()
console.table(industries.slice(20, 30))
}
main()