OpenBB/docker/lab-settings.json

{
  "title": "Gamestonk settings",
  "description": "Settings for OpenBB Terminal extension.",
  "type": "object",
  "properties": {
    "FEATURE_FLAGS": {
      "title": "Feature flags",
      "description": "Feature flags for the OpenBB Terminal.",
      "default": {
        "OPENBB_USE_CLEAR_AFTER_CMD": {
          "type": "bool",
          "form": "checkbox",
          "title": "Clear after command",
          "description": "Use clear console after each command",
          "default": false,
          "value": ""
        },
        "OPENBB_USE_COLOR": {
          "type": "bool",
          "form": "checkbox",
          "title": "Colors",
          "description": "Use coloring features",
          "default": true,
          "value": ""
        },
        "OPENBB_USE_FLAIR": {
          "type": "string",
          "form": "text",
          "title": "Console flair",
          "description": "Select console flair (choose from config_terminal.py list)",
          "default": "openbb",
          "value": ""
        },
        "OPENBB_USE_ION": {
          "type": "bool",
          "form": "checkbox",
          "title": "Interactive charts",
          "description": "Enable interactive matplotlib",
          "default": true,
          "value": ""
        },
        "OPENBB_USE_PROMPT_TOOLKIT": {
          "type": "bool",
          "form": "checkbox",
          "title": "Autocomplete",
          "description": "Enable Prompt Toolkit",
          "default": true,
          "value": ""
        },
        "OPENBB_ENABLE_PREDICT": {
          "type": "bool",
          "form": "checkbox",
          "title": "Prediction menu",
          "description": "Enable Prediction features",
          "default": true,
          "value": ""
        },
        "OPENBB_USE_PLOT_AUTOSCALING": {
          "type": "bool",
          "form": "checkbox",
          "title": "Plot autoscaling",
          "description": "Enable plot autoscaling",
          "default": false,
          "value": ""
        },
        "OPENBB_ENABLE_THOUGHTS_DAY": {
          "type": "bool",
          "form": "checkbox",
          "title": "Thoughts of the day",
          "description": "Enable thoughts of the day",
          "default": false,
          "value": ""
        },
        "OPENBB_ENABLE_QUICK_EXIT": {
          "type": "bool",
          "form": "checkbox",
          "title": "Quick exit",
          "description": "Quick exit for testing",
          "default": false,
          "value": ""
        }
      }
    },
    "APP_SETTINGS": {
      "title": "General",
      "description": "Application settings for the OpenBB Terminal.",
      "default": {
        "PAPERMILL_NOTEBOOK_REPORT_PORT": {
          "type": "number",
          "form": "number",
          "title": "Papermill port",
          "description": "Papermill port",
          "default": 8892,
          "value": ""
        },
        "PYTHON_BINARY": {
          "type": "string",
          "form": "text",
          "title": "Python executable",
          "description": "Path to the python in your custom environment",
          "default": "poetry run python",
          "value": ""
        },
        "TERMINAL_PATH": {
          "type": "string",
          "form": "text",
          "title": "Terminal path",
          "description": "Path to the terminal.py",
          "default": "terminal.py",
          "value": ""
        },
        "PATH_TO_SELENIUM_DRIVER": {
          "type": "string",
          "form": "text",
          "title": "Path to webdriver",
          "description": "Path to the selenium driver",
          "default": "",
          "value": ""
        },
        "WEBDRIVER_TO_USE": {
          "type": "string",
          "form": "text",
          "title": "Webdriver",
          "description": "Selenium browser drivers can be found at https://selenium-python.readthedocs.io/installation.html",
          "default": "chrome",
          "value": ""
        }
      }
    },
    "API_KEYS": {
      "title": "API Keys",
      "description": "Access credentials for data providers.",
      "default": {
        "OPENBB_API_KEY_ALPHAVANTAGE": {
          "type": "string",
          "form": "password",
          "title": "Alphavantage",
          "description": "https://www.alphavantage.co",
          "default": "REPLACE_ME",
          "value": ""
        },
        "OPENBB_API_KEY_FINANCIALMODELINGPREP": {
          "type": "string",
          "form": "password",
          "title": "financialmodelingprep",
          "description": "https://financialmodelingprep.com/developer",
          "default": "REPLACE_ME",
          "value": ""
        },
        "OPENBB_API_KEY_QUANDL": {
          "type": "string",
          "form": "password",
          "title": "quandl",
          "description": "https://www.quandl.com/tools/api",
          "default": "REPLACE_ME",
          "value": ""
        },
        "OPENBB_API_REDDIT_CLIENT_ID": {
          "type": "string",
          "form": "password",
          "title": "Reddit client ID",
          "description": "https://www.reddit.com/prefs/apps",
          "default": "REPLACE_ME",
          "value": ""
        },
        "OPENBB_API_REDDIT_CLIENT_SECRET": {
          "type": "string",
          "form": "password",
          "title": "Reddit client secret",
          "description": "https://www.reddit.com/prefs/apps",
          "default": "REPLACE_ME",
          "value": ""
        },
        "OPENBB_API_REDDIT_USERNAME": {
          "type": "string",
          "form": "password",
          "title": "Reddit username",
          "description": "https://www.reddit.com/prefs/apps",
          "default": "REPLACE_ME",
          "value": ""
        },
        "OPENBB_API_REDDIT_USER_AGENT": {
          "type": "string",
          "form": "password",
          "title": "Reddit user agent",
          "description": "https://www.reddit.com/prefs/apps",
          "default": "REPLACE_ME",
          "value": ""
        },
        "OPENBB_API_REDDIT_PASSWORD": {
          "type": "string",
          "form": "password",
          "title": "Reddit password",
          "description": "https://www.reddit.com/prefs/apps",
          "default": "REPLACE_ME",
          "value": ""
        },
        "OPENBB_API_POLYGON_KEY": {
          "type": "string",
          "form": "password",
          "title": "Polygon",
          "description": "https://polygon.io",
          "default": "REPLACE_ME",
          "value": ""
        },
        "OPENBB_API_TWITTER_KEY": {
          "type": "string",
          "form": "password",
          "title": "Twitter key",
          "description": "https://developer.twitter.com",
          "default": "REPLACE_ME",
          "value": ""
        },
        "OPENBB_API_TWITTER_SECRET_KEY": {
          "type": "string",
          "form": "password",
          "title": "Twitter secret",
          "description": "https://developer.twitter.com",
          "default": "REPLACE_ME",
          "value": ""
        },
        "OPENBB_API_TWITTER_BEARER_TOKEN": {
          "type": "string",
          "form": "password",
          "title": "Twitter token",
          "description": "https://developer.twitter.com",
          "default": "REPLACE_ME",
          "value": ""
        },
        "OPENBB_API_FRED_KEY": {
          "type": "string",
          "form": "password",
          "title": "FRED",
          "description": "https://fred.stlouisfed.org/docs/api/api_key.html",
          "default": "REPLACE_ME",
          "value": ""
        },
        "OPENBB_API_NEWS_TOKEN": {
          "type": "string",
          "form": "password",
          "title": "NewsAPI",
          "description": "https://newsapi.org",
          "default": "REPLACE_ME",
          "value": ""
        },
        "OPENBB_RH_USERNAME": {
          "type": "string",
          "form": "password",
          "title": "Robinhood username",
          "description": "Robinhood",
          "default": "REPLACE_ME",
          "value": ""
        },
        "OPENBB_RH_PASSWORD": {
          "type": "string",
          "form": "password",
          "title": "Robinhood password",
          "description": "Robinhood",
          "default": "REPLACE_ME",
          "value": ""
        },
        "OPENBB_DG_USERNAME": {
          "type": "string",
          "form": "password",
          "title": "Degiro username",
          "description": "Degiro",
          "default": "REPLACE_ME",
          "value": ""
        },
        "OPENBB_DG_PASSWORD": {
          "type": "string",
          "form": "password",
          "title": "Degiro password",
          "description": "Degiro",
          "default": "REPLACE_ME",
          "value": ""
        },
        "OPENBB_DG_TOTP_SECRET": {
          "type": "string",
          "form": "password",
          "title": "Degiro secret",
          "description": "Degiro",
          "default": "REPLACE_ME",
          "value": ""
        },
        "OPENBB_OANDA_ACCOUNT_TYPE": {
          "type": "string",
          "form": "password",
          "title": "Oanda account type",
          "description": "https://developer.oanda.com",
          "default": "practice",
          "value": ""
        },
        "OPENBB_OANDA_ACCOUNT": {
          "type": "string",
          "form": "password",
          "title": "Oanda account",
          "description": "https://developer.oanda.com",
          "default": "REPLACE_ME",
          "value": ""
        },
        "OPENBB_OANDA_TOKEN": {
          "type": "string",
          "form": "password",
          "title": "Oanda token",
          "description": "https://developer.oanda.com",
          "default": "REPLACE_ME",
          "value": ""
        },
        "OPENBB_API_TRADIER_TOKEN": {
          "type": "string",
          "form": "password",
          "title": "Tradier token",
          "description": "https://tradier.com/products/market-data-api",
          "default": "REPLACE_ME",
          "value": ""
        },
        "OPENBB_API_CMC_KEY": {
          "type": "string",
          "form": "password",
          "title": "Coinmarketcap key",
          "description": "https://coinmarketcap.com/api/",
          "default": "REPLACE_ME",
          "value": ""
        },
        "OPENBB_API_BINANCE_KEY": {
          "type": "string",
          "form": "password",
          "title": "Binance key",
          "description": "https://www.binance.com/en/",
          "default": "REPLACE_ME",
          "value": ""
        },
        "OPENBB_API_BINANCE_SECRET": {
          "type": "string",
          "form": "password",
          "title": "Binance secret",
          "description": "Binance secret",
          "default": "REPLACE_ME",
          "value": ""
        },
        "OPENBB_API_FINNHUB_KEY": {
          "type": "string",
          "form": "password",
          "title": "Finnhub key",
          "description": "https://finnhub.io",
          "default": "REPLACE_ME",
          "value": ""
        },
        "OPENBB_API_IEX_KEY": {
          "type": "string",
          "form": "password",
          "title": "IEX Cloud key",
          "description": "https://iexcloud.io",
          "default": "REPLACE_ME",
          "value": ""
        },
        "OPENBB_API_SENTIMENTINVESTOR_KEY": {
          "type": "string",
          "form": "password",
          "title": "Sentimentinvestor key",
          "description": "https://www.sentimentinvestor.com",
          "default": "REPLACE_ME",
          "value": ""
        },
        "OPENBB_API_SENTIMENTINVESTOR_TOKEN": {
          "type": "string",
          "form": "password",
          "title": "Sentimentinvestor token",
          "description": "https://www.sentimentinvestor.com",
          "default": "REPLACE_ME",
          "value": ""
        }
      }
    }
  }
}