Skip to content

Commit

Permalink
feat: update Readme with new input params
Browse files Browse the repository at this point in the history
  • Loading branch information
Romazes committed Jan 6, 2025
1 parent 7f2fb6c commit f91d981
Showing 1 changed file with 63 additions and 0 deletions.
63 changes: 63 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -215,12 +215,22 @@ Options:
The Auth ID of the TerminalLink server
--bybit-api-key TEXT Your Bybit API key
--bybit-api-secret TEXT Your Bybit API secret
--trade-station-use-quantconnect-auth [Yes|No]
Select 'Yes' to use QuantConnect's OAuth authentication or 'No' to proceed without it.
--trade-station-environment [live|paper]
Whether Live or Paper environment should be used
--trade-station-refresh-token TEXT
Enter your TradeStation refresh token to authenticate
--trade-station-client-id TEXT Enter the Client ID associated with your TradeStation application
--trade-station-client-secret TEXT
Enter the Client Secret associated with your TradeStation application
--trade-station-account-id TEXT
The TradeStation account Id
--alpaca-use-quantconnect-auth [Yes|No]
Select 'Yes' to use QuantConnect's OAuth authentication or 'No' to proceed without it.
--alpaca-environment [live|paper]
Whether Live or Paper environment should be used
--alpaca-access-token TEXT Enter your Alpaca access token to authenticate
--download-data Update the Lean configuration file to download data from the QuantConnect API, alias
for --data-provider-historical QuantConnect
--data-purchase-limit INTEGER The maximum amount of QCC to spend on downloading data during the backtest when using
Expand Down Expand Up @@ -435,12 +445,22 @@ Options:
--bybit-api-secret TEXT Your Bybit API secret
--bybit-vip-level [VIP0|VIP1|VIP2|VIP3|VIP4|VIP5|SupremeVIP|Pro1|Pro2|Pro3|Pro4|Pro5]
Your Bybit VIP Level
--trade-station-use-quantconnect-auth [Yes|No]
Select 'Yes' to use QuantConnect's OAuth authentication or 'No' to proceed without it.
--trade-station-environment [live|paper]
Whether Live or Paper environment should be used
--trade-station-refresh-token TEXT
Enter your TradeStation refresh token to authenticate
--trade-station-client-id TEXT Enter the Client ID associated with your TradeStation application
--trade-station-client-secret TEXT
Enter the Client Secret associated with your TradeStation application
--trade-station-account-id TEXT
The TradeStation account Id
--alpaca-use-quantconnect-auth [Yes|No]
Select 'Yes' to use QuantConnect's OAuth authentication or 'No' to proceed without it.
--alpaca-environment [live|paper]
Whether Live or Paper environment should be used
--alpaca-access-token TEXT Enter your Alpaca access token to authenticate
--polygon-api-key TEXT Your Polygon.io API Key
--iex-cloud-api-key TEXT Your iexcloud.io API token publishable key
--iex-price-plan [Launch|Grow|Enterprise]
Expand Down Expand Up @@ -916,12 +936,22 @@ Options:
The Auth ID of the TerminalLink server
--bybit-api-key TEXT Your Bybit API key
--bybit-api-secret TEXT Your Bybit API secret
--trade-station-use-quantconnect-auth [Yes|No]
Select 'Yes' to use QuantConnect's OAuth authentication or 'No' to proceed without it.
--trade-station-environment [live|paper]
Whether Live or Paper environment should be used
--trade-station-refresh-token TEXT
Enter your TradeStation refresh token to authenticate
--trade-station-client-id TEXT Enter the Client ID associated with your TradeStation application
--trade-station-client-secret TEXT
Enter the Client Secret associated with your TradeStation application
--trade-station-account-id TEXT
The TradeStation account Id
--alpaca-use-quantconnect-auth [Yes|No]
Select 'Yes' to use QuantConnect's OAuth authentication or 'No' to proceed without it.
--alpaca-environment [live|paper]
Whether Live or Paper environment should be used
--alpaca-access-token TEXT Enter your Alpaca access token to authenticate
--dataset TEXT The name of the dataset to download non-interactively
--overwrite Overwrite existing local data
-y, --yes Automatically confirm payment confirmation prompts
Expand Down Expand Up @@ -1391,12 +1421,22 @@ Options:
Your Bybit VIP Level
--bybit-use-testnet [live|paper]
Whether the testnet should be used
--trade-station-use-quantconnect-auth [Yes|No]
Select 'Yes' to use QuantConnect's OAuth authentication or 'No' to proceed without it.
--trade-station-environment [live|paper]
Whether Live or Paper environment should be used
--trade-station-refresh-token TEXT
Enter your TradeStation refresh token to authenticate
--trade-station-client-id TEXT Enter the Client ID associated with your TradeStation application
--trade-station-client-secret TEXT
Enter the Client Secret associated with your TradeStation application
--trade-station-account-id TEXT
The TradeStation account Id
--alpaca-use-quantconnect-auth [Yes|No]
Select 'Yes' to use QuantConnect's OAuth authentication or 'No' to proceed without it.
--alpaca-environment [live|paper]
Whether Live or Paper environment should be used
--alpaca-access-token TEXT Enter your Alpaca access token to authenticate
--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 (Optional).
Expand All @@ -1416,6 +1456,9 @@ Options:
--thetadata-rest-url TEXT The ThetaData host address (Optional).
--thetadata-subscription-plan [Free|Value|Standard|Pro]
Your ThetaData subscription price plan
--trade-station-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 (Optional).
--alpaca-api-key TEXT Your Alpaca Api Key
--alpaca-api-secret TEXT Your Alpaca Api Secret
--factset-auth-config-file FILE
Expand Down Expand Up @@ -1806,12 +1849,22 @@ Options:
The Auth ID of the TerminalLink server
--bybit-api-key TEXT Your Bybit API key
--bybit-api-secret TEXT Your Bybit API secret
--trade-station-use-quantconnect-auth [Yes|No]
Select 'Yes' to use QuantConnect's OAuth authentication or 'No' to proceed without it.
--trade-station-environment [live|paper]
Whether Live or Paper environment should be used
--trade-station-refresh-token TEXT
Enter your TradeStation refresh token to authenticate
--trade-station-client-id TEXT Enter the Client ID associated with your TradeStation application
--trade-station-client-secret TEXT
Enter the Client Secret associated with your TradeStation application
--trade-station-account-id TEXT
The TradeStation account Id
--alpaca-use-quantconnect-auth [Yes|No]
Select 'Yes' to use QuantConnect's OAuth authentication or 'No' to proceed without it.
--alpaca-environment [live|paper]
Whether Live or Paper environment should be used
--alpaca-access-token TEXT Enter your Alpaca access token to authenticate
--lean-config FILE The Lean configuration file that should be used (defaults to the nearest lean.json)
--verbose Enable debug logging
--help Show this message and exit.
Expand Down Expand Up @@ -2054,12 +2107,22 @@ Options:
The Auth ID of the TerminalLink server
--bybit-api-key TEXT Your Bybit API key
--bybit-api-secret TEXT Your Bybit API secret
--trade-station-use-quantconnect-auth [Yes|No]
Select 'Yes' to use QuantConnect's OAuth authentication or 'No' to proceed without it.
--trade-station-environment [live|paper]
Whether Live or Paper environment should be used
--trade-station-refresh-token TEXT
Enter your TradeStation refresh token to authenticate
--trade-station-client-id TEXT Enter the Client ID associated with your TradeStation application
--trade-station-client-secret TEXT
Enter the Client Secret associated with your TradeStation application
--trade-station-account-id TEXT
The TradeStation account Id
--alpaca-use-quantconnect-auth [Yes|No]
Select 'Yes' to use QuantConnect's OAuth authentication or 'No' to proceed without it.
--alpaca-environment [live|paper]
Whether Live or Paper environment should be used
--alpaca-access-token TEXT Enter your Alpaca access token to authenticate
--download-data Update the Lean configuration file to download data from the QuantConnect API, alias
for --data-provider-historical QuantConnect
--data-purchase-limit INTEGER The maximum amount of QCC to spend on downloading data during the research session
Expand Down

0 comments on commit f91d981

Please sign in to comment.