Centjes Stocks

Documentation for downloading historical stock prices

Reference

Options

  --config-file Path to the configuration file
  -l|--ledger ledger file default: "ledger.cent"
  download-rates Download stock prices
      --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_CONFIG_FILE FILE_PATH   Path to the configuration file                                                 
  CENTJES_STOCKS_LEDGER FILE_PATH        ledger file                                              default: "ledger.cent"
  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

  ledger file
  default: "ledger.cent"
  ledger:
    # or null
    <string>
  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 [--config-file FILE_PATH] [-l|--ledger FILE_PATH] COMMAND

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

  Output version information
  switch: --version

  Path to the configuration file
  option: --config-file FILE_PATH
  env: CENTJES_STOCKS_CONFIG_FILE FILE_PATH

  ledger file
  option: -l|--ledger FILE_PATH
  env: CENTJES_STOCKS_LEDGER FILE_PATH
  config:
    ledger: # or null
      <string>
  default: "ledger.cent"

All commands:
  Download stock prices
  command: download-rates
    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>
    
  

Options:
  -h|--help Show this help text
  --version Output version information
  --config-file Path to the configuration file
  -l|--ledger ledger file default: "ledger.cent"
  download-rates Download stock prices
      --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_CONFIG_FILE FILE_PATH   Path to the configuration file                                                 
  CENTJES_STOCKS_LEDGER FILE_PATH        ledger file                                              default: "ledger.cent"
  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:
  ledger file
  default: "ledger.cent"
  ledger:
    # or null
    <string>
  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>