Struct RestClient 

pub struct RestClient { /* private fields */ }

An authenticated HTTP client for one Alpaca endpoint.

Implementations

impl RestClient

pub fn new(credentials: &Credentials, config: RestConfig) -> Result<Self>

Builds a client from credentials and configuration.

Redirects are disabled deliberately. Because the base URL is overridable, an http:// endpoint that redirects to https:// would replay a POST body — and its auth headers — over cleartext, so the request must fail loudly instead. The one route that legitimately redirects, the broker document download, uses its own client.

Errors

Returns Error::Credentials if the credentials cannot be encoded as headers, or Error::Transport if the underlying HTTP client fails to build.

pub fn unauthenticated(config: RestConfig) -> Result<Self>

Builds a client that sends no authentication headers.

Alpaca’s crypto market data endpoints serve unauthenticated requests. Every other endpoint requires credentials.

Errors

Returns Error::Transport if the underlying HTTP client fails to build.

pub fn config(&self) -> &RestConfig

The configuration this client was built with.

pub fn at_version(&self, api_version: &str) -> Self

The same client, targeting a different API version segment.

Alpaca versions routes individually rather than per API, and it is not unusual for a client’s own version to be wrong for a given route: the trading API is v2 but its locate routes are v1 and its per-market calendar is v3; the broker API is v1 but funding wallets are v1beta and logos v1beta1.

Writing that at the call site is deliberate. A version buried in a client constructor is the mistake that shipped three event streams pointing at routes Alpaca had retired; this way the version sits next to the path it belongs to.

Cheap: the underlying HTTP client is shared, not rebuilt.

pub async fn get<T, Q>(&self, path: &str, query: &Q) -> Result<T>

where T: DeserializeOwned, Q: Serialize + ?Sized,

Issues a GET, sending query as URL parameters.

Errors

Propagates transport, API, and decoding failures.

pub async fn delete<T, Q>(&self, path: &str, query: &Q) -> Result<T>

where T: DeserializeOwned, Q: Serialize + ?Sized,

Issues a DELETE, sending query as URL parameters.

DELETE parameters go in the query string, not the body — which is what the endpoints taking them (cancel_orders, close_position) expect.

Errors

Propagates transport, API, and decoding failures.

pub async fn delete_effectful<T, Q>(&self, path: &str, query: &Q) -> Result<T>

where T: DeserializeOwned, Q: Serialize + ?Sized,

Issues a DELETE that must never be replayed.

For the routes whose verb says “remove a record” and whose effect is “submit an order”: DELETE /v2/positions/{asset} and DELETE /v2/positions, plus their broker twins. HTTP calls a DELETE idempotent and for those four it is not — a replayed liquidation sells the same quantity twice. A timeout on one is reported, not retried; a 429 still is, because the rate limiter refused it before anything acted.

Errors

Propagates transport, API, and decoding failures.

pub async fn post<T, B>(&self, path: &str, body: &B) -> Result<T>

where T: DeserializeOwned, B: Serialize + ?Sized,

Issues a POST with a JSON body.

Errors

Propagates transport, API, and decoding failures.

pub async fn put<T, B>(&self, path: &str, body: &B) -> Result<T>

where T: DeserializeOwned, B: Serialize + ?Sized,

Issues a PUT with a JSON body.

Errors

Propagates transport, API, and decoding failures.

pub async fn patch<T, B>(&self, path: &str, body: &B) -> Result<T>

where T: DeserializeOwned, B: Serialize + ?Sized,

Issues a PATCH with a JSON body.

Errors

Propagates transport, API, and decoding failures.

pub async fn request<T, Q, B>( &self, method: Method, replay: Replay, path: &str, query: Option<&Q>, body: Option<&B>, ) -> Result<T>

where T: DeserializeOwned, Q: Serialize + ?Sized, B: Serialize + ?Sized,

Issues a request with both a query string and a body.

replay decides what happens on a retryable status. Replay::ByMethod is right for almost everything; pass Replay::Never for a route whose effect contradicts its verb — one that submits an order or moves money behind a PUT or a DELETE.

The six methods above cover routes that take one or the other, which is nearly all of them. A handful take both — PUT /v2/watchlists:by_name names the watchlist in the query and carries the update in the body — and folding the query into the path string would skip its encoding.

Errors

Propagates transport, API, and decoding failures.

pub async fn get_bytes<Q>(&self, path: &str, query: &Q) -> Result<Vec<u8>>

where Q: Serialize + ?Sized,

Issues a GET and returns the response body as bytes.

For the routes that answer with something other than JSON. The logo endpoint is the only one in this crate: it serves image/png, and putting it through RestClient::get would try to parse a PNG as JSON.

Errors

Propagates transport and API failures.

pub async fn request_raw<Q, B>( &self, method: Method, replay: Replay, path: &str, query: Option<&Q>, body: Option<&B>, ) -> Result<String>

where Q: Serialize + ?Sized, B: Serialize + ?Sized,

Issues a request and returns the raw response body without deserializing.

This is the escape hatch for a route this crate does not wrap, which makes replay load-bearing: the wrapped routes have their answer chosen for them, and here it is yours. Replay::Never for anything that acts — a replayed liquidation sells twice.

Errors

Propagates transport and API failures.

Trait Implementations

impl Clone for RestClient

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RestClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.