Lib.rs

› Web programming
#inline

ib

A Rust client to the Interactive Brokers HTTP REST API

by Dylan McKay

3 stable releases

Uses old Rust 2015

3.0.0 Dec 1, 2021
2.0.0 Feb 13, 2021
1.0.0 Jan 28, 2019

MIT license

1MB
24K SLoC

Rust API client for swagger

Client Poral 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/api

Class Method HTTP request Description
AccountApi iserver_account_pnl_partitioned_get Get /iserver/account/pnl/partitioned PnL for the selected account
AccountApi iserver_account_post Post /iserver/account Switch 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
AlertApi iserver_account_account_id_alert_post Post /iserver/account/{accountId}/alert Create or modify alert
AlertApi iserver_account_alertid_get Get /iserver/account/alert/:id Get details of an alert
AlertApi iserver_account_mta_get Get /iserver/account/mta Get MTA alert
AlertApi iserver_accountaccount_id_alert_activate_post Post /iserver/account/:accountId/alert/activate Activate or deactivate an alert
AlertApi iserver_accountaccount_id_alertalert_id_delete Delete /iserver/account/:accountId/alert/:alertId Delete an alert
AlertApi iserver_accountaccount_id_alerts_get Get /iserver/account/:accountId/alerts Get a list of available alerts
CCPBetaApi ccp_account_get Get /ccp/account Brokerage Accounts
CCPBetaApi ccp_auth_init_post Post /ccp/auth/init Start CCP Session
CCPBetaApi ccp_auth_response_post Post /ccp/auth/response Complete CCP Session
CCPBetaApi ccp_order_delete Delete /ccp/order Delete Order
CCPBetaApi ccp_order_post Post /ccp/order Submit Order
CCPBetaApi ccp_order_put Put /ccp/order Update Order
CCPBetaApi ccp_orders_get Get /ccp/orders Order Status
CCPBetaApi ccp_positions_get Get /ccp/positions Positions
CCPBetaApi ccp_status_get Get /ccp/status CCP Status
CCPBetaApi ccp_trades_get Get /ccp/trades Trades
ContractApi iserver_contract_conid_algos_get Get /iserver/contract/{conid}/algos IB Algo Params
ContractApi iserver_contract_conid_info_and_rules_get Get /iserver/contract/{conid}/info-and-rules Info and Rules
ContractApi iserver_contract_conid_info_get Get /iserver/contract/{conid}/info Contract Details
ContractApi iserver_secdef_info_get Get /iserver/secdef/info Secdef Info
ContractApi iserver_secdef_search_post Post /iserver/secdef/search Search by Symbol or Name
ContractApi iserver_secdef_strikes_get Get /iserver/secdef/strikes Search Strikes
ContractApi trsrv_futures_get Get /trsrv/futures Security Futures by Symbol
ContractApi trsrv_secdef_post Post /trsrv/secdef Secdef by Conid
ContractApi trsrv_secdef_schedule_get Get /trsrv/secdef/schedule Get trading schedule for symbol
ContractApi trsrv_stocks_get Get /trsrv/stocks Security Stocks by Symbol
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. The HTTP method POST is also supported.
IBCustApi ibcust_entity_info_get Get /ibcust/entity/info IBCust Entity Info
MarketDataApi iserver_marketdata_conid_unsubscribe_get Get /iserver/marketdata/{conid}/unsubscribe Market Data Cancel (Single)
MarketDataApi iserver_marketdata_history_get Get /iserver/marketdata/history Market Data History
MarketDataApi iserver_marketdata_snapshot_get Get /iserver/marketdata/snapshot Market Data
MarketDataApi iserver_marketdata_unsubscribeall_get Get /iserver/marketdata/unsubscribeall Market Data Cancel (All)
OrderApi iserver_account_account_id_order_order_id_delete Delete /iserver/account/{accountId}/order/{orderId} Cancel Order
OrderApi iserver_account_account_id_order_order_id_post Post /iserver/account/{accountId}/order/{orderId} Modify Order
OrderApi iserver_account_account_id_order_post Post /iserver/account/{accountId}/order Place Order (Deprecated)
OrderApi iserver_account_account_id_order_whatif_post Post /iserver/account/{accountId}/order/whatif Preview Order (Deprecated)
OrderApi iserver_account_account_id_orders_post Post /iserver/account/{accountId}/orders Place Orders
OrderApi iserver_account_account_id_orders_whatif_post Post /iserver/account/{accountId}/orders/whatif Preview Orders
OrderApi iserver_account_order_status_order_id_get Get /iserver/account/order/status/{orderId} Order Status
OrderApi iserver_account_orders_fa_group_post Post /iserver/account/orders/{faGroup} Place Orders for FA
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 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_invalidate_post Post /portfolio/{accountId}/positions/invalidate Invalidates the backend cache of the Portfolio
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
PortfolioAnalystApi pa_transactions_post Post /pa/transactions Position's Transaction History
ScannerApi iserver_scanner_params_get Get /iserver/scanner/params Scanner Parameters
ScannerApi iserver_scanner_run_post Post /iserver/scanner/run run scanner to get a list of contracts
SessionApi iserver_auth_status_post Post /iserver/auth/status Authentication Status
SessionApi iserver_reauthenticate_post Post /iserver/reauthenticate Tries to re-authenticate to Brokerage
SessionApi logout_post Post /logout Ends the current session
SessionApi sso_validate_get Get /sso/validate Validate SSO
SessionApi tickle_post Post /tickle Ping the server to keep the session open
StreamingApi ws_post Post /ws Websocket Endpoint
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

Dependencies

~12MB
~253K SLoC