Skip to main content

A pure Python interface for the Brazilian Central Bank's Time Series Management System (SGS) API

Project description

SGS2

A pure Python interface for the Brazilian Central Bank's Time Series Management System (SGS) API.

Installation

pip install sgs2

Usage

Quick Start

import sgs2 as sgs

# Get a time series as a pandas DataFrame
sgs.dataframe(12)  # CDI (Brazilian Interbank Deposit Rate)

# Get data with a custom date range
sgs.dataframe(12, start='2020-01-01', end='2021-01-01')

# Get multiple series with custom column names
sgs.dataframe({433: 'ipca', 189: 'igpm'})

# Get a single series as a pandas Series
sgs.series(12)
sgs.series({12: 'cdi'})  # With custom name

json()

Fetch the raw JSON data from the API (to be implemented).

metadata()

Fetch metadata about a series (to be implemented).

search()

Fetch metadata about a series (to be implemented).

Data Codes

Some common series codes:

  • 12: CDI (Brazilian Interbank Deposit Rate)
  • 433: IPCA
  • 189: IGP-M (General Market Price Index)

License

MIT

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

sgs2-0.1.0.tar.gz (3.2 kB view details)

Uploaded Source

Built Distribution

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

sgs2-0.1.0-py3-none-any.whl (3.8 kB view details)

Uploaded Python 3

File details

Details for the file sgs2-0.1.0.tar.gz.

File metadata

  • Download URL: sgs2-0.1.0.tar.gz
  • Upload date:
  • Size: 3.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.1 CPython/3.13.1 Windows/11

File hashes

Hashes for sgs2-0.1.0.tar.gz
Algorithm Hash digest
SHA256 e9351a2489d05e453acd3af20edbd28b3eec72bc29eadf0506086ed16b084fce
MD5 a69dc2e42db1a7319fdfe7d121c262d2
BLAKE2b-256 8ee2b9c64ccf9496baaa06b637dcba51c70f1b9e72f962f75af2f062bbe4ff9e

See more details on using hashes here.

File details

Details for the file sgs2-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: sgs2-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 3.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.1 CPython/3.13.1 Windows/11

File hashes

Hashes for sgs2-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3aeced440660c6e1f129bbdeaf69f377b1ff274aabf35aec940734cc2851f9bd
MD5 a3ac4934864a428e6ba5bebaee6a751e
BLAKE2b-256 8fddf63922c3741b1307a7812b6bd8503b3a35b51dd2fabda1d3d3e1f3aff766

See more details on using hashes here.

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