Download Stock Prices

Documentation for the centjes-stocks download-rates command

Reference

Options

centjes-stocks download-rates [--begin YYYY-MM-DD] [--end YYYY-MM-DD] [-o|--output FILE_PATH]

  --begin     The begin date (inclusive), default: Start of the year
  --end       The final date (inclusive), default: Yesterday        
  -o|--output Output file path (default: stdout)                    

Environment variables

  CENTJES_STOCKS_BEGIN YYYY-MM-DD   The begin date (inclusive), default: Start of the year
  CENTJES_STOCKS_END YYYY-MM-DD     The final date (inclusive), default: Yesterday        
  CENTJES_STOCKS_OUTPUT FILE_PATH   Output file path (default: stdout)                    

Configuration values

  Stock configurations with symbol and currency
  download-rates.stocks:
    # or null
    - # StockSettings
      symbol: # required
        # Stock symbol as declared in the ledger (e.g., AAPL)
        <string>
      ticker: # optional
        # Ticker symbol for Yahoo Finance API (defaults to symbol, e.g., SWDA.L, BRK-B)
        <string>
      currency: # required
        # Currency the stock is priced in (e.g., USD)
        <string>
  The begin date (inclusive), default: Start of the year
  download-rates.begin:
    # or null
    # Day
    <string>
  The final date (inclusive), default: Yesterday
  download-rates.end:
    # or null
    # Day
    <string>
  Output file path (default: stdout)
  download-rates.output:
    # or null
    <string>

Combined settings

Usage: centjes-stocks download-rates [--begin YYYY-MM-DD] [--end YYYY-MM-DD] [-o|--output FILE_PATH]

Download stock prices

Available settings:
  Show this help text
  switch: -h|--help

  Stock configurations with symbol and currency
  config:
    download-rates.stocks: # or null
      - # StockSettings
        symbol: # required
          # Stock symbol as declared in the ledger (e.g., AAPL)
          <string>
        ticker: # optional
          # Ticker symbol for Yahoo Finance API (defaults to symbol, e.g., SWDA.L, BRK-B)
          <string>
        currency: # required
          # Currency the stock is priced in (e.g., USD)
          <string>

  The begin date (inclusive), default: Start of the year
  option: --begin YYYY-MM-DD
  env: CENTJES_STOCKS_BEGIN YYYY-MM-DD
  config:
    download-rates.begin: # or null
      # Day
      <string>

  The final date (inclusive), default: Yesterday
  option: --end YYYY-MM-DD
  env: CENTJES_STOCKS_END YYYY-MM-DD
  config:
    download-rates.end: # or null
      # Day
      <string>

  Output file path (default: stdout)
  option: -o|--output FILE_PATH
  env: CENTJES_STOCKS_OUTPUT FILE_PATH
  config:
    download-rates.output: # or null
      <string>