The API reference provides comprehensive documentation for interacting with each element of SigTech's Python framework. You can browse it as a website or access specific elements as you're coding:
Quick-access to API reference
When coding in the Research Environment, the following shortcuts will be invaluable in making the most of our API reference content.
Example
sig.ReinvestmentStrategy?
Init signature:sig.ReinvestmentStrategy( raw_data: Dict =None, identifier: Union[sigtech.framework.infra.data_adapter.identifier.Identifier, NoneType] =None, cache: bool =True, db=False, validate=True, check_input_parameters=True, env: Union[sigtech.framework.config.config.ConfiguredEnvironment, NoneType] =None,**kwargs,)Docstring:ReinvestmentStrategy -class used for handling corporate actions for underliers.Keyword arguments:* ``currency``.* ``start_date``.* ``underlyer`` (string identifier/ticker).* ``end_date`` (optional, default is date.max).* ``reinvest_cash_dividends`` (optional:ifTrue reinvests dividends at payment date, default isTrue).* ``trade_swap_format`` (optional:ifFalse trades cash equity otherwise equity swaps, default isFalse).* ``swap_include_financing`` (optional: include financing costs, default isTrue).* ``swap_reset_frequency`` (optional: determines frequency of swap reset: default is ``'SOM'``).* ``enable_tracking`` (optional: place adjustments to minimize exposure slippage, default isFalse).* ``tracking_threshold`` (optional: only need if'enable_tracking'inputisset to True, default is 1bps).* ``tracking_frequency`` (optional: determines frequency of tracking check: default is ``'SOM'``).* ``universe_filters`` (optional:list of filter names to be applied, default isFalse).* ``final_trade_out`` (optional:ifTrue will trigger order to trade out at before expiry_date, default isFalse).* ``net_dividend_override`` (optional: net dividend,ifNone the corporate action data is used, default isNone).* ``withholding_tax_override`` (optional: dividend tax,ifNone the net or equity group rate is used, default isNone).* ``libor_instrument_name`` (optional: swap financing fixing source, default is ``'US0001M INDEX'``).* ``libor_spread`` (optional: financing spread, default is 25bps).* ``borrow_cost_ts`` (optional: fixed percentage rate or timeseries of percentage rates to use for shorting costs).* ``initial_shares`` (optional: number of shares to start with,if cash isnot required ``'initial_cash'`` should be set to zero).* ``use_substrats`` (optional:ifTrue will use reinvestment strategies for spinoffs/mergers, default isFalse).Example object creation::: reinv = ReinvestmentStrategy( currency='USD', start_date=dtm.date(2005, 12, 16), trade_swap_format=True, reinvest_cash_dividends=False, underlyer='6027 EQUITY', universe_filters=['compliance', 'internal', 'm_a_targets', 'special_shorts'] )The underlying instrument can be traded in two formats:*cash (outright).* swap format (including financing leg).Internally the strategy constructs holding periods of the underlyer based on the filter lists and expiry datesetting of the underlyer.The building block schedules decisions for handling corporation actions throughout the lifetime of the strategy.File:/opt/conda/envs/sig-env/lib/python3.7/site-packages/sigtech/framework/strategies/reinvestment_strategy.pyType: DObjectModelMetaSubclasses: