SEC13FHoldings

QuantConnect.DataSource.SEC13FHoldings

SEC13FHoldings(
    time: Union[datetime, date],
    symbol: Union[Symbol, str, BaseContract, Security],
    data: List[BaseData] = None,
)

SEC13FHoldings(
    time: Union[datetime, date],
    end_time: Union[datetime, date],
    symbol: Union[Symbol, str, BaseContract, Security],
    data: List[BaseData] = None,
    underlying: BaseData = None,
    filtered_contracts: HashSet[Symbol] = None,
)

SEC13FHoldings(
    time: Union[datetime, date],
    end_time: Union[datetime, date],
    symbol: Union[Symbol, str, BaseContract, Security],
    data: List[BaseData],
    underlying: BaseData,
    filtered_contracts: HashSet[Symbol],
)

SEC13FHoldings(
    time: Union[datetime, date],
    end_time: Union[datetime, date],
    symbol: Union[Symbol, str, BaseContract, Security],
    underlying: BaseData,
    filtered_contracts: HashSet[Symbol],
)

SEC13FHoldings()

SEC13FHoldings(other: BaseDataCollection)

Bases: BaseDataCollection

Every SEC Form 13F position reported for one security on one filing date. A day's point carries one SEC13FHolding per reported line, so a manager that filed for the security that day appears once for each line it reported it on, and a day on which several managers filed carries all of them.

The collection carries no totals of its own. How many managers hold the security and how many shares they hold between them are counts over the records, and no 13F filing states either, so they are left to the algorithm.

Signature descriptions:

Initializes a new instance of the BaseDataCollection class
Helper method to create an instance without setting the data list
Initializes a new default instance of the BaseDataCollection c;ass
Copy constructor for BaseDataCollection

Parameters:

Name	Type	Description	Default
`time`	`Optional[Union[datetime, date]]`	The time of this data	`None`
`symbol`	`Optional[Union[Symbol, str, BaseContract, Security]]`	A common identifier for all data in this packet	`None`
`data`	`Optional[List[BaseData]]`	The data to add to this collection	`None`
`end_time`	`Optional[Union[datetime, date]]`	The end time of this data	`None`
`underlying`	`Optional[BaseData]`	The associated underlying price data if any	`None`
`filtered_contracts`	`Optional[HashSet[Symbol]]`	The contracts selected by the universe	`None`
`other`	`Optional[BaseDataCollection]`	The base data collection being copied	`None`

symbol

symbol: Symbol

Symbol representation for underlying Security

data_type

data_type: MarketDataType

Market Data Type of this data - does it come in individual price packets or is it grouped into OHLC.

time

time: datetime

Current time marker of this data packet.

end_time

end_time: datetime

Gets or sets the end time of this data

value

value: float

Value representation of this data packet. All data requires a representative value for this moment in time. For streams of data this is the price now, for OHLC packets this is the closing price.

price

price: float

As this is a backtesting platform we'll provide an alias of value as price.

ALL_RESOLUTIONS

ALL_RESOLUTIONS: List[Resolution] = ...

A list of all Resolution

This Field is protected.

DAILY_RESOLUTION

DAILY_RESOLUTION: List[Resolution] = ...

A list of Resolution.DAILY

This Field is protected.

MINUTE_RESOLUTION

MINUTE_RESOLUTION: List[Resolution] = ...

A list of Resolution.MINUTE

This Field is protected.

HIGH_RESOLUTION

HIGH_RESOLUTION: List[Resolution] = ...

A list of high Resolution, including minute, second, and tick.

This Field is protected.

OPTION_RESOLUTIONS

OPTION_RESOLUTIONS: List[Resolution] = ...

A list of resolutions support by Options

This Field is protected.

is_fill_forward

is_fill_forward: bool

True if this is a fill forward piece of data

underlying

underlying: BaseData

The associated underlying price data if any

filtered_contracts

filtered_contracts: HashSet[Symbol]

Gets or sets the contracts selected by the universe

data

data: List[BaseData]

Gets the data list

clone

clone() -> BaseData

Creates a copy of the instance.

data_time_zone

data_time_zone() -> Any

Data time zone (Eastern, the SEC filing time zone).

default_resolution

default_resolution() -> Resolution

Default resolution.

get_source

get_source(
    config: SubscriptionDataConfig,
    date: datetime,
    is_live_mode: bool,
) -> SubscriptionDataSource

Location of the source file. One zip per security holds one entry per filing date, so that the dataset stays at a file per security instead of the eight and a half million a loose file per date would take. LEAN reads the entry straight out of the zip.

is_sparse_data

is_sparse_data() -> bool

Sparse data: a security is only reported on the days managers file for it.

reader

reader(
    config: SubscriptionDataConfig,
    line: str,
    date: datetime,
    is_live_mode: bool,
) -> BaseData

Reads one line of the file into one reported position. The engine folds the lines this returns into the collection, grouping them by their end time, and every line of a file carries the same filing date, so one file gives one point.

requires_mapping

requires_mapping() -> bool

Linked to Equities, so renames and delistings are applied via map files.

supported_resolutions

supported_resolutions() -> List[Resolution]

Supported resolutions (Daily only, the quarterly cadence is modeled as Daily).

to_string

to_string() -> str

String representation for debugging.

deserialize_message

deserialize_message(serialized: str) -> Sequence[BaseData]

Deserialize the message from the data server

Parameters:

Name	Type	Description	Default
`serialized`	`str`	The data server's message	required

Returns:

Type	Description
`Sequence[BaseData]`	An enumerable of base data, if unsuccessful, returns an empty enumerable.

should_cache_to_security

should_cache_to_security() -> bool

Indicates whether this contains data that should be stored in the security cache

Returns:

Type	Description
`bool`	Whether this contains data that should be stored in the security cache.

update

update(
    last_trade: float,
    bid_price: float,
    ask_price: float,
    volume: float,
    bid_size: float,
    ask_size: float,
) -> None

Update routine to build a bar/tick from a data update.

Parameters:

Name	Type	Description	Default
`last_trade`	`float`	The last trade price	required
`bid_price`	`float`	Current bid price	required
`ask_price`	`float`	Current asking price	required
`volume`	`float`	Volume of this trade	required
`bid_size`	`float`	The size of the current bid, if available	required
`ask_size`	`float`	The size of the current ask, if available	required

update_ask

update_ask(ask_price: float, ask_size: float) -> None

Updates this base data with the new quote ask information

Parameters:

Name	Type	Description	Default
`ask_price`	`float`	The current ask price	required
`ask_size`	`float`	The current ask size	required

update_bid

update_bid(bid_price: float, bid_size: float) -> None

Updates this base data with the new quote bid information

Parameters:

Name	Type	Description	Default
`bid_price`	`float`	The current bid price	required
`bid_size`	`float`	The current bid size	required

update_quote

update_quote(
    bid_price: float,
    bid_size: float,
    ask_price: float,
    ask_size: float,
) -> None

Updates this base data with new quote information

Parameters:

Name	Type	Description	Default
`bid_price`	`float`	The current bid price	required
`bid_size`	`float`	The current bid size	required
`ask_price`	`float`	The current ask price	required
`ask_size`	`float`	The current ask size	required

update_trade

update_trade(last_trade: float, trade_size: float) -> None

Updates this base data with a new trade

Parameters:

Name	Type	Description	Default
`last_trade`	`float`	The price of the last trade	required
`trade_size`	`float`	The quantity traded	required

iter

__iter__() -> Iterator[BaseData]

add

add(new_data_point: BaseData) -> None

Adds a new data point to this collection

Parameters:

Name	Type	Description	Default
`new_data_point`	`BaseData`	The new data point to add	required

add_range

add_range(new_data_points: List[BaseData]) -> None

Adds a new data points to this collection

Parameters:

Name	Type	Description	Default
`new_data_points`	`List[BaseData]`	The new data points to add	required

get_enumerator

get_enumerator() -> IEnumerator[BaseData]

Returns an IEnumerator for this enumerable Object. The enumerator provides a simple way to access all the contents of a collection.

universe_symbol

universe_symbol(market: str = None) -> Symbol

Creates the universe symbol for the target market

Returns:

Type	Description
`Symbol`	The universe symbol to use.