Skip to content

Latest commit

 

History

History
97 lines (66 loc) · 4.94 KB

README.md

File metadata and controls

97 lines (66 loc) · 4.94 KB
Raw

beanprice: Price quotes fetcher for Beancount

Description

A script to fetch market data prices from various sources on the internet and render them for plain text accounting price syntax (and Beancount).

This used to be located within Beancount itself (at v2) under beancount.prices. This repo will contain all future updates to that script and to those price sources.

Documentation

Some documentation is still part of Beancount. More about how to use this can be found on that mailing-list. Otherwise read the source.

Quick start

To install beanprice, run:

pip install git+https://github.com/beancount/beanprice.git

You can fetch the latest price of a stock by running:

bean-price -e 'USD:yahoo/AAPL'

To fetch the latest prices from your beancount file, first ensure that commodities have price metadata, e.g.

2000-01-01 commodity AAPL
  price: "USD:yahoo/AAPL"

Then run:

bean-price ledger.beancount

To update prices up to the present day, run:

bean-price --update ledger.beancount

For more detailed guide for price fetching, read https://beancount.github.io/docs/fetching_prices_in_beancount.html.

Price source info

The following price sources are available:

Name Module Provides prices for Base currency Latest price? Historical price?
Alphavantage beanprice.alphavantage Stocks, FX, Crypto Many currencies ✓ ✕
Coinbase beanprice.coinbase Most common (crypto)currencies Many currencies ✓ ✓
Coincap beanprice.coincap Most common (crypto)currencies USD ✓ ✓
Coinmarketcap beanprice.coinmarketcap Most common (crypto)currencies Many Currencies ✓ ✕
IEX beanprice.iex Trading symbols USD ✓ 🚧 (Not yet!)
OANDA beanprice.oanda Many currencies Many currencies ✓ ✓
Quandl beanprice.quandl Various datasets Various datasets ✓ ✓
Rates API beanprice.ratesapi Many currencies Many currencies ✓ ✓
Thrift Savings Plan beanprice.tsp TSP Funds USD ✓ ✓
Yahoo beanprice.yahoo Many currencies Many currencies ✓ ✓
EastMoneyFund(天天基金) beanprice.eastmoneyfund Chinese Funds CNY ✓ ✓

Testing

Run tests:

pytest beanprice

Lint:

pylint beanprice

Type checker:

mypy beanprice --ignore-missing-imports

Copyright and License

Copyright (C) 2007-2020 Martin Blais. All Rights Reserved.

This code is distributed under the terms of the "GNU GPLv2 only". See COPYING file for details.