Struct FinamApi 

pub struct FinamApi { /* private fields */ }

One channel plus a shared token manager. Hands out service clients that attach the JWT to each call.

Cheap to clone (the channel is reference counted). Each accessor builds a new client over the same channel, so there is no need to keep clients around.

A streaming call keeps the JWT it was opened with. Open it again after the token is renewed (the connectors do this for their own streams).

See the module docs for a complete example.

Implementations

impl FinamApi

pub fn connect( ep: &ApiEndpoint, tokens: Arc<TokenManager>, bearer: bool, ) -> Result<Self, FinamError>

Opens a lazy channel to ep and uses tokens for authorization.

bearer selects the header format. false sends the bare JWT, which is what the official SDKs do. true sends Bearer <jwt>, which some examples in the broker documentation show. Which of the two the live broker accepts is not verified against the live API here.

Errors

FinamError::Config when the endpoint URL is invalid (see connect_lazy).

Examples

use brokapi_finam_protocol::{ApiEndpoint, FinamApi, FinamError, start_token_manager};

let api = FinamApi::connect(&endpoint, tokens.clone(), false)?;
assert!(std::sync::Arc::ptr_eq(api.tokens(), &tokens));

let bad = FinamApi::connect(&ApiEndpoint::new("not a url"), tokens, false);
assert!(matches!(bad, Err(FinamError::Config(_))));

pub fn from_channel( channel: Channel, tokens: Arc<TokenManager>, bearer: bool, ) -> Self

Wraps a channel you built yourself (for example with custom TLS or a proxy).

Nothing is checked. bearer has the same meaning as in FinamApi::connect.

pub fn tokens(&self) -> &Arc<TokenManager>

The token manager used by this client.

Use it to read the account list (TokenManager::account_ids) or to ask for a renewal.

pub fn grpc(&self) -> Grpc<Authorized>

A generic gRPC client over the same channel and token, for a call that is not made through a generated client: the method is named by a path (/package.Service/Method) and the messages are whatever codec you give it. With FILE_DESCRIPTOR_SET it calls any method of the API by name.

pub fn orders(&self) -> OrdersServiceClient<Authorized>

OrdersService: place, cancel and read orders, order and trade streams.

pub fn accounts(&self) -> AccountsServiceClient<Authorized>

AccountsService: account state, own trades, account stream.

pub fn market_data(&self) -> MarketDataServiceClient<Authorized>

MarketDataService: quotes, order books, trades, bars and their streams.

pub fn assets(&self) -> AssetsServiceClient<Authorized>

AssetsService: instrument directory, schedules, exchange clock.

pub fn usage_metrics(&self) -> UsageMetricsServiceClient<Authorized>

UsageMetricsService: how much of the request quota is left.

pub fn auth(&self) -> AuthServiceClient<Authorized>

AuthService with the current JWT attached. Auth and SubscribeJwtRenewal are driven by the TokenManager; TokenDetails is reachable here.

pub fn reports(&self) -> ReportsServiceClient<Authorized>

ReportsService: account reports.

pub fn corporate_actions(&self) -> CorporateActionsServiceClient<Authorized>

CorporateActionsService: splits, dividends and bond events.

Trait Implementations

impl Clone for FinamApi

fn clone(&self) -> FinamApi

Returns a duplicate of the value.

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

Performs copy-assignment from source.