Skip to main content

Python client for the Banco Central do Brasil SGS (Sistema Gerenciador de Series Temporais) API with 115 curated series codes for Brazilian economic and financial time series.

Project description

bcbpy

Python client for the BCB SGS (Sistema Gerenciador de Series Temporais) API from the Banco Central do Brasil.

Fetch Brazilian economic and financial time series as pandas DataFrames with a simple, Pythonic interface. Includes 115 curated series codes covering exchange rates, interest rates, inflation, GDP, employment, and more.

Installation

pip install bcbpy

Or from source:

git clone https://github.com/rteoo/bcbpy.git
cd bcbpy
pip install .

Requirements

  • Python 3.10+
  • pandas
  • requests

Quick Start

from bcbpy import fetch_series, fetch_last, fetch_multiple, INTEREST_RATES, EXCHANGE_RATES

# Last 10 CDI daily rates
cdi = fetch_last(INTEREST_RATES["CDI_DAILY"], n=10)
print(cdi)

# USD/BRL exchange rate for 2024
usd = fetch_series(EXCHANGE_RATES["USD_SALE_DAILY"], start_date="2024-01-01", end_date="2024-12-31")
print(usd)

# Multiple series merged into one DataFrame
df = fetch_multiple(
    {"CDI": INTEREST_RATES["CDI_DAILY"], "SELIC": INTEREST_RATES["SELIC_DAILY"]},
    start_date="2024-01-01",
    end_date="2024-12-31",
)
print(df.tail())

API Reference

Functions

fetch_series(code, start_date=None, end_date=None)

Fetch a time series by its SGS numeric code. Returns a pandas DataFrame indexed by date.

from bcbpy import fetch_series

# Accepts YYYY-MM-DD or DD/MM/YYYY date formats
ipca = fetch_series(433, start_date="2023-01-01", end_date="2024-12-31")

fetch_last(code, n=10)

Fetch the last N observations of a series.

from bcbpy import fetch_last

selic = fetch_last(11, n=5)

fetch_multiple(codes_dict, start_date=None, end_date=None)

Fetch multiple series and merge them into a single DataFrame, one column per series.

from bcbpy import fetch_multiple

df = fetch_multiple({"CDI": 12, "SELIC": 11, "TR": 226}, start_date="2024-01-01")

list_codes(category=None)

Print all available series codes. Pass a category name to filter.

from bcbpy import list_codes

list_codes()                        # all 115 codes across 14 categories
list_codes("INTEREST_RATES")        # only interest rate codes

search_codes(keyword)

Search codes by keyword (case-insensitive). Returns a dict of matches.

from bcbpy import search_codes

results = search_codes("IPCA")      # finds 15 IPCA-related codes
results = search_codes("USD")       # finds USD exchange rate codes

Exceptions

Exception When
SGSError Base exception for all API errors
SGSRateLimitError API returns HTTP 429 (too many requests)
SGSEmptyResponseError No data returned for the given query

Error Handling

from bcbpy import fetch_series, SGSRateLimitError, SGSEmptyResponseError

try:
    df = fetch_series(433, start_date="2024-01-01")
except SGSRateLimitError:
    print("Rate limited — wait and retry")
except SGSEmptyResponseError:
    print("No data for this date range")

Available Series Codes

115 curated codes organized in 14 categories:

Category Series Examples
EXCHANGE_RATES 6 USD/BRL daily sale/purchase, monthly averages
INTEREST_RATES 10 Selic, CDI, TR, TBF, TJLP
INFLATION 17 IPCA, INPC, IGP-M, IGP-DI, IPC-Fipe
IPCA_BREAKDOWN 11 Tradeable, non-tradeable, durables, services, cores
IPCA_CATEGORIES 9 Food, housing, transport, health, education
GDP 13 GDP current/constant/USD, per capita, quarterly components
EMPLOYMENT 7 Unemployment rate, labor force, income
INDUSTRIAL_PRODUCTION 7 Manufacturing, mining, capital/intermediate/consumer goods
FINANCIAL_MARKETS 7 Gold, Bovespa, IMA-B
SAVINGS 2 Savings rate and return
CONFIDENCE 4 Consumer (ICC) and business (ICEI) confidence
ECONOMIC_ACTIVITY 1 IBC-Br (GDP proxy, seasonally adjusted)
BASIC_BASKET 16 Cost of living by capital city
EXCHANGE_RATE_INDEX 5 Real effective exchange rate (USD, EUR, JPY, ARS)

Use any code directly by number or via the category dictionaries:

from bcbpy import INFLATION, GDP

# These are equivalent:
fetch_series(433)
fetch_series(INFLATION["IPCA"])

API Limits

  • Date range: max 10 years per query (BCB restriction since March 2025)
  • Rate limiting: HTTP 429 on excessive requests (no official limit documented)
  • Date formats: the client accepts both YYYY-MM-DD and DD/MM/YYYY

Project Structure

bcbpy/
├── bcbpy/
│   ├── __init__.py      # Public API exports
│   ├── client.py        # API client functions and exceptions
│   ├── codes.py         # 115 curated series codes in 14 categories
│   └── constants.py     # Base URLs and API configuration
├── pyproject.toml       # PyPI packaging metadata
├── BCB_API_REFERENCE.md # Full SGS + Olinda API reference guide
└── README.md

Data Source

All data is fetched from the BCB Open Data Portal under the Open Database License (ODbL).

License

MIT (see LICENSE). The BCB data accessed through this client remains under ODbL; users must comply with ODbL when redistributing data.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bcbpy-2.1.0.tar.gz (18.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bcbpy-2.1.0-py3-none-any.whl (10.9 kB view details)

Uploaded Python 3

File details

Details for the file bcbpy-2.1.0.tar.gz.

File metadata

  • Download URL: bcbpy-2.1.0.tar.gz
  • Upload date:
  • Size: 18.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for bcbpy-2.1.0.tar.gz
Algorithm Hash digest
SHA256 7f138ebdcffa4bb33ebbe3535d81252cf69aca75241823b6f191e5fe6ff693c8
MD5 3ae375b5ccff1e0ae07efa6611683477
BLAKE2b-256 cc190dc9969b2d8f91073ea8b8be771c2e2d6fe58020dd712971ed93c959b32a

See more details on using hashes here.

Provenance

The following attestation bundles were made for bcbpy-2.1.0.tar.gz:

Publisher: publish.yml on rteoo/bcbpy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file bcbpy-2.1.0-py3-none-any.whl.

File metadata

  • Download URL: bcbpy-2.1.0-py3-none-any.whl
  • Upload date:
  • Size: 10.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for bcbpy-2.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7171431caad99a9fd44021dc6e47be805a4505cc41a4a04c630cdbfdfc1a39a6
MD5 4da307835d5326cd2099c82f8e3defb8
BLAKE2b-256 f980be5df8083c7ef8f1cfa38bc31d0e1da84c8fc3ea05f5f02b5d1a0327c0b8

See more details on using hashes here.

Provenance

The following attestation bundles were made for bcbpy-2.1.0-py3-none-any.whl:

Publisher: publish.yml on rteoo/bcbpy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page