PyAgenciasBancos 0.0.2

A package that helps you to scrap web pages. It shows you a lot of information about the page.

PyAgenciasBancos

PyAgenciasBancos is a Python library for retrieving Brazilian bank agency information from the BCB (Banco Central do Brasil) API.

Installation

pip install -U PyAgenciasBancos

Or install from source:

pip install -e .

Usage

from py_agencias_bancos import agencias_bancos

agencias = agencias_bancos.AgenciasBancos()

Get agencies by municipality

result = agencias.get_agencias_by_municipio("São Paulo", 10)
for agencia in result:
    print(agencia['nome'], agencia['endereco'], agencia['telefone'])

Get agencies by CEP (postal code)

result = agencias.get_agencias_by_cep("01001-000", 5)
for agencia in result:
    print(agencia['nome'], agencia['endereco'], agencia['telefone'])

Get agencies by municipality and bank name

result = agencias.get_agencias_by_municipio_e_banco("São Paulo", "Banco do Brasil", 5)
for agencia in result:
    print(agencia['nome'], agencia['endereco'], agencia['telefone'])

API Reference

AgenciasBancos

Main class for retrieving bank agency information.

Methods

• get_agencias_by_municipio(municipio: str, quantidade_retorno: int = 1) -> List[Dict]

  • Returns a list of agencies for a given municipality.
  • municipio: The municipality name (case-insensitive)
  • quantidade_retorno: Maximum number of results to return (default: 1)

• get_agencias_by_cep(cep: str, quantidade_retorno: int = 1) -> List[Dict]

  • Returns a list of agencies for a given postal code (CEP).
  • cep: The CEP format (e.g., "01001-000")
  • quantidade_retorno: Maximum number of results to return (default: 1)

• get_agencias_by_municipio_e_banco(municipio: str, nome_banco: str, quantidade_retorno: int = 1) -> List[Dict]

  • Returns a list of agencies for a given municipality and bank name.
  • municipio: The municipality name (case-insensitive)
  • nome_banco: The bank name (case-insensitive)
  • quantidade_retorno: Maximum number of results to return (default: 1)

Return Format

Each method returns a list of dictionaries with the following keys:

• nome: Agency name
• endereco: Agency address
• telefone: Agency phone number

Running Tests

pytest

Run a single test:

pytest tests/test_agencias.py::AgenciasTests::test_get_agencias_by_municipio

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT