Skip to main content

News

News endpoints. Mirror method:

Methods

MethodKindAsyncRequestReturndocs.rsSite rustdoc
listmirroryesListRequestResult<ListResponse, Error>docs.rssite
list_allconvenienceyesListRequestResult<ListResponse, Error>docs.rssite
list_streamconveniencenoListRequestResponseStream<Result<ListResponse, Error>>docs.rssite

Requests

ListRequest

FieldOfficial WordTypeNotes
startstartOption<String>-
endendOption<String>-
sortsortOption<Sort>-
symbolssymbolsOption<Vec<String>>-
limitlimitOption<u32>-
include_contentinclude_contentOption<bool>-
exclude_contentlessexclude_contentlessOption<bool>-
page_tokenpage_tokenOption<String>-

Responses

ListResponse

FieldOfficial WordTypeNotes
newsnewsVec<NewsItem>-
next_page_tokennext_page_tokenOption<String>-

Models

NewsImage

FieldOfficial WordTypeNotes
sizesizeString-
urlurlString-

NewsItem

FieldOfficial WordTypeNotes
ididi64-
headlineheadlineString-
authorauthorString-
created_atcreated_atString-
updated_atupdated_atString-
summarysummaryString-
contentcontentString-
urlurlOption<String>-
imagesimagesVec<NewsImage>-
symbolssymbolsVec<String>-
sourcesourceString-

Enums

Sort

  • Kind: enum
  • Summary: -
  • docs.rs: Sort
  • Site rustdoc: Sort
VariantOfficial Value
Ascasc
Descdesc
  • Examples: examples/news_list.rs
  • Tests: tests/live_news.rs, tests/mock_news_corporate_actions_errors.rs
  • Benchmarks: benches/news_corporate_actions.rs

Coverage Notes

  • The strict endpoint parity ledger for this module lives in API Coverage.
  • Generated reference pages mirror the shipped Rust surface and do not claim unimplemented Alpaca endpoints as available.