pyfundamentus


Namepyfundamentus JSON
Version 0.0.8 PyPI version JSON
download
home_pagehttps://github.com/alexcamargos/pyFundamentus
SummaryPython Fundamentus is a Python API that allows you to quickly access the main fundamental indicators of the main stocks in the Brazilian market.
upload_time2024-02-14 13:12:22
maintainer
docs_urlNone
authorAlexsander Lopes Camargos
requires_python>=3.7,<4.0
licenseMIT
keywords stock market scraping financial information fundamentalist information
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Python Fundamentus

[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
[![codecov](https://codecov.io/github/alexcamargos/pyFundamentus/branch/main/graph/badge.svg?token=44RJNBZZFQ)](https://codecov.io/github/alexcamargos/pyFundamentus)

> `Python Fundamentus` is a Python API that allows you to quickly access the main fundamental indicators of the main stocks in the Brazilian market.

O Python Fundamentus é uma API desenvolvida em Python projetada para facilitar o acesso rápido aos principais indicadores fundamentais das ações mais relevantes do mercado brasileiro. Utilizando as informações disponíveis no site [Fundamentus](https://www.fundamentus.com.br/) diponibiliza informações financeiras e fundamentalistas detalhadas das empresas listadas na [B3](https://www.b3.com.br/), este projeto busca trazer a riqueza de dados financeiros diretamente para suas aplicações Python de maneira eficiente e organizada.

## Sobre o Fundamentus

O [Fundamentus](https://www.fundamentus.com.br/) se destaca como uma plataforma essencial para investidores que buscam dados aprofundados e insights financeiros das empresas negociadas na Bolsa de Valores brasileira. Com um banco de dados abrangente e facilmente acessível, o Fundamentus oferece uma análise detalhada do estado econômico-financeiro das empresas, além de uma avaliação cuidadosa do nível de preço de mercado, apoiando assim a tomada de decisão informada para investimentos.

## Recursos da API Python Fundamentus

Acesso Simplificado aos Dados: Com apenas algumas linhas de código, obtenha informações financeiras essenciais, incluindo lucro líquido, receita líquida, EBITDA, dívida líquida, entre outros.
Análise Fundamentalista ao seu Alcance: Explore os principais indicadores fundamentalistas, como P/L, ROE, ROIC, DY, e muitos outros, para avaliar a saúde financeira e o potencial de investimento das empresas.
Atualizações Constantes: Dados sempre atualizados, refletindo as últimas informações disponíveis no mercado.

## Por Que Usar o Python Fundamentus?

Este projeto é ideal para desenvolvedores, analistas financeiros, investidores individuais e institucionais que desejam incorporar análises fundamentalistas em suas estratégias de investimento ou ferramentas financeiras. Com a Python Fundamentus, você pode:
- Automatizar a coleta e análise de dados financeiros.
- Integrar análises fundamentalistas em aplicações de investimento personalizadas.
- Realizar pesquisas financeiras detalhadas com eficiência e precisão.

## Como Começar
Para começar a usar o Python Fundamentus, siga os passos abaixo:

### Instalação

`pip install pyfundamentus`

#### Usando a API

```python

import fundamentus

URL = 'https://www.fundamentus.com.br/detalhes.php'
PAYLOAD = {'papel': 'VALE3', 'interface': 'mobile'}

main_pipeline = fundamentus.Pipeline(url=URL, params=PAYLOAD)
response = main_pipeline.get_all_information()

# Extract the information from the response.
price_information = response.transformed_information['price_information']
detailed_information = response.transformed_information['detailed_information']
oscillations = response.transformed_information['oscillations']
valuation_indicators = response.transformed_information['valuation_indicators']
profitability_indicators = response.transformed_information['profitability_indicators']
indebtedness_indicators = response.transformed_information['indebtedness_indicators']
balance_sheet = response.transformed_information['balance_sheet']
income_statement = response.transformed_information['income_statement']
```

### Exibindo Informações Diretamente

```bash
git clone git@github.com:alexcamargos/pyFundamentus.git

python run_rich.py VALE3
```

## Exemplos

`python run_rich.py mglu3`

![](screenshot/mglu3.png)

`python run_rich.py wege3`

![](screenshot/wege3.png)

## Contribua

Contribuições são sempre bem-vindas! Se você tem ideias para melhorar a API ou adicionar novas funcionalidades, sinta-se à vontade para criar um fork do projeto e enviar um pull request. Juntos, podemos tornar a Python Fundamentus uma ferramenta ainda mais poderosa para a comunidade de investidores.

## Autor

Feito com :heart: por [Alexsander Lopes Camargos](https://github.com/alexcamargos) :wave: Entre em contato!

[![GitHub](https://img.shields.io/badge/-AlexCamargos-1ca0f1?style=flat-square&labelColor=1ca0f1&logo=github&logoColor=white&link=https://github.com/alexcamargos)](https://github.com/alexcamargos)
[![Twitter Badge](https://img.shields.io/badge/-@alcamargos-1ca0f1?style=flat-square&labelColor=1ca0f1&logo=twitter&logoColor=white&link=https://twitter.com/alcamargos)](https://twitter.com/alcamargos)
[![Linkedin Badge](https://img.shields.io/badge/-alexcamargos-1ca0f1?style=flat-square&logo=Linkedin&logoColor=white&link=https://www.linkedin.com/in/alexcamargos/)](https://www.linkedin.com/in/alexcamargos/)
[![Gmail Badge](https://img.shields.io/badge/-alcamargos@vivaldi.net-1ca0f1?style=flat-square&labelColor=1ca0f1&logo=Gmail&logoColor=white&link=mailto:alcamargos@vivaldi.net)](mailto:alcamargos@vivaldi.net)

## Copyright

Copyright 2022-2024 by Alexsander Lopes Camargos.

## Licença

Este projeto é distribuído sob a licença MIT. Veja o arquivo [MIT License](LICENSE) para mais detalhes.


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/alexcamargos/pyFundamentus",
    "name": "pyfundamentus",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7,<4.0",
    "maintainer_email": "",
    "keywords": "stock market,scraping,financial information,fundamentalist information",
    "author": "Alexsander Lopes Camargos",
    "author_email": "alexcamargos@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/5d/ff/7b572d9711925eca8e8913ec641b8cde3610de3b0104a2e506ab40acf61e/pyfundamentus-0.0.8.tar.gz",
    "platform": null,
    "description": "# Python Fundamentus\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)\n[![codecov](https://codecov.io/github/alexcamargos/pyFundamentus/branch/main/graph/badge.svg?token=44RJNBZZFQ)](https://codecov.io/github/alexcamargos/pyFundamentus)\n\n> `Python Fundamentus` is a Python API that allows you to quickly access the main fundamental indicators of the main stocks in the Brazilian market.\n\nO Python Fundamentus \u00e9 uma API desenvolvida em Python projetada para facilitar o acesso r\u00e1pido aos principais indicadores fundamentais das a\u00e7\u00f5es mais relevantes do mercado brasileiro. Utilizando as informa\u00e7\u00f5es dispon\u00edveis no site [Fundamentus](https://www.fundamentus.com.br/) diponibiliza informa\u00e7\u00f5es financeiras e fundamentalistas detalhadas das empresas listadas na [B3](https://www.b3.com.br/), este projeto busca trazer a riqueza de dados financeiros diretamente para suas aplica\u00e7\u00f5es Python de maneira eficiente e organizada.\n\n## Sobre o Fundamentus\n\nO [Fundamentus](https://www.fundamentus.com.br/) se destaca como uma plataforma essencial para investidores que buscam dados aprofundados e insights financeiros das empresas negociadas na Bolsa de Valores brasileira. Com um banco de dados abrangente e facilmente acess\u00edvel, o Fundamentus oferece uma an\u00e1lise detalhada do estado econ\u00f4mico-financeiro das empresas, al\u00e9m de uma avalia\u00e7\u00e3o cuidadosa do n\u00edvel de pre\u00e7o de mercado, apoiando assim a tomada de decis\u00e3o informada para investimentos.\n\n## Recursos da API Python Fundamentus\n\nAcesso Simplificado aos Dados: Com apenas algumas linhas de c\u00f3digo, obtenha informa\u00e7\u00f5es financeiras essenciais, incluindo lucro l\u00edquido, receita l\u00edquida, EBITDA, d\u00edvida l\u00edquida, entre outros.\nAn\u00e1lise Fundamentalista ao seu Alcance: Explore os principais indicadores fundamentalistas, como P/L, ROE, ROIC, DY, e muitos outros, para avaliar a sa\u00fade financeira e o potencial de investimento das empresas.\nAtualiza\u00e7\u00f5es Constantes: Dados sempre atualizados, refletindo as \u00faltimas informa\u00e7\u00f5es dispon\u00edveis no mercado.\n\n## Por Que Usar o Python Fundamentus?\n\nEste projeto \u00e9 ideal para desenvolvedores, analistas financeiros, investidores individuais e institucionais que desejam incorporar an\u00e1lises fundamentalistas em suas estrat\u00e9gias de investimento ou ferramentas financeiras. Com a Python Fundamentus, voc\u00ea pode:\n- Automatizar a coleta e an\u00e1lise de dados financeiros.\n- Integrar an\u00e1lises fundamentalistas em aplica\u00e7\u00f5es de investimento personalizadas.\n- Realizar pesquisas financeiras detalhadas com efici\u00eancia e precis\u00e3o.\n\n## Como Come\u00e7ar\nPara come\u00e7ar a usar o Python Fundamentus, siga os passos abaixo:\n\n### Instala\u00e7\u00e3o\n\n`pip install pyfundamentus`\n\n#### Usando a API\n\n```python\n\nimport fundamentus\n\nURL = 'https://www.fundamentus.com.br/detalhes.php'\nPAYLOAD = {'papel': 'VALE3', 'interface': 'mobile'}\n\nmain_pipeline = fundamentus.Pipeline(url=URL, params=PAYLOAD)\nresponse = main_pipeline.get_all_information()\n\n# Extract the information from the response.\nprice_information = response.transformed_information['price_information']\ndetailed_information = response.transformed_information['detailed_information']\noscillations = response.transformed_information['oscillations']\nvaluation_indicators = response.transformed_information['valuation_indicators']\nprofitability_indicators = response.transformed_information['profitability_indicators']\nindebtedness_indicators = response.transformed_information['indebtedness_indicators']\nbalance_sheet = response.transformed_information['balance_sheet']\nincome_statement = response.transformed_information['income_statement']\n```\n\n### Exibindo Informa\u00e7\u00f5es Diretamente\n\n```bash\ngit clone git@github.com:alexcamargos/pyFundamentus.git\n\npython run_rich.py VALE3\n```\n\n## Exemplos\n\n`python run_rich.py mglu3`\n\n![](screenshot/mglu3.png)\n\n`python run_rich.py wege3`\n\n![](screenshot/wege3.png)\n\n## Contribua\n\nContribui\u00e7\u00f5es s\u00e3o sempre bem-vindas! Se voc\u00ea tem ideias para melhorar a API ou adicionar novas funcionalidades, sinta-se \u00e0 vontade para criar um fork do projeto e enviar um pull request. Juntos, podemos tornar a Python Fundamentus uma ferramenta ainda mais poderosa para a comunidade de investidores.\n\n## Autor\n\nFeito com :heart: por [Alexsander Lopes Camargos](https://github.com/alexcamargos) :wave: Entre em contato!\n\n[![GitHub](https://img.shields.io/badge/-AlexCamargos-1ca0f1?style=flat-square&labelColor=1ca0f1&logo=github&logoColor=white&link=https://github.com/alexcamargos)](https://github.com/alexcamargos)\n[![Twitter Badge](https://img.shields.io/badge/-@alcamargos-1ca0f1?style=flat-square&labelColor=1ca0f1&logo=twitter&logoColor=white&link=https://twitter.com/alcamargos)](https://twitter.com/alcamargos)\n[![Linkedin Badge](https://img.shields.io/badge/-alexcamargos-1ca0f1?style=flat-square&logo=Linkedin&logoColor=white&link=https://www.linkedin.com/in/alexcamargos/)](https://www.linkedin.com/in/alexcamargos/)\n[![Gmail Badge](https://img.shields.io/badge/-alcamargos@vivaldi.net-1ca0f1?style=flat-square&labelColor=1ca0f1&logo=Gmail&logoColor=white&link=mailto:alcamargos@vivaldi.net)](mailto:alcamargos@vivaldi.net)\n\n## Copyright\n\nCopyright 2022-2024 by Alexsander Lopes Camargos.\n\n## Licen\u00e7a\n\nEste projeto \u00e9 distribu\u00eddo sob a licen\u00e7a MIT. Veja o arquivo [MIT License](LICENSE) para mais detalhes.\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Python Fundamentus is a Python API that allows you to quickly access the main fundamental indicators of the main stocks in the Brazilian market.",
    "version": "0.0.8",
    "project_urls": {
        "Homepage": "https://github.com/alexcamargos/pyFundamentus",
        "Repository": "https://github.com/alexcamargos/pyFundamentus"
    },
    "split_keywords": [
        "stock market",
        "scraping",
        "financial information",
        "fundamentalist information"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "cb7d3584b7f041c827665bc7dc8b3e3c9e05197a990486ae437692ff6465a0fc",
                "md5": "07b1a5b7e13a5b5b1f102ba32c89ef5d",
                "sha256": "842c739df984b07e242d4ec1b9d28862729f050956940a445e2468d1294bad12"
            },
            "downloads": -1,
            "filename": "pyfundamentus-0.0.8-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "07b1a5b7e13a5b5b1f102ba32c89ef5d",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7,<4.0",
            "size": 69909,
            "upload_time": "2024-02-14T13:12:20",
            "upload_time_iso_8601": "2024-02-14T13:12:20.274848Z",
            "url": "https://files.pythonhosted.org/packages/cb/7d/3584b7f041c827665bc7dc8b3e3c9e05197a990486ae437692ff6465a0fc/pyfundamentus-0.0.8-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5dff7b572d9711925eca8e8913ec641b8cde3610de3b0104a2e506ab40acf61e",
                "md5": "bed3e01f227212008183b3c7d8c44a35",
                "sha256": "b01d9cc06e6cde8735307bd6f2d36eabd33e44ea622c8edc9654cf33fb211db1"
            },
            "downloads": -1,
            "filename": "pyfundamentus-0.0.8.tar.gz",
            "has_sig": false,
            "md5_digest": "bed3e01f227212008183b3c7d8c44a35",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7,<4.0",
            "size": 53233,
            "upload_time": "2024-02-14T13:12:22",
            "upload_time_iso_8601": "2024-02-14T13:12:22.157868Z",
            "url": "https://files.pythonhosted.org/packages/5d/ff/7b572d9711925eca8e8913ec641b8cde3610de3b0104a2e506ab40acf61e/pyfundamentus-0.0.8.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-14 13:12:22",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "alexcamargos",
    "github_project": "pyFundamentus",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "pyfundamentus"
}
        
Elapsed time: 0.18757s