Expand description
AUTO-GENERATED CODE - DO NOT EDIT!
IB REST API
Source: crates/bezant-spec/ibkr-openapi-3.1.json
Version: 2.29.0
Generated by oas3-gen v0.25.3
The IB REST API reference documentation
Structs§
- Access
Token200 Response - Account
Attributes - Account
Attributes Parent - Describes account relations in partitioned or multiplexed (segemented) account structures.
- Account
Data - Account
Details Response - Account
Status Bulk Response - Account
Status Request - Account
Status Response - Account
Summary Response - Successful return contianing an array of at-a-glance account details.
- Account
Summary Response Cash Balance - Acct
IdRequest Body - Acct
IdRequest Body2 - Acct
IdRequest Body3 - AchInstruction
- AchInstruction
Client Account Info - AckServer
Prompt Request - Respond to a server prompt received via ntf websocket message.
- Activate
Alert Request - Activate or Deactivate existing alerts created for this account. This does not delete alerts, but disables notifications until reactivated.
- Activate
Alert Request Path - Advanced
Order Reject - Relates a message generated in response to the rejection of the submitted order ticket. In some cases, it may also present a mechanism to resubmit the same order following a prompted decision.
- Alert
- An array containing all alerts as separate objects.
- Alert
Activation Request - Alert
Activation Response - Alert
Condition - Alert
Creation Request - Alert
Creation Request Condition - Alert
Creation Response - Alert
Deletion Response - Alert
Details - details of the specified alert
- Algo
Param - Algos
Response - available algos
- Algos
Response Algo - Allocation
Group - Allocation
Group Account - Allocation
Groups - Allocation
Groups Datum - AmRequest
Status Response - Answer
Response - Apply
CsvRequest - Applies verified CSV changes. Requires both Bearer token (header) and signed JWT (body). CSV must be verified via /csv/v2/verify first. JWT validity: 1 minute.
Scope:restrictions.write
Security Policy:Signed JWT - Apply
CsvRequest Header - Associated
Entity - Associated
Person - Asynchronous
Instruction Response - Asynchronous
Instruction SetResponse - Asynchronous
Instruction SetResponse Instruction Result - Au10
TixDetail Response - Available
Funds Response - Contains a combined overview of Commidity, Security and Crypto fund values.
- Available
Funds Response Securities - Contains an overview of Security specific fund values.
- Available
Funds Response Total - total values
- Available
Statement Dates Data - Available
Statement Dates Data Value - Available
Statement Dates Data Value Daily - Available
TaxForms Data - Available
TaxForms Data Value - BNResponse
- Bank
Instructions Bulk Request Body - Bond
Filters Response - Bond
Filters Response Filter - Bond
Filters Response Filter Option - Brokerage
Session Init Request - Brokerage
Session Status - Brokerage
Session Status Server Info - Bulk
Multi Status Response - CSVResponse
- Cancel
Bulk Request Body - Cancel
Instruction - Cancel
Open Order Request - Cancel an existing, unfilled order.
- Cancel
Open Order Request Path - Cancel
Open Order Request Query - Cancel
Request Body - Category
Tree Response - Category
Tree Response Categories - A JSON object containing all category IDs and their relevant information.
- Category
Tree Response Categories Category Id - Category identifier.
- Close
AllMd Streams Request - Instruct IServer to close all of its open backend data streams for all instruments.
- Close
MdStream Request - Instruct IServer to close its backend stream for the instrument when real-time snapshots are no longer needed.
- Combo
Position Response Combo Position Response - Combo
Position Response Combo Position Response Leg - Complex
Asset Transfer Instruction - Confirm
Order Reply Request - Confirm an order reply message and continue with submission of order ticket.
- Confirm
Order Reply Request Path - Confirmed
Request Body - Conid
Request Body - Contra
Broker Info - Contract
Info - Contract
Rules - detailed contract information
- Contract
Rules Increment Rule - Contract
Rules Order Defaults - Indicates default order type for the given security type.
- Contract
Rules Order Defaults Lmt - Contract
Rules TifDefaults - Object containing details about your TIF value defaults. These defaults can be viewed and modified in TWS’s within the Global Configuration.
- Create
Alert Request - Endpoint used to create a new alert, or modify an existing alert.
- Create
Alert Request Path - Create
Allocation Group Request - Add a new allocation group. This group can be used to trade in place of the {accountId} for the /iserver/account/{accountId}/orders endpoint.
- Create
Browser Session Response - Create
Session Response - Currency
Pairs - Delete
Alert Request - Permanently delete an existing alert. Deleting an MTA alert will reset it to the default state.
- Delete
Alert Request Path - Delete
Allocation Group Request - Deletes a previously created allocation group. This endpoint is only supported for Financial Advisors and IBroker Accounts.
- Delete
Bank Instruction - Delete
FyiDevice Request - Delete a specific device from our saved list of notification devices.
- Delete
FyiDevice Request Path - Delete
Watchlist Request - Delete a specified watchlist from the username’s settings.
- Delete
Watchlist Request Query - Delivery
Options - Delivery
OptionsE - Deposit
Funds Instruction - Deposit
Funds Instruction IraDeposit Detail - Deposit
Funds Instruction Open Banking - Deposit
Funds Instruction Open Banking Plaid Options - Deposit
Funds Polling Response - Deposit
Funds Polling Result - Deposit
Funds Polling Result Deposit Details - Deposit
Funds Polling Result Deposit Details Open Banking - Detail200
Response - Detail200
Response Account Info List - Detail
Request Body - Detailed
Contract Information - Disclaimer
Info - Dwac
Instruction - DynAccount
Search Response - DynAccount
Search Response Matched Account - Echo
Response - Edda
Instruction - Enabled
Request Body - EntityIRA
Bene - Enumeration
Response - Error
Response - External
Asset Transfers Bulk Request Body - External
Cash Transfers Bulk Request Body - External
Position Transfer - Failed
Tickle Response - Features
- Features
Symbol - File
Data - File
Details Response - FopInstruction
- Forecast
Details Response - Forecast
Market Response - Forecast
Market Response Contract - Forecast
Rules Response - Forecast
Schedules Response - Forecast
Schedules Response Trading Schedule - Forecast
Schedules Response Trading Schedule Trading Time - Form
Details - Form
File Response - Form
Payload - Funds
- Contains commodities specific fund values.
- FyiEnable
Device Option - FyiSettings
FyiSetting - FyiVT
- Generate
Token Request - Generate OAuth 2.0 access tokens based on request parameters.
- GetAccount
Market Summary Request - Returns a summary of an account’s market value, by currency and asset class.
- GetAccount
Market Summary Request Path - GetAccount
Owners Request - Receive a list of all applicant names on the account and for which account and entity is represented.
- GetAccount
Owners Request Path - GetAccount
Summary Request - Provides a general overview of the account details such as balance values.
- GetAccount
Summary Request Path - GetAccounts
InModel Request - Request all accounts held within a model.
- GetAlert
Details Request - Request details of a specific alert by providing the assigned alertId Id.
- GetAlert
Details Request Path - GetAlert
Details Request Query - GetAlgos
ByInstrument Request - Returns supported IB Algos for an instrument. A pre-flight request must be submitted before retrieving information.
- GetAlgos
ByInstrument Request Path - GetAlgos
ByInstrument Request Query - GetAll
Accounts ForConid Request - Get positions in accounts for a given instrument (no secDef await control)
- GetAll
Accounts ForConid Request Path - GetAll
Accounts Request - return accounts
- GetAll
Alerts Request - Retrieve a list of all alerts attached to the provided account.
- GetAll
Alerts Request Path - GetAll
Fyis Request - Get a list of available notifications.
- GetAll
Fyis Request Query - GetAll
Model Positions Request - Request all positions held within the model.
- GetAll
Subaccounts Request - Retrieve attributes of the subaccounts in the account structure.
- GetAll
Watchlists Request - Returns all saved watchlists stored on IB backend for the username in use in the current Web API session.
- GetAll
Watchlists Request Query - GetAllmodels
Request - Retrieve summaries for all models under the advisor account.
- GetAllocatable
Subaccounts Request - Retrieves a list of all sub-accounts and returns their net liquidity and available equity for advisors to make decisions on what accounts should be allocated and how. This endpoint is only supported for Financial Advisors and IBroker Accounts.
- GetAllocation
Groups Request - Retrieves a list of all of the advisor’s allocation groups. This describes the name of the allocation group, number of subaccounts within the group, and the method in use for the group. This endpoint is only supported for Financial Advisors and IBroker Accounts.
- GetAllocation
Presets Request - Retrieve the preset behavior for allocation groups for specific events. This endpoint is only supported for Financial Advisors and IBroker Accounts.
- GetAsset
Allocation Request - Get an account’s allocations by asset class, sector group, and sector.
- GetAsset
Allocation Request Path - GetAsset
Allocation Request Query - GetAvailable
Stmt Dates Response - GetAvailable
TaxForms Response - GetAvailable
Trade Confirmation Dates Response - GetAvailable
Trade Confirmation Dates Response Data - GetBalance
Summary Request - Returns a summary of an account’s equity and cash balances, in total and by account segment.
- GetBalance
Summary Request Path - GetBond
Filters Request - Request a list of filters relating to a given Bond issuerID. The issuerId is retrieved from /iserver/secdef/search and can be used in /iserver/secdef/info?issuerId={issuerId} for retrieving conIds.
- GetBond
Filters Request Query - GetBroker
List Response - GetBrokerage
Accounts Request - Returns a list of accounts the user has trading access to, their respective aliases and the currently selected account. Note this endpoint must be called before modifying an order or querying open orders.
- GetBrokerage
Status Request - Current Authentication status to the Brokerage system. Market Data and Trading is not possible if not authenticated.
- GetCombo
Positions Request - Provides all positions held in the account acquired as a combination, including values such as ratios, size, and market value.
- GetCombo
Positions Request Path - GetCombo
Positions Request Query - GetConids
ByExchange Request - Send out a request to retrieve all contracts made available on a requested exchange. This returns all contracts that are tradable on the exchange, even those that are not using the exchange as their primary listing.
- GetConids
ByExchange Request Query - GetContract
Info Request - Returns the attributes of the instrument.
- GetContract
Info Request Query - GetContract
Rules Request - Returns trading related rules for a specific contract and side.
- GetContract
Strikes Request - Returns lists of valid strikes for options contracts on a given underlier, for all currently trading expirations. The /iserver/secdef/search endpoint must be called prior for the underlying. Otherwise empty arrays will return for “puts” and “calls”.
- GetContract
Strikes Request Query - GetContract
Symbols From Body Request - Returns a list of contracts based on the search symbol provided as a query param.
- GetContract
Symbols Request - Returns a list of contracts based on the search symbol provided as a query param.
- GetContract
Symbols Request Query - GetCurrency
Pairs Request - Obtains available currency pairs corresponding to the given target currency.
- GetCurrency
Pairs Request Query - GetDynamic
Accounts Request - Returns a list of accounts matching a query pattern set in the request. Broker accounts configured with the DYNACCT property will not receive account information at login. Instead, they must dynamically query then set their account number. Customers without the DYNACCT property will receive a 503 error.
- GetDynamic
Accounts Request Path - GetExchange
Rates Request - Obtains the exchange rates of the currency pair.
- GetExchange
Rates Request Query - GetForecast
Categories Request - Returns the category names, parent ids, and markets for Event Contracts.
- GetForecast
Contract Request - Provides instrument details for the specific forecast contract.
- GetForecast
Contract Request Query - GetForecast
Markets Request - Returns all high level contract details affiliated with the underlying market conid provided.
- GetForecast
Markets Request Query - GetForecast
Rules Request - Provides trading rules for specific event contracts.
- GetForecast
Rules Request Query - GetForecast
Schedule Request - Provides forecast trading schedules.
- GetForecast
Schedule Request Query - GetFund
Summary Request - Provides a summary specific for avilable funds giving more depth than the standard /summary endpoint.
- GetFund
Summary Request Path - GetFuture
BySymbol Request - Returns a list of non-expired future contracts for given symbol(s)
- GetFuture
BySymbol Request Query - GetFyi
Delivery Request - Options for sending fyis to email and other devices.
- GetFyi
Disclaimerss Request - Receive additional disclaimers based on the specified typecode.
- GetFyi
Disclaimerss Request Path - GetFyi
Settings Request - Return the current choices of subscriptions for notifications.
- GetGw
ApiV1 Accounts Accountid Details Request
Scope:accounts.read
Security Policy:HTTPS- GetGw
ApiV1 Accounts Accountid Details Request Path - GetGw
ApiV1 Accounts Accountid KycRequest - Generate URL address to complete real-time KYC verification using Au10Tix
Scope:accounts.read
Security Policy:HTTPS - GetGw
ApiV1 Accounts Accountid KycRequest Path - GetGw
ApiV1 Accounts Accountid Login Messages Request - Query login messages assigned by accountId
Scope:accounts.read
Security Policy:HTTPS - GetGw
ApiV1 Accounts Accountid Login Messages Request Path - GetGw
ApiV1 Accounts Accountid Login Messages Request Query - GetGw
ApiV1 Accounts Accountid Status Request - Query status of account by accountId
Scope:accounts.read
Security Policy:HTTPS - GetGw
ApiV1 Accounts Accountid Status Request Path - GetGw
ApiV1 Accounts Accountid Tasks Request - Query registration tasks assigned to account and pending tasks that are required for account approval
Scope:accounts.read
Security Policy:HTTPS - GetGw
ApiV1 Accounts Accountid Tasks Request Path - GetGw
ApiV1 Accounts Accountid Tasks Request Query - GetGw
ApiV1 Accounts Login Messages Request - Query all accounts associated with ‘Client ID’ that have incomplete login message
Scope:accounts.read
Security Policy:HTTPS - GetGw
ApiV1 Accounts Login Messages Request Query - GetGw
ApiV1 Accounts Request - Retrieve the application request and IBKR response data based on IBKR accountId or externalId. Only available for accounts that originate via API
Scope:accounts.read
Security Policy:HTTPS - GetGw
ApiV1 Accounts Request Query - GetGw
ApiV1 Accounts Status Request - Query status of all accounts associated with ‘Client ID’
Scope:accounts.read
Security Policy:HTTPS - GetGw
ApiV1 Accounts Status Request Query - GetGw
ApiV1 Client Instructions Clientinstructionid Request - Retrieve status of request by clientInstructionId.
Scope:instructions.read
Security Policy:HTTPS - GetGw
ApiV1 Client Instructions Clientinstructionid Request Path - GetGw
ApiV1 Client Instructions Clientinstructionid Request Query - GetGw
ApiV1 Echo Https Request
Scope:echo.read
Security Policy:HTTPS- GetGw
ApiV1 Enumerations Complex Asset Transfer Request - Get list of brokers supported for given asset transfer type
Scope:enumerations.read
Security Policy:HTTPS - GetGw
ApiV1 Enumerations Complex Asset Transfer Request Query - GetGw
ApiV1 Enumerations Enumerationtype Request - Used to query list of enumerations for attributes included within extPositionsTransfers, occupation, employerBusiness, financialInformation, affiliationDetails, tradingPermissions, etc.
Scope:accounts.readORenumerations.read
Security Policy:HTTPS - GetGw
ApiV1 Enumerations Enumerationtype Request Path - GetGw
ApiV1 Enumerations Enumerationtype Request Query - GetGw
ApiV1 Forms Request - Get forms
Scope:accounts.readORforms.read
Security Policy:HTTPS - GetGw
ApiV1 Forms Request Query - GetGw
ApiV1 Forms Required Forms Request - Get required forms
Scope:accounts.read
Security Policy:HTTPS - GetGw
ApiV1 Forms Required Forms Request Query - GetGw
ApiV1 Instruction Sets Instructionsetid Request - Retrieve status of all requests associated with instructionSetId.
Scope:instructions.read
Security Policy:HTTPS - GetGw
ApiV1 Instruction Sets Instructionsetid Request Path - GetGw
ApiV1 Instruction Sets Instructionsetid Request Query - GetGw
ApiV1 Instructions Instructionid Request - Retrieve status of request by instructionId
Scope:instructions.read
Security Policy:HTTPS - GetGw
ApiV1 Instructions Instructionid Request Path - GetGw
ApiV1 Instructions Instructionid Request Query - GetGw
ApiV1 Participating Banks Request - Get list of banks which support banking connection with Interactive Brokers.
Scope:enumerations.read
Security Policy:HTTPS - GetGw
ApiV1 Participating Banks Request Query - GetGw
ApiV1 Requests Request - Fetch Requests’ Details By Timeframe
Scope:accounts.read
Security Policy:HTTPS - GetGw
ApiV1 Requests Request Query - GetGw
ApiV1 Statements Available Request
Scope:statements.readORreports.read
Security Policy:HTTPS- GetGw
ApiV1 Statements Available Request Header - GetGw
ApiV1 Statements Available Request Query - GetGw
ApiV1 TaxDocuments Available Request
Scope:statements.readORreports.read
Security Policy:HTTPS- GetGw
ApiV1 TaxDocuments Available Request Header - GetGw
ApiV1 TaxDocuments Available Request Query - GetGw
ApiV1 Trade Confirmations Available Request
Scope:statements.readORreports.read
Security Policy:HTTPS- GetGw
ApiV1 Trade Confirmations Available Request Header - GetGw
ApiV1 Trade Confirmations Available Request Query - GetGw
ApiV1 Validations Usernames Username Request - Verify whether user is valid and available
Scope:accounts.readORvalidations.read
Security Policy:HTTPS - GetGw
ApiV1 Validations Usernames Username Request Path - GetInfo
AndRules Request - Requests full contract details and trading rules for the given conid. A follow-up request will provide additional trading rules.
- GetInfo
AndRules Request Path - GetInstrument
Definition Request - Returns a list of security definitions for the given conids.
- GetInstrument
Definition Request Query - GetInstrument
Info Request - Requests full contract details for the given conid.
- GetInstrument
Info Request Path - GetInvested
Accounts InModel Request - Request the list of all accounts already invested in the provided model and a summary of their investment.
- GetInvested
Accounts Summary - GetInvested
Accounts Summary Account List - GetMany
Subaccounts Request - Used in tiered account structures (such as Financial Advisor and IBroker Accounts) to return a list of sub-accounts, paginated up to 20 accounts per page, for which the user can view position and account-related information. This endpoint must be called prior to calling other /portfolio endpoints for those sub-accounts. If you have less than 100 sub-accounts use /portfolio/subaccounts. To query a list of accounts the user can trade, see /iserver/accounts.
- GetMany
Subaccounts Request Query - GetMargin
Summary Request - Returns a summary of an account’s margin, in total and by account segment.
- GetMargin
Summary Request Path - GetMd
History Request - Request historical data for an instrument in the form of OHLC bars.
- GetMd
History Request Query - GetMd
Snapshot Request - Get Market Data for the given conid(s). A pre-flight request must be made prior to ever receiving data. For some fields, it may take more than a few moments to receive information. See response fields for a list of available fields that can be request via fields argument. The endpoint /iserver/accounts must be called prior to /iserver/marketdata/snapshot. For derivative contracts the endpoint /iserver/secdef/search must be called first.
- GetMd
Snapshot Request Query - GetModel
Presets Request - Get the preset behavior for model rebalancing.
- GetModel
Summary Single Request - Request a summary for a single model.
- GetMta
Details Request - Retrieve information about your MTA alert. Each login user only has one mobile trading assistant (MTA) alert with it’s own unique tool id that cannot be changed. MTA alerts can not be created or deleted, only modified. When modified a new order Id is generated.
- GetOpen
Orders Request - Returns open orders and filled or cancelled orders submitted during the current brokerage session.
- GetOpen
Orders Request Query - GetOrder
Status Request - Retrieve the status of a single order. Only displays orders from the current brokerage session. If orders executed on a previous day or session, queries will 503 error.
- GetOrder
Status Request Path - GetPaginated
Positions Request - Get all positions in an account.
- GetPaginated
Positions Request Path - GetPaginated
Positions Request Query - GetParticipating
List Response - GetParticipating
List Response Participating Bank - GetPerformance
AllPeriods Request - Returns the performance (MTM) for the given accounts, if more than one account is passed, the result is consolidated.
- GetPerformance
AllPeriods Request Query - GetPnl
Request - Returns updated profit and loss values for the selected account. Initial request will return an empty array in the upnl object.
- GetPortfolio
Ledger Request - Get the given account’s ledger data detailing its balances by currency.
- GetPortfolio
Ledger Request Path - GetPortfolio
Metadata Request - Get a single account’s attributes and capabilities.
- GetPortfolio
Metadata Request Path - GetPortfolio
Summary Request - Returns detailed summary of account values, by segment where appropriate.
- GetPortfolio
Summary Request Path - GetPosition
ByConid Request - Get position for a given instrument in a single account.
- GetPosition
ByConid Request Path - GetScanner
Parameters Request - Returns an xml file containing all available parameters to be sent for the Iserver scanner request.
- GetScanner
Results Request - Searches for contracts according to the filters specified in /iserver/scanner/params endpoint.
- GetSession
Token Request - If the gateway has not received any requests for several minutes an open session will automatically timeout. The tickle endpoint pings the server to prevent the session from ending. It is expected to call this endpoint approximately every 60 seconds to maintain the connection to the brokerage session.
- GetSession
Validation Request - Validates the current session for the SSO user.
- GetSingle
Allocation Group Request - Retrieves the configuration of a single account group. This describes the name of the allocation group, the specific accounts contained in the group, and the allocation method in use along with any relevant quantities. This endpoint is only supported for Financial Advisors and IBroker Accounts.
- GetSingle
Performance Period Request - Returns the performance (MTM) for the given accounts, if more than one account is passed, the result is consolidated.
- GetSpecific
Watchlist Request - Retrieve details of a single watchlist stored in the username’s settings.
- GetSpecific
Watchlist Request Query - GetStatements
Response - GetStock
BySymbol Request - Returns an object contains all stock contracts for given symbol(s)
- GetStock
BySymbol Request Query - GetTrade
History Request - Retrieve a list of trades, up to a maximum of 7 days prior.
- GetTrade
History Request Query - GetTrading
Schedule GetTrsrv Secdef Schedule Request - Returns the trading schedule up to a month for the requested contract.
- GetTrading
Schedule GetTrsrv Secdef Schedule Request Query - GetTrading
Schedule Request - Returns the trading schedule for the 6 total days surrounding the current trading day. Non-Trading days, such as holidays, will not be returned.
- GetTrading
Schedule Request Query - GetTransactions
Request - Transaction history for a given number of conids and accounts. Types of transactions include dividend payments, buy and sell transactions, transfers.
- GetUncached
Positions Request - Returns a list of positions for the given account. /portfolio/accounts or /portfolio/subaccounts must be called prior to this endpoint. This endpoint provides near-real time updates and removes caching otherwise found in the /portfolio/{accountId}/positions/{pageId} endpoint.
- GetUncached
Positions Request Path - GetUncached
Positions Request Query - GetUnread
Fyis Request - Returns the total number of unread notifications
- Group
Request Body - Group
Request Body2 - Group
Request Body Account - IbRest
ApiClient - Individual
Combo Position - IndividualIRA
Bene - Individual
Position - A specific account’s position in the requested conid.
- Individual
Position Display Rule - Object defining minimum increments used in displaying market data for the instrument.
- Individual
Position Display Rule Display Rule Step - A single display rule increment.
- Individual
Position Increment Rule - Objects describing a single increment rule.
- Initialize
Session Request - After retrieving the access token and subsequent Live Session Token, customers can initialize their brokerage session with the ssodh/init endpoint.
- Instruction
Polling Response - Instruction
Request Body - Instruction
Response - Instruction
Result - Internal
Asset Transfers Bulk Request Body - Internal
Cash Transfer Instruction - Internal
Cash Transfers Bulk Request Body - Internal
Position Transfer Instruction - Invalidate
Position Cache Request - Instructs IB to discard cached portfolio positions for a given account, so that the next request for positions delivers freshly obtained data.
- Invalidate
Position Cache Request Path - Invest
Divest200 Response - Invest
Divest Request Body - Invest
Divest Request Body Account List - Iserver
History BidAsk Response - Object containing the requested historical data and related metadata.
- Iserver
History Last Response - Object containing the requested historical data and related metadata.
- Iserver
History Midpoint Response - Object containing the requested historical data and related metadata.
- Iserver
Scanner Params - Iserver
Scanner Params Filter List - Iserver
Scanner Params Filter List Combo Value - Iserver
Scanner Params Instrument List - Iserver
Scanner Params Location Tree - Iserver
Scanner Params Location Tree Location - Iserver
Scanner Params Location Tree Location Location - Iserver
Scanner Params Scan Type List - Iserver
Scanner RunRequest - Iserver
Scanner RunRequest Filter - Iserver
Scanner RunResponse - Iserver
Scanner RunResponse Contract - Ledger
- Contains objects reflecting all currencies in which the account’s positions trade.
- Live
Orders Response - Live
Orders Response Order - Object representing one order.
- Live
Session Token200 Response - Login
Message - Login
Message Request - Login
Message Response - Logout
Request - Logs the user out of the gateway session. Any further activity requires re-authentication. Discard client-side cookies upon logout.
- Message
IdRequest Body - Message
Response - Model
List Response - Model
List Response Item - Model
Position Response - Model
Position Response Cash - Model
Position Response Position List - Model
Presets Response - Model
Summary Response - Modify
Allocation Group Request - Modify an existing allocation group.
- Modify
FyiDelivery Request - Choose whether a particular device is enabled or disabled.
- Modify
FyiEmails Request - Enable or disable your account’s primary email to receive notifications.
- Modify
FyiEmails Request Query - Modify
FyiNotification Request - Enable or disable group of notifications by the specific typecode.
- Modify
FyiNotification Request Path - Modify
Open Order Request - Modify an existing, unfilled order.
- Modify
Open Order Request Path - Name
Request Body - NonDisclosed
Detail - Notification
Read Acknowledge - Notification
Read AcknowledgeP - Returns details about the notification read status.
- Notification
Request Body - Notifications
Notification - Oauth
Token Response - Order
Cancel Success - Acknowledges IB’s acceptance of the request to cancel the order. Does not report whether the cancellation can or will ultimately be enacted.
- Order
Preview - Projected costs and changes to margin and equity values in the account, if the order ticket were executed in full.
- Order
Preview Amount - Describes the projected costs associated with the order ticket.
- Order
Preview Equity - Describes the projected change to the account’s equity.
- Order
Preview Initial - Describes the projected change to initial margin.
- Order
Preview Maintenance - Describes the projected change to maintenance margin.
- Order
Preview Position - Describes the projected change to the account’s position in the instrument.
- Order
Reply Message Order Reply Message - An object containing order reply messages emitted against a single order ticket.
- Order
Reply NotFound - Indicates that the order reply ID does not exist.
- Order
Status - Object containing information about the status of an order ticket.
- Order
Submit Error - Indicates that the order reply message or submission was not accepted.
- Order
Submit Success Order Submit Success - Result of successful submission of one order ticket.
- Orders
Submission Request - Patch
GwApi V1Accounts Accountid Status Request - Query status of account by accountId
Scope:accounts.write
Security Policy:Signed JWT - Patch
GwApi V1Accounts Accountid Status Request Path - Patch
GwApi V1Accounts Accountid Tasks Request - Task status can be updated from this api
Scope:accounts.write
Security Policy:Signed JWT - Patch
GwApi V1Accounts Accountid Tasks Request Path - Patch
GwApi V1Accounts Request - Update information for an existing accountId
Scope:accounts.write
Security Policy:Signed JWT - Patch
GwApi V1Requests Requestid Status Request - This api will be used to update the status of am request
Scope:accounts.read
Security Policy:Signed JWT - Patch
GwApi V1Requests Requestid Status Request Path - Pending
Task - Pending
Tasks Response - Performance
Request Body - Performance
Response - Performance
Response Cps - Returns the object containing the Cumulative performance data.
- Performance
Response CpsDatum - Performance
Response Nav - Net asset value data for the account or consolidated accounts. NAV data is not applicable to benchmarks.
- Performance
Response NavDatum - Performance
Response NavDatum Start Nav - Returns the intiial NAV available.
- Performance
Response Tpps - Returns the time period performance data.
- PnlPartitioned
Response - PnlPartitioned
Response Upnl - Refers to the U accounts PnL. This does reference Realized Profit and Loss.
- PnlPartitioned
Response Upnl U1234567 Core - The account or model’s Profit and Loss.
- Polling
Instruction Result - Portfolio2
Positions Portfolio2position - Portfolio
Allocations - Portfolio
Allocations Asset Class - Object containing values of positions sorted by long/short and asset class.
- Portfolio
Allocations Group - Object containing values of positions sorted by long/short and Sector Group.
- Portfolio
Allocations Sector - Object containing values of positions sorted by long/short and Sector.
- Portfolio
Summary - Portfolio
Summary Value - Position200
Response - Position
Request Body - Position
Request Body2 - Post
GwApi V1Accounts Accountid Tasks Request - Task can be assigned from this api
Scope:accounts.write
Security Policy:Signed JWT - Post
GwApi V1Accounts Accountid Tasks Request Path - Post
GwApi V1Accounts Documents Request - Provides mechanism to submit Agreements and Disclosures to IBKR once a day instead of with each application. We store these documents on the servers and will use them for new application requests submitted that day.
- Documents will need to be submitted once a day (before the Applications are submitted). PDFs will be displayed and submitted as is- no changes/edits will be made to the actual PDF files.
- This end-point will not process any Tax Form Documents. Tax Form document should be submitted with every application
- If submitted in the morning, you only need to include the Tax Form attachment for each applicant. Otherwise, you will need to include PDFs with each application (Create Account).
Scope:accounts.write
Security Policy:Signed JWT - Post
GwApi V1Accounts Request - Submit account application. This will create brokerage account for the end user.
Scope:accounts.write
Security Policy:Signed JWT - Post
GwApi V1Balances Query Request - View available cash for withdrawal and account equity value by accountId
Scope:balances.read
Security Policy:Signed JWT - Post
GwApi V1Balances Query Request Query - Post
GwApi V1Bank Instructions Bulk Request
Scope:bank-instructions.write
Security Policy:Signed JWT- Post
GwApi V1Bank Instructions Bulk Request Query - Post
GwApi V1Bank Instructions Query Request - View active bank instructions for an accountId.
Scope:bank-instructions.read
Security Policy:Signed JWT - Post
GwApi V1Bank Instructions Query Request Query - Post
GwApi V1Bank Instructions Request - Create or delete bank instructions by accountId. Only ACH and EDDA are supported for ‘Create’.
Scope:bank-instructions.write
Security Policy:Signed JWT - Post
GwApi V1Bank Instructions Request Query - Post
GwApi V1Echo Signed JwtRequest
Scope:echo.write
Security Policy:Signed JWT- Post
GwApi V1External Asset Transfers Bulk Request
Scope:transfers.write
Security Policy:Signed JWT- Post
GwApi V1External Asset Transfers Bulk Request Query - Post
GwApi V1External Asset Transfers Request - Initiate request to submit external position transfer. Methods- ACATS, ATON, Basic FOP, FOP, DWAC. More information on transfer methods can be found here - https://www.interactivebrokers.com/campus/trading-lessons/cash-and-position-transfers/
Scope:transfers.write
Security Policy:Signed JWT - Post
GwApi V1External Asset Transfers Request Query - Post
GwApi V1External Cash Transfers Bulk Request
Scope:transfers.write
Security Policy:Signed JWT- Post
GwApi V1External Cash Transfers Bulk Request Query - Post
GwApi V1External Cash Transfers Query Request - View available cash for withdrawal with and without margin loan by accountId
Scope:transfers.read
Security Policy:Signed JWT - Post
GwApi V1External Cash Transfers Query Request Query - Post
GwApi V1External Cash Transfers Request - Initiate request to deposit or withdrawal between IBKR account and bank account. More information on transfer methods can be found here - https://www.interactivebrokers.com/campus/trading-lessons/cash-and-position-transfers
Scope:transfers.write
Security Policy:Signed JWT - Post
GwApi V1External Cash Transfers Request Query - Post
GwApi V1Instructions Cancel Bulk Request
Scope:instructions.write
Security Policy:Signed JWT- Post
GwApi V1Instructions Cancel Bulk Request Query - Post
GwApi V1Instructions Cancel Request - Cancel request by instructionId.
Scope:instructions.write
Security Policy:Signed JWT - Post
GwApi V1Instructions Cancel Request Query - Post
GwApi V1Instructions Query Request - Query list of recent transactions (up to 30 days) based on accountId.
Scope:instructions.read
Security Policy:Signed JWT - Post
GwApi V1Instructions Query Request Query - Post
GwApi V1Internal Asset Transfers Bulk Request
Scope:transfers.write
Security Policy:Signed JWT- Post
GwApi V1Internal Asset Transfers Bulk Request Query - Post
GwApi V1Internal Asset Transfers Request - Transfer positions internally between two accounts with Interactive Brokers
Scope:transfers.write
Security Policy:Signed JWT - Post
GwApi V1Internal Asset Transfers Request Query - Post
GwApi V1Internal Cash Transfers Bulk Request
Scope:transfers.write
Security Policy:Signed JWT- Post
GwApi V1Internal Cash Transfers Bulk Request Query - Post
GwApi V1Internal Cash Transfers Request - Transfer cash internally between two accounts with Interactive Brokers.
Scope:transfers.write
Security Policy:Signed JWT - Post
GwApi V1Internal Cash Transfers Request Query - Post
GwApi V1Sso Browser Sessions Request
Scope:sso-browser-sessions.write
Security Policy:Signed JWT- Post
GwApi V1Sso Browser Sessions Request Header - Post
GwApi V1Sso Sessions Request
Scope:sso-sessions.write
Security Policy:Signed JWT- Post
GwApi V1Sso Sessions Request Header - Post
GwApi V1Statements Request
Scope:statements.readORstatements.writeORreports.write
Security Policy:Signed JWT- Post
GwApi V1Statements Request Header - Post
GwApi V1Tax Documents Request
Scope:statements.writeORreports.write
Security Policy:Signed JWT- Post
GwApi V1Tax Documents Request Header - Post
GwApi V1Trade Confirmations Request
Scope:statements.writeORreports.write
Security Policy:Signed JWT- Post
GwApi V1Trade Confirmations Request Header - Post
NewWatchlist Request - Create a named watchlist by submitting a set of conids.
- Predefined
Destination Instruction - Predefined
Destination Instruction Financial Institution - Presets
- Preview
Margin Impact Request - Preview the projected effects of an order ticket or bracket of orders, including cost and changes to margin and account equity.
- Preview
Margin Impact Request Path - Query
Bank Instruction - Query
Bank Instruction Response - Query
Bank Instruction Result - Query
Bank Instruction Result Bank Instruction Detail - QueryIRA
Contributions - QueryIRA
Contributions Response - QueryIRA
Contributions Result - QueryIRA
Contributions Result Contribution - Query
Recent Instruction Response - Query
Recent Instruction Result - Query
Recent Instruction Result Instruction History - Query
Recent Instructions - Query
Recent Instructions Transaction History - Query
Recent Recurring Event Response - Query
Recent Recurring Event Result - Query
Recent Recurring Event Result Transaction History - Query
Recent Recurring Event Result Transaction History Result - Query
Recent Recurring Events - Query
Recurring Instructions - Query
Recurring Instructions Response - Query
Recurring Instructions Result - Query
Recurring Instructions Result Recurring Instruction - Query
Request Body - Query
Request Body2 - Query
Request Body3 - Query
Request Body4 - Query
Withdrawable Amounts Instruction Result - Query
Withdrawable Amounts Response - Query
Withdrawable Amounts Without Origin Hold Response - Query
Withdrawable Amounts Without Origin Hold Result - Query
Withdrawable Cash Equity - Query
Withdrawable Cash Equity Response - Query
Withdrawable Cash Equity Result - Query
Withdrawable Funds - Questionnaire
Response - Rate
Response - Read
FyiDisclaimer Request - Mark a specific disclaimer message as read.
- Read
FyiDisclaimer Request Path - Read
FyiNotification Request - Mark a particular notification message as read or unread.
- Read
FyiNotification Request Path - Recurring
Instruction Detail - Registration
Task - Registration
Tasks Response - ReqAccess
Token Request - Request an access token for the IB username that has granted authorization to the consumer.
- ReqAccess
Token Request Header - ReqID
Request Body - ReqLive
Session Token Request - Generate a Live Session Token shared secret and gain access to Web API.
- ReqLive
Session Token Request Header - ReqTemp
Token Request - Request a temporary token as a third party to begin the OAuth 1.0a authorization workflow.
- ReqTemp
Token Request Header - Request
Detail - Request
Details Request - Request
Details Response - Required
Forms Request - Required
Forms Response - Reset
Order Suppression Request - Removes suppression of all order reply messages that were previously suppressed in the current brokerage session.
- Response
Data - Response
File Response - Restriction
Info - Result
Error - Rule200
Response - Rule
Request Body - Save200
Response - Save200
Response2 - Save
Request Body - Save
Request Body Cash Target - Save
Request Body Position Target - Schedule
Response - Schedule
Response Schedules - Returns a series of date objects of the given contract.
- Schedule
Response Schedules Date - object containing the of hours objects detailing extended and liquid trading.
- Schedule
Response Schedules Date Extended Hour - Schedule
Response Schedules Date Liquid Hour - Search
Request Body - SecDef
Info Response - Secdef
Search Response Secdef Search Response - Secdef
Search Response Secdef Search Response Issuer - Secdef
Search Response Secdef Search Response Section - SetAccount
Response - SetAccountinvestment
InModel Request - Assign an account and the amount of cash to allocate into a model.
- SetActive
Account Request - Switch the active account for how you request data. Only available for financial advisors and multi-account structures.
- SetAllocation
Preset Request - Set the preset behavior for new allocation groups for specific events.
- SetDynamic
Account Request - Set the active dynamic account.
- SetModel
Presets Request - Set the preset behavior for models.
- SetModel
Target Positions Request - Create or Modify a model’s target positions.
- Signature
AndOwners - Signature
AndOwners Applicant - Single
Historical BarBid Ask - Object containing Bid and Ask data for a single OHLC bar.
- Single
Historical BarLast - Object containing Last or Trades data for a single OHLC bar.
- Single
Historical BarMidpoint - Object containing Midpoint data for a single OHLC bar.
- Single
Order Submission Request - A single order ticket.
- Single
Order Submission Request Json Payload - Single
Order Submission Request Json Payload Allocation Profile - The assigned contents for how the order should be allocated amongst subaccount(s).
- Single
Order Submission Request Json Payload Allocation Profile Allocation - Single
Order Submission Request Strategy Parameters - Parameters governing the selected algorithm, if applicable.
- Single
Watchlist - Object detailing a single watchlist.
- Single
Watchlist Entry - Object containing watchlist entry for a single instrument.
- SsoValidate
Response - SsoValidate
Response Features - Returns supported features such as bonds and option trading.
- Status
Response - Status
Response2 - Confirms successful reply to the server prompt.
- Status
Response3 - Confirms successful removal of suppression.
- Status
Response4 - Stmt
Request - Stocks
- Strike200
Response - SubAccounts
- SubAccounts
Account - SubAccounts
Account Datum - Subaccounts2
Response - Subaccounts2
Response Metadata - Metadata container describing the subaccounts.
- Submit
Model Orders Request - Submit all pending orders to the models. This is similar to the Model page’s Submit All Orders selection.
- Submit
NewOrder Request - Submit a new order(s) ticket, bracket, or OCA group.
- Submit
NewOrder Request Path - Success
Response - Success
Response2 - Success
Response3 - Acknowledges a successful request.
- Successful
Tickle Response - Successful
Tickle Response Hmds - Returns connection details for the historical market data server.
- Successful
Tickle Response Iserver - Summary
Market Value Response - Summary
Market Value Response Currency - Returns an object containing market value details of the currency and positions held using that currency.
- Summary
OfAccount Balances Response - Summary
OfAccount Balances Response Commodities - Contains Commodity-specific balance details.
- Summary
OfAccount Balances Response Securities - Contains Security-specific balance details.
- Summary
OfAccount Balances Response Total - Contains total balance details for the account.
- Summary
OfAccount Margin Response - Summary
OfAccount Margin Response Commodities - Summary
OfAccount Margin Response Crypto AtPaxos - Summary
OfAccount Margin Response Securities - Summary
Request Body - Suppress
Order Replies Request - Suppress the specified order reply messages for the duration of the brokerage session.
- Synchronous
Instruction Response - Task
Action Response - TaxForm
Request - TaxForm
Response - TaxForm
Type - Token
Request - Token
Response - Trade
Confirmation Request - Trade
Confirmation Response - Trades
Response Trades Response - Object containing details of a single execution.
- Trading
Instrument Trading Instrument Description - Trading
Instrument Trading Instrument Description Description - Trading
Instrument Variant0 - Trading
Schedule Trading Schedule - Trading
Schedule Trading Schedule Schedule - Trading
Schedule Trading Schedule Schedule Session - Trading
Schedule Trading Schedule Schedule Time - Traditional
Bank Instruction Verification - Transaction
Request Body - Transactions
Response - Transactions
Response Rpnl - Returns the object containing the realized pnl for the contract on the date.
- Transactions
Response Rpnl Items - Transactions
Response Transaction - Transfer200
Response - Transfer
Request Body - Transfer
Request Body2 - Transfer
Request Body3 - Transfer
Request Body4 - Transfer
Request Body5 - Trsrv
SecDef Response - a contract’s security definition
- Trsrv
SecDef Response Secdef - Trsrv
SecDef Response Secdef Display Rule - Trsrv
SecDef Response Secdef Display Rule Display Rule Step - Trsrv
SecDef Response Secdef Increment Rule - Unsubscribed
Response - Indicates a successful request to unsubscribe all streams.
- User
- User
Accounts Response - User
Accounts Response Acct Props - Returns an json object for each accessible account’s properties.
- User
Accounts Response Acct Props U1234567 - User
Accounts Response Aliases - User
Accounts Response Allow Features - User
Accounts Response Chart Periods - User
Accounts Response Server Info - User
Entity - Provide information about the particular entity
- User
Name Available Response - Verify
CsvRequest - Validates CSV structure, restriction names, and rule parameters without applying changes. Must be called before /csv/v2/apply with the same requestId.
Scope:restrictions.write
Security Policy:Signed JWT - Verify
CsvRequest Header - Verify
Request - Watchlist200
Response - Watchlist
Delete Success - Object detailing the successful deletion of a watchlist.
- Watchlist
Delete Success Data - Watchlist
Request Body - Watchlist
Request Body Row - Watchlists
Response - Object containing a successful query for watchlists saved for the username in use in the current Web API session.
- Watchlists
Response Data - Contains the watchlist query results.
- Watchlists
Response Data User List - Details of a single watchlist.
- Withdraw
Funds Instruction - Withdraw
Funds Instruction IraWithdrawal Detail
Enums§
- Account200
Response - Account
Attributes Business Type - A descriptor of the nature of the account, reflecting the responsible group within IB.
- Account
Attributes Clearing Status - Status of the account with respect to clearing at IB. O is open, P pending, N new, A abandoned, C closed, R rejected.
- Account
Attributes IbEntity - IB business entity under which the account resides.
- AchInstruction
AchType - AchInstruction
Bank Instruction Code - AchInstruction
Client Account Info Bank Account Type Code - AckServer
Prompt Response - Response types for ackServerPrompt
- Activate
Alert Response - Response types for activateAlert
- Alert
Activation Request Alert Active - Determines if the alert is active [1] or not [0]
- Alert
Creation Request Condition Logic Bind - Describes how multiple conditions should behave together. Available logic types:
- Alert
Creation Request Condition Type - Designate what condition type to use. Note the “MTA” types listed are only supported if iTWSOrdersOnly=1 Available condition types:
- Alert
Creation Request Tif - Time in Force duration of alert.
- Alert
Details Order Status - represent order statusAlways returns “Presubmitted”.
- Algo
Param Default Value - Default parameter value. Type defined in valueClassName field
- Algo
Param Value Class Name - Returns the variable type of the parameter.
- Allocation
Method - Interactive Brokers supports two forms of allocation methods. Allocation methods that have calculations completed by Interactive Brokers, and a set of allocation methods calculated by the user and then specified. IB-computed allocation methods:
- Apply
CsvResponse - Response types for applyCSV
- Bank
Instruction Method - Bond
Filters Response Filter Display Text - An identifier used to document returned options/values. This can be thought of as a key value.
- Cancel
Open Order Response - Response types for cancelOpenOrder
- Close
AllMd Streams Response - Response types for closeAllMdStreams
- Close
MdStream Response - Response types for closeMdStream
- Confirm
Order Reply Response - Response types for confirmOrderReply
- Contract
Rules CqtType - Contract
Rules IbAlgo Type - Contract
Rules Order Type - Contract
Rules Order Types Outside - Create
Alert Response - Response types for createAlert
- Create
Allocation Group Response - Response types for createAllocationGroup
- Delete
Alert Response - Response types for deleteAlert
- Delete
Bank Instruction Bank Instruction Method - Delete
FyiDevice Response - Response types for deleteFyiDevice
- Delete
Watchlist Response - Response types for deleteWatchlist
- Deposit
Funds Instruction Bank Instruction Method - Deposit
Funds Instruction IraDeposit Detail From IraType - Deposit
Funds Instruction IraDeposit Detail IraContribution Type - Deposit
Funds Instruction IraDeposit Detail IraTax Year Type - Echo
Response Request Method - Echo
Response Security Policy - Edda
Instruction Debtor Identification Document Type - Enumeration
Type - exchange-bundles - query most up to date list of exchange-bundles for tradingPermissions
- business-and-occupation - list of occupation and employerBusiness for employmentDetails
- employee-track - query most up to date companyId for account. For affiliation details, if company has an existing IBKR Employee Track account
- fin-info-ranges - query most up to date range IDs by currency for annualNetIncome, netWorth, liquidNetWorth
- acats - query most up to date values for brokerId and brokerName. Used if funding via US ACATS extPositionsTransfers
- aton - query most up to date values for brokerId and brokerName. Used if funding via US ACATS extPositionsTransfers
- market-data - query most up to date values for brokerId and brokerName. Used if funding via ATON Canada extPositionsTransfers
- edd-avt - query questions associated with EDD (Enhanced Due Diligence) or AVT (Additional Verification) tasks assigned to an account
- prohibited-country - view list of prohibited countries. Applicants that reside in prohibited country are restricted from opening an account with IBKR. Error will be thrown IF legalResidenceCountry, OR country (included within Residence, mailingAddress and employerAddress, taxResidency node) is a prohibited country
- employee-plans - view EPA that are linked to master account (applicable IF offering SEP IRA accounts)
- questionnaires - obtain list of questionnaires
- security-questions - obtain list of questions supported for IBKR security questions
- quiz-questions - obtain list of questions associated with IBKR knowledge assessment
- wire-instructions - obtain list of wire instructions
- product-country-bundles - obtain list of product country bundles
- External
Position Transfer Source Iratype - Generate
Token Response - Response types for generateToken
- GetAccount
Market Summary Response - Response types for getAccountMarketSummary
- GetAccount
Owners Response - Response types for getAccountOwners
- GetAccount
Summary Response - Response types for getAccountSummary
- GetAccounts
InModel Response - Response types for getAccountsInModel
- GetAlert
Details Response - Response types for getAlertDetails
- GetAlgos
ByInstrument Request Query Algos - List of algo ids delimited by “;” to filter by. Max of 8 algos ids can be specified. Case sensitive to algo id.
- GetAlgos
ByInstrument Response - Response types for getAlgosByInstrument
- GetAll
Accounts ForConid Response - Response types for getAllAccountsForConid
- GetAll
Accounts Response - Response types for getAllAccounts
- GetAll
Alerts Response - Response types for getAllAlerts
- GetAll
Fyis Response - Response types for getAllFyis
- GetAll
Model Positions Response - Response types for getAllModelPositions
- GetAll
Subaccounts Response - Response types for getAllSubaccounts
- GetAll
Watchlists Response - Response types for getAllWatchlists
- GetAllmodels
Response - Response types for getAllmodels
- GetAllocatable
Subaccounts Response - Response types for getAllocatableSubaccounts
- GetAllocation
Groups Response - Response types for getAllocationGroups
- GetAllocation
Presets Response - Response types for getAllocationPresets
- GetAsset
Allocation Response - Response types for getAssetAllocation
- GetBalance
Summary Response - Response types for getBalanceSummary
- GetBond
Filters Response - Response types for getBondFilters
- GetBrokerage
Accounts Response - Response types for getBrokerageAccounts
- GetBrokerage
Status Response - Response types for getBrokerageStatus
- GetCombo
Positions Response - Response types for getComboPositions
- GetConids
ByExchange Response - Response types for getConidsByExchange
- GetContract
Info Response - Response types for getContractInfo
- GetContract
Rules Response - Response types for getContractRules
- GetContract
Strikes Request Query Sectype - Security type of the requested contract of interest. Valid asset classes are:
- GetContract
Strikes Response - Response types for getContractStrikes
- GetContract
Symbols Request Query SecType - GetContract
Symbols Response - Response types for getContractSymbols
- GetCurrency
Pairs Response - Response types for getCurrencyPairs
- GetDynamic
Accounts Response - Response types for getDynamicAccounts
- GetExchange
Rates Response - Response types for getExchangeRates
- GetForecast
Categories Response - Response types for getForecastCategories
- GetForecast
Contract Response - Response types for getForecastContract
- GetForecast
Markets Response - Response types for getForecastMarkets
- GetForecast
Rules Response - Response types for getForecastRules
- GetForecast
Schedule Response - Response types for getForecastSchedule
- GetFund
Summary Response - Response types for getFundSummary
- GetFuture
BySymbol Response - Response types for getFutureBySymbol
- GetFyi
Delivery Response - Response types for getFyiDelivery
- GetFyi
Disclaimerss Response - Response types for getFyiDisclaimerss
- GetFyi
Settings Response - Response types for getFyiSettings
- GetGw
ApiV1 Accounts Accountid Details Response - Response types for get_gw_api_v1_accounts_accountid_details
- GetGw
ApiV1 Accounts Accountid KycResponse - Response types for get_gw_api_v1_accounts_accountid_kyc
- GetGw
ApiV1 Accounts Accountid Status Response - Response types for get_gw_api_v1_accounts_accountid_status
- GetGw
ApiV1 Accounts Accountid Tasks Request Query Type - GetGw
ApiV1 Accounts Accountid Tasks Response - Response types for get_gw_api_v1_accounts_accountid_tasks
- GetGw
ApiV1 Accounts Login Messages Response - Response types for get_gw_api_v1_accounts_login_messages
- GetGw
ApiV1 Accounts Response - Response types for get_gw_api_v1_accounts
- GetGw
ApiV1 Accounts Status Response - Response types for get_gw_api_v1_accounts_status
- GetGw
ApiV1 Echo Https Response - Response types for get_gw_api_v1_echo_https
- GetGw
ApiV1 Enumerations Complex Asset Transfer Response - Response types for get_gw_api_v1_enumerations_complex_asset_transfer
- GetGw
ApiV1 Enumerations Enumerationtype Request Query Language - GetGw
ApiV1 Enumerations Enumerationtype Response - Response types for get_gw_api_v1_enumerations_enumerationtype
- GetGw
ApiV1 Forms Request Query Projection - GetGw
ApiV1 Forms Required Forms Response - Response types for get_gw_api_v1_forms_required_forms
- GetGw
ApiV1 Forms Response - Response types for get_gw_api_v1_forms
- GetGw
ApiV1 Instruction Sets Instructionsetid Response - Response types for get_gw_api_v1_instruction_sets_instructionsetid
- GetGw
ApiV1 Instructions Instructionid Response - Response types for get_gw_api_v1_instructions_instructionid
- GetGw
ApiV1 Participating Banks Response - Response types for get_gw_api_v1_participating_banks
- GetGw
ApiV1 Requests Response - Response types for get_gw_api_v1_requests
- GetGw
ApiV1 Statements Available Response - Response types for get_gw_api_v1_statements_available
- GetGw
ApiV1 TaxDocuments Available Response - Response types for get_gw_api_v1_tax_documents_available
- GetGw
ApiV1 Trade Confirmations Available Response - Response types for get_gw_api_v1_trade_confirmations_available
- GetGw
ApiV1 Validations Usernames Username Response - Response types for get_gw_api_v1_validations_usernames_username
- GetInfo
AndRules Response - Response types for getInfoAndRules
- GetInstrument
Definition Response - Response types for getInstrumentDefinition
- GetInstrument
Info Response - Response types for getInstrumentInfo
- GetInvested
Accounts InModel Response - Response types for getInvestedAccountsInModel
- GetMany
Subaccounts Response - Response types for getManySubaccounts
- GetMargin
Summary Response - Response types for getMarginSummary
- GetMd
History Request Query Direction - GetMd
History Response - Response types for getMdHistory
- GetMd
Snapshot Response - Response types for getMdSnapshot
- GetModel
Presets Response - Response types for getModelPresets
- GetModel
Summary Single Response - Response types for getModelSummarySingle
- GetMta
Details Response - Response types for getMtaDetails
- GetOpen
Orders Request Query Filters - GetOpen
Orders Response - Response types for getOpenOrders
- GetOrder
Status Response - Response types for getOrderStatus
- GetPaginated
Positions Response - Response types for getPaginatedPositions
- GetPerformance
AllPeriods Response - Response types for getPerformanceAllPeriods
- GetPnl
Response - Response types for getPnl
- GetPortfolio
Ledger Response - Response types for getPortfolioLedger
- GetPortfolio
Metadata Response - Response types for getPortfolioMetadata
- GetPortfolio
Summary Response - Response types for getPortfolioSummary
- GetPosition
ByConid Response - Response types for getPositionByConid
- GetScanner
Parameters Response - Response types for getScannerParameters
- GetScanner
Results Response - Response types for getScannerResults
- GetSession
Token Response - Response types for getSessionToken
- GetSession
Validation Response - Response types for getSessionValidation
- GetSingle
Allocation Group Response - Response types for getSingleAllocationGroup
- GetSingle
Performance Period Response - Response types for getSinglePerformancePeriod
- GetSpecific
Watchlist Response - Response types for getSpecificWatchlist
- GetStock
BySymbol Response - Response types for getStockBySymbol
- GetTrade
History Response - Response types for getTradeHistory
- GetTrading
Schedule GetTrsrv Secdef Schedule Request Query Asset Class - Specify the security type of the given contract. Valid asset classes are:
- GetTrading
Schedule GetTrsrv Secdef Schedule Response - Response types for getTradingSchedule_get_trsrv_secdef_schedule
- GetTrading
Schedule Response - Response types for getTradingSchedule
- GetTransactions
Response - Response types for getTransactions
- GetUncached
Positions Request Query Direction - The chronologic order of orders to sort by.
- GetUncached
Positions Response - Response types for getUncachedPositions
- GetUnread
Fyis Response - Response types for getUnreadFyis
- History200
Response - Individual
Combo Position PutOr Call - The right of an options contract, if applicable.
- Individual
Position PutOr Call - The right of an options contract, if applicable.
- Initialize
Session Response - Response types for initializeSession
- Instruction200
Response - Instruction
Direction - Instruction
Request Body Instruction - Instruction
Request Body Instruction Type - Instruction
Result Instruction Status - Instruction
Result Instruction Type - Invalidate
Position Cache Response - Response types for invalidatePositionCache
- Iserver
Scanner RunRequest Filter Value - Value corresponding to the input for “code”.
- Iserver
Snapshot Kind - Logout
Response - Response types for logout
- MdFields
- Many FYI endpoints reference a “typecode” value. The table below lists the available codes and what they correspond to.
- Message
IdRequest Body Message Id - A warning message to be pre-approved.
- Modify
FyiDelivery Response - Response types for modifyFyiDelivery
- Modify
FyiEmails Response - Response types for modifyFyiEmails
- Modify
Open Order Response - Response types for modifyOpenOrder
- Order200
Response - Order200
Response2 - Order200
Response3 - Order
Status Child Order Type - Indicates if the order ticket is hedged, and if so, in what way. 0 = No hedge, A = Attached child hedge order, B = Beta/portfolio hedge
- Order
Status Order Status - Status of the order ticket.
- Order
Status SecType - IB asset class identifier.
- Order
Status Tif - Time in force of the order ticket.
- Patch
GwApi V1Requests Requestid Status Response - Response types for patch_gw_api_v1_requests_requestid_status
- Performance
Request Body Period - Specify the period for which the account should be analyzed. Available period lengths:
- Polling
Instruction Result Instruction Status - Position
Request Body2 Sort Direction - Direction to sort the request by.
- Position
Request Body2 Sort Field - Field to sort the response by.
- Post
GwApi V1Accounts Accountid Tasks Response - Response types for post_gw_api_v1_accounts_accountid_tasks
- Post
GwApi V1Accounts Response - Response types for post_gw_api_v1_accounts
- Post
GwApi V1Balances Query Response - Response types for post_gw_api_v1_balances_query
- Post
GwApi V1Bank Instructions Bulk Response - Response types for post_gw_api_v1_bank_instructions_bulk
- Post
GwApi V1Bank Instructions Query Response - Response types for post_gw_api_v1_bank_instructions_query
- Post
GwApi V1Bank Instructions Response - Response types for post_gw_api_v1_bank_instructions
- Post
GwApi V1External Cash Transfers Query Response - Response types for post_gw_api_v1_external_cash_transfers_query
- Post
GwApi V1Instructions Cancel Response - Response types for post_gw_api_v1_instructions_cancel
- Post
GwApi V1Sso Browser Sessions Response - Response types for post_gw_api_v1_sso_browser_sessions
- Post
GwApi V1Sso Sessions Response - Response types for post_gw_api_v1_sso_sessions
- Post
GwApi V1Statements Response - Response types for post_gw_api_v1_statements
- Post
GwApi V1Tax Documents Response - Response types for post_gw_api_v1_tax_documents
- Post
GwApi V1Trade Confirmations Response - Response types for post_gw_api_v1_trade_confirmations
- Post
NewWatchlist Response - Response types for postNewWatchlist
- Predefined
Destination Instruction Bank Instruction Method - Predefined
Destination Instruction Financial Institution Branch Code Type - Predefined
Destination Instruction Financial Institution Identifier Type - Presets
Default Method ForAll - Interactive Brokers supports two forms of allocation methods. Allocation methods that have calculations completed by Interactive Brokers, and a set of allocation methods calculated by the user and then specified. IB-computed allocation methods:
- Preview
Margin Impact Response - Response types for previewMarginImpact
- Query201
Response - Query201
Response2 - Query
Instruction Kind - Query
Instruction Kind2 - Query
Recent Instructions Transaction History Transaction Type - Query
Request Body2 Instruction Type - Query
Request Body3 Instruction Type - Query
Request Body Instruction - Read
FyiNotification Response - Response types for readFyiNotification
- Recurring
Instruction Detail Frequency - Reply200
Response - ReqAccess
Token Response - Response types for reqAccessToken
- ReqLive
Session Token Response - Response types for reqLiveSessionToken
- ReqTemp
Token Response - Response types for reqTempToken
- Request
Status - Reset
Order Suppression Response - Response types for resetOrderSuppression
- SetAccountinvestment
InModel Response - Response types for setAccountinvestmentInModel
- SetActive
Account Response - Response types for setActiveAccount
- SetAllocation
Preset Response - Response types for setAllocationPreset
- SetModel
Presets Response - Response types for setModelPresets
- SetModel
Target Positions Response - Response types for setModelTargetPositions
- Side
- Side of the order ticket.
- Single
Order Submission Request Json Payload Allocation Profile Alloc Type - The allocation type to define how shares should be distributed. A warning message to be pre-approved.
- Single
Order Submission Request Trailing Type - Specifies the type of trailing used with a Trailing order.
- Single
Watchlist Entry Asset Class - All-capital, shorthand security type identifier of the instrument.
- SubAccounts
Account Datum Key - Defines the value of the object
- SubType
- Submit
Model Orders Response - Response types for submitModelOrders
- Submit
NewOrder Response - Response types for submitNewOrder
- Suppress
Order Replies Response - Response types for suppressOrderReplies
- Task200
Response - Tickle
Response - Token
Request Client Authentication Method - Trades
Response Trades Response Side - Side of the execution.
- Trading
Instrument - Trading
Instrument Trading Instrument Description Description Asset Type - Trading
Instrument Trading Instrument Description Description Security IdType - Traditional
Bank Instruction Verification Bank Instruction Code - Transactions
Response Rpnl Items Side - Determines if the day was a loss or gain *
L- LOSS *G- GAIN - Transfer
Request Body2 Instruction - Transfer
Request Body2 Instruction Type - Transfer
Request Body3 Instruction - Transfer
Request Body3 Instruction Type - Typecodes
- Many FYI endpoints reference a “typecode” value. The table below lists the available codes and what they correspond to.
- User
Entity Entity Type - The type of entity assigned to the user
- Withdraw
Funds Instruction Bank Instruction Method - Withdraw
Funds Instruction IraWithdrawal Detail IraWithhold Type
Constants§
Type Aliases§
- Account200
Response2 - Array of objects representing accounts in the structure.
- Account
Request Body - Alerts
- Array
Node - Combo
Position Response - Array of objects each containing a single combo position.
- FyiSettings
- Individual
Position Array - Iserver
Snapshot - Returns an object for each conId requested.
- Notifications
- Order
Reply Message - An array containing objects that each deliver the order reply messages emitted against one order ticket in the submission request’s array. Indicies of the order reply message objects in this array correspond to the indicies of the order tickets in the submission request’s array.
- Order
Submit Success - A successful submission of one or more order tickets.
- Portfolio2
Positions - Array of position objects, each defining a position held in the account.
- Position200
Response2 - Array of objects reflecting all positions in the given account.
- Restriction
Request Body - Signed JWT token
- Secdef
Search Response - Subaccount200
Response - Task200
Response2 - Trades
Response - Array of objects representing executions.
- Trading
Schedule - trading’s schedules
- UtcDate
Time - UTC datetime string in format YYYYMMDD-hh:mm:ss.