Mira/templates/mira-data-config.example at main · byteseek/Mira · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
# Mira data substrate — local configuration (example).
#
# Copy this file to  private/mira-data.env  (gitignored) and fill in your real
# contact. This file is the standard place for user-specific contact + API keys,
# kept out of tracked files per the repo's private-state boundary.
#
# Format: simple KEY=value, '#' starts a comment. No quotes needed.
# Resolution order: environment variable > MIRA_DATA_CONFIG file >
# private/mira-data.env > ~/.config/mira/mira-data.env
#
#   cp templates/mira-data-config.example private/mira-data.env
#   $EDITOR private/mira-data.env

# --- Contact (required for official-data sources) -------------------------
# SEC's access policy requires a contactable User-Agent to fetch filings /
# companyfacts. Adapters that hit SEC refuse to run under the shipped
# placeholder, so set your REAL email here to enable official-data fetches.
MIRA_CONTACT_EMAIL=you@your-domain.com

# Optional display name placed before the email in the User-Agent.
# MIRA_CONTACT_NAME=Your Name or Org

# Or set the full User-Agent string directly (overrides the two fields above).
# MIRA_HTTP_UA=Your Name you@your-domain.com

# --- Optional API keys (only for keyed sources; not needed for SEC/BLS/Yahoo) -
# FRED_API_KEY=
# BEA_API_KEY=

# --- Optional local Interactive Brokers Gateway / TWS connection -----------
# Keep these in private/mira-data.env or environment variables only.
# Typical ports:
#   7497 = TWS paper trading
#   7496 = TWS live
#   4002 = IB Gateway paper trading
#   4001 = IB Gateway live
# The adapter is read-only and requires optional Python package: ib_insync.
# MIRA_IBKR_HOST=127.0.0.1
# MIRA_IBKR_PORT=4002
# MIRA_IBKR_CLIENT_ID=19
# MIRA_IBKR_CLIENT_ID_AUTO=1
# MIRA_IBKR_CLIENT_ID_RETRIES=5
# MIRA_IBKR_ACCOUNT=
# MIRA_IBKR_PORTFOLIO_ID=ibkr_default
# MIRA_IBKR_READONLY=1
# MIRA_IBKR_MARKET_DATA_TYPE=3
# MIRA_IBKR_EXCHANGE=SMART
# MIRA_IBKR_CURRENCY=USD
# MIRA_IBKR_PRIMARY_EXCHANGE=
# MIRA_IBKR_HIST_DURATION=1 Y
# MIRA_IBKR_HIST_BAR_SIZE=1 day
# MIRA_IBKR_HIST_WHAT=TRADES
# MIRA_IBKR_HIST_USE_RTH=1

# --- Optional local Futu OpenD quote connection ---------------------------
# Keep these in private/mira-data.env or environment variables only.
# The adapter is quote-read-only and requires optional Python package:
# futu-api. It does not create a trade context or place orders.
# Futu symbols are market-prefixed, e.g. US.AAPL, HK.00700, SH.600519.
# If you pass an unprefixed symbol, MIRA_FUTU_DEFAULT_MARKET is prepended.
# MIRA_FUTU_HOST=127.0.0.1
# MIRA_FUTU_PORT=11111
# MIRA_FUTU_DEFAULT_MARKET=US
# MIRA_FUTU_CURRENCY=USD
# MIRA_FUTU_TIMEOUT=10
# MIRA_FUTU_HIST_START=
# MIRA_FUTU_HIST_KTYPE=K_DAY
# MIRA_FUTU_HIST_AUTYPE=QFQ

# --- Local live market-data preference ------------------------------------
# Set this only on machines where the local broker/provider connector is
# authorized and reachable. When set to futu_opend, `fetch market_price` and
# technical OHLCV routines prefer Futu OpenD over public delayed aggregators.
# MIRA_MARKET_DATA_DEFAULT_SOURCE=futu_opend
# MIRA_LIVE_MARKET_DATA_SOURCE=futu_opend_local
# MIRA_BROKER_DATA_PRIORITY=futu_opend_local,ibkr_gateway_local
# MIRA_FUTU_ENABLED_MARKETS=US,HK,CN_A_SHARE,SG,JP
# MIRA_FUTU_PERMISSION_NOTES=