ListNewsHeadlinesRequestDTO

stonepy.models.ListNewsHeadlinesRequestDTO.ListNewsHeadlinesRequestDTO

Bases: RequestModel

A request for news stories. The stories can be filtered by one of the four available filters: (Category, MarketId, MarketName, RicCode) . Only use 1 of the filters at a time. If zero or more than one filter is used simultaneously, then an exception is thrown and a 400 status error code is returned.

source class-attribute instance-attribute

source: str | None = Field(default=None, alias='Source')

The source for the news stories. Leave blank to use the default news provider as the source. Valid options are: dj | mni | ci .

category class-attribute instance-attribute

category: str | None = Field(default=None, alias="Category")

A news category that can be used to filter the news. Valid categories depend on the source used: for dj : uk | aus , for ci : SEMINARSCHINA , for mni : ALL .

market_id class-attribute instance-attribute

market_id: int | None = Field(
    default=None, alias="MarketId"
)

A market ID that can be used to filter the news.

market_name class-attribute instance-attribute

market_name: str | None = Field(
    default=None, alias="MarketName"
)

A market name that can be used to filter the news.

ric_code class-attribute instance-attribute

ric_code: str | None = Field(default=None, alias='RicCode')

A Reuters Instrument Code (RIC) that can be used to filter the news.

max_results class-attribute instance-attribute

max_results: int | None = Field(
    default=None, alias="MaxResults"
)

The maximum number of responses to return. Leave blank to return the top 25 results.

culture_id class-attribute instance-attribute

culture_id: int | None = Field(
    default=None, alias="CultureId"
)

The Culture ID used to filter results. Leave blank to use the culture of the requesting user.