1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120

// Copyright (C) 2019-2023 The apca Developers
// SPDX-License-Identifier: GPL-3.0-or-later

#![allow(clippy::let_unit_value, clippy::unreadable_literal)]
#![warn(
  bad_style,
  dead_code,
  future_incompatible,
  illegal_floating_point_literal_pattern,
  improper_ctypes,
  late_bound_lifetime_arguments,
  missing_copy_implementations,
  missing_debug_implementations,
  missing_docs,
  no_mangle_generic_items,
  non_shorthand_field_patterns,
  nonstandard_style,
  overflowing_literals,
  path_statements,
  patterns_in_fns_without_body,
  proc_macro_derive_resolution_fallback,
  renamed_and_removed_lints,
  rust_2018_compatibility,
  rust_2018_idioms,
  stable_features,
  trivial_bounds,
  trivial_numeric_casts,
  type_alias_bounds,
  tyvar_behind_raw_pointer,
  unconditional_recursion,
  unreachable_code,
  unreachable_patterns,
  unreachable_pub,
  unstable_features,
  unstable_name_collisions,
  unused,
  unused_comparisons,
  unused_import_braces,
  unused_lifetimes,
  unused_qualifications,
  unused_results,
  where_clauses_object_safety,
  while_true,
  rustdoc::broken_intra_doc_links
)]

//! A crate for interacting with the [Alpaca
//! API](https://alpaca.markets/docs/). In many ways it mirrors the
//! structure of the upstream API, which is composed of functionality
//! for trading (represented here by the [`api`] module) as well as
//! market data retrieval (provided as part of the [`data`] module).
//!
//! Most operations require a [`Client`] object, instantiation of which
//! in turn happens via a [`ApiInfo`] instance, which captures relevant
//! configuration data such as credentials and URLs to use. A common
//! workflow is to just set the `APCA_API_KEY_ID` (to the Alpaca key ID)
//! and `APCA_API_SECRET_KEY` (to the Alpaca secret key) environment
//! variables and use default values for everything else.
//!
//! ```no_run
//! use apca::ApiInfo;
//! use apca::Client;
//!
//! // Assumes credentials to be present in the `APCA_API_KEY_ID` and
//! // `APCA_API_SECRET_KEY` environment variables.
//! let api_info = ApiInfo::from_env().unwrap();
//! let client = Client::new(api_info);
//! # let _client = client;
//! ```
//!
//! With a [`Client`] instance available, we can now start issuing
//! requests to the upstream Trading API.
//!
//! ```no_run
//! # use apca::ApiInfo;
//! # use apca::Client;
//! # let api_info = ApiInfo::from_env().unwrap();
//! # let client = Client::new(api_info);
//! use apca::api::v2::account;
//!
//! # tokio::runtime::Runtime::new().unwrap().block_on(async move {
//! // Inquire general information about the account, such as available
//! // cash and buying power.
//! let account = client.issue::<account::Get>(&()).await.unwrap();
//! let currency = account.currency;
//! println!("cash:\t{} {currency}", account.cash);
//! println!("buying power:\t{} {currency}", account.buying_power);
//! # })
//! ```

#[macro_use]
extern crate http_endpoint;

#[macro_use]
mod endpoint;

/// A module comprising the functionality backing interactions with the
/// trading API.
pub mod api;

/// A module for retrieving market data.
pub mod data;

mod api_info;
mod client;
mod error;
mod subscribable;
mod util;
mod websocket;

use std::borrow::Cow;

pub use crate::api_info::ApiInfo;
pub use crate::client::Client;
pub use crate::endpoint::ApiError;
pub use crate::error::Error;
pub use crate::error::RequestError;
pub use crate::subscribable::Subscribable;

type Str = Cow<'static, str>;