https://github.com/xuhcc/beancount-exchangerates
Price source for Beancount that loads data from https://exchangerate.host/
https://github.com/xuhcc/beancount-exchangerates
beancount beancount-prices exchangeratesapi
Last synced: about 1 month ago
JSON representation
Price source for Beancount that loads data from https://exchangerate.host/
- Host: GitHub
- URL: https://github.com/xuhcc/beancount-exchangerates
- Owner: xuhcc
- License: gpl-3.0
- Created: 2019-08-15T10:47:23.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-12-26T14:34:33.000Z (4 months ago)
- Last Synced: 2024-12-26T15:18:37.855Z (4 months ago)
- Topics: beancount, beancount-prices, exchangeratesapi
- Language: Python
- Homepage:
- Size: 34.2 KB
- Stars: 14
- Watchers: 3
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-beancount - exchangeratesapi.io
README
# Beancount Exchange Rates
Price source for [Beancount](http://furius.ca/beancount/) that can load data from or other providers with similar APIs.
## Providers
### Frankfurter.dev
List of supported currencies:
No API key required.
### ExchangeRatesAPI.io & Fixer.io
or :
* Require an API key
* Support more symbols than Frankfurter.dev; both the same, see and
* Only support EUR as `base` currency (at least on their free plans)
## Installation
Install latest version with `pip`:
```
pip install https://github.com/xuhcc/beancount-exchangerates/archive/master.zip
```
## Usage
Source string format is `:beancount_exchangerates/:`.
Default API base url is `https://api.frankfurter.dev/v1/`. It can be changed using `EXCHANGERATE_API_URL` environment variable (which should end with slash) to any service that implements Fixer API.
Use `EXCHANGERATE_ACCESS_KEY` to specify the `access_key` query parameter (not required by frankfurter.dev).
Data source can be changed using `EXCHANGERATE_SOURCE` environment variable.
### Examples
Evaluate source string with `bean-price`:
```
PYTHONPATH=.:$PYTHONPATH bean-price --no-cache -e 'CHF:beancount_exchangerates/USD:CHF'
EXCHANGERATE_API_URL=https://api.exchangeratesapi.io/v1/ EXCHANGERATE_ACCESS_KEY=... bean-price --no-cache -e 'EUR:beancount_exchangerates/EUR:XAU'
```
Set price source for commodity in beancount file:
```
1970-01-01 commodity USD
price: "CHF:beancount_exchangerates/USD:CHF"
```