Struct Client 

pub struct Client { /* private fields */ }

Shareable OANDA v20 client.

Implementations

impl Client

pub async fn list_accounts( &self, ) -> Result<ApiResponse<ListAccountsResponse>, OperationError<GenericRejection>>

List accounts.

impl Client

pub async fn account_details( &self, account_id: &AccountID, ) -> Result<ApiResponse<AccountDetailsResponse>, OperationError<GenericRejection>>

Account details.

impl Client

pub async fn account_summary( &self, account_id: &AccountID, ) -> Result<ApiResponse<AccountSummaryResponse>, OperationError<GenericRejection>>

Account summary.

impl Client

pub async fn account_instruments( &self, account_id: &AccountID, query: Option<&AccountInstrumentsQuery>, ) -> Result<ApiResponse<AccountInstrumentsResponse>, OperationError<GenericRejection>>

Account instruments.

impl Client

pub async fn configure_account( &self, account_id: &AccountID, body: &ConfigureAccountBody, ) -> Result<ApiResponse<ConfigureAccountResponse>, OperationError<ConfigureAccountRejection>>

Configure account.

impl Client

pub async fn account_changes( &self, account_id: &AccountID, query: Option<&AccountChangesQuery>, ) -> Result<ApiResponse<AccountChangesResponse>, OperationError<GenericRejection>>

Account changes.

impl Client

pub fn set_exit_reserve(&self, requests: u32) -> Result<()>

Replace the shared request reserve for cancellation and position or trade closes.

Zero releases the reserve. All clients sharing this admission owner observe the replacement; waiting reads reconsider it immediately. One caller coordinator should own this policy. Changes preserve spent capacity, provider cooldowns and already admitted requests. Exit capacity is finite.

Errors

Returns Error::InvalidInput when requests is at least 120 or the rate lock is poisoned. Invalid changes preserve the policy and admission state.

pub fn builder( environment: Environment, bearer_token: impl Into<String>, ) -> ClientBuilder

Start building a client with an injected personal access token.

pub fn acknowledge_reconciliation(&self, account: &AccountID) -> Result<()>

Allow mutations after the caller has reconciled this account against OANDA state.

This is an acknowledgement by the caller, not a state query performed by the client.

Errors

Returns an error when the shared fence set cannot be locked. The account then stays fenced, so its remaining mutations are refused until a client that can lock succeeds.

pub async fn fetch_page<T: DeserializeOwned>( &self, next_page: &Url, ) -> Result<ApiResponse<T>, OperationError<GenericRejection>>

Follow a provider pagination link on this client’s REST origin.

The caller supplies the expected typed body for the originating list operation.

Errors

Returns an error for an off-origin link, transport failure, provider rejection, or invalid response.

impl Client

pub async fn create_order( &self, account_id: &AccountID, body: &CreateOrderBody, ) -> Result<ApiResponse<CreateOrderResponse>, OperationError<CreateOrderRejection>>

Create order.

impl Client

pub async fn list_orders( &self, account_id: &AccountID, query: Option<&ListOrdersQuery>, ) -> Result<ApiResponse<ListOrdersResponse>, OperationError<GenericRejection>>

List orders.

impl Client

pub async fn list_pending_orders( &self, account_id: &AccountID, ) -> Result<ApiResponse<ListPendingOrdersResponse>, OperationError<GenericRejection>>

List pending orders.

impl Client

pub async fn order_details( &self, account_id: &AccountID, order_specifier: &OrderSpecifier, ) -> Result<ApiResponse<OrderDetailsResponse>, OperationError<GenericRejection>>

Order details.

impl Client

pub async fn replace_order( &self, account_id: &AccountID, order_specifier: &OrderSpecifier, body: &ReplaceOrderBody, client_request_id: Option<&ClientRequestID>, ) -> Result<ApiResponse<ReplaceOrderResponse>, OperationError<ReplaceOrderRejection>>

Replace order.

impl Client

pub async fn cancel_order( &self, account_id: &AccountID, order_specifier: &OrderSpecifier, client_request_id: Option<&ClientRequestID>, ) -> Result<ApiResponse<CancelOrderResponse>, OperationError<CancelOrderRejection>>

Cancel order.

impl Client

pub async fn update_order_client_extensions( &self, account_id: &AccountID, order_specifier: &OrderSpecifier, body: &UpdateOrderClientExtensionsBody, ) -> Result<ApiResponse<UpdateOrderClientExtensionsResponse>, OperationError<UpdateOrderClientExtensionsRejection>>

Update order client extensions.

impl Client

pub async fn list_positions( &self, account_id: &AccountID, ) -> Result<ApiResponse<ListPositionsResponse>, OperationError<GenericRejection>>

List positions.

impl Client

pub async fn list_open_positions( &self, account_id: &AccountID, ) -> Result<ApiResponse<ListOpenPositionsResponse>, OperationError<GenericRejection>>

List open positions.

impl Client

pub async fn position_details( &self, account_id: &AccountID, instrument: &InstrumentName, ) -> Result<ApiResponse<PositionDetailsResponse>, OperationError<GenericRejection>>

Position details.

impl Client

pub async fn close_position( &self, account_id: &AccountID, instrument: &InstrumentName, body: &ClosePositionBody, ) -> Result<ApiResponse<ClosePositionResponse>, OperationError<ClosePositionRejection>>

Close position.

impl Client

pub async fn latest_candles( &self, account_id: &AccountID, query: &LatestCandlesQuery, ) -> Result<ApiResponse<LatestCandlesResponse>, OperationError<GenericRejection>>

Latest candles.

impl Client

pub async fn pricing( &self, account_id: &AccountID, query: &PricingQuery, ) -> Result<ApiResponse<PricingResponse>, OperationError<GenericRejection>>

Pricing.

impl Client

pub async fn instrument_candles( &self, account_id: &AccountID, instrument: &InstrumentName, query: Option<&InstrumentCandlesQuery>, ) -> Result<ApiResponse<InstrumentCandlesResponse>, OperationError<GenericRejection>>

Instrument candles.

impl Client

pub async fn stream_pricing( &self, account: &AccountID, query: &StreamPricingQuery, ) -> Result<HttpStream<PriceStreamEvent>>

Open the sampled account pricing stream.

Errors

Returns an error for an invalid query, exhausted stream capacity, transport failure, or provider rejection.

pub async fn stream_transactions( &self, account: &AccountID, ) -> Result<HttpStream<TransactionStreamEvent>>

Open the account transaction stream. It starts at connection time; use transaction history for recovery.

Errors

Returns an error for exhausted stream capacity, transport failure, or provider rejection.

impl Client

pub async fn list_trades( &self, account_id: &AccountID, query: Option<&ListTradesQuery>, ) -> Result<ApiResponse<ListTradesResponse>, OperationError<GenericRejection>>

List trades.

impl Client

pub async fn list_open_trades( &self, account_id: &AccountID, ) -> Result<ApiResponse<ListOpenTradesResponse>, OperationError<GenericRejection>>

List open trades.

impl Client

pub async fn trade_details( &self, account_id: &AccountID, trade_specifier: &TradeSpecifier, ) -> Result<ApiResponse<TradeDetailsResponse>, OperationError<GenericRejection>>

Trade details.

impl Client

pub async fn close_trade( &self, account_id: &AccountID, trade_specifier: &TradeSpecifier, body: &CloseTradeBody, ) -> Result<ApiResponse<CloseTradeResponse>, OperationError<CloseTradeRejection>>

Close trade.

impl Client

pub async fn update_trade_client_extensions( &self, account_id: &AccountID, trade_specifier: &TradeSpecifier, body: &UpdateTradeClientExtensionsBody, ) -> Result<ApiResponse<UpdateTradeClientExtensionsResponse>, OperationError<UpdateTradeClientExtensionsRejection>>

Update trade client extensions.

impl Client

pub async fn set_trade_dependent_orders( &self, account_id: &AccountID, trade_specifier: &TradeSpecifier, body: &SetTradeDependentOrdersBody, ) -> Result<ApiResponse<SetTradeDependentOrdersResponse>, OperationError<SetTradeDependentOrdersRejection>>

Set trade dependent orders.

impl Client

pub async fn list_transactions( &self, account_id: &AccountID, query: Option<&ListTransactionsQuery>, ) -> Result<ApiResponse<ListTransactionsResponse>, OperationError<GenericRejection>>

List transactions.

impl Client

pub async fn transaction_details( &self, account_id: &AccountID, transaction_id: &TransactionID, ) -> Result<ApiResponse<TransactionDetailsResponse>, OperationError<GenericRejection>>

Transaction details.

impl Client

pub async fn transactions_by_id_range( &self, account_id: &AccountID, query: &TransactionsByIdRangeQuery, ) -> Result<ApiResponse<TransactionsByIdRangeResponse>, OperationError<GenericRejection>>

Transactions by id range.

impl Client

pub async fn transactions_since_id( &self, account_id: &AccountID, query: &TransactionsSinceIdQuery, ) -> Result<ApiResponse<TransactionsSinceIdResponse>, OperationError<GenericRejection>>

Transactions since id.

Trait Implementations

impl Clone for Client

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 Client

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

Formats the value using the given formatter.