Skip to main content

Create a local DB with the term structure of the Brazilian CDI curve (data from B3).

Project description

B3 CDI Curve by Fluxonaut

This package is a collection of Python scripts that extracts, consolidates and interpolates data from the Brazilian CDI Curve provided on the B3 Exchange web site. It allows you to produce a historical data series for any given duration (considering it respects the maximum available duration). It stores all the term structure of the CDI curve in a local SQLite database as well.

Setup and usage

Just install from PyPI as shown below.

pip install b3-cdi-curve

Now just import it to your project. The package exposes two methods, sync_db() and create_time_series(duration: int). Below you can find a basic usage example and a more detailed explanation.

import b3cdi

# Create and/or update local DB
b3cdi.sync_db()

# Create time series for the desired duration (in days)
b3cdi.create_time_series(360)

Creating database

sync_db

This method loops through all the dates between the beginning of the series and the last working day looking for the prices on the B3 web site. It then generates and saves a local SQLite database (located on ./output/cdi.db).

The first run takes around two and half hours to build the database and it takes around 1.35 GB of disk space.

After it runs once, it'll check for the last inserted date, so it'll look only for working days after the last update. This keeps the database updated for each time you run the code.

create_time_series

create_time_series(duration: int)

This method queries the local database to produce a Pandas DataFrame with the historical series of the requested duration. It then saves it as a CSV file on the ./output/ folder. The parameter of the method is where you input your desired duration (e.g. 360).

Contributing

Pull requests are welcome. Please open an issue first to discuss what you would like to change.

To-do

  • Tests
  • Optimize db size

Fluxonaut

This code was made possible by the amazing people working at Fluxonaut who dedicated their free time to help the community. Please be sure to check our our website at https://fluxonaut.com.

License

This project is under the MIT license.

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

b3-cdi-curve-1.2.0.tar.gz (5.0 kB view hashes)

Uploaded Source

Built Distribution

b3_cdi_curve-1.2.0-py3-none-any.whl (6.9 kB view hashes)

Uploaded Python 3

Supported by

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