Skip to content

goraxe/ib-web-rust

BranchesTags

Repository files navigation

Rust API client for ib_web_rust

The IB REST API reference documentation

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

  • API version: 2.9.0
  • Package version: 1.0.0
  • Generator version: 7.7.0
  • Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

Put the package under your project folder in a directory named ib_web_rust and add the following to Cargo.toml under [dependencies]:

ib_web_rust = { path = "./ib_web_rust" }

Documentation for API Endpoints

All URIs are relative to https://api.ibkr.com

Class Method HTTP request Description
AccountManagementAccountsApi gw_api_v1_accounts_account_id_details_get GET /gw/api/v1/accounts/{accountId}/details Get account details data i.e. capabilities, investment experience, PII data
AccountManagementAccountsApi gw_api_v1_accounts_account_id_kyc_get GET /gw/api/v1/accounts/{accountId}/kyc Get Au10Tix Details
AccountManagementAccountsApi gw_api_v1_accounts_account_id_login_messages_get GET /gw/api/v1/accounts/{accountId}/login-messages Get login messages per account
AccountManagementAccountsApi gw_api_v1_accounts_account_id_status_get GET /gw/api/v1/accounts/{accountId}/status Get account status
AccountManagementAccountsApi gw_api_v1_accounts_account_id_tasks_get GET /gw/api/v1/accounts/{accountId}/tasks Get pending tasks
AccountManagementAccountsApi gw_api_v1_accounts_close_client_id_post POST /gw/api/v1/accounts/close/{clientId} Initiate account closure request for the provided account
AccountManagementAccountsApi gw_api_v1_accounts_get GET /gw/api/v1/accounts Get file details
AccountManagementAccountsApi gw_api_v1_accounts_patch PATCH /gw/api/v1/accounts Update existing accounts
AccountManagementAccountsApi gw_api_v1_accounts_post POST /gw/api/v1/accounts Create new accounts
AccountManagementInstructionsApi gw_api_v1_bank_instructions_client_id_post POST /gw/api/v1/bank-instructions/{clientId} Initiate a banking instruction (currently only ACH, eDDA, Delete) for the provided IB account
AccountManagementInstructionsApi gw_api_v1_bank_instructions_query_client_id_post POST /gw/api/v1/bank-instructions/query/{clientId} Bank instruction Queries
AccountManagementInstructionsApi gw_api_v1_client_instructions_client_id_client_instruction_id_get GET /gw/api/v1/client-instructions/{clientId}/{clientInstructionId} Poll status of an Internal Cash Transfer for given instruction id.
AccountManagementInstructionsApi gw_api_v1_instruction_sets_client_id_instruction_set_id_get GET /gw/api/v1/instruction-sets/{clientId}/{instructionSetId} Poll status of multiple Internal Cash Transfers for given instruction set id.
AccountManagementInstructionsApi gw_api_v1_instructions_cancel_client_id_post POST /gw/api/v1/instructions/cancel/{clientId} Initiate a cancel instruction request for provided instructionId
AccountManagementInstructionsApi gw_api_v1_instructions_instruction_id_client_id_get GET /gw/api/v1/instructions/{instructionId}/{clientId} Poll status of an Internal Cash Transfer for given instruction id.
AccountManagementInstructionsApi gw_api_v1_instructions_query_client_id_post POST /gw/api/v1/instructions/query/{clientId} Get Recent Instructions
AccountManagementStatementsApi gw_api_v1_statements_post POST /gw/api/v1/statements Generates statements in supported formats based on request parameters.
AccountManagementTransfersApi gw_api_v1_external_asset_transfers_client_id_post POST /gw/api/v1/external-asset-transfers/{clientId} External Asset transfer (FOP, DWAC , Complex Asset Transfer)
AccountManagementTransfersApi gw_api_v1_external_cash_transfers_client_id_post POST /gw/api/v1/external-cash-transfers/{clientId} External Cash transfers (Deposit and Withdraw fund)
AccountManagementTransfersApi gw_api_v1_external_cash_transfers_query_client_id_post POST /gw/api/v1/external-cash-transfers/query/{clientId} Get Withdrawable Cash Queries
AccountManagementTransfersApi gw_api_v1_internal_asset_transfers_client_id_post POST /gw/api/v1/internal-asset-transfers/{clientId} Asset transfers within IB
AccountManagementTransfersApi gw_api_v1_internal_cash_transfers_client_id_post POST /gw/api/v1/internal-cash-transfers/{clientId} Cash transfer within IB
AccountManagementUtilitiesApi gw_api_v1_enumerations_enumeration_type_get GET /gw/api/v1/enumerations/{enumerationType} Get enumerations for Trading permission, Employment detail, Affiliation detail, Financial Range information, ACATS and so on
AccountManagementUtilitiesApi gw_api_v1_fee_templates_client_id_post POST /gw/api/v1/fee-templates/{clientId} Initiate a fee template request for provided account
AccountManagementUtilitiesApi gw_api_v1_fee_templates_query_client_id_post POST /gw/api/v1/fee-templates/query/{clientId} Get fee template details
AccountManagementUtilitiesApi gw_api_v1_participating_banks_client_id_get GET /gw/api/v1/participating-banks/{clientId} Get list of participating banks
AccountManagementUtilitiesApi gw_api_v1_requests_request_id_status_get GET /gw/api/v1/requests/{requestId}/status Get status of a request
AuthorizationSsoSessionsApi gw_api_v1_sso_sessions_post POST /gw/api/v1/sso-sessions Create a new SSO session on behalf of an end-user.
AuthorizationTokenApi generate_token POST /oauth2/api/v1/token Request an OAuth 2.0 access token
TradingAccountsApi acesws_account_id_signatures_and_owners_get GET /acesws/{accountId}/signatures-and-owners Signatures and Owners
TradingAccountsApi iserver_account_account_id_summary_available_funds_get GET /iserver/account/{accountId}/summary/available_funds Summary of Available Funds
TradingAccountsApi iserver_account_account_id_summary_balances_get GET /iserver/account/{accountId}/summary/balances Summary of Account Balances
TradingAccountsApi iserver_account_account_id_summary_get GET /iserver/account/{accountId}/summary General Account Summary
TradingAccountsApi iserver_account_account_id_summary_margins_get GET /iserver/account/{accountId}/summary/margins Summary of Account Margin
TradingAccountsApi iserver_account_account_id_summary_market_value_get GET /iserver/account/{accountId}/summary/market_value Summary of Account's Market Value
TradingAccountsApi iserver_account_pnl_partitioned_get GET /iserver/account/pnl/partitioned Account Profit and Loss
TradingAccountsApi iserver_account_post POST /iserver/account Switch Account
TradingAccountsApi iserver_account_search_search_pattern_get GET /iserver/account/search/{searchPattern} Search Dynamic Account
TradingAccountsApi iserver_accounts_get GET /iserver/accounts Receive brokerage accounts for the current user.
TradingAccountsApi iserver_dynaccount_post POST /iserver/dynaccount Set Dynamic Account
TradingAlertsApi iserver_account_account_id_alert_activate_post POST /iserver/account/{accountId}/alert/activate Activate or deactivate an alert
TradingAlertsApi iserver_account_account_id_alert_alert_id_delete DELETE /iserver/account/{accountId}/alert/{alertId} Delete an alert
TradingAlertsApi iserver_account_account_id_alert_post POST /iserver/account/{accountId}/alert Create or Modify Alert
TradingAlertsApi iserver_account_account_id_alerts_get GET /iserver/account/{accountId}/alerts Get a list of available alerts
TradingAlertsApi iserver_account_alert_alert_id_get GET /iserver/account/alert/{alertId} Get details of a specific alert
TradingAlertsApi iserver_account_mta_get GET /iserver/account/mta Get MTA Alert
TradingContractsApi iserver_contract_conid_algos_get GET /iserver/contract/{conid}/algos Search Algo Params by Contract ID
TradingContractsApi iserver_contract_conid_info_and_rules_get GET /iserver/contract/{conid}/info-and-rules Contract information and rules by Contract ID
TradingContractsApi iserver_contract_conid_info_get GET /iserver/contract/{conid}/info Contract information by Contract ID
TradingContractsApi iserver_contract_rules_post POST /iserver/contract/rules Search Contract Rules
TradingContractsApi iserver_currency_pairs_get GET /iserver/currency/pairs
TradingContractsApi iserver_exchangerate_get GET /iserver/exchangerate Currency Exchange Rate
TradingContractsApi iserver_secdef_bond_filters_get GET /iserver/secdef/bond-filters Search Bond Filter Information
TradingContractsApi iserver_secdef_info_get GET /iserver/secdef/info SecDef info
TradingContractsApi iserver_secdef_search_get GET /iserver/secdef/search Returns a list of contracts based on symbol.
TradingContractsApi iserver_secdef_search_post POST /iserver/secdef/search Returns a list of contracts based on symbol.
TradingContractsApi iserver_secdef_strikes_get GET /iserver/secdef/strikes Get strikes
TradingContractsApi trsrv_all_conids_get GET /trsrv/all-conids All Conids by Exchange
TradingContractsApi trsrv_futures_get GET /trsrv/futures Future Security Definition By Symbol
TradingContractsApi trsrv_secdef_get GET /trsrv/secdef Search the security definition by Contract ID
TradingContractsApi trsrv_secdef_schedule_get GET /trsrv/secdef/schedule Trading Schedule by Symbol
TradingContractsApi trsrv_stocks_get GET /trsrv/stocks Stock Security Definition By Symbol
TradingFaAllocationManagementApi iserver_account_allocation_accounts_get GET /iserver/account/allocation/accounts Allocatable Sub-Accounts
TradingFaAllocationManagementApi iserver_account_allocation_group_delete_post POST /iserver/account/allocation/group/delete Remove Allocation Group
TradingFaAllocationManagementApi iserver_account_allocation_group_get GET /iserver/account/allocation/group List All Allocation Groups
TradingFaAllocationManagementApi iserver_account_allocation_group_post POST /iserver/account/allocation/group Add Allocation Group
TradingFaAllocationManagementApi iserver_account_allocation_group_put PUT /iserver/account/allocation/group Modify Allocation Group
TradingFaAllocationManagementApi iserver_account_allocation_group_single_post POST /iserver/account/allocation/group/single Retrieve Single Allocation Group
TradingFaAllocationManagementApi iserver_account_allocation_presets_get GET /iserver/account/allocation/presets Retrieve Allocation Presets
TradingFaAllocationManagementApi iserver_account_allocation_presets_post POST /iserver/account/allocation/presets Set the Allocation Presets
TradingFyisAndNotificationsApi fyi_deliveryoptions_device_id_delete DELETE /fyi/deliveryoptions/{deviceId} Delete a Device
TradingFyisAndNotificationsApi fyi_deliveryoptions_device_post POST /fyi/deliveryoptions/device Enable/Disable Device Option
TradingFyisAndNotificationsApi fyi_deliveryoptions_email_put PUT /fyi/deliveryoptions/email Enable/Disable Email Option
TradingFyisAndNotificationsApi fyi_deliveryoptions_get GET /fyi/deliveryoptions Get Delivery OptionsCopy Location
TradingFyisAndNotificationsApi fyi_disclaimer_typecode_get GET /fyi/disclaimer/{typecode} Get disclaimer for a certain kind of fyi
TradingFyisAndNotificationsApi fyi_disclaimer_typecode_put PUT /fyi/disclaimer/{typecode} Mark Disclaimer Read
TradingFyisAndNotificationsApi fyi_notifications_get GET /fyi/notifications Get a list of notifications
TradingFyisAndNotificationsApi fyi_notifications_notification_id_put PUT /fyi/notifications/{notificationId} Mark Notification Read
TradingFyisAndNotificationsApi fyi_settings_get GET /fyi/settings Get Notification Settings
TradingFyisAndNotificationsApi fyi_settings_typecode_post POST /fyi/settings/{typecode} Modify FYI Notifications
TradingFyisAndNotificationsApi fyi_unreadnumber_get GET /fyi/unreadnumber Unread Bulletins
TradingMarketDataApi hmds_history_get GET /hmds/history Request historical data for an instrument in the form of OHLC bars.
TradingMarketDataApi iserver_marketdata_history_get GET /iserver/marketdata/history Request historical data for an instrument in the form of OHLC bars.
TradingMarketDataApi iserver_marketdata_snapshot_get GET /iserver/marketdata/snapshot Live Market Data Snapshot
TradingMarketDataApi iserver_marketdata_unsubscribe_post POST /iserver/marketdata/unsubscribe Instruct IServer to close its backend stream for the instrument.
TradingMarketDataApi iserver_marketdata_unsubscribeall_get GET /iserver/marketdata/unsubscribeall Instruct IServer to close all of its open backend data streams for all instruments.
TradingMarketDataApi md_regsnapshot_get GET /md/regsnapshot Request a regulatory snapshot for an instrument.
TradingOAuth10aApi oauth_access_token_post POST /oauth/access_token Request an access token for the IB username that has granted authorization to the consumer.
TradingOAuth10aApi oauth_live_session_token_post POST /oauth/live_session_token Generate a Live Session Token shared secret and gain access to Web API.
TradingOAuth10aApi oauth_request_token_post POST /oauth/request_token Request a temporary token as a third party to begin the OAuth 1.0a authorization workflow.
TradingOrdersApi iserver_account_account_id_order_order_id_delete DELETE /iserver/account/{accountId}/order/{orderId} Cancel an existing, unfilled order.
TradingOrdersApi iserver_account_account_id_order_order_id_post POST /iserver/account/{accountId}/order/{orderId} Modify an existing, unfilled order.
TradingOrdersApi iserver_account_account_id_orders_post POST /iserver/account/{accountId}/orders Submit a new order(s) ticket, bracket, or OCA group.
TradingOrdersApi iserver_account_account_id_orders_whatif_post POST /iserver/account/{accountId}/orders/whatif Preview the projected effects of an order ticket or bracket of orders, including cost and changes to margin and account equity.
TradingOrdersApi iserver_account_order_status_order_id_get GET /iserver/account/order/status/{orderId} Retrieve the status of a single order.
TradingOrdersApi iserver_account_orders_get GET /iserver/account/orders Retrieves open orders and filled or cancelled orders submitted during the current brokerage session.
TradingOrdersApi iserver_account_trades_get GET /iserver/account/trades Retrieve a list of trades.
TradingOrdersApi iserver_notification_post POST /iserver/notification Respond to a server prompt.
TradingOrdersApi iserver_questions_suppress_post POST /iserver/questions/suppress Suppress the specified order reply messages.
TradingOrdersApi iserver_questions_suppress_reset_post POST /iserver/questions/suppress/reset Removes suppression of all order reply messages.
TradingOrdersApi iserver_reply_reply_id_post POST /iserver/reply/{replyId} Confirm an order reply message.
TradingPortfolioApi portfolio_account_id_allocation_get GET /portfolio/{accountId}/allocation Get an account's allocations by asset class, sector group, and sector.
TradingPortfolioApi portfolio_account_id_ledger_get GET /portfolio/{accountId}/ledger Get ledger data for the given account.
TradingPortfolioApi portfolio_account_id_meta_get GET /portfolio/{accountId}/meta Get an account's attributes.
TradingPortfolioApi portfolio_account_id_position_conid_get GET /portfolio/{accountId}/position/{conid} Get position for a given instrument in a single account.
TradingPortfolioApi portfolio_account_id_positions_invalidate_post POST /portfolio/{accountId}/positions/invalidate Instructs IB to discard cached portfolio positions for a given account.
TradingPortfolioApi portfolio_account_id_positions_page_id_get GET /portfolio/{accountId}/positions/{pageId} Get all positions in an account.
TradingPortfolioApi portfolio_account_id_summary_get GET /portfolio/{accountId}/summary Portfolio account summary
TradingPortfolioApi portfolio_accounts_get GET /portfolio/accounts accounts
TradingPortfolioApi portfolio_positions_conid_get GET /portfolio/positions/{conid} Get positions in accounts for a given instrument
TradingPortfolioApi portfolio_subaccounts_get GET /portfolio/subaccounts Get attributes of subaccounts in account structure
TradingPortfolioAnalystApi pa_allperiods_param0_post POST /pa/allperiods/{param0} Account Performance (All Time Periods)
TradingPortfolioAnalystApi pa_performance_post POST /pa/performance Account Performance
TradingPortfolioAnalystApi pa_transactions_post POST /pa/transactions Transaction History
TradingScannerApi hmds_scanner_params_get GET /hmds/scanner/params HMDS Scanner Parameters
TradingScannerApi hmds_scanner_run_post POST /hmds/scanner/run HMDS Market Scanner
TradingScannerApi iserver_scanner_params_get GET /iserver/scanner/params Iserver Scanner Parameters
TradingScannerApi iserver_scanner_run_post POST /iserver/scanner/run Iserver Market Scanner
TradingSessionApi iserver_auth_ssodh_init_post POST /iserver/auth/ssodh/init Initialize Brokerage Session.
TradingSessionApi iserver_auth_status_post POST /iserver/auth/status Brokerage Session Auth Status
TradingSessionApi iserver_reauthenticate_get GET /iserver/reauthenticate Re-authenticate the Brokerage Session
TradingSessionApi logout_post POST /logout Logout of the current session.
TradingSessionApi sso_validate_get GET /sso/validate Validate SSO
TradingSessionApi tickle_post POST /tickle Server ping.
TradingWatchlistsApi iserver_watchlist_delete DELETE /iserver/watchlist Delete a specified watchlist from the username's settings.
TradingWatchlistsApi iserver_watchlist_get GET /iserver/watchlist Retrieve details of a single watchlist stored in the username's settings.
TradingWatchlistsApi iserver_watchlist_post POST /iserver/watchlist Create a watchlist to monitor a set of instruments.
TradingWatchlistsApi iserver_watchlists_get GET /iserver/watchlists Retrieve all saved watchlists stored on IB backend for the username in use in the current Web API session.
TradingWebsocketApi ws_get GET /ws Open websocket.

Documentation For Models

To get access to the crate's generated documentation, use:

cargo doc --open

Author

[email protected]

About

IB WebAPI generated from OpenAPI spec

Resources

Readme
Activity

Stars

1 star

Watchers

1 watching

Forks

1 fork
Report repository

Releases

No releases published

Packages

No packages published

Languages