BrainCompanyFilingLanguageMetricsAll

QuantConnect.DataSource.BrainCompanyFilingLanguageMetricsAll

BrainCompanyFilingLanguageMetricsAll()

Bases: BrainCompanyFilingLanguageMetricsBase[QuantConnect_DataSource_BrainCompanyFilingLanguageMetricsAll]

Brain sentiment on 10-K/10-Q SEC reports

Constructor for initialising the dase data class

DATA_SOURCE_ID

DATA_SOURCE_ID: int

Data source ID

report_type

report_type: str

This codeEntityType is protected.

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

The end time of this data. Some data covers spans (trade bars) and as such we want to know the entire time span covered

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 codeEntityType is protected.

DAILY_RESOLUTION

DAILY_RESOLUTION: List[Resolution] = ...

A list of Resolution.DAILY

This codeEntityType is protected.

MINUTE_RESOLUTION

MINUTE_RESOLUTION: List[Resolution] = ...

A list of Resolution.MINUTE

This codeEntityType is protected.

HIGH_RESOLUTION

HIGH_RESOLUTION: List[Resolution] = ...

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

This codeEntityType is protected.

OPTION_RESOLUTIONS

OPTION_RESOLUTIONS: List[Resolution] = ...

A list of resolutions support by Options

This codeEntityType is protected.

is_fill_forward

is_fill_forward: bool

True if this is a fill forward piece of data

report_date

report_date: datetime

report_category

report_category: str

report_period

report_period: Optional[int]

previous_report_date

previous_report_date: Optional[datetime]

previous_report_category

previous_report_category: str

previous_report_period

previous_report_period: Optional[int]

report_sentiment

report_sentiment: BrainCompanyFilingLanguageMetrics

risk_factors_statement_sentiment

risk_factors_statement_sentiment: (
    BrainCompanyFilingLanguageMetrics
)

management_discussion_analyasis_of_financial_condition_and_results_of_operations

management_discussion_analyasis_of_financial_condition_and_results_of_operations: (
    BrainCompanyFilingLanguageMetrics
)

clone

clone() -> BaseData

reader

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

Parses the data from the line provided and loads it into LEAN

Parameters:

Name	Type	Description	Default
config	SubscriptionDataConfig	Subscription configuration	required
line	str	Line of data	required
date	datetime	Date	required
is_live_mode	bool	Is live mode	required

Returns:

Type	Description
BaseData	New instance.

requires_mapping

requires_mapping() -> bool

Indicates whether the data source is tied to an underlying symbol and requires that corporate events be applied to it as well, such as renames and delistings

Returns:

Type	Description
bool	false.

data_time_zone

data_time_zone() -> Any

Specifies the data time zone for this data type. This is useful for custom data types

Returns:

Type	Description
Any	The NodaTime.DateTimeZone of this data type.

default_resolution

default_resolution() -> Resolution

Gets the default resolution for this data and security type

deserialize_message

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

Deserialize the message from the data server

Parameters:

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

Returns:

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

get_source

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

Return the URL string source of the file. This will be converted to a stream

Parameters:

Name	Type	Description	Default
config	SubscriptionDataConfig	Configuration object	required
date	datetime	Date of this source file	required
is_live_mode	bool	true if we're in live mode, false for backtesting mode	required

Returns:

Type	Description
SubscriptionDataSource	String URL of source file.

is_sparse_data

is_sparse_data() -> bool

Indicates whether the data is sparse. If true, we disable logging for missing files

Returns:

Type	Description
bool	true.

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.

supported_resolutions

supported_resolutions() -> List[Resolution]

Gets the supported resolution for this data and security type

to_string

to_string() -> str

Converts the instance to string

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

clone_data

clone_data() -> (
    QuantConnect_DataSource_BrainCompanyFilingLanguageMetricsBase_T
)

Clones the data

This codeEntityType is protected.

Returns:

Type	Description
QuantConnect_DataSource_BrainCompanyFilingLanguageMetricsBase_T	A clone of the object.