Client
- Module path:
alpaca_data - docs.rs: https://docs.rs/alpaca-data
- Site rustdoc root: https://wmzhai.github.io/alpaca-data-rs/api/
Public Types
| Type | Kind | Summary | docs.rs | Site rustdoc |
|---|---|---|---|---|
Client | struct | Root async client for Alpaca Market Data HTTP APIs. Build a client once, then obtain resource clients with [Self::stocks], [Self::options], [Self::crypto], [Self::news], and [Self::corporate_actions]. # Examples no_run use alpaca_data::Client; let client = Client::builder().build()?; # let _ = client; # Ok::<(), alpaca_data::Error>(()) | docs.rs | site |
ClientBuilder | struct | - | docs.rs | site |
Client Methods
| Method | Kind | Async | Request | Return | docs.rs | Site rustdoc |
|---|---|---|---|---|---|---|
new | builder | no | - | Self | docs.rs | site |
builder | builder | no | - | ClientBuilder | docs.rs | site |
stocks | accessor | no | - | StocksClient | docs.rs | site |
options | accessor | no | - | OptionsClient | docs.rs | site |
crypto | accessor | no | - | CryptoClient | docs.rs | site |
news | accessor | no | - | NewsClient | docs.rs | site |
corporate_actions | accessor | no | - | CorporateActionsClient | docs.rs | site |
ClientBuilder Methods
| Method | Kind | Async | Request | Return | docs.rs | Site rustdoc |
|---|---|---|---|---|---|---|
api_key | builder | no | impl Into<String> | Self | docs.rs | site |
secret_key | builder | no | impl Into<String> | Self | docs.rs | site |
base_url | builder | no | impl Into<String> | Self | docs.rs | site |
timeout | builder | no | Duration | Self | docs.rs | site |
reqwest_client | builder | no | reqwest::Client | Self | docs.rs | site |
observer | builder | no | Arc<dyn TransportObserver> | Self | docs.rs | site |
max_retries | builder | no | u32 | Self | docs.rs | site |
retry_on_429 | builder | no | bool | Self | docs.rs | site |
respect_retry_after | builder | no | bool | Self | docs.rs | site |
base_backoff | builder | no | Duration | Self | docs.rs | site |
max_backoff | builder | no | Duration | Self | docs.rs | site |
retry_jitter | builder | no | Duration | Self | docs.rs | site |
total_retry_budget | builder | no | Duration | Self | docs.rs | site |
credentials_from_env | builder | no | - | Result<Self, Error> | docs.rs | site |
credentials_from_env_names | builder | no | &str | Result<Self, Error> | docs.rs | site |
max_in_flight | builder | no | usize | Self | docs.rs | site |
build | builder | no | - | Result<Client, Error> | docs.rs | site |