# About
`b3` is a Python library that allows extracting data provided by B3.
The library was designed to be part of a software for analysis of public
companies, although it can be used on its own for other purposes.
# What is B3?
B3 is the Brazilian stock exchange. Among its responsibilities is buying
and selling securities, such as stocks and stock options.
Note that, as B3 is concerned with market data, it is beyond its scope to
store or provide financial data from publicly-held companies, such as the
balance sheet and the income statement. Such financial data is the responsibility
of CVM, and its automated handling is possible with the library [cvm][repo-pycvm].
# Usage
To retrieve online information of companies:
```py
>>> import b3
>>> co = b3.company_detail('1023')
>>> co.company_name
'BCO BRASIL S.A.'
>>> co.cnpj
'00000000000191'
>>> co.company_code
'BBAS'
```
To extract historical quotes:
```py
import b3
with b3.historical_quotes_reader('path/to/COTAHIST.txt') as reader:
for bulletin in reader:
print(bulletin)
```
# Disclaimer
`b3` is an open-source library that has no connection or affiliation with
B3. The library uses the public API from B3's website and was created solely
for educational purposes. Read B3's [Terms of Use][b3-terms-of-use] for
details about your rights to use their information.
[repo-pycvm]: <https://github.com/callmegiorgio/pycvm>
[b3-terms-of-use]: <https://www.b3.com.br/en_us/terms-of-use-and-data-protection/terms-of-use/>
Raw data
{
"_id": null,
"home_page": "https://github.com/glourencoffee/pybov/",
"name": "pybov",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "investment,finances",
"author": "Giovanni Louren\u00e7o",
"author_email": "gvnl.developer@outlook.com",
"download_url": "https://files.pythonhosted.org/packages/76/ec/09c5c62fe54da3acea7af96acaa98eacb9e05e1825ad594a33e83dc6b32b/pybov-0.1.2.tar.gz",
"platform": null,
"description": "# About\n\n`b3` is a Python library that allows extracting data provided by B3.\nThe library was designed to be part of a software for analysis of public\ncompanies, although it can be used on its own for other purposes.\n\n# What is B3?\n\nB3 is the Brazilian stock exchange. Among its responsibilities is buying\nand selling securities, such as stocks and stock options.\n\nNote that, as B3 is concerned with market data, it is beyond its scope to\nstore or provide financial data from publicly-held companies, such as the\nbalance sheet and the income statement. Such financial data is the responsibility\nof CVM, and its automated handling is possible with the library [cvm][repo-pycvm].\n\n# Usage\n\nTo retrieve online information of companies:\n\n```py\n>>> import b3\n>>> co = b3.company_detail('1023')\n>>> co.company_name\n'BCO BRASIL S.A.'\n>>> co.cnpj\n'00000000000191'\n>>> co.company_code\n'BBAS'\n```\n\nTo extract historical quotes:\n\n```py\nimport b3\n\nwith b3.historical_quotes_reader('path/to/COTAHIST.txt') as reader:\n for bulletin in reader:\n print(bulletin)\n```\n\n# Disclaimer\n\n`b3` is an open-source library that has no connection or affiliation with\nB3. The library uses the public API from B3's website and was created solely\nfor educational purposes. Read B3's [Terms of Use][b3-terms-of-use] for\ndetails about your rights to use their information.\n\n [repo-pycvm]: <https://github.com/callmegiorgio/pycvm>\n [b3-terms-of-use]: <https://www.b3.com.br/en_us/terms-of-use-and-data-protection/terms-of-use/>\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python library for processing data from B3",
"version": "0.1.2",
"project_urls": {
"Homepage": "https://github.com/glourencoffee/pybov/"
},
"split_keywords": [
"investment",
"finances"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c4d4023d828838baef459098cf4ac5db2075fd6a4590dbb96e351662840620df",
"md5": "79b498b100d2d54be4017f2f3ab52851",
"sha256": "ce240afcebd346323cd7b052a8b495bf9e0dfc781275f7336449102a161736d1"
},
"downloads": -1,
"filename": "pybov-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "79b498b100d2d54be4017f2f3ab52851",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 11239,
"upload_time": "2023-05-26T17:06:46",
"upload_time_iso_8601": "2023-05-26T17:06:46.119459Z",
"url": "https://files.pythonhosted.org/packages/c4/d4/023d828838baef459098cf4ac5db2075fd6a4590dbb96e351662840620df/pybov-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "76ec09c5c62fe54da3acea7af96acaa98eacb9e05e1825ad594a33e83dc6b32b",
"md5": "18d0f5686476ccea3ea5c35c71ac18c2",
"sha256": "87717d9212bb41b799f54e7ee8193dab2e6b917c320e947c9f53c56129ad554e"
},
"downloads": -1,
"filename": "pybov-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "18d0f5686476ccea3ea5c35c71ac18c2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 28111,
"upload_time": "2023-05-26T17:06:50",
"upload_time_iso_8601": "2023-05-26T17:06:50.388316Z",
"url": "https://files.pythonhosted.org/packages/76/ec/09c5c62fe54da3acea7af96acaa98eacb9e05e1825ad594a33e83dc6b32b/pybov-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-26 17:06:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "glourencoffee",
"github_project": "pybov",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "pybov"
}
JSON
