Struct IbkrFlexClient 

pub struct IbkrFlexClient { /* private fields */ }

Client for fetching corporate-action records from the IBKR Flex Web Service.

Debug omits both the token (a credential) and the reqwest::Client, so neither can leak.

Implementations

impl IbkrFlexClient

pub fn new(config: IbkrFlexConfig) -> Result<Self, IbkrFlexError>

Create a client from a IbkrFlexConfig.

Errors

Returns IbkrFlexError::Http if the underlying HTTP client cannot be built.

pub fn with_poll_policy(self, policy: FlexPollPolicy) -> Self

Override the GetStatement FlexPollPolicy (poll timing / budget).

Builder-style; defaults to FlexPollPolicy::default. Widen the budget for a large statement (which takes longer to generate):

let _client = IbkrFlexClient::from_env()?.with_poll_policy(FlexPollPolicy {
    initial_delay: Duration::from_secs(10),
    interval: Duration::from_secs(10),
    max_attempts: 30,
});

pub fn from_env() -> Result<Self, IbkrFlexError>

Create a client from environment variables (see IbkrFlexConfig::from_env).

Errors

Returns IbkrFlexError::EnvVar if a required variable is missing, or IbkrFlexError::Http if the HTTP client cannot be built.

pub async fn fetch_statement_xml(&self) -> Result<String, IbkrFlexError>

Run the full 2-call Flex flow and return the raw <FlexQueryResponse> statement XML.

Issues SendRequest, then polls GetStatement until the statement is ready, governed by this client’s FlexPollPolicy (an initial_delay before the first poll, interval between subsequent polls, and a max_attempts budget). Defaults to FlexPollPolicy::default; override with with_poll_policy.

Security

The Flex token is transmitted as the t= URL query parameter (as IBKR’s protocol requires), so it is part of every request URL. Do not attach request-logging middleware to the underlying reqwest::Client that records full URLs, or the token will be captured in plaintext. The poll URL returned by SendRequest is required to be https:// for the same reason — the token must never traverse an unencrypted connection.

For the same reason, IbkrFlexError::Http must never embed the request URL: a reqwest::Error’s Display includes the URL it was building, which would carry t=<TOKEN> into any log that formats the error. The From<reqwest::Error> conversion for IbkrFlexError strips the URL via reqwest::Error::without_url before the error is stored, so a plain ? is safe here and in any request path added later.

Two IBKR hosts are involved: ndcdyn.interactivebrokers.com (the hard-coded FLEX_BASE_URL that serves SendRequest) and gdcdyn.interactivebrokers.com (the statement-download host that SendRequest returns in its poll URL). The poll host is deliberately not pinned to an allowlist — only its scheme is enforced (https://) — so IBKR can relocate statement serving without breaking this client, while the https:// gate keeps the token encrypted regardless of which host is returned.

Errors

• IbkrFlexError::Http on a transport failure.
• IbkrFlexError::Flex if the service reports a terminal non-success status.
• IbkrFlexError::HttpStatus if a non-success HTTP status carries a body that is not a recognizable Flex envelope (e.g. a proxy/CDN error page).
• IbkrFlexError::PollTimeout if the statement is still generating after the poll budget.
• IbkrFlexError::Parse if a response cannot be parsed.

pub async fn fetch_corporate_actions( &self, ) -> Result<Vec<IbkrFlexCorporateAction>, IbkrFlexError>

Fetch the statement and parse its Corporate Actions section into faithful records.

Convenience over fetch_statement_xml + parse_corporate_actions. Returns all reorg rows; filtering to splits is the caller’s job. See IbkrFlexCorporateAction for the record contract and limitations.

Errors

Same as fetch_statement_xml.

Trait Implementations

impl Clone for IbkrFlexClient

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 IbkrFlexClient

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

Formats the value using the given formatter.