https://github.com/alensiljak/as-symbols

A component for managing the list of financial symbols, used by other apps.
https://github.com/alensiljak/as-symbols

Last synced: about 2 months ago
JSON representation

A component for managing the list of financial symbols, used by other apps.

• Host: GitHub
• URL: https://github.com/alensiljak/as-symbols
• Owner: alensiljak
• License: gpl-3.0
• Created: 2023-01-20T15:03:33.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-04-15T14:48:01.000Z (over 1 year ago)
• Last Synced: 2024-04-23T17:52:20.387Z (9 months ago)
• Language: Rust
• Size: 35.2 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# as-symbols

A library for managing the list of financial symbols and related information

# Purpose

The purpose of this package is to read and provide a list of financial symbols together with their related information.

The main intended clients for the library are the [PriceDb](https://github.com/alensiljak/pricedb-rust) and [IBFlex](https://github.com/alensiljak/interactive-brokers-flex-rs) applications/libraries.

Symbols replaces the table in the PriceDb database and serves as the collection of symbols for which PriceDb retrieves and manages prices.

IBFlex uses the symbols table to translate the symbols between IB symbols and the symbols used in Ledger journal.

# Use

``` rust

let path = PathBuf::from("tests/dummy.csv");

let list = read_symbols(&path).expect("parsed");

```

# Format

The library reads the file containing the symbols data. Based on tests, the CSV format seems the simplest and the most-performant for this purpose.

The columns in the file are defined in the SymbolMetadata struct.