Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update Readme with new TerminalLink inputs #466

Merged
merged 3 commits into from
Jul 8, 2024
Merged

Update Readme with new TerminalLink inputs #466

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5ddf96f
Update readme
jhonabreul Jun 20, 2024
9ce92c1
Update readme
jhonabreul Jun 25, 2024
1a5fc22
Update readme
jhonabreul Jul 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 24 additions & 22 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ Options:
--ib-weekly-restart-utc-time TEXT
Weekly restart UTC time (hh:mm:ss). Each week on Sunday your algorithm is restarted at
this time, and will require 2FA verification. This is required by Interactive Brokers.
Use this option explicitly to override the default value.
Use this option explicitly to override the default value. (Optional).
--oanda-account-id TEXT Your OANDA account id
--oanda-access-token TEXT Your OANDA API token
--oanda-environment [Practice|Trade]
Expand Down Expand Up @@ -189,8 +189,8 @@ Options:
--coinapi-api-key TEXT Your coinapi.io Api Key
--coinapi-product [Free|Startup|Streamer|Professional|Enterprise]
CoinApi pricing plan (https://www.coinapi.io/market-data-api/pricing)
--thetadata-ws-url TEXT The ThetaData host address
--thetadata-rest-url TEXT The ThetaData host address
--thetadata-ws-url TEXT The ThetaData host address (Optional).
--thetadata-rest-url TEXT The ThetaData host address (Optional).
--thetadata-subscription-plan [Free|Value|Standard|Pro]
Your ThetaData subscription price plan
--terminal-link-connection-type [DAPI|SAPI]
Expand Down Expand Up @@ -330,7 +330,7 @@ Options:
--ib-weekly-restart-utc-time TEXT
Weekly restart UTC time (hh:mm:ss). Each week on Sunday your algorithm is restarted at
this time, and will require 2FA verification. This is required by Interactive Brokers.
Use this option explicitly to override the default value.
Use this option explicitly to override the default value. (Optional).
--tradier-account-id TEXT Your Tradier account id
--tradier-access-token TEXT Your Tradier access token
--tradier-environment [live|paper]
Expand Down Expand Up @@ -379,9 +379,10 @@ Options:
--terminal-link-server-port INTEGER
The port of the SAPI server
--terminal-link-emsx-broker TEXT
The EMSX broker to use
The EMSX broker to use (Optional).
--terminal-link-emsx-account TEXT
The EMSX account to use
The EMSX account to use (Optional).
Martin-Molinero marked this conversation as resolved.
Show resolved Hide resolved
--terminal-link-emsx-team TEXT The EMSX team to receive order events from (Optional).
--terminal-link-openfigi-api-key TEXT
The Open FIGI API key to use for mapping options
--tt-user-name TEXT Your Trading Technologies username
Expand Down Expand Up @@ -821,7 +822,7 @@ Options:
--ib-weekly-restart-utc-time TEXT
Weekly restart UTC time (hh:mm:ss). Each week on Sunday your algorithm is restarted at
this time, and will require 2FA verification. This is required by Interactive Brokers.
Use this option explicitly to override the default value.
Use this option explicitly to override the default value. (Optional).
--oanda-account-id TEXT Your OANDA account id
--oanda-access-token TEXT Your OANDA API token
--oanda-environment [Practice|Trade]
Expand Down Expand Up @@ -857,8 +858,8 @@ Options:
--coinapi-api-key TEXT Your coinapi.io Api Key
--coinapi-product [Free|Startup|Streamer|Professional|Enterprise]
CoinApi pricing plan (https://www.coinapi.io/market-data-api/pricing)
--thetadata-ws-url TEXT The ThetaData host address
--thetadata-rest-url TEXT The ThetaData host address
--thetadata-ws-url TEXT The ThetaData host address (Optional).
--thetadata-rest-url TEXT The ThetaData host address (Optional).
--thetadata-subscription-plan [Free|Value|Standard|Pro]
Your ThetaData subscription price plan
--terminal-link-connection-type [DAPI|SAPI]
Expand Down Expand Up @@ -1236,7 +1237,7 @@ Options:
--ib-weekly-restart-utc-time TEXT
Weekly restart UTC time (hh:mm:ss). Each week on Sunday your algorithm is restarted at
this time, and will require 2FA verification. This is required by Interactive Brokers.
Use this option explicitly to override the default value.
Use this option explicitly to override the default value. (Optional).
--tradier-account-id TEXT Your Tradier account id
--tradier-access-token TEXT Your Tradier access token
--tradier-environment [live|paper]
Expand Down Expand Up @@ -1287,9 +1288,10 @@ Options:
--terminal-link-server-port INTEGER
The port of the TerminalLink server
--terminal-link-emsx-broker TEXT
The EMSX broker to use
The EMSX broker to use (Optional).
--terminal-link-emsx-account TEXT
The EMSX account to use
The EMSX account to use (Optional).
--terminal-link-emsx-team TEXT The EMSX team to receive order events from (Optional).
--terminal-link-openfigi-api-key TEXT
The Open FIGI API key to use for mapping options
--tt-user-name TEXT Your Trading Technologies username
Expand All @@ -1310,7 +1312,7 @@ Options:
The order routing target comp id to use
--tt-order-routing-host TEXT The host of the order routing server
--tt-order-routing-port TEXT The port of the order routing server
--tt-log-fix-messages BOOLEAN Whether FIX messages should be logged
--tt-log-fix-messages BOOLEAN Whether FIX messages should be logged (Optional).
--kraken-api-key TEXT Your Kraken API key
--kraken-api-secret TEXT Your Kraken API secret
--kraken-verification-tier [Starter|Intermediate|Pro]
Expand All @@ -1328,7 +1330,7 @@ Options:
Whether the testnet should be used
--ib-enable-delayed-streaming-data BOOLEAN
Whether delayed data may be used when your algorithm subscribes to a security you
don't have a market data subscription for
don't have a market data subscription for (Optional).
--iqfeed-iqconnect TEXT The path to the IQConnect binary
--iqfeed-username TEXT Your IQFeed username
--iqfeed-password TEXT Your IQFeed password
Expand All @@ -1341,8 +1343,8 @@ Options:
--coinapi-api-key TEXT Your coinapi.io Api Key
--coinapi-product [Free|Startup|Streamer|Professional|Enterprise]
CoinApi pricing plan (https://www.coinapi.io/market-data-api/pricing)
--thetadata-ws-url TEXT The ThetaData host address
--thetadata-rest-url TEXT The ThetaData host address
--thetadata-ws-url TEXT The ThetaData host address (Optional).
--thetadata-rest-url TEXT The ThetaData host address (Optional).
--thetadata-subscription-plan [Free|Value|Standard|Pro]
Your ThetaData subscription price plan
--factset-auth-config-file FILE
Expand Down Expand Up @@ -1676,7 +1678,7 @@ Options:
--ib-weekly-restart-utc-time TEXT
Weekly restart UTC time (hh:mm:ss). Each week on Sunday your algorithm is restarted at
this time, and will require 2FA verification. This is required by Interactive Brokers.
Use this option explicitly to override the default value.
Use this option explicitly to override the default value. (Optional).
--oanda-account-id TEXT Your OANDA account id
--oanda-access-token TEXT Your OANDA API token
--oanda-environment [Practice|Trade]
Expand Down Expand Up @@ -1712,8 +1714,8 @@ Options:
--coinapi-api-key TEXT Your coinapi.io Api Key
--coinapi-product [Free|Startup|Streamer|Professional|Enterprise]
CoinApi pricing plan (https://www.coinapi.io/market-data-api/pricing)
--thetadata-ws-url TEXT The ThetaData host address
--thetadata-rest-url TEXT The ThetaData host address
--thetadata-ws-url TEXT The ThetaData host address (Optional).
--thetadata-rest-url TEXT The ThetaData host address (Optional).
--thetadata-subscription-plan [Free|Value|Standard|Pro]
Your ThetaData subscription price plan
--terminal-link-connection-type [DAPI|SAPI]
Expand Down Expand Up @@ -1843,7 +1845,7 @@ Options:
--ib-weekly-restart-utc-time TEXT
Weekly restart UTC time (hh:mm:ss). Each week on Sunday your algorithm is restarted at
this time, and will require 2FA verification. This is required by Interactive Brokers.
Use this option explicitly to override the default value.
Use this option explicitly to override the default value. (Optional).
--oanda-account-id TEXT Your OANDA account id
--oanda-access-token TEXT Your OANDA API token
--oanda-environment [Practice|Trade]
Expand Down Expand Up @@ -1879,8 +1881,8 @@ Options:
--coinapi-api-key TEXT Your coinapi.io Api Key
--coinapi-product [Free|Startup|Streamer|Professional|Enterprise]
CoinApi pricing plan (https://www.coinapi.io/market-data-api/pricing)
--thetadata-ws-url TEXT The ThetaData host address
--thetadata-rest-url TEXT The ThetaData host address
--thetadata-ws-url TEXT The ThetaData host address (Optional).
--thetadata-rest-url TEXT The ThetaData host address (Optional).
--thetadata-subscription-plan [Free|Value|Standard|Pro]
Your ThetaData subscription price plan
--terminal-link-connection-type [DAPI|SAPI]
Expand Down
2 changes: 2 additions & 0 deletions lean/models/configuration.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,8 @@ def __init__(self, config_json_object):
self._prompt_info = config_json_object["prompt-info"]
if "help" in config_json_object:
self._help = config_json_object["help"]
if self._optional:
self._help += " (Optional)."
if "save-persistently-in-lean" in config_json_object:
self._save_persistently_in_lean = config_json_object["save-persistently-in-lean"]

Expand Down
Loading