Skip to content

Commit 05c3552

Browse files
AdalyatNazirovAdalyatNazirov
authored
Add read me for dYdX brokerage (#610)
* add os files to gitignore * add dYdX documentation
1 parent 35722a5 commit 05c3552

2 files changed

Lines changed: 40 additions & 9 deletions

File tree

‎.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ __pycache__/
99
# JetBrains Rider
1010
.idea/
1111

12+
# OS Files
13+
.DS_Store
14+
1215
# Distribution / packaging
1316
.Python
1417
build/

‎README.md‎

Lines changed: 37 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ Options:
165165
-d, --detach Run the backtest in a detached Docker container and return immediately
166166
--debug [pycharm|ptvsd|debugpy|vsdbg|rider|local-platform]
167167
Enable a certain debugging method (see --help for more information)
168-
--data-provider-historical [Interactive Brokers|Oanda|Bitfinex|Coinbase Advanced Trade|Binance|Kraken|CharlesSchwab|IQFeed|Polygon|FactSet|AlphaVantage|CoinApi|ThetaData|QuantConnect|Local|Terminal Link|Bybit|TradeStation|Alpaca|Tastytrade|Eze]
168+
--data-provider-historical [Interactive Brokers|Oanda|Bitfinex|Coinbase Advanced Trade|Binance|Kraken|CharlesSchwab|IQFeed|Polygon|FactSet|AlphaVantage|CoinApi|ThetaData|QuantConnect|Local|Terminal Link|Bybit|TradeStation|Alpaca|Tastytrade|Eze|dYdX]
169169
Update the Lean configuration file to retrieve data from the given historical provider
170170
--ib-user-name TEXT Your Interactive Brokers username
171171
--ib-account TEXT Your Interactive Brokers account id
@@ -241,6 +241,10 @@ Options:
241241
--eze-locale TEXT Examples (broker provided): GLOBAL, AMERICAS, LIVE, DELAYED
242242
--eze-user-name TEXT Your Eze Brokers username
243243
--eze-password TEXT Your Eze Brokers password
244+
--dydx-private-key-hex TEXT Your dYdX API private key in hex format
245+
--dydx-address TEXT Your dYdX wallet address
246+
--dydx-subaccount-number INTEGER
247+
Your dYdX subaccount number
244248
--download-data Update the Lean configuration file to download data from the QuantConnect API, alias
245249
for --data-provider-historical QuantConnect
246250
--data-purchase-limit INTEGER The maximum amount of QCC to spend on downloading data during the backtest when using
@@ -375,9 +379,9 @@ Usage: lean cloud live deploy [OPTIONS] PROJECT
375379
--notify-insights.
376380
377381
Options:
378-
--brokerage [Paper Trading|Interactive Brokers|Tradier|Oanda|Bitfinex|Coinbase Advanced Trade|Binance|Zerodha|Samco|Terminal Link|Trading Technologies|Kraken|CharlesSchwab|Bybit|TradeStation|Alpaca|Tastytrade|Eze]
382+
--brokerage [Paper Trading|Interactive Brokers|Tradier|Oanda|Bitfinex|Coinbase Advanced Trade|Binance|Zerodha|Samco|Terminal Link|Trading Technologies|Kraken|CharlesSchwab|Bybit|TradeStation|Alpaca|Tastytrade|Eze|dYdX]
379383
The brokerage to use
380-
--data-provider-live [QuantConnect|Interactive Brokers|Tradier|Oanda|Bitfinex|Coinbase Advanced Trade|Binance|Zerodha|Samco|Terminal Link|Trading Technologies|Kraken|CharlesSchwab|Polygon|CoinApi|Bybit|TradeStation|Alpaca|Tastytrade|Eze]
384+
--data-provider-live [QuantConnect|Interactive Brokers|Tradier|Oanda|Bitfinex|Coinbase Advanced Trade|Binance|Zerodha|Samco|Terminal Link|Trading Technologies|Kraken|CharlesSchwab|Polygon|CoinApi|Bybit|TradeStation|Alpaca|Tastytrade|Eze|dYdX]
381385
The live data provider to use
382386
--ib-user-name TEXT Your Interactive Brokers username
383387
--ib-account TEXT Your Interactive Brokers account id
@@ -475,6 +479,12 @@ Options:
475479
--eze-user-name TEXT Your Eze Brokers username
476480
--eze-password TEXT Your Eze Brokers password
477481
--eze-trading-account TEXT Format: BANK;BRANCH;CUSTOMER;DEPOSIT
482+
--dydx-private-key-hex TEXT Your dYdX API private key in hex format
483+
--dydx-address TEXT Your dYdX wallet address
484+
--dydx-subaccount-number INTEGER
485+
Your dYdX subaccount number
486+
--dydx-environment [live|paper]
487+
Whether the developer sandbox should be used
478488
--polygon-api-key TEXT Your Polygon.io API Key
479489
--polygon-license-type [Individual|Business]
480490
Select your Polygon.io subscription plan (Optional).
@@ -884,7 +894,7 @@ Usage: lean data download [OPTIONS]
884894
https://www.quantconnect.com/datasets
885895
886896
Options:
887-
--data-provider-historical [Interactive Brokers|Oanda|Bitfinex|Coinbase Advanced Trade|Binance|Kraken|CharlesSchwab|IQFeed|Polygon|FactSet|AlphaVantage|CoinApi|ThetaData|QuantConnect|Local|Terminal Link|Bybit|TradeStation|Alpaca|Tastytrade|Eze]
897+
--data-provider-historical [Interactive Brokers|Oanda|Bitfinex|Coinbase Advanced Trade|Binance|Kraken|CharlesSchwab|IQFeed|Polygon|FactSet|AlphaVantage|CoinApi|ThetaData|QuantConnect|Local|Terminal Link|Bybit|TradeStation|Alpaca|Tastytrade|Eze|dYdX]
888898
The name of the downloader data provider.
889899
--ib-user-name TEXT Your Interactive Brokers username
890900
--ib-account TEXT Your Interactive Brokers account id
@@ -960,6 +970,10 @@ Options:
960970
--eze-locale TEXT Examples (broker provided): GLOBAL, AMERICAS, LIVE, DELAYED
961971
--eze-user-name TEXT Your Eze Brokers username
962972
--eze-password TEXT Your Eze Brokers password
973+
--dydx-private-key-hex TEXT Your dYdX API private key in hex format
974+
--dydx-address TEXT Your dYdX wallet address
975+
--dydx-subaccount-number INTEGER
976+
Your dYdX subaccount number
963977
--dataset TEXT The name of the dataset to download non-interactively
964978
--overwrite Overwrite existing local data
965979
-y, --yes Automatically confirm payment confirmation prompts
@@ -1328,11 +1342,11 @@ Options:
13281342
--environment TEXT The environment to use
13291343
--output DIRECTORY Directory to store results in (defaults to PROJECT/live/TIMESTAMP)
13301344
-d, --detach Run the live deployment in a detached Docker container and return immediately
1331-
--brokerage [Paper Trading|Interactive Brokers|Tradier|Oanda|Bitfinex|Coinbase Advanced Trade|Binance|Zerodha|Samco|Terminal Link|Trading Technologies|Kraken|CharlesSchwab|Bybit|TradeStation|Alpaca|Tastytrade|Eze]
1345+
--brokerage [Paper Trading|Interactive Brokers|Tradier|Oanda|Bitfinex|Coinbase Advanced Trade|Binance|Zerodha|Samco|Terminal Link|Trading Technologies|Kraken|CharlesSchwab|Bybit|TradeStation|Alpaca|Tastytrade|Eze|dYdX]
13321346
The brokerage to use
1333-
--data-provider-live [Interactive Brokers|Tradier|Oanda|Bitfinex|Coinbase Advanced Trade|Binance|Zerodha|Samco|Terminal Link|Trading Technologies|Kraken|CharlesSchwab|IQFeed|Polygon|CoinApi|ThetaData|Custom data only|Bybit|TradeStation|Alpaca|Tastytrade|Eze]
1347+
--data-provider-live [Interactive Brokers|Tradier|Oanda|Bitfinex|Coinbase Advanced Trade|Binance|Zerodha|Samco|Terminal Link|Trading Technologies|Kraken|CharlesSchwab|IQFeed|Polygon|CoinApi|ThetaData|Custom data only|Bybit|TradeStation|Alpaca|Tastytrade|Eze|dYdX]
13341348
The live data provider to use
1335-
--data-provider-historical [Interactive Brokers|Oanda|Bitfinex|Coinbase Advanced Trade|Binance|Kraken|CharlesSchwab|IQFeed|Polygon|FactSet|AlphaVantage|CoinApi|ThetaData|QuantConnect|Local|Bybit|TradeStation|Alpaca|Tastytrade|Eze]
1349+
--data-provider-historical [Interactive Brokers|Oanda|Bitfinex|Coinbase Advanced Trade|Binance|Kraken|CharlesSchwab|IQFeed|Polygon|FactSet|AlphaVantage|CoinApi|ThetaData|QuantConnect|Local|Bybit|TradeStation|Alpaca|Tastytrade|Eze|dYdX]
13361350
Update the Lean configuration file to retrieve data from the given historical provider
13371351
--ib-user-name TEXT Your Interactive Brokers username
13381352
--ib-account TEXT Your Interactive Brokers account id
@@ -1445,6 +1459,12 @@ Options:
14451459
--eze-user-name TEXT Your Eze Brokers username
14461460
--eze-password TEXT Your Eze Brokers password
14471461
--eze-trading-account TEXT Format: BANK;BRANCH;CUSTOMER;DEPOSIT
1462+
--dydx-private-key-hex TEXT Your dYdX API private key in hex format
1463+
--dydx-address TEXT Your dYdX wallet address
1464+
--dydx-subaccount-number INTEGER
1465+
Your dYdX subaccount number
1466+
--dydx-environment [live|paper]
1467+
Whether the developer sandbox should be used
14481468
--ib-enable-delayed-streaming-data BOOLEAN
14491469
Whether delayed data may be used when your algorithm subscribes to a security you
14501470
don't have a market data subscription for (Optional).
@@ -1781,7 +1801,7 @@ Options:
17811801
--parameter <TEXT FLOAT FLOAT FLOAT>...
17821802
The 'parameter min max step' pairs configuring the parameters to optimize
17831803
--constraint TEXT The 'statistic operator value' pairs configuring the constraints of the optimization
1784-
--data-provider-historical [Interactive Brokers|Oanda|Bitfinex|Coinbase Advanced Trade|Binance|Kraken|CharlesSchwab|IQFeed|Polygon|FactSet|AlphaVantage|CoinApi|ThetaData|QuantConnect|Local|Terminal Link|Bybit|TradeStation|Alpaca|Tastytrade|Eze]
1804+
--data-provider-historical [Interactive Brokers|Oanda|Bitfinex|Coinbase Advanced Trade|Binance|Kraken|CharlesSchwab|IQFeed|Polygon|FactSet|AlphaVantage|CoinApi|ThetaData|QuantConnect|Local|Terminal Link|Bybit|TradeStation|Alpaca|Tastytrade|Eze|dYdX]
17851805
Update the Lean configuration file to retrieve data from the given historical provider
17861806
--download-data Update the Lean configuration file to download data from the QuantConnect API, alias
17871807
for --data-provider-historical QuantConnect
@@ -1870,6 +1890,10 @@ Options:
18701890
--eze-locale TEXT Examples (broker provided): GLOBAL, AMERICAS, LIVE, DELAYED
18711891
--eze-user-name TEXT Your Eze Brokers username
18721892
--eze-password TEXT Your Eze Brokers password
1893+
--dydx-private-key-hex TEXT Your dYdX API private key in hex format
1894+
--dydx-address TEXT Your dYdX wallet address
1895+
--dydx-subaccount-number INTEGER
1896+
Your dYdX subaccount number
18731897
--lean-config FILE The Lean configuration file that should be used (defaults to the nearest lean.json)
18741898
--verbose Enable debug logging
18751899
--help Show this message and exit.
@@ -2047,7 +2071,7 @@ Usage: lean research [OPTIONS] PROJECT
20472071
20482072
Options:
20492073
--port INTEGER The port to run Jupyter Lab on (defaults to 8888)
2050-
--data-provider-historical [Interactive Brokers|Oanda|Bitfinex|Coinbase Advanced Trade|Binance|Kraken|CharlesSchwab|IQFeed|Polygon|FactSet|AlphaVantage|CoinApi|ThetaData|QuantConnect|Local|Terminal Link|Bybit|TradeStation|Alpaca|Tastytrade|Eze]
2074+
--data-provider-historical [Interactive Brokers|Oanda|Bitfinex|Coinbase Advanced Trade|Binance|Kraken|CharlesSchwab|IQFeed|Polygon|FactSet|AlphaVantage|CoinApi|ThetaData|QuantConnect|Local|Terminal Link|Bybit|TradeStation|Alpaca|Tastytrade|Eze|dYdX]
20512075
Update the Lean configuration file to retrieve data from the given historical provider
20522076
--ib-user-name TEXT Your Interactive Brokers username
20532077
--ib-account TEXT Your Interactive Brokers account id
@@ -2123,6 +2147,10 @@ Options:
21232147
--eze-locale TEXT Examples (broker provided): GLOBAL, AMERICAS, LIVE, DELAYED
21242148
--eze-user-name TEXT Your Eze Brokers username
21252149
--eze-password TEXT Your Eze Brokers password
2150+
--dydx-private-key-hex TEXT Your dYdX API private key in hex format
2151+
--dydx-address TEXT Your dYdX wallet address
2152+
--dydx-subaccount-number INTEGER
2153+
Your dYdX subaccount number
21262154
--download-data Update the Lean configuration file to download data from the QuantConnect API, alias
21272155
for --data-provider-historical QuantConnect
21282156
--data-purchase-limit INTEGER The maximum amount of QCC to spend on downloading data during the research session

0 commit comments

Comments
 (0)