ib 1.0.0

A Rust client to the Interactive Brokers HTTP REST API
Documentation

Rust API client for swagger

Production version of the Client Portal Web API

Overview

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

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.languages.RustClientCodegen

Installation

Put the package under your project folder and add the following in import:

    "./swagger"

Documentation for API Endpoints

All URIs are relative to https://localhost:5000/v1/portal

Class Method HTTP request Description
AccountApi iserver_account_post Post /iserver/account Updates currently selected account to the provided account
AccountApi iserver_accounts_get Get /iserver/accounts Brokerage Accounts
AccountApi portfolio_account_id_ledger_get Get /portfolio/{accountId}/ledger Account Ledger
AccountApi portfolio_account_id_meta_get Get /portfolio/{accountId}/meta Account Information
AccountApi portfolio_account_id_summary_get Get /portfolio/{accountId}/summary Account Summary
AccountApi portfolio_accounts_get Get /portfolio/accounts Portfolio Accounts
AccountApi portfolio_subaccounts_get Get /portfolio/subaccounts List of Sub-Accounts
ContractApi iserver_contract_conid_info_get Get /iserver/contract/{conid}/info Contract Info
ContractApi iserver_secdef_search_post Post /iserver/secdef/search Search by symbol or name
ContractApi trsrv_futures_get Get /trsrv/futures Security Futures by Symbol
ContractApi trsrv_secdef_post Post /trsrv/secdef Secdef by Conid
FYIApi fyi_deliveryoptions_device_id_delete Delete /fyi/deliveryoptions/{deviceId} delete a device
FYIApi fyi_deliveryoptions_device_post Post /fyi/deliveryoptions/device enable/disable device option
FYIApi fyi_deliveryoptions_email_put Put /fyi/deliveryoptions/email enable/disable email option
FYIApi fyi_deliveryoptions_get Get /fyi/deliveryoptions Get delivery options
FYIApi fyi_disclaimer_typecode_get Get /fyi/disclaimer/{typecode} get disclaimer for a certain kind of fyi
FYIApi fyi_disclaimer_typecode_put Put /fyi/disclaimer/{typecode} mark disclaimer read
FYIApi fyi_notifications_get Get /fyi/notifications Get a list of notifications
FYIApi fyi_notifications_more_get Get /fyi/notifications/more Get more notifications based on a certain one
FYIApi fyi_notifications_notification_id_put Put /fyi/notifications/{notificationId} Get a list of notifications
FYIApi fyi_settings_get Get /fyi/settings Get a list of subscriptions
FYIApi fyi_settings_typecode_post Post /fyi/settings/{typecode} enable/disable certain subscription
FYIApi fyi_unreadnumber_get Get /fyi/unreadnumber Get unread number of fyis
MarketDataApi iserver_marketdata_history_get Get /iserver/marketdata/history Market Data History
MarketDataApi iserver_marketdata_snapshot_get Get /iserver/marketdata/snapshot Market Data
OrderApi iserver_account_account_id_order_orig_customer_order_id_delete Delete /iserver/account/{accountId}/order/{origCustomerOrderId} Delete Order
OrderApi iserver_account_account_id_order_orig_customer_order_id_post Post /iserver/account/{accountId}/order/{origCustomerOrderId} Modify Order
OrderApi iserver_account_account_id_order_post Post /iserver/account/{accountId}/order Place Order
OrderApi iserver_account_account_id_order_whatif_post Post /iserver/account/{accountId}/order/whatif Preview Order
OrderApi iserver_account_orders_get Get /iserver/account/orders Live Orders
OrderApi iserver_reply_replyid_post Post /iserver/reply/{replyid} Place Order Reply
PnlApi iserver_account_pnl_partitioned_get Get /iserver/account/pnl/partitioned PNL information for the selected account
PortfolioApi portfolio_account_id_allocation_get Get /portfolio/{accountId}/allocation Account Allocation
PortfolioApi portfolio_account_id_ledger_get Get /portfolio/{accountId}/ledger Account Ledger
PortfolioApi portfolio_account_id_meta_get Get /portfolio/{accountId}/meta Account Information
PortfolioApi portfolio_account_id_position_conid_get Get /portfolio/{accountId}/position/{conid} Position by Conid
PortfolioApi portfolio_account_id_positions_page_id_get Get /portfolio/{accountId}/positions/{pageId} Portfolio Positions
PortfolioApi portfolio_account_id_summary_get Get /portfolio/{accountId}/summary Account Summary
PortfolioApi portfolio_accounts_get Get /portfolio/accounts Portfolio Accounts
PortfolioApi portfolio_allocation_post Post /portfolio/allocation Account Alloction (All Accounts)
PortfolioApi portfolio_positions_conid_get Get /portfolio/positions/{conid} Positions by Conid
PortfolioApi portfolio_subaccounts_get Get /portfolio/subaccounts List of Sub-Accounts
PortfolioAnalystApi pa_performance_post Post /pa/performance Account Performance
PortfolioAnalystApi pa_summary_post Post /pa/summary Account Balance's Summary
ScannerApi iserver_scanner_params_get Get /iserver/scanner/params get lists of available scanners
ScannerApi iserver_scanner_run_post Post /iserver/scanner/run run scanner to get a list of contracts
TradesApi iserver_account_trades_get Get /iserver/account/trades List of Trades for the selected account

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author