load_vault_database#

API documentation for tradingstrategy.alternative_data.vault.load_vault_database Python function.

load_vault_database(path=None, filter_bad_entries=True)[source]#

Load pickled vault metadata database generated with an offline script.

  • For sideloading vault data

  • Normalises vault data in a good documented format

  • For the generation see this tutorial

Parameters:

  • path (pathlib.Path | None) –

    Path to the pickle file.

    If not given use the default location.

    Can be zstd compressed with .zstd suffix.

  • filter_bad_entries (bool) –

Return type:

VaultUniverse