getquote

Getquote implementation for ledger(1)
Log | Files | Refs | README

README.md (1240B)

      1 # Getquote Implementation for Ledger(1)
      2 
      3 This is a simple getquote implementation for ledger(1) using the
      4 [Twelve Data](https://twelvedata.com/) [API](https://twelvedata.com/docs).
      5 
      6 ## Requirements
      7 
      8 - Standard UNIX utilities
      9 - jq utility to process JSON
     10 - curl utility to make API requests
     11 - /bin/sh with -o pipefail option
     12 - Twelve Data API Key ([free](https://twelvedata.com/pricing) up
     13   to 8 requests per minute and 800/day)
     14 
     15 ## Installation
     16 
     17 Edit config.mk to match your system (getquote is installed under
     18 the /usr/local namespace by default).
     19 
     20 Once configured, install with BSD make:
     21 
     22 	$ make install
     23 
     24 ## Configuration
     25 
     26 The getquote configuration directory is located under `$XDG_CONFIG_HOME`,
     27 or `$HOME/.local/config` if it's undefined.
     28 
     29 An API key is expected to be set in the `TWELVE_DATA_API_KEY`
     30 environment variable or stored in the configuration directory under
     31 "keys/api.twelvedata.com".
     32 
     33 It's recommended to make a "symbols" file in the configuration
     34 directory to define which symbols are tickers to get a quote for:
     35 By default symbols are treated as a currency, and only by failing
     36 to get an exchange rate will they be treated as tickers. See
     37 getquote(5) for the syntax.
     38 
     39 For further instructions see the included manuals.