# QUANTCONNECT.COM - Democratizing Finance, Empowering Individuals. # Lean Algorithmic Trading Engine v2.0. Copyright 2014 QuantConnect Corporation. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. import json from AlgorithmImports import * ### ### Regression test to demonstrate setting custom Symbol Properties and Market Hours for a custom data import ### ### ### ### ### ### class CustomDataPropertiesRegressionAlgorithm(QCAlgorithm): def initialize(self) -> None: self.set_start_date(2018, 4, 5) # Set Start Date self.set_end_date(2018, 4, 10) # Set End Date self.set_cash(100000) # Set Strategy Cash # Define our custom data properties and exchange hours ticker = 'BTC' properties = SymbolProperties("Bitcoin", "USD", 1, 0.01, 0.01, ticker) exchange_hours = SecurityExchangeHours.always_open(TimeZones.NEW_YORK) # Add the custom data to our algorithm with our custom properties and exchange hours self._bitcoin = self.add_data(Bitcoin, ticker, properties, exchange_hours, leverage=1, fill_forward=False) # Verify our symbol properties were changed and loaded into this security if self._bitcoin.symbol_properties != properties : raise AssertionError("Failed to set and retrieve custom SymbolProperties for BTC") # Verify our exchange hours were changed and loaded into this security if self._bitcoin.exchange.hours != exchange_hours : raise AssertionError("Failed to set and retrieve custom ExchangeHours for BTC") # For regression purposes on AddData overloads, this call is simply to ensure Lean can accept this # with default params and is not routed to a breaking function. self.add_data(Bitcoin, "BTCUSD") def on_data(self, data: Slice) -> None: if not self.portfolio.invested: if data['BTC'].close != 0 : self.order('BTC', self.portfolio.margin_remaining/abs(data['BTC'].close + 1)) def on_end_of_algorithm(self) -> None: #Reset our Symbol property value, for testing purposes. self.symbol_properties_database.set_entry(Market.USA, self.market_hours_database.get_database_symbol_key(self._bitcoin.symbol), SecurityType.BASE, SymbolProperties.get_default("USD")) class Bitcoin(PythonData): '''Custom Data Type: Bitcoin data from Quandl - http://www.quandl.com/help/api-for-bitcoin-data''' def get_source(self, config: SubscriptionDataConfig, date: datetime, is_live_mode: bool) -> SubscriptionDataSource: if is_live_mode: return SubscriptionDataSource("https://www.bitstamp.net/api/ticker/", SubscriptionTransportMedium.REST) # Read from a local data file so the test is deterministic instead of depending on a remote source source = f"{Globals.data_folder}/crypto/coinbase/daily/btcusd_trade.zip" return SubscriptionDataSource(source, SubscriptionTransportMedium.LOCAL_FILE, FileFormat.CSV) def reader(self, config: SubscriptionDataConfig, line: str, date: datetime, is_live_mode: bool) -> DynamicData: coin = Bitcoin() coin.symbol = config.symbol if is_live_mode: # Example Line Format: # {"high": "441.00", "last": "421.86", "timestamp": "1411606877", "bid": "421.96", "vwap": "428.58", "volume": "14120.40683975", "low": "418.83", "ask": "421.99"} try: live_btc = json.loads(line) # If value is zero, return None value = live_btc["last"] if value == 0: return coin coin.time = datetime.now() coin.value = value coin["Open"] = float(live_btc["open"]) coin["High"] = float(live_btc["high"]) coin["Low"] = float(live_btc["low"]) coin["Close"] = float(live_btc["last"]) coin["Ask"] = float(live_btc["ask"]) coin["Bid"] = float(live_btc["bid"]) coin["VolumeBTC"] = float(live_btc["volume"]) coin["WeightedPrice"] = float(live_btc["vwap"]) return coin except ValueError: # Do nothing, possible error in json decoding return coin # Example Line Format: # date open high low close volume # 20180405 00:00 6791.68 6933.11 6568.64 6785.85 13832.668772 try: data = line.split(',') coin.time = datetime.strptime(data[0], "%Y%m%d %H:%M") coin.end_time = coin.time + timedelta(1) coin.value = float(data[4]) coin["Open"] = float(data[1]) coin["High"] = float(data[2]) coin["Low"] = float(data[3]) coin["Close"] = float(data[4]) coin["VolumeBTC"] = float(data[5]) return coin except ValueError: # Do nothing, skip malformed rows return coin