News endpoints. Mirror method:
Methods
| Method | Kind | Async | Request | Return | docs.rs | Site rustdoc |
|---|
list | mirror | yes | ListRequest | Result<ListResponse, Error> | docs.rs | site |
list_all | convenience | yes | ListRequest | Result<ListResponse, Error> | docs.rs | site |
list_stream | convenience | no | ListRequest | ResponseStream<Result<ListResponse, Error>> | docs.rs | site |
Requests
ListRequest
| Field | Official Word | Type | Notes |
|---|
start | start | Option<String> | - |
end | end | Option<String> | - |
sort | sort | Option<Sort> | - |
symbols | symbols | Option<Vec<String>> | - |
limit | limit | Option<u32> | - |
include_content | include_content | Option<bool> | - |
exclude_contentless | exclude_contentless | Option<bool> | - |
page_token | page_token | Option<String> | - |
Responses
ListResponse
| Field | Official Word | Type | Notes |
|---|
news | news | Vec<NewsItem> | - |
next_page_token | next_page_token | Option<String> | - |
Models
NewsImage
| Field | Official Word | Type | Notes |
|---|
size | size | String | - |
url | url | String | - |
NewsItem
| Field | Official Word | Type | Notes |
|---|
id | id | i64 | - |
headline | headline | String | - |
author | author | String | - |
created_at | created_at | String | - |
updated_at | updated_at | String | - |
summary | summary | String | - |
content | content | String | - |
url | url | Option<String> | - |
images | images | Vec<NewsImage> | - |
symbols | symbols | Vec<String> | - |
source | source | String | - |
Enums
Sort
- Kind: enum
- Summary: -
- docs.rs: Sort
- Site rustdoc: Sort
| Variant | Official Value |
|---|
Asc | asc |
Desc | desc |
- 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.