Skip to content

Configuration Overview

fyers-store is configuration-driven. Most behavior is controlled via YAML files under config/, with safe defaults and strict validation.

Path Resolution

Config paths are resolved using FYERS_STORE_ROOT or the OS user data directory. You can override specific files with environment variables: - FYERS_CREDENTIALS_YAML - FYERS_LOGGING_CONFIG_YAML - FYERS_STATE_YAML - FYERS_STATE_DB_PATH - FYERS_STATE_ACCOUNT_ID

Scenario: Running from a packaged install. - Set FYERS_STORE_ROOT to a writable directory. - Run fyers-store migrate to copy config templates and DBs.

Config Files

  • Credentials: docs/config/fyers-credentials.md
  • REST limits: docs/config/fyers-rest-limits.md
  • WS settings: docs/config/fyers-ws.md
  • Cache: docs/config/cache.md
  • State: docs/config/state.md
  • Broker: docs/config/broker.md
  • Data feed: docs/config/data-feed.md
  • Logging: docs/config/logging.md
  • NSE calendar: docs/config/nse-calendar.md

Versioning

Each YAML file requires a top-level version: 1 key. Missing or incorrect versions cause a fast failure with a clear error message.