{"openapi":"3.1.0","info":{"title":"API Reference","version":"1.0.0"},"paths":{"/v1/api/oauth/request_token":{"post":{"operationId":"reqTempToken","summary":"Obtain A Request Token","description":"Request a temporary token as a third party to begin the OAuth 1.0a authorization workflow.","tags":["tradingOAuth10A"],"parameters":[{"name":"Authorization","in":"header","description":"OAuth 1.0a authorization request header for request to /request_token endpoint.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success response with temporary OAuth access token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Trading OAuth 1.0a_reqTempToken_Response_200"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/oauth/access_token":{"post":{"operationId":"reqAccessToken","summary":"Generate An Access Token","description":"Request an access token for the IB username that has granted authorization to the consumer.","tags":["tradingOAuth10A"],"parameters":[{"name":"Authorization","in":"header","description":"OAuth 1.0a authorization request header for request to /access_token endpoint.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success response with permanent OAuth access token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Trading OAuth 1.0a_reqAccessToken_Response_200"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/oauth/live_session_token":{"post":{"operationId":"reqLiveSessionToken","summary":"Generate A Live Session Token","description":"Generate a Live Session Token shared secret and gain access to Web API.","tags":["tradingOAuth10A"],"parameters":[{"name":"Authorization","in":"header","description":"OAuth 1.0a authorization request header for request to /live_session_token endpoint.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success response with Diffie-Hellman challenge and Signature value","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Trading OAuth 1.0a_reqLiveSessionToken_Response_200"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/gw/api/v1/sso-browser-sessions":{"post":{"operationId":"createSsoBrowserSessions","summary":"Create SSO Browser Session.","description":"<br>**Scope**: `sso-browser-sessions.write`<br>**Security Policy**: `Signed JWT`","tags":["authorizationSsoBrowserSessions"],"parameters":[{"name":"authorization","in":"header","description":"Specifies the authorization header value (e.g., Bearer eyJ0eXAiOiJKV1...).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Create a Single Sign On (SSO) to access the IBKR hosted portal (White Branded).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBrowserSessionResponse"}}}},"400":{"description":"Returns a Problem detail instance representing a bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingRequiredParameterResponse"}}}},"401":{"description":"Returns a Problem detail instance representing an unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidAccessTokenResponse"}}}},"403":{"description":"Returns a Problem detail instance representing a forbidden request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsufficientScopeResponse"}}}},"500":{"description":"Returns a Problem detail instance representing an internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}}}},"/gw/api/v1/sso-sessions":{"post":{"operationId":"createSsoSessions","summary":"Create A New SSO Session On Behalf Of An End-user.","description":"<br>**Scope**: `sso-sessions.write`<br>**Security Policy**: `Signed JWT`","tags":["authorizationSsoSessions"],"parameters":[{"name":"authorization","in":"header","description":"Specifies the authorization header value (e.g., Bearer eyJ0eXAiOiJKV1...).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a JSON object containing a reference to the newly created SSO session.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSessionResponse"}}}},"400":{"description":"Returns a Problem detail instance representing a bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingRequiredParameterResponse"}}}},"401":{"description":"Returns a Problem detail instance representing an unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidAccessTokenResponse"}}}},"403":{"description":"Returns a Problem detail instance representing a forbidden request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsufficientScopeResponse"}}}},"500":{"description":"Returns a Problem detail instance representing an internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}}}},"/oauth2/api/v1/token":{"post":{"operationId":"generateToken","summary":"Create Access Token","description":"Generate OAuth 2.0 access tokens based on request parameters.","tags":["authorizationToken"],"responses":{"200":{"description":"Returns a token response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenResponse"}}}},"400":{"description":"Returns a [Problem detail](https://datatracker.ietf.org/doc/html/rfc9457) instance representing a bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"500":{"description":"Returns a [Problem detail](https://datatracker.ietf.org/doc/html/rfc9457) instance representing an internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenRequest"}}}}}},"/v1/api/iserver/account/pnl/partitioned":{"get":{"operationId":"getPnl","summary":"Account Profit And Loss","description":"Returns updated profit and loss values for the selected account. Initial request will return an empty array in the upnl object.\n","tags":["tradingAccounts"],"responses":{"200":{"description":"Refers to \"updated PnL\". Holds a json object of key-value paired pnl details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pnlPartitionedResponse"}}}},"400":{"description":"bad request; passed input cannot pass initial validation and detected right away","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/acesws/{accountId}/signatures-and-owners":{"get":{"operationId":"getAccountOwners","summary":"List Account Signatures And Owners","description":"Receive a list of all applicant names on the account and for which account and entity is represented.","tags":["tradingAccounts"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"An object containing valid accounts and the account properties regarding trading access. This endpoint is also used to confirm account validation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/signatureAndOwners"}}}},"400":{"description":"bad request; accountId is empty","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/iserver/accounts":{"get":{"operationId":"getBrokerageAccounts","summary":"List All Tradable Accounts","description":"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.","tags":["tradingAccounts"],"responses":{"200":{"description":"An object containing valid accounts and the account properties regarding trading access. This endpoint is also used to confirm account validation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/userAccountsResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/iserver/account/search/{searchPattern}":{"get":{"operationId":"getDynamicAccounts","summary":"Search Dynamic Accounts","description":"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.\n","tags":["tradingAccounts"],"parameters":[{"name":"searchPattern","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns all accounts that match the searchPattern string.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dynAccountSearchResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/iserver/dynaccount":{"post":{"operationId":"setDynamicAccount","summary":"Set Active Dynamic Account","description":"Set the active dynamic account.","tags":["tradingAccounts"],"responses":{"200":{"description":"An array of objects detailing contract information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setAccountResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"acctId":{"type":"string","description":"The account ID that should be set for future requests."}},"required":["acctId"]}}}}}},"/v1/api/iserver/account/{accountId}/summary/balances":{"get":{"operationId":"getBalanceSummary","summary":"Summary Of Account Balances","description":"Returns a summary of an account's equity and cash balances, in total and by account segment.","tags":["tradingAccounts"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Indicates a successful return of available funds.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/summaryOfAccountBalancesResponse"}}}},"400":{"description":"bad request; passed input cannot pass initial validation and detected right away","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/iserver/account/{accountId}/summary/margins":{"get":{"operationId":"getMarginSummary","summary":"Summary Of Account Margin Usage","description":"Returns a summary of an account's margin, in total and by account segment.","tags":["tradingAccounts"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Indicates a success request to receive margin balance values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/summaryOfAccountMarginResponse"}}}},"400":{"description":"bad request; passed input cannot pass initial validation and detected right away","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/iserver/account/{accountId}/summary/market_value":{"get":{"operationId":"getAccountMarketSummary","summary":"Summary Of Account Market Value","description":"Returns a summary of an account's market value, by currency and asset class.","tags":["tradingAccounts"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Indicates a successful market value request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/summaryMarketValueResponse"}}}},"400":{"description":"bad request; passed input cannot pass initial validation and detected right away","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/iserver/account/{accountId}/summary":{"get":{"operationId":"getAccountSummary","summary":"Summary Of Account Values","description":"Provides a general overview of the account details such as balance values.","tags":["tradingAccounts"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Provides a general overview of the account details such as balance values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/accountSummaryResponse"}}}},"400":{"description":"bad request; passed input cannot pass initial validation and detected right away","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/iserver/account/{accountId}/summary/available_funds":{"get":{"operationId":"getFundSummary","summary":"Summary Of Available Funds","description":"Provides a summary specific for avilable funds giving more depth than the standard /summary endpoint.","tags":["tradingAccounts"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Indicates a successful return of available funds.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/availableFundsResponse"}}}},"400":{"description":"bad request; passed input cannot pass initial validation and detected right away","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/iserver/account":{"post":{"operationId":"setActiveAccount","summary":"Switch Selected Account","description":"Switch the active account for how you request data. Only available for financial advisors and multi-account structures.\n","tags":["tradingAccounts"],"responses":{"200":{"description":"Validates the account swapped to.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setAccountResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error. Unable to process request if incoming values are not valid. For example accountId is not correct\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"acctId":{"type":"string","description":"Identifier for the unique account to retrieve information from."}}}}}}}},"/v1/api/iserver/account/{accountId}/alert/activate":{"post":{"operationId":"activateAlert","summary":"Activate Or Deactivate An Alert","description":"Activate or Deactivate existing alerts created for this account. This does not delete alerts, but disables notifications until reactivated.","tags":["tradingAlerts"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"An object containing details about the activated/deactivated alert.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/alertActivationResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error; unable to process incoming request due to invalid data in it","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/alertActivationRequest"}}}}}},"/v1/api/iserver/account/{accountId}/alert/{alertId}":{"delete":{"operationId":"deleteAlert","summary":"Delete An Alert","description":"Permanently delete an existing alert. Deleting an MTA alert will reset it to the default state.","tags":["tradingAlerts"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"alertId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"An object containing details on the deleted endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/alertDeletionResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error; Unable to delete alert in case when provided alert id doesn't exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{}}}}}}},"/v1/api/iserver/account/mta":{"get":{"operationId":"getMtaDetails","summary":"Details Of A Mobile Trading Alert","description":"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.\n","tags":["tradingAlerts"],"responses":{"200":{"description":"The alert description for the unique MTA alert on the account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/alertDetails"}}}}}}},"/v1/api/iserver/account/alert/{alertId}":{"get":{"operationId":"getAlertDetails","summary":"Details Of A Specific Alert","description":"Request details of a specific alert by providing the assigned alertId Id.","tags":["tradingAlerts"],"parameters":[{"name":"alertId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"type","in":"query","required":true,"schema":{"$ref":"#/components/schemas/V1ApiIserverAccountAlertAlertIdGetParametersType"}}],"responses":{"200":{"description":"An object containing all unique details of the specified alert.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/alertDetails"}}}},"400":{"description":"bad request if orderId is empty or type is invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"orderId is not parsable; unable to process request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/iserver/account/{accountId}/alerts":{"get":{"operationId":"getAllAlerts","summary":"List All Alerts","description":"Retrieve a list of all alerts attached to the provided account.","tags":["tradingAlerts"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"An array of objects detailing contract information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/alerts"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/iserver/currency/pairs":{"get":{"operationId":"getCurrencyPairs","summary":"Available Currency Pairs","description":"Obtains available currency pairs corresponding to the given target currency.","tags":["tradingContracts"],"parameters":[{"name":"currency","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a list of valid forex pairs for the given currency. The currency can apply as both the target or base currency.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/currencyPairs"}}}},"400":{"description":"Missing, empty, non-numeric, or out-of-range parameter. The `error` field is always prefixed with `Bad Request:`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/iserver/exchangerate":{"get":{"operationId":"getExchangeRates","summary":"Currency Exchange Rate","description":"Obtains the exchange rates of the currency pair.","tags":["tradingContracts"],"parameters":[{"name":"target","in":"query","required":true,"schema":{"type":"string"}},{"name":"source","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful requests return the currency exchange rate of the target currency value divided by the source currency.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Trading Contracts_getExchangeRates_Response_200"}}}},"400":{"description":"Missing, empty, non-numeric, or out-of-range parameter. The `error` field is always prefixed with `Bad Request:`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/iserver/contract/{conid}/info":{"get":{"operationId":"getInstrumentInfo","summary":"General Instrument Information","description":"Requests full contract details for the given conid.","tags":["tradingContracts"],"parameters":[{"name":"conid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns detailed information for the passed contract.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/contractInfo"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/iserver/secdef/info":{"get":{"operationId":"getContractInfo","summary":"Instrument Attributes Detail","description":"Returns the attributes of the instrument.","tags":["tradingContracts"],"parameters":[{"name":"conid","in":"query","required":false,"schema":{"type":"string"}},{"name":"sectype","in":"query","required":false,"schema":{"description":"Any type"}},{"name":"month","in":"query","required":false,"schema":{"description":"Any type"}},{"name":"exchange","in":"query","required":false,"schema":{"description":"Any type"}},{"name":"strike","in":"query","required":false,"schema":{"description":"Any type"}},{"name":"right","in":"query","required":false,"schema":{"$ref":"#/components/schemas/V1ApiIserverSecdefInfoGetParametersRight"}},{"name":"issuerId","in":"query","required":false,"schema":{"type":"string"}},{"name":"filters","in":"query","required":false,"schema":{"description":"Any type"}}],"responses":{"200":{"description":"Successful response containing a contract's security definition.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/secDefInfoResponse"}}}},"400":{"description":"Missing, empty, non-numeric, or out-of-range parameter. The `error` field is always prefixed with `Bad Request:`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/trsrv/secdef":{"get":{"operationId":"getInstrumentDefinition","summary":"Instrument Definition Detail","description":"Returns a list of security definitions for the given conids.","tags":["tradingContracts"],"parameters":[{"name":"conids","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response containing a contract's security definition.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/trsrvSecDefResponse"}}}},"400":{"description":"Missing, empty, non-numeric, or out-of-range parameter. The `error` field is always prefixed with `Bad Request:`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/iserver/contract/{conid}/info-and-rules":{"get":{"operationId":"getInfoAndRules","summary":"Instrument Info And Market Rules","description":"Requests full contract details and trading rules for the given conid. A follow-up request will provide additional trading rules.\n","tags":["tradingContracts"],"parameters":[{"name":"conid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns all contract information and trading rules for the contract.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Trading Contracts_getInfoAndRules_Response_200"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/trsrv/all-conids":{"get":{"operationId":"getConidsByExchange","summary":"List All Stock Conids By Exchange","description":"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.","tags":["tradingContracts"],"parameters":[{"name":"exchange","in":"query","required":true,"schema":{"type":"string"}},{"name":"assetClass","in":"query","required":false,"schema":{"description":"Any type","default":"STK"}}],"responses":{"200":{"description":"Successful response containing a contract's security definition.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/V1ApiTrsrvAllConidsGetResponsesContentApplicationJsonSchemaItems"}}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/iserver/contract/{conid}/algos":{"get":{"operationId":"getAlgosByInstrument","summary":"Search Algos For An Instrument","description":"Returns supported IB Algos for an instrument. A pre-flight request must be submitted before retrieving information.","tags":["tradingContracts"],"parameters":[{"name":"conid","in":"path","required":true,"schema":{"type":"string"}},{"name":"algos","in":"query","required":false,"schema":{"$ref":"#/components/schemas/V1ApiIserverContractConidAlgosGetParametersAlgos"}},{"name":"addDescription","in":"query","required":false,"schema":{"$ref":"#/components/schemas/V1ApiIserverContractConidAlgosGetParametersAddDescription","default":0}},{"name":"addParams","in":"query","required":false,"schema":{"$ref":"#/components/schemas/V1ApiIserverContractConidAlgosGetParametersAddParams","default":0}}],"responses":{"200":{"description":"Returns a list of available algos and a description of their behavior.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/algosResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/iserver/secdef/bond-filters":{"get":{"operationId":"getBondFilters","summary":"Search Bond Filter Information","description":"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.","tags":["tradingContracts"],"parameters":[{"name":"symbol","in":"query","required":true,"schema":{"type":"string"}},{"name":"issuerId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful requests return the currency exchange rate of the target currency value divided by the source currency.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bondFiltersResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/iserver/contract/rules":{"post":{"operationId":"getContractRules","summary":"Search Contract Rules","description":"Returns trading related rules for a specific contract and side.","tags":["tradingContracts"],"responses":{"200":{"description":"An array of objects detailing contract information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/contractRules"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"conid":{"type":"integer","format":"int64","description":"Contract identifier for the interested contract."},"isBuy":{"type":"boolean","default":true,"description":"Side of the market rules apply too. Set to true for Buy Orders, set to false for Sell orders."},"modifyOrder":{"type":"boolean","default":false,"description":"Used to find trading rules related to an existing order."},"orderId":{"type":"integer","format":"int64","description":"Specify the order identifier used for tracking a given order."}},"required":["conid"]}}}}}},"/v1/api/trsrv/futures":{"get":{"operationId":"getFutureBySymbol","summary":"Search Futures By Symbol","description":"Returns a list of non-expired future contracts for given symbol(s)","tags":["tradingContracts"],"parameters":[{"name":"symbols","in":"query","required":true,"schema":{"type":"string"}},{"name":"exchange","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response containing a contract's security definition.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/features"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/iserver/secdef/search":{"get":{"operationId":"getContractSymbols","summary":"Search Instruments By Symbol","description":"Returns a list of contracts based on the search symbol provided as a query param.","tags":["tradingContracts"],"parameters":[{"name":"symbol","in":"query","required":false,"schema":{"type":"string"}},{"name":"secType","in":"query","description":"Available underlying security types:\n  * `STK` - Represents an underlying as a Stock security type.\n  * `IND` - Represents an underlying as an Index security type.\n  * `BOND` - Represents an underlying as a Bond security type.\n","required":false,"schema":{"$ref":"#/components/schemas/V1ApiIserverSecdefSearchGetParametersSecType","default":"STK"}},{"name":"name","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"more","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"fund","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"fundFamilyConidEx","in":"query","required":false,"schema":{"type":"string"}},{"name":"pattern","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"referrer","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"An array of objects detailing contract information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/secdefSearchResponse"}}}},"400":{"description":"Missing, empty, non-numeric, or out-of-range parameter. The `error` field is always prefixed with `Bad Request:`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}},"post":{"operationId":"getContractSymbolsFromBody","summary":"Search Instruments By Symbol","description":"Returns a list of contracts based on the search symbol provided as a query param.","tags":["tradingContracts"],"responses":{"200":{"description":"An array of objects detailing contract information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/secdefSearchResponse"}}}},"400":{"description":"Missing, empty, non-numeric, or out-of-range parameter. The `error` field is always prefixed with `Bad Request:`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"symbol":{"type":"string","description":"The ticker symbol, bond issuer type, or company name of the equity you are looking to trade."},"secType":{"$ref":"#/components/schemas/V1ApiIserverSecdefSearchPostRequestBodyContentApplicationJsonSchemaSecType","default":"STK","description":"Available underlying security types:\n  * `STK` - Represents an underlying as a Stock security type.\n  * `IND` - Represents an underlying as an Index security type.\n  * `BOND` - Represents an underlying as a Bond security type.\n"},"name":{"type":"boolean","description":"Denotes if the symbol value is the ticker symbol or part of the company's name."},"more":{"type":"boolean"},"fund":{"type":"boolean","description":"fund search"},"fundFamilyConidEx":{"type":"string"},"pattern":{"type":"boolean","description":"pattern search"},"referrer":{"type":"string"}},"required":["symbol"]}}}}}},"/v1/api/trsrv/stocks":{"get":{"operationId":"getStockBySymbol","summary":"Search Stocks By Symbol","description":"Returns an object contains all stock contracts for given symbol(s)","tags":["tradingContracts"],"parameters":[{"name":"symbols","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response containing a contract's security definition.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/stocks"}}}},"400":{"description":"Missing, empty, non-numeric, or out-of-range parameter. The `error` field is always prefixed with `Bad Request:`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/iserver/secdef/strikes":{"get":{"operationId":"getContractStrikes","summary":"Search Strikes For An Underlier","description":"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\".\n","tags":["tradingContracts"],"parameters":[{"name":"conid","in":"query","required":true,"schema":{"type":"string"}},{"name":"sectype","in":"query","required":true,"schema":{"$ref":"#/components/schemas/V1ApiIserverSecdefStrikesGetParametersSectype"}},{"name":"month","in":"query","required":true,"schema":{"type":"string"}},{"name":"exchange","in":"query","required":false,"schema":{"type":"string","default":"SMART"}}],"responses":{"200":{"description":"Successful response containing a contract's security definition.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Trading Contracts_getContractStrikes_Response_200"}}}},"400":{"description":"Missing, empty, non-numeric, or out-of-range parameter. The `error` field is always prefixed with `Bad Request:`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/trsrv/secdef/schedule":{"get":{"operationId":"getTradingSchedule","summary":"Trading Schedule By Symbol","description":"Returns the trading schedule up to a month for the requested contract.","tags":["tradingContracts"],"parameters":[{"name":"assetClass","in":"query","required":true,"schema":{"$ref":"#/components/schemas/V1ApiTrsrvSecdefScheduleGetParametersAssetClass"}},{"name":"symbol","in":"query","required":true,"schema":{"type":"string"}},{"name":"exchange","in":"query","required":false,"schema":{"type":"string"}},{"name":"exchangeFilter","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns the trading schedule up to a month for the requested contract.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tradingSchedule"}}}},"400":{"description":"Missing, empty, non-numeric, or out-of-range parameter. The `error` field is always prefixed with `Bad Request:`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/forecast/category/tree":{"get":{"operationId":"getForecastCategories","summary":"Event Contract Categories","description":"Returns the category names, parent ids, and markets for Event Contracts.","tags":["tradingEventContracts"],"responses":{"200":{"description":"Returns a list of category identifiers and name to be used for more granular contract discovery.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/categoryTreeResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/forecast/contract/details":{"get":{"operationId":"getForecastContract","summary":"Event Contract Details","description":"Provides instrument details for the specific forecast contract.","tags":["tradingEventContracts"],"parameters":[{"name":"conid","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns the expanded list of the event contract containing both Yes and No side identifier information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/forecastDetailsResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/forecast/contract/rules":{"get":{"operationId":"getForecastRules","summary":"Event Contract Rules","description":"Provides trading rules for specific event contracts.","tags":["tradingEventContracts"],"parameters":[{"name":"conid","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns the corresponding contracts rules.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/forecastRulesResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/forecast/contract/schedules":{"get":{"operationId":"getForecastSchedule","summary":"Event Contract Schedules","description":"Provides forecast trading schedules.","tags":["tradingEventContracts"],"parameters":[{"name":"conid","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns the liquid and extended trading hours of the coming and prior trading days.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/forecastSchedulesResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/forecast/contract/market":{"get":{"operationId":"getForecastMarkets","summary":"Provides All Contracts For Given Underlying Market.","description":"Returns all high level contract details affiliated with the underlying market conid provided.","tags":["tradingEventContracts"],"parameters":[{"name":"underlyingConid","in":"query","required":true,"schema":{"type":"string"}},{"name":"exchange","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns the liquid and extended trading hours of the coming and prior trading days.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/forecastMarketResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/iserver/account/allocation/group":{"post":{"operationId":"createAllocationGroup","summary":"Add Allocation Group","description":"Add a new allocation group. This group can be used to trade in place of the {accountId} for the /v1/api/iserver/account/{accountId}/orders endpoint.","tags":["tradingFaAllocationManagement"],"responses":{"200":{"description":"Returns a confirmation that the modification was successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Trading FA Allocation Management_createAllocationGroup_Response_200"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name used to refer to your allocation group. If prev_name is specified, this will become the new name of the group."},"accounts":{"type":"array","items":{"$ref":"#/components/schemas/V1ApiIserverAccountAllocationGroupPostRequestBodyContentApplicationJsonSchemaAccountsItems"},"description":"An array of accounts that should be held in the allocation group and, if using a User-specified allocaiton method, the value correlated to the allocation."},"default_method":{"$ref":"#/components/schemas/allocationMethod"}},"required":["name","accounts","default_method"]}}}}},"get":{"operationId":"getAllocationGroups","summary":"List All Allocation Groups","description":"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. \n","tags":["tradingFaAllocationManagement"],"responses":{"200":{"description":"Returns the \"data\" array, which contains all allocation groups under the advisor account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/allocationGroups"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}},"put":{"operationId":"modifyAllocationGroup","summary":"Modify Allocation Group","description":"Modify an existing allocation group.","tags":["tradingFaAllocationManagement"],"responses":{"200":{"description":"Returns a confirmation that the modification was successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Trading FA Allocation Management_modifyAllocationGroup_Response_200"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name used to refer to your allocation group. If prev_name is specified, this will become the new name of the group."},"prev_name":{"type":"string","description":"Can be used to rename a group. Using this field will recognize the previous name, while the \"name\" filed will mark the updated name."},"accounts":{"type":"array","items":{"$ref":"#/components/schemas/V1ApiIserverAccountAllocationGroupPutRequestBodyContentApplicationJsonSchemaAccountsItems"},"description":"An array of accounts that should be held in the allocation group and, if using a User-specified allocaiton method, the value correlated to the allocation."},"default_method":{"$ref":"#/components/schemas/allocationMethod"}},"required":["name","accounts","default_method"]}}}}}},"/v1/api/iserver/account/allocation/group/delete":{"post":{"operationId":"deleteAllocationGroup","summary":"Delete An Allocation Group","description":"Deletes a previously created allocation group. This endpoint is only supported for Financial Advisors and IBroker Accounts. \n","tags":["tradingFaAllocationManagement"],"responses":{"200":{"description":"Returns a confirmation that the modification was successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Trading FA Allocation Management_deleteAllocationGroup_Response_200"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of an existing allocation group."}},"required":["name"]}}}}}},"/v1/api/iserver/account/allocation/accounts":{"get":{"operationId":"getAllocatableSubaccounts","summary":"List Allocatable Subaccounts","description":"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. \n","tags":["tradingFaAllocationManagement"],"responses":{"200":{"description":"Indicates data is being returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/subAccounts"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/iserver/account/allocation/presets":{"get":{"operationId":"getAllocationPresets","summary":"Retrieve Allocation Presets","description":"Retrieve the preset behavior for allocation groups for specific events. This endpoint is only supported for Financial Advisors and IBroker Accounts. \n","tags":["tradingFaAllocationManagement"],"responses":{"200":{"description":"Successfully retrieve preset details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/presets"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}},"post":{"operationId":"setAllocationPreset","summary":"Set Allocation Preset","description":"Set the preset behavior for new allocation groups for specific events.","tags":["tradingFaAllocationManagement"],"responses":{"200":{"description":"Successfully retrieve preset details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Trading FA Allocation Management_setAllocationPreset_Response_200"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/presets"}}}}}},"/v1/api/iserver/account/allocation/group/single":{"post":{"operationId":"getSingleAllocationGroup","summary":"Retrieve Single Allocation Group","description":"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. \n","tags":["tradingFaAllocationManagement"],"responses":{"200":{"description":"Returns details of the allocation group.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/allocationGroup"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of an existing allocation group."}},"required":["name"]}}}}}},"/v1/api/fa/fa-preset/get":{"post":{"operationId":"getModelPresets","summary":"Get Model Preset","description":"Get the preset behavior for model rebalancing.","tags":["tradingFaModelPortfolios"],"responses":{"200":{"description":"Successfully retrieve preset details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/modelPresetsResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"reqID":{"type":"integer","format":"int64","description":"Request identifier to uniquely track a request."}},"required":["reqID"]}}}}}},"/v1/api/fa/model/accounts-details":{"post":{"operationId":"getAccountsInModel","summary":"Get Models Accounts","description":"Request all accounts held within a model.","tags":["tradingFaModelPortfolios"],"responses":{"200":{"description":"Successfully retrieve account details of in a model.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Trading FA Model Portfolios_getAccountsInModel_Response_200"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"calcPnls":{"type":"boolean","description":"Determine if Profit and Loss values"},"model":{"type":"string","description":"Request model to pull account details from."},"reqID":{"type":"integer","format":"int64","description":"Request identifier to uniquely track a request."}}}}}}}},"/v1/api/fa/model/invest-divest":{"post":{"operationId":"setAccountinvestmentInModel","summary":"Invest Account Into Model","description":"Assign an account and the amount of cash to allocate into a model.","tags":["tradingFaModelPortfolios"],"responses":{"200":{"description":"Successfully submitted model investment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Trading FA Model Portfolios_setAccountinvestmentInModel_Response_200"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"reqID":{"type":"integer","format":"int64","description":"Request identifier to uniquely track a request."},"model":{"type":"string","description":"Define the model to invest accounts into."},"accountList":{"type":"array","items":{"$ref":"#/components/schemas/V1ApiFaModelInvestDivestPostRequestBodyContentApplicationJsonSchemaAccountListItems"},"description":"Collection of accounts to invest in a model."}}}}}}}},"/v1/api/fa/model/list":{"post":{"operationId":"getAllmodels","summary":"Request All Models","description":"Retrieve summaries for all models under the advisor account.","tags":["tradingFaModelPortfolios"],"responses":{"200":{"description":"Successfully retrieve the model list","content":{"application/json":{"schema":{"$ref":"#/components/schemas/modelListResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"reqID":{"type":"integer","format":"int64","description":"Request identifier to uniquely track a request."}},"required":["reqID"]}}}}}},"/v1/api/fa/model/positions":{"post":{"operationId":"getAllModelPositions","summary":"Request Model Positions","description":"Request all positions held within the model.","tags":["tradingFaModelPortfolios"],"responses":{"200":{"description":"Successfully retrieve position details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/modelPositionResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"reqID":{"type":"integer","format":"int64","description":"Request identifier to uniquely track a request."},"model":{"type":"string","description":"Name of your model."},"sortField":{"$ref":"#/components/schemas/V1ApiFaModelPositionsPostRequestBodyContentApplicationJsonSchemaSortField","description":"Field to sort the response by.\n  * `actual` - Current actual model allocation for the instrument.\n  * `actualRangeMax` - Maximum actual model allocation allowed for the instrument.\n  * `actualRangeMin` - Minimum actual model allocation allowed for the instrument.\n  * `ccy` - Currency of the instrument.\n  * `conid` - Contract identifier, or conid.\n  * `dlv` - Market value.\n  * `instrumentImbalance` - How far an instrument's actual allocation is from its model.\n  * `instrument` - Symbol of the security.\n  * `mv` - Market value of the model position.\n  * `position` - Number of shares held by the model.\n  * `target` - Target percentage of an instrument held within a model.\n"},"sortDirection":{"$ref":"#/components/schemas/V1ApiFaModelPositionsPostRequestBodyContentApplicationJsonSchemaSortDirection","description":"Direction to sort the request by.\n * `ASC` - Sort from greatest to smallest.\n * `DESC` - Sort from smallest to greatest.\n"},"limit":{"type":"integer","format":"int64","description":"Maximum number of positions to return."}}}}}}}},"/v1/api/fa/model/summary":{"post":{"operationId":"getModelSummarySingle","summary":"Request Model Summary","description":"Request a summary for a single model.","tags":["tradingFaModelPortfolios"],"responses":{"200":{"description":"Successfully retrieve model summary.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/modelSummaryResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"reqID":{"type":"integer","format":"int64","description":"Request identifier to uniquely track a request."},"model":{"type":"string","description":"Name of your model."}}}}}}}},"/v1/api/fa/model/save":{"post":{"operationId":"setModelTargetPositions","summary":"Set Model Allocations","description":"Create or Modify a model's target positions.","tags":["tradingFaModelPortfolios"],"responses":{"200":{"description":"Successfully saved a model","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Trading FA Model Portfolios_setModelTargetPositions_Response_200"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"cashTargets":{"type":"array","items":{"$ref":"#/components/schemas/V1ApiFaModelSavePostRequestBodyContentApplicationJsonSchemaCashTargetsItems"},"description":"Array target cash objects"},"desc":{"type":"string","description":"Personal description of model to read in IBKR GUI elements."},"isStatic":{"type":"boolean","description":"Determine if investing and rebalancing should be handled statically or dynamically.\n * `true` - Static models will always use the original targets.\n * `false` - Dynamic models will adjust allocation in response to market movements.\n"},"model":{"type":"string","description":"Name of your model."},"positionTargets":{"type":"array","items":{"$ref":"#/components/schemas/V1ApiFaModelSavePostRequestBodyContentApplicationJsonSchemaPositionTargetsItems"},"description":"List containing all contracts to hold in the model."},"reqID":{"type":"integer","format":"int64","description":"Request identifier to uniquely track a request."}},"required":["cashTargets","desc","isStatic","model","positionTargets","reqID"]}}}}}},"/v1/api/fa/fa-preset/save":{"post":{"operationId":"setModelPresets","summary":"Set Model Preset","description":"Set the preset behavior for models.","tags":["tradingFaModelPortfolios"],"responses":{"200":{"description":"Successfully retrieve preset details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Trading FA Model Portfolios_setModelPresets_Response_200"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/modelPresetsResponse"}}}}}},"/v1/api/fa/model/submit-transfers":{"post":{"operationId":"submitModelOrders","summary":"Submit Transfers","description":"Submit all pending orders to the models. This is similar to the Model page's Submit All Orders selection.","tags":["tradingFaModelPortfolios"],"responses":{"200":{"description":"Successfully transmit all orders.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Trading FA Model Portfolios_submitModelOrders_Response_200"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"reqID":{"type":"integer","format":"int64","description":"Request identifier to uniquely track a request."},"fpOrderId":{"type":"integer","format":"int64","description":"Order identifier to monitor the order transmissions. Will be set to a valid id if and only if any transfers are present in the response. Otherwise, -1 is returned."}}}}}}}},"/v1/api/fa/model/invest-divest-positions":{"post":{"operationId":"getInvestedAccountsInModel","summary":"Summary Of Accounts Invested In The Model","description":"Request the list of all accounts already invested in the provided model and a summary of their investment.","tags":["tradingFaModelPortfolios"],"responses":{"200":{"description":"Successfully retrieve preset details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getInvestedAccountsSummary"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"reqID":{"type":"integer","format":"int64","description":"Request identifier to uniquely track a request."},"model":{"type":"string","description":"Define the model to retrieve accounts from."},"subscriptionStatus":{"type":"integer","format":"int64","description":"Describes if the model is in polling mode."}}}}}}}},"/v1/api/fyi/deliveryoptions/{deviceId}":{"delete":{"operationId":"deleteFyiDevice","summary":"Delete A Device","description":"Delete a specific device from our saved list of notification devices.","tags":["tradingFyIsAndNotifications"],"parameters":[{"name":"deviceId","in":"path","required":true,"schema":{"description":"Any type"}}],"responses":{"200":{"description":"No response message is returned. Instead, you will only receive an empty string with a 200 OK status code indicating a successfully deleted account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Trading FYIs and Notifications_deleteFyiDevice_Response_200"}}}}}}},"/v1/api/fyi/deliveryoptions":{"get":{"operationId":"getFyiDelivery","summary":"Get Delivery Options","description":"Options for sending fyis to email and other devices.","tags":["tradingFyIsAndNotifications"],"responses":{"200":{"description":"Successfully retrieve preset details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/deliveryOptions"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/fyi/disclaimer/{typecode}":{"get":{"operationId":"getFyiDisclaimerss","summary":"Get Disclaimers By FYI Type","description":"Receive additional disclaimers based on the specified typecode.","tags":["tradingFyIsAndNotifications"],"parameters":[{"name":"typecode","in":"path","required":true,"schema":{"$ref":"#/components/schemas/typecodes"}}],"responses":{"200":{"description":"Successfully disclaimer details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/disclaimerInfo"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}},"put":{"operationId":"readFyiDisclaimer","summary":"Mark FYI Disclaimer Read","description":"Mark a specific disclaimer message as read.","tags":["tradingFyIsAndNotifications"],"parameters":[{"name":"typecode","in":"path","required":true,"schema":{"$ref":"#/components/schemas/typecodes"}}],"responses":{"200":{"description":"Successfully marked as read","content":{"application/json":{"schema":{"$ref":"#/components/schemas/fyiVT"}}}},"400":{"description":"Missing, empty, non-numeric, or out-of-range parameter. The `error` field is always prefixed with `Bad Request:`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/fyi/settings":{"get":{"operationId":"getFyiSettings","summary":"Get Notification Settings","description":"Return the current choices of subscriptions for notifications.","tags":["tradingFyIsAndNotifications"],"responses":{"200":{"description":"Indicates data is being returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/fyiSettings"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/fyi/unreadnumber":{"get":{"operationId":"getUnreadFyis","summary":"Get Number Of Unread Notifications","description":"Returns the total number of unread notifications","tags":["tradingFyIsAndNotifications"],"responses":{"200":{"description":"Indicates data is being returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Trading FYIs and Notifications_getUnreadFyis_Response_200"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"423":{"description":"Return if called too frequently. Should not be called more than 1 time in 5 minutes","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetUnreadFyisRequestLockedError"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/fyi/notifications":{"get":{"operationId":"getAllFyis","summary":"List All Notifications","description":"Get a list of available notifications.","tags":["tradingFyIsAndNotifications"],"parameters":[{"name":"max","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"include","in":"query","required":false,"schema":{"description":"Any type"}},{"name":"exclude","in":"query","required":false,"schema":{"description":"Any type"}},{"name":"id","in":"query","required":false,"schema":{"description":"Any type"}}],"responses":{"200":{"description":"Successfully enabled or disabled your email notifications.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/notifications"}}}},"400":{"description":"Missing, empty, non-numeric, or out-of-range parameter. The `error` field is always prefixed with `Bad Request:`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/fyi/notifications/{notificationId}":{"put":{"operationId":"readFyiNotification","summary":"Mark Notification Read","description":"Mark a particular notification message as read or unread.","tags":["tradingFyIsAndNotifications"],"parameters":[{"name":"notificationId","in":"path","required":true,"schema":{"description":"Any type"}}],"responses":{"200":{"description":"Successfully enabled or disabled your email notifications.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/notificationReadAcknowledge"}}}},"400":{"description":"Missing, empty, non-numeric, or out-of-range parameter. The `error` field is always prefixed with `Bad Request:`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/fyi/settings/{typecode}":{"post":{"operationId":"modifyFyiNotification","summary":"Modify FYI Notifications","description":"Enable or disable group of notifications by the specific typecode.","tags":["tradingFyIsAndNotifications"],"parameters":[{"name":"typecode","in":"path","required":true,"schema":{"$ref":"#/components/schemas/typecodes"}}],"responses":{"200":{"description":"Successfully retrieve preset details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/fyiVT"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"the notification should be enabled or disabled."}}}}}}}},"/v1/api/fyi/deliveryoptions/device":{"post":{"operationId":"modifyFyiDelivery","summary":"Toggle Delivery To A Device","description":"Choose whether a particular device is enabled or disabled.","tags":["tradingFyIsAndNotifications"],"responses":{"200":{"description":"Successfully retrieve preset details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/fyiVT"}}}},"400":{"description":"Missing, empty, non-numeric, or out-of-range parameter. The `error` field is always prefixed with `Bad Request:`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/fyiEnableDeviceOption"}}}}}},"/v1/api/fyi/deliveryoptions/email":{"put":{"operationId":"modifyFyiEmails","summary":"Toggle Email Delivery","description":"Enable or disable your account's primary email to receive notifications.","tags":["tradingFyIsAndNotifications"],"parameters":[{"name":"enabled","in":"query","required":true,"schema":{"description":"Any type"}}],"responses":{"200":{"description":"Successfully enabled or disabled your email notifications.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/fyiVT"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/iserver/marketdata/unsubscribe":{"post":{"operationId":"closeMdStream","summary":"Close A Backend Data Stream","description":"Instruct IServer to close its backend stream for the instrument when real-time snapshots are no longer needed.","tags":["tradingMarketData"],"responses":{"200":{"description":"Acknowledges a successful request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Trading Market Data_closeMdStream_Response_200"}}}},"400":{"description":"Missing, empty, non-numeric, or out-of-range parameter. The `error` field is always prefixed with `Bad Request:`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"conid":{"type":"integer","format":"int64","description":"The IB contract ID of the instrument whose market data feed is to be unsubscribed."}}}}}}}},"/v1/api/iserver/marketdata/unsubscribeall":{"get":{"operationId":"closeAllMdStreams","summary":"Close All Backend Data Streams","description":"Instruct IServer to close all of its open backend data streams for all instruments.","tags":["tradingMarketData"],"responses":{"200":{"description":"Indicates a successful request to unsubscribe all streams.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Trading Market Data_closeAllMdStreams_Response_200"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/iserver/marketdata/history":{"get":{"operationId":"getMdHistory","summary":"Historical OHLC Bar Data","description":"Request historical data for an instrument in the form of OHLC bars.","tags":["tradingMarketData"],"parameters":[{"name":"conid","in":"query","description":"IB contract ID of the requested instrument.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"period","in":"query","description":"A time duration away from startTime into the future to be divided into bars of the specified width. Supported Period Sizes\n  * `min` - Minutes\n  * `h` - Hour(s)\n  * `d` - Day(s)\n  * `w` - Week(s)\n  * `m` - Month(s)\n  * `y` - Year(s)\n","required":true,"schema":{"type":"string","default":"1d"}},{"name":"bar","in":"query","description":"The width of the bars into which the interval determined by period and startTime will be divided. It is not required that bar evenly divide period; partial bars can be returned. Supported Bar Sizes\n  * `S` - Second(s)\n  * `min` - Minute(s)\n  * `h` - Hour(s)\n  * `d` - Day(s)\n  * `w` - Week(s)\n  * `m` - Month(s)\n","required":true,"schema":{"type":"string","default":"1min"}},{"name":"exchange","in":"query","description":"Exchange (or SMART) from which data is requested.","required":false,"schema":{"type":"string"}},{"name":"outsideRth","in":"query","description":"Indicates whether data outside of regular trading hours should be included in response.","required":false,"schema":{"type":"boolean","default":false}},{"name":"startTime","in":"query","description":"A fixed UTC date-time reference point for the historical data request, from which the specified period extends. Format is YYYYMMDD-hh:mm:ss. If omitted, the current time is used, and direction must be omitted or 1.","required":false,"schema":{"$ref":"#/components/schemas/utcDateTime"}},{"name":"direction","in":"query","description":"Indicates whether data should begin or end at the start time.\n  * `-1` - Historical data will begin away from the start time, ending at the current time/startTime.\n  * `1` - Historical data begins at the start time, moving towards the current time. Only supported when startTime is included.\n","required":false,"schema":{"$ref":"#/components/schemas/V1ApiIserverMarketdataHistoryGetParametersDirection","default":-1}},{"name":"source","in":"query","description":"The type of data to be returned in the historical bars. Supported Bar Sizes\n  * `Bid_Ask` - The OHLC bid/ask values.\n  * `Last` - The OHLC trade values.\n  * `Midpoint` - The OHLC of the Bid-Ask midpoint.\n","required":false,"schema":{"type":"string","default":"Last"}}],"responses":{"200":{"description":"Historical data query successfully returned data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Trading Market Data_getMdHistory_Response_200"}}}},"400":{"description":"Missing, empty, non-numeric, or out-of-range parameter. The `error` field is always prefixed with `Bad Request:`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/iserver/marketdata/snapshot":{"get":{"operationId":"getMdSnapshot","summary":"Live Market Data Snapshot","description":"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.\n","tags":["tradingMarketData"],"parameters":[{"name":"conids","in":"query","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"schema":{"$ref":"#/components/schemas/mdFields"}}],"responses":{"200":{"description":"Successfully requested market data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/iserverSnapshot"}}}},"400":{"description":"Missing, empty, non-numeric, or out-of-range parameter. The `error` field is always prefixed with `Bad Request:`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/iserver/account/{accountId}/order/{orderId}":{"delete":{"operationId":"cancelOpenOrder","summary":"Cancel An Open Order","description":"Cancel an existing, unfilled order.","tags":["tradingOrders"],"parameters":[{"name":"accountId","in":"path","description":"The account to which the order will clear.","required":true,"schema":{"type":"string"}},{"name":"orderId","in":"path","description":"The IB-assigned order ID of the desired order ticket.","required":true,"schema":{"type":"string"}},{"name":"extOperator","in":"query","description":"ExtOperator is used to identify external operator.","required":false,"schema":{"type":"string"}},{"name":"manualIndicator","in":"query","description":"For all orders for US Futures products, clients must submit this flag to indicate whether the order was originated manually (by a natural person) or automatically (by an automated trading system transmitting orders without human intervention). Submit a True value to indicate a manually originated order, and submit a False value to indicate an automated order. Orders for USFUT products that do not include this field will be rejected.","required":false,"schema":{"type":"boolean"}},{"name":"manualCancelTime","in":"query","description":"Time of manual cancel.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Status of submission","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Trading Orders_cancelOpenOrder_Response_200"}}}},"400":{"description":"Missing, empty, non-numeric, or out-of-range parameter. The `error` field is always prefixed with `Bad Request:`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}},"post":{"operationId":"modifyOpenOrder","summary":"Modify Open Order","description":"Modify an existing, unfilled order.","tags":["tradingOrders"],"parameters":[{"name":"accountId","in":"path","description":"The account to which the order will clear.","required":true,"schema":{"type":"string"}},{"name":"orderId","in":"path","description":"The IB-assigned order ID of the desired order ticket.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Status of submission","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Trading Orders_modifyOpenOrder_Response_200"}}}},"400":{"description":"Missing, empty, non-numeric, or out-of-range parameter. The `error` field is always prefixed with `Bad Request:`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/singleOrderSubmissionRequest"}}}}}},"/v1/api/iserver/reply/{replyId}":{"post":{"operationId":"confirmOrderReply","summary":"Confirm Order Reply Message","description":"Confirm an order reply message and continue with submission of order ticket.","tags":["tradingOrders"],"parameters":[{"name":"replyId","in":"path","description":"The UUID of the reply message to be confirmed, obtained from an order submission response. This is delivered from the POST /iserver/account/{accountId}/orders endpoint when triggering certain warning messages. \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Status of reply","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Trading Orders_confirmOrderReply_Response_200"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"confirmed":{"type":"boolean","description":"Value of true answers the question in the affirmative and proceeds with order submission."}}}}}}}},"/v1/api/iserver/notification":{"post":{"operationId":"ackServerPrompt","summary":"Dismiss Server Prompt","description":"Respond to a server prompt received via ntf websocket message.","tags":["tradingOrders"],"responses":{"200":{"description":"Status of submitted prompt","content":{"application/json":{"schema":{"type":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"orderId":{"type":"integer","format":"int64","description":"IB-assigned order identifier obtained from the ntf websocket message that delivered the server prompt."},"reqId":{"type":"string","description":"IB-assigned request identifier obtained from the ntf websocket message that delivered the server prompt."},"text":{"type":"string","description":"The selected value from the \"options\" array delivered in the server prompt ntf websocket message."}}}}}}}},"/v1/api/iserver/account/orders":{"get":{"operationId":"getOpenOrders","summary":"List Open Orders","description":"Returns open orders and filled or cancelled orders submitted during the current brokerage session.","tags":["tradingOrders"],"parameters":[{"name":"filters","in":"query","description":"Filter results using a comma-separated list of Order Status values. Also accepts a value to sort results by time.","required":false,"schema":{"$ref":"#/components/schemas/V1ApiIserverAccountOrdersGetParametersFilters"}},{"name":"force","in":"query","description":"Instructs IB to clear cache of orders and obtain updated view from brokerage backend. Response will be an empty array.","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Orders for a specific account","content":{"application/json":{"schema":{"$ref":"#/components/schemas/liveOrdersResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/iserver/account/{accountId}/orders/whatif":{"post":{"operationId":"previewMarginImpact","summary":"New Order Preview","description":"Preview the projected effects of an order ticket or bracket of orders, including cost and changes to margin and account equity.","tags":["tradingOrders"],"parameters":[{"name":"accountId","in":"path","description":"The account to which the order will clear.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Order Preview","content":{"application/json":{"schema":{"$ref":"#/components/schemas/orderPreview"}}}},"400":{"description":"Missing, empty, non-numeric, or out-of-range parameter. The `error` field is always prefixed with `Bad Request:`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ordersSubmissionRequest"}}}}}},"/v1/api/iserver/questions/suppress/reset":{"post":{"operationId":"resetOrderSuppression","summary":"Reset Order Reply Message Suppression","description":"Removes suppression of all order reply messages that were previously suppressed in the current brokerage session.","tags":["tradingOrders"],"responses":{"200":{"description":"Request's status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Trading Orders_resetOrderSuppression_Response_200"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/iserver/account/order/status/{orderId}":{"get":{"operationId":"getOrderStatus","summary":"Status Of A Single Order","description":"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.\n","tags":["tradingOrders"],"parameters":[{"name":"orderId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"order status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Trading Orders_getOrderStatus_Response_200"}}}},"400":{"description":"Missing, empty, non-numeric, or out-of-range parameter. The `error` field is always prefixed with `Bad Request:`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/iserver/account/{accountId}/orders":{"post":{"operationId":"submitNewOrder","summary":"Submit New Order","description":"Submit a new order(s) ticket, bracket, or OCA group.","tags":["tradingOrders"],"parameters":[{"name":"accountId","in":"path","description":"The account to which the order will clear.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Order submission response (success, error, reply is required or order reject)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Trading Orders_submitNewOrder_Response_200"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ordersSubmissionRequest"}}}}}},"/v1/api/iserver/questions/suppress":{"post":{"operationId":"suppressOrderReplies","summary":"Suppress Order Reply Messages","description":"Suppress the specified order reply messages for the duration of the brokerage session.","tags":["tradingOrders"],"responses":{"200":{"description":"Request's status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Trading Orders_suppressOrderReplies_Response_200"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"messageIds":{"type":"array","items":{"$ref":"#/components/schemas/V1ApiIserverQuestionsSuppressPostRequestBodyContentApplicationJsonSchemaMessageIdsItems"},"description":"Array of order reply messageId identifier strings to be suppressed."}}}}}}}},"/v1/api/iserver/account/trades":{"get":{"operationId":"getTradeHistory","summary":"Trade History","description":"Retrieve a list of trades, up to a maximum of 7 days prior.","tags":["tradingOrders"],"parameters":[{"name":"days","in":"query","description":"The number of prior days prior to include in response, up to a maximum of 7. If omitted, only the current day's executions will be returned.","required":false,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"trades","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tradesResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/portfolio/{accountId}/allocation":{"get":{"operationId":"getAssetAllocation","summary":"Account Allocations","description":"Get an account's allocations by asset class, sector group, and sector.","tags":["tradingPortfolio"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"model","in":"query","required":false,"schema":{"description":"Any type"}}],"responses":{"200":{"description":"response with allocations","content":{"application/json":{"schema":{"$ref":"#/components/schemas/portfolioAllocations"}}}},"400":{"description":"Missing, empty, non-numeric, or out-of-range parameter. The `error` field is always prefixed with `Bad Request:`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/portfolio/{accountId}/meta":{"get":{"operationId":"getPortfolioMetadata","summary":"Account Attributes","description":"Get a single account's attributes and capabilities.","tags":["tradingPortfolio"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"An account's attributes","content":{"application/json":{"schema":{"$ref":"#/components/schemas/accountAttributes"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/portfolio/{accountId}/ledger":{"get":{"operationId":"getPortfolioLedger","summary":"Account Ledger","description":"Get the given account's ledger data detailing its balances by currency.","tags":["tradingPortfolio"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"ledger","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ledger"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/portfolio/{accountId}/summary":{"get":{"operationId":"getPortfolioSummary","summary":"Account Portfolio Summary","description":"Returns detailed summary of account values, by segment where appropriate.","tags":["tradingPortfolio"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"response with summary definitions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/portfolioSummary"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/portfolio/{accountId}/position/{conid}":{"get":{"operationId":"getPositionByConid","summary":"Account Position In An Instrument","description":"Get position for a given instrument in a single account.","tags":["tradingPortfolio"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"conid","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Position details by conid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/individualPositionArray"}}}},"400":{"description":"Missing, empty, non-numeric, or out-of-range parameter. The `error` field is always prefixed with `Bad Request:`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/portfolio/{accountId}/positions/{pageId}":{"get":{"operationId":"getPaginatedPositions","summary":"Account Positions","description":"Get all positions in an account.","tags":["tradingPortfolio"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"pageId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"model","in":"query","required":false,"schema":{"description":"Any type"}},{"name":"sort","in":"query","required":false,"schema":{"description":"Any type"}},{"name":"direction","in":"query","required":false,"schema":{"description":"Any type"}},{"name":"waitForSecDef","in":"query","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"positions","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/individualPosition"}}}}},"400":{"description":"Missing, empty, non-numeric, or out-of-range parameter. The `error` field is always prefixed with `Bad Request:`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/portfolio2/{accountId}/positions":{"get":{"operationId":"getUncachedPositions","summary":"Account Positions (NEW)","description":"Returns a list of positions for the given account. /v1/api/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.\n","tags":["tradingPortfolio"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"model","in":"query","required":false,"schema":{"type":"string"}},{"name":"direction","in":"query","required":false,"schema":{"$ref":"#/components/schemas/V1ApiPortfolio2AccountIdPositionsGetParametersDirection","default":"a"}}],"responses":{"200":{"description":"response with position details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/portfolio2Positions"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/portfolio/positions/{conid}":{"get":{"operationId":"getAllAccountsForConid","summary":"All Account Positions In An Instrument","description":"Get positions in accounts for a given instrument (no secDef await control)","tags":["tradingPortfolio"],"parameters":[{"name":"conid","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Object containing positions in the requested conid broken out by account.","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/individualPosition"}}}}},"400":{"description":"Missing, empty, non-numeric, or out-of-range parameter. The `error` field is always prefixed with `Bad Request:`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/portfolio/{accountId}/combo/positions":{"get":{"operationId":"getComboPositions","summary":"Combination Positions","description":"Provides all positions held in the account acquired as a combination, including values such as ratios, size, and market value.","tags":["tradingPortfolio"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"nocache","in":"query","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"response with combo position definitions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/comboPositionResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/portfolio/accounts":{"get":{"operationId":"getAllAccounts","summary":"List All Accounts","description":"return accounts","tags":["tradingPortfolio"],"responses":{"200":{"description":"returned array with user account","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/accountAttributes"}}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/portfolio/subaccounts":{"get":{"operationId":"getAllSubaccounts","summary":"List All Subaccounts","description":"Retrieve attributes of the subaccounts in the account structure.","tags":["tradingPortfolio"],"responses":{"200":{"description":"Array of objects representing accounts in the structure.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/accountAttributes"}}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/portfolio/subaccounts2":{"get":{"operationId":"getManySubaccounts","summary":"Portfolio Subaccounts (Large Account Structures)","description":"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.\n","tags":["tradingPortfolio"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"nocache","in":"query","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"response with subaccount definitions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/subaccounts2Response"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/portfolio/{accountId}/positions/invalidate":{"post":{"operationId":"invalidatePositionCache","summary":"Refresh Position Cache","description":"Instructs IB to discard cached portfolio positions for a given account, so that the next request for positions delivers freshly obtained data.","tags":["tradingPortfolio"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"status of invalidation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Trading Portfolio_invalidatePositionCache_Response_200"}}}},"400":{"description":"Missing, empty, non-numeric, or out-of-range parameter. The `error` field is always prefixed with `Bad Request:`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/pa/performance":{"post":{"operationId":"getSinglePerformancePeriod","summary":"Account Performance","description":"Returns the performance (MTM) for the given accounts, if more than one account is passed, the result is consolidated.","tags":["tradingPortfolioAnalyst"],"responses":{"200":{"description":"An array of objects detailing contract information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/performanceResponse"}}}},"400":{"description":"Missing, empty, non-numeric, or out-of-range parameter. The `error` field is always prefixed with `Bad Request:`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"acctIds":{"type":"array","items":{"description":"Any type"},"description":"An array of strings containing each account identifier to retrieve performance details for."},"period":{"$ref":"#/components/schemas/V1ApiPaPerformancePostRequestBodyContentApplicationJsonSchemaPeriod","default":"12M","description":"Specify the period for which the account should be analyzed. Available period lengths:\n  * `1D` - The last 24 hours.\n  * `7D` - The last 7 full days.\n  * `MTD` - Performance since the 1st of the month.\n  * `1M` - A full calendar month from the last full trade day.\n  * `3M` - 3 full calendar months from the last full trade day.\n  * `6M` - 6 full calendar months from the last full trade day.\n  * `12M` - 12 full calendar month from the last full trade day.\n  * `YTD` - Performance since January 1st.\n"}}}}}}}},"/v1/api/pa/allperiods":{"post":{"operationId":"getPerformanceAllPeriods","summary":"Account Performance (All Time Periods)","description":"Returns the performance (MTM) for the given accounts, if more than one account is passed, the result is consolidated.","tags":["tradingPortfolioAnalyst"],"parameters":[{"name":"param","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"An array of objects detailing contract information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/detailedContractInformation"}}}},"400":{"description":"Missing, empty, non-numeric, or out-of-range parameter. The `error` field is always prefixed with `Bad Request:`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"acctIds":{"type":"array","items":{"type":"string"},"description":"An array of strings containing each account identifier to retrieve performance details for."}}}}}}}},"/v1/api/pa/allocation":{"post":{"operationId":"createAllocation","summary":"Portfolio Allocation","description":"Returns consolidated portfolio allocation by Financial Instrument, Asset Class, Sector, Region, or Country for a given set of accounts. Result is aggregated for the included accounts. Current day data is supported only if all included accounts have the same base currency as specified in the currency parameter.\n","tags":["tradingPortfolioAnalyst"],"responses":{"200":{"description":"Returns the allocation breakdown for the specified accounts.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/allocationResponse"}}}},"400":{"description":"Missing, empty, non-numeric, or out-of-range parameter. The `error` field is always prefixed with `Bad Request:`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"acctIds":{"type":"array","items":{"type":"string"}},"type":{"$ref":"#/components/schemas/V1ApiPaAllocationPostRequestBodyContentApplicationJsonSchemaType","description":"The allocation category type. One of FINANCIAL_INSTRUMENT, ASSET_CLASS, SECTOR, REGION, COUNTRY, or ALL. Case insensitive. When ALL is specified, the response includes allocations for every category type.\n"},"currency":{"type":"string","default":"USD","description":"Three character currency code. The base currency to use for the NAV calculation in the response.\n"},"date":{"type":"string","description":"Optional. Formatted as yyyymmdd. If specified, should be prior to the current day. If not specified, request will be for the current day. If the request is for current day and current day data is not available, then the response will be for the previous business day.\n"},"model":{"type":"string","description":"Optional. Model portfolio name to use for the allocation calculation."}},"required":["acctIds","type"]}}}}}},"/v1/api/pa/transactions":{"post":{"operationId":"getTransactions","summary":"Transaction History","description":"Transaction history for a given number of conids and accounts. Types of transactions include dividend payments, buy and sell transactions, transfers.","tags":["tradingPortfolioAnalyst"],"responses":{"200":{"description":"An array of objects detailing contract information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/transactionsResponse"}}}},"400":{"description":"Missing, empty, non-numeric, or out-of-range parameter. The `error` field is always prefixed with `Bad Request:`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"acctIds":{"type":"array","items":{"type":"string"}},"conids":{"type":"array","items":{"type":"integer","format":"int64"}},"currency":{"type":"string","default":"USD","description":"Define the currency to display price amounts with."},"days":{"type":"integer","format":"int64","default":90,"description":"Specify the number of days to receive transaction data for."}}}}}}}},"/v1/api/iserver/scanner/params":{"get":{"operationId":"getScannerParameters","summary":"Get Valid IServer Scanner Parameters","description":"Returns an xml file containing all available parameters to be sent for the Iserver scanner request.","tags":["tradingScanner"],"responses":{"200":{"description":"An array of objects detailing contract information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/iserverScannerParams"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/iserver/scanner/run":{"post":{"operationId":"getScannerResults","summary":"Run An IServer Market Scanner","description":"Searches for contracts according to the filters specified in /iserver/scanner/params endpoint.","tags":["tradingScanner"],"responses":{"200":{"description":"An array of objects detailing contract information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/iserverScannerRunResponse"}}}},"400":{"description":"Missing, empty, non-numeric, or out-of-range parameter. The `error` field is always prefixed with `Bad Request:`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iserverScannerRunRequest"}}}}}},"/v1/api/tickle":{"post":{"operationId":"getSessionToken","summary":"Brokerage Keep-Alive Ping","description":"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.","tags":["tradingSession"],"responses":{"200":{"description":"An array of objects detailing contract information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tickleResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/api/iserver/auth/status":{"post":{"operationId":"getBrokerageStatus","summary":"Brokerage Session Status","description":"Current Authentication status to the Brokerage system. Market Data and Trading is not possible if not authenticated.","tags":["tradingSession"],"responses":{"200":{"description":"Detailed status of the Brokerage session","content":{"application/json":{"schema":{"$ref":"#/components/schemas/brokerageSessionStatus"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/api/iserver/auth/ssodh/init":{"post":{"operationId":"initializeSession","summary":"Initialize Brokerage Session","description":"After retrieving the access token and subsequent Live Session Token, customers can initialize their brokerage session with the ssodh/init endpoint.","tags":["tradingSession"],"responses":{"200":{"description":"An array of objects detailing contract information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/brokerageSessionStatus"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/brokerageSessionInitRequest"}}}}}},"/v1/api/logout":{"post":{"operationId":"logout","summary":"Terminate Web API Session","description":"Logs the user out of the gateway session. Any further activity requires re-authentication. Discard client-side cookies upon logout.\n","tags":["tradingSession"],"responses":{"200":{"description":"An array of objects detailing contract information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Trading Session_logout_Response_200"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/api/sso/validate":{"get":{"operationId":"getSessionValidation","summary":"Validate SSO Web API Session","description":"Validates the current session for the SSO user.","tags":["tradingSession"],"responses":{"200":{"description":"An array of objects detailing contract information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ssoValidateResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/api/iserver/watchlist":{"post":{"operationId":"postNewWatchlist","summary":"Create A Watchlist","description":"Create a named watchlist by submitting a set of conids.","tags":["tradingWatchlists"],"responses":{"200":{"description":"Watchlist creation successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Trading Watchlists_postNewWatchlist_Response_200"}}}},"400":{"description":"Missing, empty, non-numeric, or out-of-range parameter. The `error` field is always prefixed with `Bad Request:`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"requestBody":{"description":"Watchlist contents.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Must be a number, digits 0-9 only. Must be unique relative to other watchlist IDs."},"name":{"type":"string","description":"Arbitrary human-readable name to be displayed in TWS and Client Portal."},"rows":{"type":"array","items":{"$ref":"#/components/schemas/V1ApiIserverWatchlistPostRequestBodyContentApplicationJsonSchemaRowsItems"},"description":"Array of JSON objects corresponding to watchlist rows, one per instruments."}},"required":["id","name","rows"]}}}}},"delete":{"operationId":"deleteWatchlist","summary":"Delete A Saved Watchlist","description":"Delete a specified watchlist from the username's settings.","tags":["tradingWatchlists"],"parameters":[{"name":"id","in":"query","description":"Watchlist ID of the watchlist to be deleted.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful deletion of specified watchlist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/watchlistDeleteSuccess"}}}},"400":{"description":"Missing, empty, non-numeric, or out-of-range parameter. The `error` field is always prefixed with `Bad Request:`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}},"get":{"operationId":"getSpecificWatchlist","summary":"Return A Single Saved Watchlist","description":"Retrieve details of a single watchlist stored in the username's settings.","tags":["tradingWatchlists"],"parameters":[{"name":"id","in":"query","description":"Watchlist ID of the requested watchlist.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful deletion of specified watchlist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/singleWatchlist"}}}},"400":{"description":"Missing, empty, non-numeric, or out-of-range parameter. The `error` field is always prefixed with `Bad Request:`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/v1/api/iserver/watchlists":{"get":{"operationId":"getAllWatchlists","summary":"Return All Saved Watchlists","description":"Returns all saved watchlists stored on IB backend for the username in use in the current Web API session.","tags":["tradingWatchlists"],"parameters":[{"name":"SC","in":"query","description":"Can only be used with value USER_WATCHLIST, which returns only user-created watchlists and excludes those created by IB.","required":false,"schema":{"$ref":"#/components/schemas/V1ApiIserverWatchlistsGetParametersSc"}}],"responses":{"200":{"description":"Historical data query successfully returned data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/watchlistsResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests.  For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorOnlyResponse"}}}},"503":{"description":"service is unavailable. For example if request takes more than 10s due to some internal service unavailability,  request aborted and this status returned\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/gw/api/v1/accounts/{accountId}/tasks":{"post":{"operationId":"createAccountsTasks","summary":"Assign Tasks","description":"Task can be assigned from this api<br><br>**Scope**: `accounts.write`<br>**Security Policy**: `Signed JWT`","tags":["accountManagementAccounts"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Task can be assigned from this api","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TaskActionResponse"}}}}},"400":{"description":"Returns error description representing bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"401":{"description":"Returns error description representing access issue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"403":{"description":"Returns error description representing access issue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"500":{"description":"Returns error description representing internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"integer","format":"int64"}}}}}},"get":{"operationId":"getAccountsTasks","summary":"Get Registration Tasks","description":"Query registration tasks assigned to account and pending tasks that are required for account approval<br><br>**Scope**: `accounts.read`<br>**Security Policy**: `HTTPS`","tags":["accountManagementAccounts"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","required":false,"schema":{"$ref":"#/components/schemas/GwApiV1AccountsAccountIdTasksGetParametersType","default":"registration"}}],"responses":{"200":{"description":"Query registration tasks assigned to account and pending tasks that are required for account approval","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account Management Accounts_getAccountsTasks_Response_200"}}}},"400":{"description":"Returns error description representing bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"401":{"description":"Returns error description representing access issue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"403":{"description":"Returns error description representing access issue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"500":{"description":"Returns error description representing internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}}}},"patch":{"operationId":"updateAccountsTasks","summary":"Update Tasks Status","description":"Task status can be updated from this api<br><br>**Scope**: `accounts.write`<br>**Security Policy**: `Signed JWT`","tags":["accountManagementAccounts"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Task status can be updated from this api","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TaskActionResponse"}}}}},"400":{"description":"Returns error description representing bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"401":{"description":"Returns error description representing access issue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"403":{"description":"Returns error description representing access issue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"500":{"description":"Returns error description representing internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FormStatusUpdate"}}}}}}},"/gw/api/v1/accounts":{"post":{"operationId":"createAccounts","summary":"Create Account","description":"Submit account application. This will create brokerage account for the end user.<br><br>**Scope**: `accounts.write`<br>**Security Policy**: `Signed JWT`","tags":["accountManagementAccounts"],"responses":{"200":{"description":"Submit account application. This will create brokerage account for the end user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"}}}},"400":{"description":"Returns error description representing bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"401":{"description":"Returns error description representing access issue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"403":{"description":"Returns error description representing access issue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"422":{"description":"Request was rejected by the system due to a business rule or validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"}}}},"500":{"description":"Returns error description representing internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}}}},"get":{"operationId":"listAccounts","summary":"Retrieve Processed Application","description":"Retrieve the application request and IBKR response data based on IBKR accountId or externalId. Only available for accounts that originate via API<br><br>**Scope**: `accounts.read`<br>**Security Policy**: `HTTPS`","tags":["accountManagementAccounts"],"parameters":[{"name":"accountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"externalId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Retrieve the application request and IBKR response data based on IBKR accountId or externalId. Only available for accounts that originate via API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account Management Accounts_listAccounts_Response_200"}}}},"400":{"description":"Returns error description representing bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"401":{"description":"Returns error description representing access issue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"403":{"description":"Returns error description representing access issue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"500":{"description":"Returns error description representing internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}}}},"patch":{"operationId":"updateAccounts","summary":"Update Account","description":"Update information for an existing accountId<br><br>**Scope**: `accounts.write`<br>**Security Policy**: `Signed JWT`","tags":["accountManagementAccounts"],"responses":{"200":{"description":"Update information for an existing accountId","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"}}}},"400":{"description":"Returns error description representing bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"401":{"description":"Returns error description representing access issue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"403":{"description":"Returns error description representing access issue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"422":{"description":"Request was rejected by the system due to a business rule or validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"}}}},"500":{"description":"Returns error description representing internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}}}}},"/gw/api/v1/accounts/{accountId}/details":{"get":{"operationId":"getAccountsDetails","summary":"Get Account Information","description":"<br>**Scope**: `accounts.read`<br>**Security Policy**: `HTTPS`","tags":["accountManagementAccounts"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"View information associated with account including contact data, financial information and trading configuration.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountDetailsResponse"}}}},"400":{"description":"Returns error description representing bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"401":{"description":"Returns error description representing access issue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"403":{"description":"Returns error description representing access issue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"500":{"description":"Returns error description representing internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}}}}},"/gw/api/v1/accounts/status":{"get":{"operationId":"listAccountsStatus","summary":"Get Account Status: Bulk Request","description":"Query status of all accounts associated with `Client ID'<br><br>**Scope**: `accounts.read`<br>**Security Policy**: `HTTPS`","tags":["accountManagementAccounts"],"parameters":[{"name":"accountStatusRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/AccountStatusRequest"}}],"responses":{"200":{"description":"Query status of all accounts associated with `Client ID'","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountStatusBulkResponse"}}}},"400":{"description":"Returns error description representing bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"401":{"description":"Returns error description representing access issue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"403":{"description":"Returns error description representing access issue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"500":{"description":"Returns error description representing internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}}}}},"/gw/api/v1/accounts/{accountId}/login-messages":{"get":{"operationId":"getAccountsLoginMessages","summary":"Get Login Message By Account","description":"Query login messages assigned by accountId<br><br>**Scope**: `accounts.read`<br>**Security Policy**: `HTTPS`","tags":["accountManagementAccounts"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Query login messages assigned by accountId","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginMessageResponse"}}}},"400":{"description":"Returns error description representing bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"401":{"description":"Returns error description representing access issue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"403":{"description":"Returns error description representing access issue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"500":{"description":"Returns error description representing internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}}}}},"/gw/api/v1/accounts/login-messages":{"get":{"operationId":"listAccountsLoginMessages","summary":"Get Login Messages","description":"Query all accounts associated with `Client ID` that have incomplete login message<br><br>**Scope**: `accounts.read`<br>**Security Policy**: `HTTPS`","tags":["accountManagementAccounts"],"parameters":[{"name":"loginMessageRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/LoginMessageRequest"}}],"responses":{"200":{"description":"Query all accounts associated with `Client ID` that have incomplete login message","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginMessageResponse"}}}},"400":{"description":"Returns error description representing bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"401":{"description":"Returns error description representing access issue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"403":{"description":"Returns error description representing access issue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"500":{"description":"Returns error description representing internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}}}}},"/gw/api/v1/accounts/{accountId}/status":{"get":{"operationId":"getAccountsStatus","summary":"Get Status By Account","description":"Query status of account by accountId<br><br>**Scope**: `accounts.read`<br>**Security Policy**: `HTTPS`","tags":["accountManagementAccounts"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Query status of account by accountId.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountStatusResponse"}}}},"400":{"description":"Returns error description representing bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"401":{"description":"Returns error description representing access issue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"403":{"description":"Returns error description representing access issue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"500":{"description":"Returns error description representing internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}}}}},"/gw/api/v1/accounts/{accountId}/kyc":{"get":{"operationId":"getAccountsKyc","summary":"Retrieve Au10Tix URL","description":"Generate URL address to complete real-time KYC verification using Au10Tix<br><br>**Scope**: `accounts.read`<br>**Security Policy**: `HTTPS`","tags":["accountManagementAccounts"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Generate URL address to complete real-time KYC verification using Au10Tix","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Au10TixDetailResponse"}}}},"400":{"description":"Returns error description representing bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"401":{"description":"Returns error description representing access issue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"403":{"description":"Returns error description representing access issue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"500":{"description":"Returns error description representing internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}}}}},"/gw/api/v1/accounts/documents":{"post":{"operationId":"createAccountsDocuments","summary":"Submit General Agreements And Disclosures","description":"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.<ul><li>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.</li><li>This end-point will not process any Tax Form Documents. Tax Form document should be submitted with every application</li><li>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).</li></ul><br><br>**Scope**: `accounts.write`<br>**Security Policy**: `Signed JWT`","tags":["accountManagementAccounts"],"responses":{"200":{"description":"Submit standard agreements and disclosures","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"}}}},"400":{"description":"Returns error description representing bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"401":{"description":"Returns error description representing access issue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"403":{"description":"Returns error description representing access issue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"422":{"description":"Request was rejected by the system due to a business rule or validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"}}}},"500":{"description":"Returns error description representing internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}}}}},"/gw/api/v1/instructions/cancel":{"post":{"operationId":"createInstructionsCancel","summary":"Cancel Request","description":"Cancel request by instructionId.<br><br>**Scope**: `instructions.write`<br>**Security Policy**: `Signed JWT`","tags":["accountManagementBanking"],"parameters":[{"name":"client-id","in":"path","description":"The client's clientId","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Instruction successfully created and processed synchronously","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SynchronousInstructionResponse"}}}},"400":{"description":"Returns a Problem detail instance representing a bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingRequiredParameterResponse"}}}},"403":{"description":"Returns a Problem detail instance representing a forbidden request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenInstructionResponse"}}}},"422":{"description":"Returns a Problem detail instance representing a business error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessRejectResponse"}}}},"500":{"description":"Returns a Problem detail instance representing an internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"instructionType":{"$ref":"#/components/schemas/GwApiV1InstructionsCancelPostRequestBodyContentApplicationJsonSchemaInstructionType"},"instruction":{"$ref":"#/components/schemas/CancelInstruction"}},"required":["instructionType","instruction"]}}}}}},"/gw/api/v1/bank-instructions:bulk":{"post":{"operationId":"bulkBankInstructions","summary":"Creates Multiple Banking Instructions(ach, Delete, Micro-amount, Predefined-destination-instruction)","description":"<br>**Scope**: `bank-instructions.write`<br>**Security Policy**: `Signed JWT`","tags":["accountManagementBanking"],"parameters":[{"name":"client-id","in":"path","description":"The client's clientId","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Accepts all instructions in Bulk request to create them asynchronously","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsynchronousInstructionSetResponse"}}}},"400":{"description":"Returns a Problem detail instance representing a bad request. Returned even if only one instruction in the bulk upload has syntactical errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingRequiredParameterResponse"}}}},"500":{"description":"Unable to process request due to an Internal Error. Please try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}},"requestBody":{"description":"Create Bulk Banking Instructions request body","content":{"application/json":{"schema":{"type":"object","properties":{"instructionType":{"$ref":"#/components/schemas/GwApiV1BankInstructionsBulkPostRequestBodyContentApplicationJsonSchemaInstructionType"},"instructions":{"type":"array","items":{"description":"Any type"}}},"required":["instructionType","instructions"]}}}}}},"/gw/api/v1/instructions/cancel:bulk":{"post":{"operationId":"bulkInstructionsCancel","summary":"Creates Multiple Cancel Instructions","description":"<br>**Scope**: `instructions.write`<br>**Security Policy**: `Signed JWT`","tags":["accountManagementBanking"],"parameters":[{"name":"client-id","in":"path","description":"The client's clientId","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Accepts all instructions in Bulk request to create them asynchronously","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsynchronousInstructionSetResponse"}}}},"400":{"description":"Returns a Problem detail instance representing a bad request. Returned even if only one instruction in the bulk upload has syntactical errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingRequiredParameterResponse"}}}},"500":{"description":"Unable to process request due to an Internal Error. Please try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}},"requestBody":{"description":"Create Bulk Cancel Instructions request body","content":{"application/json":{"schema":{"type":"object","properties":{"instructionType":{"$ref":"#/components/schemas/GwApiV1InstructionsCancelBulkPostRequestBodyContentApplicationJsonSchemaInstructionType"},"instructions":{"type":"array","items":{"description":"Any type"}}},"required":["instructionType","instructions"]}}}}}},"/gw/api/v1/external-asset-transfers:bulk":{"post":{"operationId":"bulkExternalAssetTransfers","summary":"Creates Multiple External Asset Transfers (Fop, DWAC And Complex Asset Transfer)","description":"<br>**Scope**: `transfers.write`<br>**Security Policy**: `Signed JWT`","tags":["accountManagementBanking"],"parameters":[{"name":"client-id","in":"path","description":"The client's clientId","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Accepts all instructions in Bulk request to create them asynchronously","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsynchronousInstructionSetResponse"}}}},"400":{"description":"Returns a Problem detail instance representing a bad request. Returned even if only one instruction in the bulk upload has syntactical errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingRequiredParameterResponse"}}}},"500":{"description":"Unable to process request due to an Internal Error. Please try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}},"requestBody":{"description":"Create Bulk External Asset transfers (Fop, DWAC and Complex Asset Transfer) request body","content":{"application/json":{"schema":{"type":"object","properties":{"instructionType":{"$ref":"#/components/schemas/GwApiV1ExternalAssetTransfersBulkPostRequestBodyContentApplicationJsonSchemaInstructionType"},"instructions":{"type":"array","items":{"description":"Any type"}}},"required":["instructionType","instructions"]}}}}}},"/gw/api/v2/external-asset-transfers:bulk":{"post":{"operationId":"bulkExternalAssetTransfers_2","summary":"Creates Multiple External Asset Transfers (Fop, DWAC And Complex Asset Transfer)","description":"<br>**Scope**: `transfers.write`<br>**Security Policy**: `Signed JWT`","tags":["accountManagementBanking"],"parameters":[{"name":"client-id","in":"path","description":"The client's clientId","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Accepts all instructions in Bulk request to create them asynchronously","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsynchronousInstructionSetResponse"}}}},"400":{"description":"Returns a Problem detail instance representing a bad request. Returned even if only one instruction in the bulk upload has syntactical errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingRequiredParameterResponse"}}}},"500":{"description":"Unable to process request due to an Internal Error. Please try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}},"requestBody":{"description":"Create Bulk External Asset transfers (Fop, DWAC and Complex Asset Transfer) request body","content":{"application/json":{"schema":{"type":"object","properties":{"instructionType":{"$ref":"#/components/schemas/GwApiV2ExternalAssetTransfersBulkPostRequestBodyContentApplicationJsonSchemaInstructionType"},"instructions":{"type":"array","items":{"description":"Any type"}}},"required":["instructionType","instructions"]}}}}}},"/gw/api/v1/external-cash-transfers:bulk":{"post":{"operationId":"bulkExternalCashTransfers","summary":"Creates Multiple External Cash Transfers (Deposit And Withdraw Fund)","description":"<br>**Scope**: `transfers.write`<br>**Security Policy**: `Signed JWT`","tags":["accountManagementBanking"],"parameters":[{"name":"client-id","in":"path","description":"The client's clientId","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Accepts all instructions in Bulk request to create them asynchronously","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsynchronousInstructionSetResponse"}}}},"400":{"description":"Returns a Problem detail instance representing a bad request. Returned even if only one instruction in the bulk upload has syntactical errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingRequiredParameterResponse"}}}},"500":{"description":"Unable to process request due to an Internal Error. Please try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}},"requestBody":{"description":"Create Bulk External Cash transfers (Deposit and Withdraw fund) request body","content":{"application/json":{"schema":{"type":"object","properties":{"instructionType":{"$ref":"#/components/schemas/GwApiV1ExternalCashTransfersBulkPostRequestBodyContentApplicationJsonSchemaInstructionType"},"instructions":{"type":"array","items":{"description":"Any type"}}},"required":["instructionType","instructions"]}}}}}},"/gw/api/v1/internal-asset-transfers:bulk":{"post":{"operationId":"bulkInternalAssetTransfers","summary":"Creates Multiple Internal Asset Transfers Between The Provided Account Id Pairs","description":"<br>**Scope**: `transfers.write`<br>**Security Policy**: `Signed JWT`","tags":["accountManagementBanking"],"parameters":[{"name":"client-id","in":"path","description":"The client's clientId","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Accepts all instructions in Bulk request to create them asynchronously","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsynchronousInstructionSetResponse"}}}},"400":{"description":"Returns a Problem detail instance representing a bad request. Returned even if only one instruction in the bulk upload has syntactical errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingRequiredParameterResponse"}}}},"500":{"description":"Unable to process request due to an Internal Error. Please try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}},"requestBody":{"description":"Create Bulk Internal Asset Transfers request body","content":{"application/json":{"schema":{"type":"object","properties":{"instructionType":{"$ref":"#/components/schemas/GwApiV1InternalAssetTransfersBulkPostRequestBodyContentApplicationJsonSchemaInstructionType"},"instructions":{"type":"array","items":{"description":"Any type"}}},"required":["instructionType","instructions"]}}}}}},"/gw/api/v1/internal-cash-transfers:bulk":{"post":{"operationId":"bulkInternalCashTransfers","summary":"Creates Multiple Internal Cash Transfers Between The Provided Account Id Pairs","description":"<br>**Scope**: `transfers.write`<br>**Security Policy**: `Signed JWT`","tags":["accountManagementBanking"],"parameters":[{"name":"client-id","in":"path","description":"The client's clientId","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Accepts all instructions in Bulk request to create them asynchronously","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsynchronousInstructionSetResponse"}}}},"400":{"description":"Returns a Problem detail instance representing a bad request. Returned even if only one instruction in the bulk upload has syntactical errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingRequiredParameterResponse"}}}},"500":{"description":"Unable to process request due to an Internal Error. Please try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}},"requestBody":{"description":"Create Bulk Internal Cash Transfers request body","content":{"application/json":{"schema":{"type":"object","properties":{"instructionType":{"$ref":"#/components/schemas/GwApiV1InternalCashTransfersBulkPostRequestBodyContentApplicationJsonSchemaInstructionType"},"instructions":{"type":"array","items":{"description":"Any type"}}},"required":["instructionType","instructions"]}}}}}},"/gw/api/v1/client-instructions/{clientInstructionId}":{"get":{"operationId":"getClientInstructions","summary":"Get Status For ClientInstructionId","description":"Retrieve status of request by clientInstructionId.<br><br>**Scope**: `instructions.read`<br>**Security Policy**: `HTTPS`","tags":["accountManagementBanking"],"parameters":[{"name":"client-id","in":"path","description":"The client's clientId","required":true,"schema":{"type":"string"}},{"name":"clientInstructionId","in":"path","description":"The target instruction id.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns the status of an instruction.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account Management Banking_getClientInstructions_Response_200"}}}},"404":{"description":"Returns a Problem detail instance representing a not found request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoSuchInstructionResponse"}}}},"500":{"description":"Unable to process request due to an Internal Error. Please try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}}}},"/gw/api/v1/instructions/{instructionId}":{"get":{"operationId":"getInstructions","summary":"Get Status For InstructionId","description":"Retrieve status of request by instructionId<br><br>**Scope**: `instructions.read`<br>**Security Policy**: `HTTPS`","tags":["accountManagementBanking"],"parameters":[{"name":"client-id","in":"path","description":"The client's clientId","required":true,"schema":{"type":"string"}},{"name":"instructionId","in":"path","description":"The target instruction id.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns the status of an instruction.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account Management Banking_getInstructions_Response_200"}}}},"404":{"description":"Returns a Problem detail instance representing a not found request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoSuchInstructionResponse"}}}},"500":{"description":"Unable to process request due to an Internal Error. Please try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}}}},"/gw/api/v1/instruction-sets/{instructionSetId}":{"get":{"operationId":"getInstructionSets","summary":"Get Status For InstructionSetId","description":"Retrieve status of all requests associated with instructionSetId.<br><br>**Scope**: `instructions.read`<br>**Security Policy**: `HTTPS`","tags":["accountManagementBanking"],"parameters":[{"name":"client-id","in":"path","description":"The client's clientId","required":true,"schema":{"type":"string"}},{"name":"instructionSetId","in":"path","description":"The target instruction set id.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns the status multiple instructions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkMultiStatusResponse"}}}},"404":{"description":"Returns a Problem detail instance representing a not found request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoSuchInstructionSetResponse"}}}},"500":{"description":"Unable to process request due to an Internal Error. Please try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}}}},"/gw/api/v1/instructions/query":{"post":{"operationId":"createInstructionsQuery","summary":"Get Transaction History","description":"Query list of recent transactions (up to 30 days) based on accountId.<br><br>**Scope**: `instructions.read`<br>**Security Policy**: `Signed JWT`","tags":["accountManagementBanking"],"parameters":[{"name":"client-id","in":"path","description":"The client's clientId","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Accepts request to create a new instruction asynchronously","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsynchronousInstructionResponse"}}}},"400":{"description":"Returns a Problem detail instance representing a bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingRequiredParameterResponse"}}}},"403":{"description":"Returns a Problem detail instance representing a forbidden request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenInstructionResponse"}}}},"422":{"description":"Returns a Problem detail instance representing a business error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessRejectResponse"}}}},"500":{"description":"Returns a Problem detail instance representing an internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}},"requestBody":{"description":"Create recent instructions request body","content":{"application/json":{"schema":{"type":"object","properties":{"instructionType":{"$ref":"#/components/schemas/GwApiV1InstructionsQueryPostRequestBodyContentApplicationJsonSchemaInstructionType"},"instruction":{"$ref":"#/components/schemas/QueryRecentInstructions"}},"required":["instructionType","instruction"]}}}}}},"/gw/api/v1/bank-instructions":{"post":{"operationId":"createBankInstructions","summary":"Manage Bank Instructions","description":"Create or delete bank instructions by accountId. Only ACH and EDDA are supported for 'Create'.<br><br>**Scope**: `bank-instructions.write`<br>**Security Policy**: `Signed JWT`","tags":["accountManagementBanking"],"parameters":[{"name":"client-id","in":"path","description":"The client's clientId","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Accepts request to create a new instruction asynchronously","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsynchronousInstructionResponse"}}}},"400":{"description":"Returns a Problem detail instance representing a bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingRequiredParameterResponse"}}}},"403":{"description":"Returns a Problem detail instance representing a forbidden request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenInstructionResponse"}}}},"422":{"description":"Returns a Problem detail instance representing a business error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessRejectResponse"}}}},"500":{"description":"Returns a Problem detail instance representing an internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"instructionType":{"$ref":"#/components/schemas/GwApiV1BankInstructionsPostRequestBodyContentApplicationJsonSchemaInstructionType"},"instruction":{"$ref":"#/components/schemas/GwApiV1BankInstructionsPostRequestBodyContentApplicationJsonSchemaInstruction"}},"required":["instructionType","instruction"]}}}}}},"/gw/api/v1/external-cash-transfers":{"post":{"operationId":"createExternalCashTransfers","summary":"Transfer Cash Externally","description":"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<br><br>**Scope**: `transfers.write`<br>**Security Policy**: `Signed JWT`","tags":["accountManagementBanking"],"parameters":[{"name":"client-id","in":"path","description":"The client's clientId","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Accepts request to create a new instruction asynchronously","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsynchronousInstructionResponse"}}}},"400":{"description":"Returns a Problem detail instance representing a bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingRequiredParameterResponse"}}}},"403":{"description":"Returns a Problem detail instance representing a forbidden request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenInstructionResponse"}}}},"422":{"description":"Returns a Problem detail instance representing a business error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessRejectResponse"}}}},"500":{"description":"Returns a Problem detail instance representing an internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"instructionType":{"$ref":"#/components/schemas/GwApiV1ExternalCashTransfersPostRequestBodyContentApplicationJsonSchemaInstructionType"},"instruction":{"$ref":"#/components/schemas/GwApiV1ExternalCashTransfersPostRequestBodyContentApplicationJsonSchemaInstruction"}},"required":["instructionType","instruction"]}}}}}},"/gw/api/v1/internal-cash-transfers":{"post":{"operationId":"createInternalCashTransfers","summary":"Transfer Cash Internally","description":"Transfer cash internally between two accounts with Interactive Brokers.<br><br>**Scope**: `transfers.write`<br>**Security Policy**: `Signed JWT`","tags":["accountManagementBanking"],"parameters":[{"name":"client-id","in":"path","description":"The client's clientId","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Creates a new instruction synchronously, e.g., for Internal Cash Transfer w/o dateTimeToOccur","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SynchronousInstructionResponse"}}}},"400":{"description":"Returns a Problem detail instance representing a bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingRequiredParameterResponse"}}}},"403":{"description":"Returns a Problem detail instance representing a forbidden request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenInstructionResponse"}}}},"422":{"description":"Returns a Problem detail instance representing a business error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessRejectResponse"}}}},"500":{"description":"Returns a Problem detail instance representing an internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"instructionType":{"$ref":"#/components/schemas/GwApiV1InternalCashTransfersPostRequestBodyContentApplicationJsonSchemaInstructionType"},"instruction":{"$ref":"#/components/schemas/InternalCashTransferInstruction"}},"required":["instructionType","instruction"]}}}}}},"/gw/api/v1/external-asset-transfers":{"post":{"operationId":"createExternalAssetTransfers","summary":"Transfer Positions Externally (ACATS, ATON, FOP, DWAC, Complex Asset Transfer)","description":"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/<br><br>**Scope**: `transfers.write`<br>**Security Policy**: `Signed JWT`","tags":["accountManagementBanking"],"parameters":[{"name":"client-id","in":"path","description":"The client's clientId","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Accepts request to create a new instruction asynchronously","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsynchronousInstructionResponse"}}}},"400":{"description":"Returns a Problem detail instance representing a bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingRequiredParameterResponse"}}}},"403":{"description":"Returns a Problem detail instance representing a forbidden request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenInstructionResponse"}}}},"422":{"description":"Returns a Problem detail instance representing a business error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessRejectResponse"}}}},"500":{"description":"Returns a Problem detail instance representing an internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"instructionType":{"$ref":"#/components/schemas/GwApiV1ExternalAssetTransfersPostRequestBodyContentApplicationJsonSchemaInstructionType"},"instruction":{"$ref":"#/components/schemas/GwApiV1ExternalAssetTransfersPostRequestBodyContentApplicationJsonSchemaInstruction"}},"required":["instructionType","instruction"]}}}}}},"/gw/api/v2/external-asset-transfers":{"post":{"operationId":"createExternalAssetTransfers_2","summary":"Transfer Positions Externally (FOP, DWAC, Complex Asset Transfer)","description":"Initiate request to submit external position transfer. Methods- Basic FOP, FOP, DWAC. More information on transfer methods can be found here - https://www.interactivebrokers.com/campus/trading-lessons/cash-and-position-transfers/<br><br>**Scope**: `transfers.write`<br>**Security Policy**: `Signed JWT`","tags":["accountManagementBanking"],"parameters":[{"name":"client-id","in":"path","description":"The client's clientId","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Accepts request to create a new instruction asynchronously","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsynchronousInstructionResponse"}}}},"400":{"description":"Returns a Problem detail instance representing a bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingRequiredParameterResponse"}}}},"403":{"description":"Returns a Problem detail instance representing a forbidden request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenInstructionResponse"}}}},"422":{"description":"Returns a Problem detail instance representing a business error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessRejectResponse"}}}},"500":{"description":"Returns a Problem detail instance representing an internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"instructionType":{"$ref":"#/components/schemas/GwApiV2ExternalAssetTransfersPostRequestBodyContentApplicationJsonSchemaInstructionType"},"instruction":{"$ref":"#/components/schemas/GwApiV2ExternalAssetTransfersPostRequestBodyContentApplicationJsonSchemaInstruction"}},"required":["instructionType","instruction"]}}}}}},"/gw/api/v1/internal-asset-transfers":{"post":{"operationId":"createInternalAssetTransfers","summary":"Transfer Positions Internally","description":"Transfer positions internally between two accounts with Interactive Brokers<br><br>**Scope**: `transfers.write`<br>**Security Policy**: `Signed JWT`","tags":["accountManagementBanking"],"parameters":[{"name":"client-id","in":"path","description":"The client's clientId","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Accepts request to create a new instruction asynchronously","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsynchronousInstructionResponse"}}}},"400":{"description":"Returns a Problem detail instance representing a bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingRequiredParameterResponse"}}}},"403":{"description":"Returns a Problem detail instance representing a forbidden request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenInstructionResponse"}}}},"422":{"description":"Returns a Problem detail instance representing a business error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessRejectResponse"}}}},"500":{"description":"Returns a Problem detail instance representing an internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"instructionType":{"$ref":"#/components/schemas/GwApiV1InternalAssetTransfersPostRequestBodyContentApplicationJsonSchemaInstructionType"},"instruction":{"$ref":"#/components/schemas/InternalPositionTransferInstruction"}},"required":["instructionType","instruction"]}}}}}},"/gw/api/v1/bank-instructions/query":{"post":{"operationId":"createBankInstructionsQuery","summary":"View Bank Instructions","description":"View active bank instructions for an accountId.<br><br>**Scope**: `bank-instructions.read`<br>**Security Policy**: `Signed JWT`","tags":["accountManagementBanking"],"parameters":[{"name":"client-id","in":"path","description":"The client's clientId","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Instruction successfully created and processed synchronously","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account Management Banking_createBankInstructionsQuery_Response_201"}}}},"400":{"description":"Returns a Problem detail instance representing a bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingRequiredParameterResponse"}}}},"403":{"description":"Returns a Problem detail instance representing a forbidden request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenInstructionResponse"}}}},"422":{"description":"Returns a Problem detail instance representing a business error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessRejectResponse"}}}},"500":{"description":"Returns a Problem detail instance representing an internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}},"requestBody":{"description":"Create get instruction name request body","content":{"application/json":{"schema":{"type":"object","properties":{"instructionType":{"$ref":"#/components/schemas/GwApiV1BankInstructionsQueryPostRequestBodyContentApplicationJsonSchemaInstructionType"},"instruction":{"$ref":"#/components/schemas/GwApiV1BankInstructionsQueryPostRequestBodyContentApplicationJsonSchemaInstruction"}},"required":["instructionType","instruction"]}}}}}},"/gw/api/v1/external-cash-transfers/query":{"post":{"operationId":"createExternalCashTransfersQuery","summary":"View Cash Balances","description":"View available cash for withdrawal with and without margin loan by accountId<br><br>**Scope**: `transfers.read`<br>**Security Policy**: `Signed JWT`","tags":["accountManagementBanking"],"parameters":[{"name":"client-id","in":"path","description":"The client's clientId","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Instruction successfully created and processed synchronously","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account Management Banking_createExternalCashTransfersQuery_Response_201"}}}},"400":{"description":"Returns a Problem detail instance representing a bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingRequiredParameterResponse"}}}},"403":{"description":"Returns a Problem detail instance representing a forbidden request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenInstructionResponse"}}}},"422":{"description":"Returns a Problem detail instance representing a business error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessRejectResponse"}}}},"500":{"description":"Returns a Problem detail instance representing an internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}},"requestBody":{"description":"Create an external cash transfer query request body","content":{"application/json":{"schema":{"type":"object","properties":{"instructionType":{"$ref":"#/components/schemas/GwApiV1ExternalCashTransfersQueryPostRequestBodyContentApplicationJsonSchemaInstructionType"},"instruction":{"$ref":"#/components/schemas/GwApiV1ExternalCashTransfersQueryPostRequestBodyContentApplicationJsonSchemaInstruction"}},"required":["instructionType","instruction"]}}}}}},"/gw/api/v1/statements/available":{"get":{"operationId":"listStatementsAvailable","summary":"Fetch Available Daily, Monthly, And Annual Report Dates For An Account Id","description":"<br>**Scope**: `statements.read` OR `reports.read`<br>**Security Policy**: `HTTPS`","tags":["accountManagementReports"],"parameters":[{"name":"accountId","in":"query","description":"Specifies the account id to retrieve information","required":true,"schema":{"type":"string"}},{"name":"authorization","in":"header","description":"Specifies the authorization header value (e.g., Bearer eyJ0eXAiOiJKV1...).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a JSON object containing the available report dates.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAvailableStmtDatesResponse"}}}},"400":{"description":"Returns a Problem detail instance representing a bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingRequiredParameterResponse"}}}},"401":{"description":"Returns a Problem detail instance representing an unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidAccessTokenResponse"}}}},"402":{"description":"Returns a Problem detail instance representing an unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedAccessResponse"}}}},"403":{"description":"Returns a Problem detail instance representing a forbidden request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsufficientScopeResponse"}}}},"500":{"description":"Returns a Problem detail instance representing an internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}}}},"/gw/api/v1/tax-documents/available":{"get":{"operationId":"listTaxDocumentsAvailable","summary":"Fetch List Of Available Tax Reports/forms/documents For A Specified Account And Tax Year","description":"<br>**Scope**: `statements.read` OR `reports.read`<br>**Security Policy**: `HTTPS`","tags":["accountManagementReports"],"parameters":[{"name":"accountId","in":"query","description":"Specifies the account id to retrieve information","required":true,"schema":{"type":"string"}},{"name":"year","in":"query","description":"Specifies the tax year to retrieve information","required":true,"schema":{"type":"string"}},{"name":"authorization","in":"header","description":"Specifies the authorization header value (e.g., Bearer eyJ0eXAiOiJKV1...).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a JSON object containing the available report dates.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAvailableTaxFormsResponse"}}}},"400":{"description":"Returns a Problem detail instance representing a bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingRequiredParameterResponse"}}}},"401":{"description":"Returns a Problem detail instance representing an unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidAccessTokenResponse"}}}},"402":{"description":"Returns a Problem detail instance representing an unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedAccessResponse"}}}},"403":{"description":"Returns a Problem detail instance representing a forbidden request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsufficientScopeResponse"}}}},"500":{"description":"Returns a Problem detail instance representing an internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}}}},"/gw/api/v1/trade-confirmations/available":{"get":{"operationId":"listTradeConfirmationsAvailable","summary":"Fetch List Of Available Trade Confirmation Dates, For A Specific Account Id","description":"<br>**Scope**: `statements.read` OR `reports.read`<br>**Security Policy**: `HTTPS`","tags":["accountManagementReports"],"parameters":[{"name":"accountId","in":"query","description":"Specifies the account id to retrieve information","required":true,"schema":{"type":"string"}},{"name":"authorization","in":"header","description":"Specifies the authorization header value (e.g., Bearer eyJ0eXAiOiJKV1...).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a JSON object containing the available user-traded dates.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAvailableTradeConfirmationDatesResponse"}}}},"400":{"description":"Returns a Problem detail instance representing a bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingRequiredParameterResponse"}}}},"401":{"description":"Returns a Problem detail instance representing an unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidAccessTokenResponse"}}}},"402":{"description":"Returns a Problem detail instance representing an unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedAccessResponse"}}}},"403":{"description":"Returns a Problem detail instance representing a forbidden request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsufficientScopeResponse"}}}},"500":{"description":"Returns a Problem detail instance representing an internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}}}},"/gw/api/v1/tax-documents":{"post":{"operationId":"createTaxDocuments","summary":"Fetch Tax Forms In Supported Formats Based On Request Parameters.","description":"<br>**Scope**: `statements.write` OR `reports.write`<br>**Security Policy**: `Signed JWT`","tags":["accountManagementReports"],"parameters":[{"name":"authorization","in":"header","description":"Specifies the authorization header value (e.g., Bearer eyJ0eXAiOiJKV1...).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a JSON object containing the relevant Tax Form.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxFormResponse"}}}},"400":{"description":"Returns a Problem detail instance representing a bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingRequiredParameterResponse"}}}},"401":{"description":"Returns a Problem detail instance representing an unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidAccessTokenResponse"}}}},"402":{"description":"Returns a Problem detail instance representing an unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedAccessResponse"}}}},"403":{"description":"Returns a Problem detail instance representing a forbidden request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsufficientScopeResponse"}}}},"500":{"description":"Returns a Problem detail instance representing an internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}},"requestBody":{"description":"Tax Form request object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxFormRequest"}}}}}},"/gw/api/v1/trade-confirmations":{"post":{"operationId":"createTradeConfirmations","summary":"Fetch Trade Confirmations In Supported Formats Based On Request Parameters.","description":"<br>**Scope**: `statements.write` OR `reports.write`<br>**Security Policy**: `Signed JWT`","tags":["accountManagementReports"],"parameters":[{"name":"authorization","in":"header","description":"Specifies the authorization header value (e.g., Bearer eyJ0eXAiOiJKV1...).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a JSON object containing the relevant Trade Confirmation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TradeConfirmationResponse"}}}},"400":{"description":"Returns a Problem detail instance representing a bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingRequiredParameterResponse"}}}},"401":{"description":"Returns a Problem detail instance representing an unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidAccessTokenResponse"}}}},"402":{"description":"Returns a Problem detail instance representing an unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedAccessResponse"}}}},"403":{"description":"Returns a Problem detail instance representing a forbidden request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsufficientScopeResponse"}}}},"500":{"description":"Returns a Problem detail instance representing an internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}},"requestBody":{"description":"Trade confirmation request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TradeConfirmationRequest"}}}}}},"/gw/api/v1/statements":{"post":{"operationId":"createStatements","summary":"Generates Statements In Supported Formats Based On Request Parameters.","description":"<br>**Scope**: `statements.read` OR `statements.write` OR `reports.write`<br>**Security Policy**: `Signed JWT`","tags":["accountManagementReports"],"parameters":[{"name":"authorization","in":"header","description":"Specifies the authorization header value (e.g., Bearer eyJ0eXAiOiJKV1...).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a JSON object containing the relevant statement.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetStatementsResponse"}}}},"400":{"description":"Returns a Problem detail instance representing a bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingRequiredParameterResponse"}}}},"401":{"description":"Returns a Problem detail instance representing an unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidAccessTokenResponse"}}}},"402":{"description":"Returns a Problem detail instance representing an unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedAccessResponse"}}}},"403":{"description":"Returns a Problem detail instance representing a forbidden request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsufficientScopeResponse"}}}},"500":{"description":"Returns a Problem detail instance representing an internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}},"requestBody":{"description":"Report request object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StmtRequest"}}}}}},"/gw/api/v1/enumerations/complex-asset-transfer":{"get":{"operationId":"listEnumerationsComplexAssetTransfer","summary":"Get A List Of Participating Brokers For The Given Asset Type","description":"Get list of brokers supported for given asset transfer type<br><br>**Scope**: `enumerations.read`<br>**Security Policy**: `HTTPS`","tags":["accountManagementUtilities"],"parameters":[{"name":"client-id","in":"path","description":"The client's clientId","required":true,"schema":{"type":"string"}},{"name":"instructionType","in":"query","description":"Asset transfer type to get the list of supported brokers","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns list of brokers supported for given asset type","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBrokerListResponse"}}}},"400":{"description":"Returns a Problem detail instance representing a not found request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoSuchInstructionResponse"}}}},"500":{"description":"Unable to process request due to an Internal Error. Please try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}}}},"/gw/api/v1/enumerations/{enumerationType}":{"get":{"operationId":"getEnumerations","summary":"Get Enumerations","description":"Used to query list of enumerations for attributes included within extPositionsTransfers, occupation, employerBusiness, financialInformation, affiliationDetails, tradingPermissions, etc.<br><br>**Scope**: `accounts.read` OR `enumerations.read`<br>**Security Policy**: `HTTPS`","tags":["accountManagementUtilities"],"parameters":[{"name":"type","in":"path","required":true,"schema":{"$ref":"#/components/schemas/EnumerationType"}},{"name":"enumerationType","in":"path","required":true,"schema":{"type":"string"}},{"name":"currency","in":"query","required":false,"schema":{"type":"string"}},{"name":"ibEntity","in":"query","required":false,"schema":{"type":"string"}},{"name":"mdStatusNonPro","in":"query","required":false,"schema":{"type":"string"}},{"name":"form-number","in":"query","required":false,"schema":{"type":"string"}},{"name":"language","in":"query","required":false,"schema":{"$ref":"#/components/schemas/GwApiV1EnumerationsEnumerationTypeGetParametersLanguage"}},{"name":"accountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"userName","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Get enumerations","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnumerationResponse"}}}},"400":{"description":"Returns error description representing bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"401":{"description":"Returns error description representing access issue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"403":{"description":"Returns error description representing access issue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"500":{"description":"Returns error description representing internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}}}}},"/gw/api/v1/forms":{"get":{"operationId":"listForms","summary":"Get Forms","description":"Get forms<br><br>**Scope**: `accounts.read` OR `forms.read`<br>**Security Policy**: `HTTPS`","tags":["accountManagementUtilities"],"parameters":[{"name":"formNo","in":"query","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"getDocs","in":"query","required":false,"schema":{"type":"string"}},{"name":"fromDate","in":"query","required":false,"schema":{"type":"string"}},{"name":"toDate","in":"query","required":false,"schema":{"type":"string"}},{"name":"language","in":"query","required":false,"schema":{"type":"string"}},{"name":"projection","in":"query","required":false,"schema":{"$ref":"#/components/schemas/GwApiV1FormsGetParametersProjection","default":"NONE"}}],"responses":{"200":{"description":"Get forms","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormFileResponse"}}}},"400":{"description":"Returns error description representing bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"401":{"description":"Returns error description representing access issue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"403":{"description":"Returns error description representing access issue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"500":{"description":"Returns error description representing internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}}}}},"/gw/api/v1/participating-banks":{"get":{"operationId":"listParticipatingBanks","summary":"Get Participating Banks","description":"Get list of banks which support banking connection with Interactive Brokers.<br><br>**Scope**: `enumerations.read`<br>**Security Policy**: `HTTPS`","tags":["accountManagementUtilities"],"parameters":[{"name":"client-id","in":"path","description":"The client's clientId","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","description":"Parameter for which the list of participating banks is fetched","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns the list of participating banks.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetParticipatingListResponse"}}}},"400":{"description":"Returns a Problem detail instance representing a not found request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoSuchInstructionResponse"}}}},"500":{"description":"Unable to process request due to an Internal Error. Please try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}}}},"/gw/api/v1/requests":{"get":{"operationId":"listRequests","summary":"Get Requests' Details By Timeframe","description":"Fetch Requests' Details By Timeframe<br><br>**Scope**: `accounts.read`<br>**Security Policy**: `HTTPS`","tags":["accountManagementUtilities"],"parameters":[{"name":"requestDetails","in":"query","required":true,"schema":{"$ref":"#/components/schemas/RequestDetailsRequest"}}],"responses":{"200":{"description":"Fetch Requests' Details By Timeframe","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestDetailsResponse"}}}},"400":{"description":"Returns error description representing bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"401":{"description":"Returns error description representing access issue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"403":{"description":"Returns error description representing access issue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"500":{"description":"Returns error description representing internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}}}}},"/gw/api/v1/forms/required-forms":{"get":{"operationId":"listFormsRequiredForms","summary":"Get Required Forms","description":"Get required forms<br><br>**Scope**: `accounts.read`<br>**Security Policy**: `HTTPS`","tags":["accountManagementUtilities"],"parameters":[{"name":"requiredFormsRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/RequiredFormsRequest"}}],"responses":{"200":{"description":"Get required forms","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequiredFormsResponse"}}}},"400":{"description":"Returns error description representing bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"401":{"description":"Returns error description representing access issue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"403":{"description":"Returns error description representing access issue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"500":{"description":"Returns error description representing internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}}}}},"/gw/api/v1/requests/{requestId}/status":{"get":{"operationId":"getRequestsStatus","summary":"Get Status Of A Request","description":"Returns status for account management request<br><br>**Scope**: `accounts.read`<br>**Security Policy**: `HTTPS`","tags":["accountManagementUtilities"],"parameters":[{"name":"requestId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"type","in":"query","required":true,"schema":{"$ref":"#/components/schemas/GwApiV1RequestsRequestIdStatusGetParametersType"}}],"responses":{"200":{"description":"Returns status for account management request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account Management Utilities_getRequestsStatus_Response_200"}}}},"400":{"description":"Returns error description representing bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"401":{"description":"Returns error description representing access issue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"403":{"description":"Returns error description representing access issue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"500":{"description":"Returns error description representing internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}}}}},"/gw/api/v1/validations/usernames/{username}":{"get":{"operationId":"getValidationsUsernames","summary":"Verify User Availability","description":"Verify whether user is valid and available<br><br>**Scope**: `accounts.read` OR `validations.read`<br>**Security Policy**: `HTTPS`","tags":["accountManagementUtilities"],"parameters":[{"name":"username","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Verify whether user is valid and available","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserNameAvailableResponse"}}}},"400":{"description":"Returns error description representing bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"401":{"description":"Returns error description representing access issue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"403":{"description":"Returns error description representing access issue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}},"500":{"description":"Returns error description representing internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailResponse"}}}}}}},"/gw/api/v1/restrictions":{"post":{"operationId":"applyCSV","summary":"Apply PTC CSV","description":"Applies previously verified CSV changes. Requires two tokens:\n\n**Authorization header** — RS256-signed JWT containing an `accountId` claim, used to identify the master account. A missing or invalid token does not return HTTP 401; the request proceeds and fails at validation with `success: false`.\n\n**Request body** — a separate RS256-signed JWT (validity: 1 minute) whose payload contains the request claims (`userName`, `requestId`, `payload`, and optionally `isEmpTrack`). The `requestId` must match a prior successful `/csv/v2/verify` call.\n\nFailures that occur before the body JWT payload is parsed (inactive token, missing payload) return `success: false` without a `requestId` field.<br><br>**Scope**: `restrictions.write`<br>**Security Policy**: `Signed JWT`","tags":["preTradeComplianceRestrictions"],"parameters":[{"name":"Authorization","in":"header","description":"RS256-signed JWT (Bearer format), signed with your registered private key. Must contain an `accountId` claim identifying the master account. Separate from and additional to the JWT in the request body.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Always HTTP 200. Inspect the `success` field to determine the outcome. All failure conditions — authentication, authorization, validation, and internal errors — return `success: false`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CSVResponse"}}}}},"requestBody":{"description":"RS256-signed JWT (validity: 1 minute) whose payload contains `userName`, `requestId`, `payload` (Base64-encoded CSV), and optionally `isEmpTrack`. The `requestId` must match a prior successful `/csv/v2/verify` call. Distinct from the Authorization header JWT.","content":{"application/json":{"schema":{"type":"string","format":"jwt"}}}}}},"/gw/api/v1/restrictions/list":{"get":{"operationId":"getListDetails","summary":"Get List Details","description":"Returns list metadata and instrument entries. The list must be owned by the caller. Returns 403 for both unauthorized and non-existent lists to prevent ID enumeration.<br><br>**Scope**: `restrictions.read`<br>**Security Policy**: `HTTPS`","tags":["preTradeComplianceRestrictions"],"parameters":[{"name":"masterUserName","in":"query","description":"IBKR master username of the authenticated caller. Max 64 characters.","required":true,"schema":{"type":"string","maxLength":64}},{"name":"listId","in":"query","description":"Positive integer in the range 1-2147483647. Decimals and non-numeric values return 400. Values above 2147483647 return 400.","required":true,"schema":{"type":"integer","format":"int64","minimum":1,"maximum":2147483647}},{"name":"isEmpTrack","in":"query","description":"Set to `T` for employer-track authorization.","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"RS256-signed JWT (Bearer format), signed with your registered private key. Must contain an `accountId` claim identifying the master account. A missing or invalid token returns HTTP 401.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"List metadata and entries.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDetailsResponse"}}}},"400":{"description":"Missing, empty, non-numeric, or out-of-range parameter. The `error` field is always prefixed with `Bad Request:`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Resource does not belong to the caller, does not exist, or an unsupported HTTP method was used. All cases return an identical body to prevent ID enumeration.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/gw/api/v1/restrictions/lists/ids":{"get":{"operationId":"getMasterListIds","summary":"Get List IDs Created By The Caller's Master Account","description":"Returns all list IDs created by the authenticated caller's own master account (or employer, in emp-track mode), same as the PTC portal's Lists page.<br><br>**Scope**: `restrictions.read`<br>**Security Policy**: `HTTPS`","tags":["preTradeComplianceRestrictions"],"parameters":[{"name":"masterUserName","in":"query","description":"IBKR master username of the authenticated caller. Max 64 characters.","required":true,"schema":{"type":"string","maxLength":64}},{"name":"isEmpTrack","in":"query","description":"Set to `T` for employer-track authorization.","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"RS256-signed JWT (Bearer format), signed with your registered private key. Must contain an `accountId` claim identifying the master account. A missing or invalid token returns HTTP 401.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"List IDs created by the caller's master account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MasterListIdsResponse"}}}},"400":{"description":"Missing, empty, non-numeric, or out-of-range parameter. The `error` field is always prefixed with `Bad Request:`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/gw/api/v1/restrictions/restriction":{"get":{"operationId":"getRestrictionDetails","summary":"Get Restriction Details","description":"Returns full details of a restriction including rules. The restriction must be owned by the caller. Returns 403 for both unauthorized and non-existent restrictions to prevent ID enumeration.<br><br>**Scope**: `restrictions.read`<br>**Security Policy**: `HTTPS`","tags":["preTradeComplianceRestrictions"],"parameters":[{"name":"masterUserName","in":"query","description":"IBKR master username of the authenticated caller. Max 64 characters.","required":true,"schema":{"type":"string","maxLength":64}},{"name":"restrictionId","in":"query","description":"Positive integer. Decimals and non-numeric values return 400.","required":true,"schema":{"type":"integer","format":"int64","minimum":1}},{"name":"isEmpTrack","in":"query","description":"Set to `T` for employer-track authorization.","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"RS256-signed JWT (Bearer format), signed with your registered private key. Must contain an `accountId` claim identifying the master account. A missing or invalid token returns HTTP 401.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Full restriction details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestrictionDetailsResponse"}}}},"400":{"description":"Missing, empty, non-numeric, or out-of-range parameter. The `error` field is always prefixed with `Bad Request:`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Resource does not belong to the caller, does not exist, or an unsupported HTTP method was used. All cases return an identical body to prevent ID enumeration.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/gw/api/v1/restrictions/ids":{"get":{"operationId":"getMasterRestrictionIds","summary":"Get Restriction IDs Created By The Caller's Master Account","description":"Returns all restriction IDs created by the authenticated caller's own master account (or employer, in emp-track mode), same as the PTC portal's Restrictions page. Each entry includes a `byOperator` flag distinguishing IB(operator)-created restrictions from Client-created ones.<br><br>**Scope**: `restrictions.read`<br>**Security Policy**: `HTTPS`","tags":["preTradeComplianceRestrictions"],"parameters":[{"name":"masterUserName","in":"query","description":"IBKR master username of the authenticated caller. Max 64 characters.","required":true,"schema":{"type":"string","maxLength":64}},{"name":"isEmpTrack","in":"query","description":"Set to `T` for employer-track authorization.","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"RS256-signed JWT (Bearer format), signed with your registered private key. Must contain an `accountId` claim identifying the master account. A missing or invalid token returns HTTP 401.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Restrictions created by the caller's master account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MasterRestrictionsResponse"}}}},"400":{"description":"Missing, empty, non-numeric, or out-of-range parameter. The `error` field is always prefixed with `Bad Request:`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/gw/api/v1/restrictions/user":{"get":{"operationId":"getUserRestrictions","summary":"Get Restriction IDs For A User","description":"Returns all restriction IDs for the given username. The username must be the master user, a sub-user, or a user with trading access under the master account. Returns 403 for both unauthorized and non-existent users to prevent ID enumeration.<br><br>**Scope**: `restrictions.read`<br>**Security Policy**: `HTTPS`","tags":["preTradeComplianceRestrictions"],"parameters":[{"name":"masterUserName","in":"query","description":"IBKR master username of the authenticated caller. Max 64 characters.","required":true,"schema":{"type":"string","maxLength":64}},{"name":"userName","in":"query","description":"Username to query. Max 64 characters.","required":true,"schema":{"type":"string","maxLength":64}},{"name":"isEmpTrack","in":"query","description":"Set to `T` for employer-track authorization.","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"RS256-signed JWT (Bearer format), signed with your registered private key. Must contain an `accountId` claim identifying the master account. A missing or invalid token returns HTTP 401.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Restriction IDs for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserRestrictionsResponse"}}}},"400":{"description":"Missing, empty, non-numeric, or out-of-range parameter. The `error` field is always prefixed with `Bad Request:`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Resource does not belong to the caller, does not exist, or an unsupported HTTP method was used. All cases return an identical body to prevent ID enumeration.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/gw/api/v1/restrictions/account":{"get":{"operationId":"getAccountRestrictions","summary":"Get Restriction IDs For An Account","description":"Returns all restriction IDs for the given account. The account must be the caller's master account or a direct sub-account. Returns 403 for both unauthorized and non-existent accounts to prevent ID enumeration.<br><br>**Scope**: `restrictions.read`<br>**Security Policy**: `HTTPS`","tags":["preTradeComplianceRestrictions"],"parameters":[{"name":"masterUserName","in":"query","description":"IBKR master username of the authenticated caller. Max 64 characters.","required":true,"schema":{"type":"string","maxLength":64}},{"name":"accountId","in":"query","description":"Master or sub-account ID. Max 64 characters.","required":true,"schema":{"type":"string","maxLength":64}},{"name":"isEmpTrack","in":"query","description":"Set to `T` for employer-track authorization.","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"RS256-signed JWT (Bearer format), signed with your registered private key. Must contain an `accountId` claim identifying the master account. A missing or invalid token returns HTTP 401.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Restriction IDs for the account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountRestrictionsResponse"}}}},"400":{"description":"Missing, empty, non-numeric, or out-of-range parameter. The `error` field is always prefixed with `Bad Request:`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, invalid, or unparseable Authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Resource does not belong to the caller, does not exist, or an unsupported HTTP method was used. All cases return an identical body to prevent ID enumeration.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/gw/api/v1/restrictions/verify":{"post":{"operationId":"verifyCSV","summary":"Verify PTC CSV","description":"Validates CSV content without applying changes. Must be called before `/csv/v2/apply` with the same `requestId`.\n\nThe master account identity is resolved from the `accountId` claim in the Authorization header JWT. Do not include `masterAcctId` in the request body.\n\nA missing or invalid Authorization header does not return HTTP 401. The request proceeds and fails at validation with `success: false, message: \"Master account not specified and not emp track\"` unless `isEmpTrack: T` is set in the body.<br><br>**Scope**: `restrictions.write`<br>**Security Policy**: `Signed JWT`","tags":["preTradeComplianceRestrictions"],"parameters":[{"name":"Authorization","in":"header","description":"RS256-signed JWT (Bearer format), signed with your registered private key. Must contain an `accountId` claim identifying the master account.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Always HTTP 200. Inspect the `success` field to determine the outcome. All failure conditions — authentication, authorization, validation, and internal errors — return `success: false`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CSVResponse"}}}}},"requestBody":{"description":"JSON body containing `userName`, `requestId`, and Base64-encoded CSV `payload`. Do not include `masterAcctId`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifyRequest"}}}}}},"/gw/api/v1/balances/query":{"post":{"operationId":"createBalancesQuery","summary":"View Cash Balances","description":"View available cash for withdrawal and account equity value by accountId<br><br>**Scope**: `balances.read`<br>**Security Policy**: `Signed JWT`","tags":["thirdPartiesCashBalances"],"parameters":[{"name":"client-id","in":"path","description":"The client's clientId","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Instruction successfully created and processed synchronously","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Third Parties Cash Balances_createBalancesQuery_Response_201"}}}},"400":{"description":"Returns a Problem detail instance representing a bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingRequiredParameterResponse"}}}},"403":{"description":"Returns a Problem detail instance representing a forbidden request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenInstructionResponse"}}}},"422":{"description":"Returns a Problem detail instance representing a business error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessRejectResponse"}}}},"500":{"description":"Returns a Problem detail instance representing an internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}},"requestBody":{"description":"Create an query request body","content":{"application/json":{"schema":{"type":"object","properties":{"instructionType":{"$ref":"#/components/schemas/GwApiV1BalancesQueryPostRequestBodyContentApplicationJsonSchemaInstructionType"},"instruction":{"$ref":"#/components/schemas/GwApiV1BalancesQueryPostRequestBodyContentApplicationJsonSchemaInstruction"}},"required":["instructionType","instruction"]}}}}}},"/gw/api/v1/tax-vouchers":{"post":{"operationId":"createTaxVoucherRequests","summary":"Create Tax Voucher Requests","description":"Creates tax voucher requests from a signed JWT payload. The request body must be a signed OAuth2 JWT (text/plain) whose decoded payload contains the list of tax voucher requests.<br><br>**Scope**: `tax-vouchers.write`<br>**Security Policy**: `Signed JWT`","tags":["thirdPartiesTaxVouchers"],"parameters":[{"name":"X-Request-ID","in":"header","description":"Unique identifier for each HTTP request for tracing and debugging purposes","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Tax voucher requests created successfully","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TaxVoucherDTO"}}}}},"400":{"description":"Invalid request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"OAuth2 JWT verification failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"description":"Signed OAuth2 JWT. The decoded payload must conform to the TaxVoucherJWTListWrapper schema.","content":{"application/json":{"schema":{"type":"string"}}}}}},"/gw/api/v1/tax-vouchers/{requestId}/download":{"get":{"operationId":"downloadFile","summary":"Download Tax Voucher File","description":"Downloads the tax voucher PDF file for the given tax voucher request ID.<br><br>**Scope**: `tax-vouchers.read`<br>**Security Policy**: `HTTPS`","tags":["thirdPartiesTaxVouchers"],"parameters":[{"name":"requestPublicId","in":"path","description":"Request ID (UUID)","required":true,"schema":{"type":"string"}},{"name":"requestId","in":"path","required":true,"schema":{"type":"string"}},{"name":"X-Request-ID","in":"header","description":"Unique identifier for each HTTP request for tracing and debugging purposes","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"File downloaded successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Third Parties Tax Vouchers_downloadFile_Response_200"}}}},"401":{"description":"OAuth2 verification failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Tax voucher file not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/gw/api/v1/tax-vouchers/dividends":{"get":{"operationId":"fetchDividends_1","summary":"Fetch Dividend Details","description":"Retrieves dividend details for the given customer account, year, and country.<br><br>**Scope**: `tax-vouchers.read`<br>**Security Policy**: `HTTPS`","tags":["thirdPartiesTaxVouchers"],"parameters":[{"name":"custAcctId","in":"query","description":"Customer account ID","required":true,"schema":{"type":"string"}},{"name":"year","in":"query","description":"Tax year (e.g. 2023)","required":true,"schema":{"type":"string"}},{"name":"countryCode","in":"query","description":"Country code (e.g. DE)","required":true,"schema":{"type":"string"}},{"name":"X-Request-ID","in":"header","description":"Unique identifier for each HTTP request for tracing and debugging purposes","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"List of dividends returned successfully","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DividendDTO"}}}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"OAuth2 verification failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/gw/api/v1/tax-vouchers/active-countries":{"get":{"operationId":"getActiveCountryList","summary":"Get Active Country List","description":"Returns the list of active countries eligible for tax voucher requests, including applicable fees and currencies<br><br>**Scope**: `tax-vouchers.read`<br>**Security Policy**: `HTTPS`","tags":["thirdPartiesTaxVouchers"],"parameters":[{"name":"X-Request-ID","in":"header","description":"Unique identifier for each HTTP request for tracing and debugging purposes","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Country list returned successfully","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Country"}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/gw/api/v1/tax-vouchers/years":{"get":{"operationId":"getYears","summary":"Get Available Years","description":"Returns the list of tax years available for tax voucher requests<br><br>**Scope**: `tax-vouchers.read`<br>**Security Policy**: `HTTPS`","tags":["thirdPartiesTaxVouchers"],"parameters":[{"name":"X-Request-ID","in":"header","description":"Unique identifier for each HTTP request for tracing and debugging purposes","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Available years returned successfully","content":{"application/json":{"schema":{"type":"array","items":{"type":"integer","format":"int64"}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/gw/api/v1/tax-vouchers/{requestId}/state":{"get":{"operationId":"getCurrentState_1","summary":"Get Tax Voucher Request State","description":"Returns the current state of a tax voucher request by tax voucher request ID.<br><br>**Scope**: `tax-vouchers.read`<br>**Security Policy**: `HTTPS`","tags":["thirdPartiesTaxVouchers"],"parameters":[{"name":"requestPublicId","in":"path","description":"Request ID (UUID)","required":true,"schema":{"type":"string"}},{"name":"requestId","in":"path","required":true,"schema":{"type":"string"}},{"name":"X-Request-ID","in":"header","description":"Unique identifier for each HTTP request for tracing and debugging purposes","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Tax voucher state returned successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxVoucherDTO"}}}},"401":{"description":"OAuth2 verification failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Tax voucher request not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/gw/api/v1/echo/https":{"get":{"operationId":"listEchoHttps","summary":"Echo A Request With HTTPS Security Policy Back After Validation.","description":"<br>**Scope**: `echo.read`<br>**Security Policy**: `HTTPS`","tags":["utilitiesEcho"],"responses":{"200":{"description":"Returns a JSON object containing the request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EchoResponse"}}}},"401":{"description":"Returns a Problem detail instance representing an unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidAccessTokenResponse"}}}},"403":{"description":"Returns a Problem detail instance representing a forbidden request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsufficientScopeResponse"}}}},"500":{"description":"Returns a Problem detail instance representing an internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}}}},"/gw/api/v1/echo/signed-jwt":{"post":{"operationId":"createEchoSignedJwt","summary":"Echo A Request With Signed JWT Security Policy Back After Validation.","description":"<br>**Scope**: `echo.write`<br>**Security Policy**: `Signed JWT`","tags":["utilitiesEcho"],"responses":{"200":{"description":"Returns a JSON object containing the request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EchoResponse"}}}},"401":{"description":"Returns a Problem detail instance representing an unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidAccessTokenResponse"}}}},"403":{"description":"Returns a Problem detail instance representing a forbidden request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsufficientScopeResponse"}}}},"500":{"description":"Returns a Problem detail instance representing an internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}}}},"/v1/api/ws":{"get":{"operationId":"openWebsocket","summary":"Open Websocket","description":"Open websocket.","tags":["tradingWebsocket"],"parameters":[{"name":"bearer_token","in":"query","description":"Required for OAuth 2.0 users.  Query parameter defining Bearer Token to authorize connection. \n","required":false,"schema":{"type":"string"}},{"name":"oauth_token","in":"query","description":"Required when authroizing with OAuth 1.0a. 8-character OAuth access token. \n","required":false,"schema":{"type":"string"}},{"name":"Connection","in":"header","required":true,"schema":{"$ref":"#/components/schemas/V1ApiWsGetParametersConnection"}},{"name":"Upgrade","in":"header","required":true,"schema":{"$ref":"#/components/schemas/V1ApiWsGetParametersUpgrade"}}],"responses":{"200":{"description":"Successful response"}}}}},"servers":[{"url":"https://localhost:5000","description":"Client Portal Gateway"},{"url":"https://api.ibkr.com","description":"Production"},{"url":"https://qa.interactivebrokers.com","description":"Sandbox"}],"components":{"schemas":{"Trading OAuth 1.0a_reqTempToken_Response_200":{"type":"object","properties":{"oauth_token":{"type":"string","description":"Temporary OAuth access token. 20 character hex value."}},"title":"Trading OAuth 1.0a_reqTempToken_Response_200"},"ErrorResponse":{"type":"object","properties":{"status":{"type":"integer","format":"int64"},"error":{"type":"string"},"message":{"type":"string"}},"title":"ErrorResponse"},"errorResponse":{"type":"object","properties":{"error":{"type":"string","description":"error reason"},"statusCode":{"type":"integer","format":"int64","description":"mimic response status code"}},"title":"errorResponse"},"Trading OAuth 1.0a_reqAccessToken_Response_200":{"type":"object","properties":{"is_true":{"type":"boolean","description":"Indicates whether the authorizing username is paper or not."},"oauth_token":{"type":"string","description":"Permanent OAuth access token for the consumer with respect to the authorizing username. 20 character hex value."},"oauth_token_secret":{"type":"string","description":"OAuth token secret value. Base64-encoded string."}},"title":"Trading OAuth 1.0a_reqAccessToken_Response_200"},"Trading OAuth 1.0a_reqLiveSessionToken_Response_200":{"type":"object","properties":{"diffie_hellman_challenge":{"type":"string","description":"Diffie-Hellman challenge value used to compute live session token locally by client."},"live_session_token_signature":{"type":"string","description":"Signature value used to validate successful client-side computation of live session token."},"live_session_token_expiration":{"type":"integer","format":"int64","description":"Unix timestamp in milliseconds of time of live session token computation by IB. Live session tokens are valid for 24 hours from this time."}},"title":"Trading OAuth 1.0a_reqLiveSessionToken_Response_200"},"CreateBrowserSessionResponse":{"type":"object","properties":{"active":{"type":"boolean"},"url":{"type":"string"}},"title":"CreateBrowserSessionResponse"},"InvalidArgument":{"type":"object","properties":{"field":{"type":"string"},"description":{"type":"string"}},"required":["field"],"title":"InvalidArgument"},"MissingRequiredParameterResponse":{"type":"object","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer","format":"int64"},"invalidArguments":{"type":"array","items":{"$ref":"#/components/schemas/InvalidArgument"}}},"required":["type","title","status"],"title":"MissingRequiredParameterResponse"},"InvalidAccessTokenResponse":{"type":"object","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer","format":"int64"},"detail":{"type":"string"}},"required":["type","title","status"],"title":"InvalidAccessTokenResponse"},"InsufficientScopeResponse":{"type":"object","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer","format":"int64"},"detail":{"type":"string"}},"required":["type","title","status"],"title":"InsufficientScopeResponse"},"InternalServerErrorResponse":{"type":"object","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer","format":"int64"}},"required":["type","title","status"],"title":"InternalServerErrorResponse"},"CreateSessionResponse":{"type":"object","properties":{"active":{"type":"boolean"},"access_token":{"type":"string"},"token_type":{"type":"string"}},"required":["access_token"],"title":"CreateSessionResponse"},"TokenRequestClientAuthenticationMethod":{"type":"string","enum":["none","private_key_jwt","client_secret_basic","client_secret_post"],"title":"TokenRequestClientAuthenticationMethod"},"TokenRequest":{"type":"object","properties":{"scope":{"type":"string"},"clientId":{"type":"string"},"clientAuthenticationMethod":{"$ref":"#/components/schemas/TokenRequestClientAuthenticationMethod"},"clientSecret":{"type":"string"},"clientAssertion":{"type":"string"},"clientAssertionType":{"type":"string"}},"title":"TokenRequest"},"TokenResponse":{"type":"object","properties":{"access_token":{"type":"string","description":"The serialized access token"},"refresh_token":{"type":"string","description":"The serialized refresh token if applicable"},"id_token":{"type":"string","description":"The serialized ID token if applicable"},"token_type":{"type":"string","description":"The token type (e.g., Bearer)"},"scope":{"type":"string","description":"The space-delimited list of granted scopes"},"expires_in":{"type":"integer","format":"int64","description":"The number of seconds from now until the access token expires"}},"title":"TokenResponse"},"ProblemDetailResponse":{"type":"object","properties":{"type":{"type":"string","format":"uri"},"title":{"type":"string"},"status":{"type":"integer","format":"int64"},"detail":{"type":"string"},"instance":{"type":"string","format":"uri"}},"title":"ProblemDetailResponse"},"PnlPartitionedResponseUpnlU1234567Core":{"type":"object","properties":{"rowType":{"type":"integer","format":"int64","description":"Returns the positional value of the returned account. Always returns 1 for individual accounts."},"dpl":{"type":"integer","format":"int64","description":"Daily PnL for the specified account profile."},"nl":{"type":"integer","format":"int64","description":"Net Liquidity for the specified account profile."},"upl":{"type":"integer","format":"int64","description":"Unrealized PnL for the specified account profile."},"el":{"type":"integer","format":"int64","description":"Excess Liquidity for the specified account profile."},"mv":{"type":"integer","format":"int64","description":"Margin value for the specified account profile."}},"description":"The account or model's Profit and Loss.","title":"PnlPartitionedResponseUpnlU1234567Core"},"PnlPartitionedResponseUpnl":{"type":"object","properties":{"U1234567.Core":{"$ref":"#/components/schemas/PnlPartitionedResponseUpnlU1234567Core","description":"The account or model's Profit and Loss."}},"description":"Refers to the U accounts PnL. This does reference Realized Profit and Loss.","title":"PnlPartitionedResponseUpnl"},"pnlPartitionedResponse":{"type":"object","properties":{"upnl":{"$ref":"#/components/schemas/PnlPartitionedResponseUpnl","description":"Refers to the U accounts PnL. This does reference Realized Profit and Loss."}},"title":"pnlPartitionedResponse"},"UserEntityEntityType":{"type":"string","enum":["INDIVIDUAL","Joint","ORG"],"description":"The type of entity assigned to the user","title":"UserEntityEntityType"},"UserEntity":{"type":"object","properties":{"entityName":{"type":"string","description":"The full entity's name, concatenating the first and last name fields"},"entityType":{"$ref":"#/components/schemas/UserEntityEntityType","description":"The type of entity assigned to the user"},"firstName":{"type":"string","description":"The first name of the user"},"lastName":{"type":"string","description":"The last name of the user"}},"description":"Provide information about the particular entity","title":"UserEntity"},"user":{"type":"object","properties":{"roleId":{"type":"string","description":"The role of the username as it relates to the account"},"hasRightCodeInd":{"type":"boolean","description":"Internally used"},"userName":{"type":"string","description":"Identifies the username for the designated entity."},"entity":{"$ref":"#/components/schemas/UserEntity","description":"Provide information about the particular entity"}},"title":"user"},"SignatureAndOwnersApplicant":{"type":"object","properties":{"signatures":{"type":"array","items":{"type":"string"},"description":"All names attached to the account"}},"title":"SignatureAndOwnersApplicant"},"signatureAndOwners":{"type":"object","properties":{"accountId":{"type":"string","description":"Account identifier"},"users":{"type":"array","items":{"$ref":"#/components/schemas/user"}},"applicant":{"$ref":"#/components/schemas/SignatureAndOwnersApplicant"}},"title":"signatureAndOwners"},"UserAccountsResponseAcctPropsU1234567":{"type":"object","properties":{"hasChildAccounts":{"type":"boolean"},"supportsCashQty":{"type":"boolean"},"liteUnderPro":{"type":"boolean"},"noFXConv":{"type":"boolean"},"isProp":{"type":"boolean"},"supportsFractions":{"type":"boolean"},"allowCustomerTime":{"type":"boolean"},"autoFx":{"type":"boolean"}},"title":"UserAccountsResponseAcctPropsU1234567"},"UserAccountsResponseAcctProps":{"type":"object","properties":{"U1234567":{"$ref":"#/components/schemas/UserAccountsResponseAcctPropsU1234567"}},"description":"Returns an json object for each accessible account's properties.","title":"UserAccountsResponseAcctProps"},"UserAccountsResponseAliases":{"type":"object","properties":{"U1234567":{"type":"string"}},"title":"UserAccountsResponseAliases"},"UserAccountsResponseAllowFeatures":{"type":"object","properties":{"showGFIS":{"type":"boolean"},"showEUCostReport":{"type":"boolean"},"allowEventContract":{"type":"boolean"},"allowFXConv":{"type":"boolean"},"allowFinancialLens":{"type":"boolean"},"allowMTA":{"type":"boolean"},"allowTypeAhead":{"type":"boolean"},"allowEventTrading":{"type":"boolean"},"snapshotRefreshTimeout":{"type":"integer","format":"int64"},"liteUser":{"type":"boolean"},"showWebNews":{"type":"boolean"},"research":{"type":"boolean"},"debugPnl":{"type":"boolean"},"showTaxOpt":{"type":"boolean"},"showImpactDashboard":{"type":"boolean"},"allowDynAccount":{"type":"boolean"},"allowCrypto":{"type":"boolean"},"allowedAssetTypes":{"type":"string"},"restrictTradeSubscription":{"type":"boolean"},"showUkUserLabels":{"type":"boolean"},"sideBySide":{"type":"boolean"}},"title":"UserAccountsResponseAllowFeatures"},"UserAccountsResponseChartPeriods":{"type":"object","properties":{"STK":{"type":"array","items":{"type":"string"}},"CFD":{"type":"array","items":{"type":"string"}},"OPT":{"type":"array","items":{"type":"string"}},"FOP":{"type":"array","items":{"type":"string"}},"WAR":{"type":"array","items":{"type":"string"}},"IOPT":{"type":"array","items":{"type":"string"}},"FUT":{"type":"array","items":{"type":"string"}},"CASH":{"type":"array","items":{"type":"string"}},"IND":{"type":"array","items":{"type":"string"}},"BOND":{"type":"array","items":{"type":"string"}},"FUND":{"type":"array","items":{"type":"string"}},"CMDTY":{"type":"array","items":{"type":"string"}},"PHYSS":{"type":"array","items":{"type":"string"}},"CRYPTO":{"type":"array","items":{"type":"string"}}},"title":"UserAccountsResponseChartPeriods"},"UserAccountsResponseServerInfo":{"type":"object","properties":{"serverName":{"type":"string"},"serverVersion":{"type":"string"}},"title":"UserAccountsResponseServerInfo"},"userAccountsResponse":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"string"},"description":"Returns an array of all accessible accountIds."},"acctProps":{"$ref":"#/components/schemas/UserAccountsResponseAcctProps","description":"Returns an json object for each accessible account's properties."},"aliases":{"$ref":"#/components/schemas/UserAccountsResponseAliases"},"allowFeatures":{"$ref":"#/components/schemas/UserAccountsResponseAllowFeatures"},"chartPeriods":{"$ref":"#/components/schemas/UserAccountsResponseChartPeriods"},"groups":{"type":"array","items":{"type":"string"}},"profiles":{"type":"array","items":{"type":"string"}},"selectedAccount":{"type":"string"},"serverInfo":{"$ref":"#/components/schemas/UserAccountsResponseServerInfo"},"sessionId":{"type":"string"},"isFt":{"type":"boolean"},"isPaper":{"type":"boolean"}},"title":"userAccountsResponse"},"DynAccountSearchResponseMatchedAccountsItems":{"type":"object","properties":{"accountId":{"type":"string","description":"Returns a matching account ID that corresponds to the matching value."},"alias":{"type":"string","description":"Returns the corresponding alias or alternative name for the specific account ID. May be a duplicate of the accountId value in most cases."},"allocationId":{"type":"string","description":"Returns the allocation identifier used internally for the account."}},"title":"DynAccountSearchResponseMatchedAccountsItems"},"dynAccountSearchResponse":{"type":"object","properties":{"matchedAccounts":{"type":"array","items":{"$ref":"#/components/schemas/DynAccountSearchResponseMatchedAccountsItems"},"description":"Contains a series of objects that pertain to the account information requested."},"pattern":{"type":"string","description":"Displays the searchPattern used for the request."}},"title":"dynAccountSearchResponse"},"setAccountResponse":{"type":"object","properties":{"set":{"type":"boolean","description":"Confirms that the account change was set"},"acctId":{"type":"string","description":"Confirms the account switched to."}},"title":"setAccountResponse"},"errorOnlyResponse":{"type":"object","properties":{"error":{"type":"string","description":"error reason"}},"title":"errorOnlyResponse"},"SummaryOfAccountBalancesResponseTotal":{"type":"object","properties":{"net_liquidation":{"type":"string","description":"The basis for determining the price of the assets in your account."},"Nt Lqdtn Uncrtnty":{"type":"string","description":"Displays the uncertainty of the Net Liquidating Value associated with after-hours price changes."},"equity_with_loan":{"type":"string","description":"* `Cash Accounts` Settled cash\n * `Margin Accounts` Total cash value + stock value + bond value + fund value + European & Asian options value.\n"},"Prvs Dy Eqty Wth Ln Vl":{"type":"string","description":"The accounts equity balance including loan value."},"sec_gross_pos_val":{"type":"string","description":"Equals the sum of the absolute value of all positions except cash, index futures and US treasuries."},"cash":{"type":"string","description":"Total cash balance in the account"},"MTD Interest":{"type":"string","description":"Total Month-to-date interest."},"Pndng Dbt Crd Chrgs":{"type":"string","description":"Any pending charges for the IBKR debit account."}},"description":"Contains total balance details for the account.","title":"SummaryOfAccountBalancesResponseTotal"},"SummaryOfAccountBalancesResponseCommodities":{"type":"object","properties":{"net_liquidation":{"type":"string","description":"The basis for determining the price of the assets in your account."},"equity_with_loan":{"type":"string","description":"* `Cash Accounts` Settled cash\n * `Margin Accounts` Total cash value + stock value + bond value + fund value + European & Asian options value.\n"},"cash":{"type":"string","description":"Total cash balance in the account"},"MTD Interest":{"type":"string","description":"Total Month-to-date interest."},"Pndng Dbt Crd Chrgs":{"type":"string","description":"Any pending charges for the IBKR debit account."}},"description":"Contains Commodity-specific balance details.","title":"SummaryOfAccountBalancesResponseCommodities"},"SummaryOfAccountBalancesResponseSecurities":{"type":"object","properties":{"net_liquidation":{"type":"string","description":"The basis for determining the price of the assets in your account."},"equity_with_loan":{"type":"string","description":"* `Cash Accounts` Settled cash\n * `Margin Accounts` Total cash value + stock value + bond value + fund value + European & Asian options value.\n"},"Prvs Dy Eqty Wth Ln Vl":{"type":"string","description":"The accounts equity balance including loan value."},"sec_gross_pos_val":{"type":"string","description":"Equals the sum of the absolute value of all positions except cash, index futures and US treasuries."},"cash":{"type":"string","description":"Total cash balance in the account"},"MTD Interest":{"type":"string","description":"Total Month-to-date interest."},"Pndng Dbt Crd Chrgs":{"type":"string","description":"Any pending charges for the IBKR debit account."}},"description":"Contains Security-specific balance details.","title":"SummaryOfAccountBalancesResponseSecurities"},"summaryOfAccountBalancesResponse":{"type":"object","properties":{"total":{"$ref":"#/components/schemas/SummaryOfAccountBalancesResponseTotal","description":"Contains total balance details for the account."},"commodities":{"$ref":"#/components/schemas/SummaryOfAccountBalancesResponseCommodities","description":"Contains Commodity-specific balance details."},"securities":{"$ref":"#/components/schemas/SummaryOfAccountBalancesResponseSecurities","description":"Contains Security-specific balance details."}},"title":"summaryOfAccountBalancesResponse"},"SummaryOfAccountMarginResponseTotal":{"type":"object","properties":{"current_initial":{"type":"string","description":"The minimum amount required to open a new position."},"Prdctd Pst-xpry Mrgn @ Opn":{"type":"string","description":"Provides a projected \"at expiration\" margin value based on the soon-to-expire contracts in your portfolio."},"current_maint":{"type":"string","description":"The amount of equity required to maintain your positions."},"projected_liquidity_inital_margin":{"type":"string","description":"Provides a projected \"liquid\" initial margin value based on account liquidation value."},"Prjctd Lk Ahd Mntnnc Mrgn":{"type":"string","description":"If it is 3:00 pm ET, the next calculation you're looking ahead to is after the close, or the Overnight Initial Margin. If it's 3:00 am ET, the next calculation will be at the market's open.\n * `Securities` - Projected maintenance margin requirement as of next period's margin change, in the base currency of the account. \n * `Commodities` - Maintenance margin requirement as of next period's margin change in the base currency of the account based on current margin requirements, which are subject to change. This value depends on when you are viewing your margin requirements.\n"},"projected_overnight_initial_margin":{"type":"string","description":"Overnight refers to the window of time after the local market trading day is closed. \n  * Securities - Projected overnight initial margin requirement in the base currency of the account. \n  * Commodities - Overnight initial margin requirement in the base currency of the account based on current margin requirements, which are subject to change.\n"},"Prjctd Ovrnght Mntnnc Mrgn":{"type":"string","description":"Overnight refers to the window of time after the local market trading day is closed. \n  * `Securities` - Projected overnight maintenance margin requirement in the base currency of the account. \n  * `Commodities` - Overnight maintenance margin requirement in the base currency of the account based on current margin requirements, which are subject to change.\n"}},"title":"SummaryOfAccountMarginResponseTotal"},"SummaryOfAccountMarginResponseCryptoAtPaxos":{"type":"object","properties":{"current_initial":{"type":"string","description":"The minimum amount required to open a new position."},"Prdctd Pst-xpry Mrgn @ Opn":{"type":"string","description":"Provides a projected \"at expiration\" margin value based on the soon-to-expire contracts in your portfolio."},"current_maint":{"type":"string","description":"The amount of equity required to maintain your positions."},"projected_liquidity_inital_margin":{"type":"string","description":"Provides a projected \"liquid\" initial margin value based on account liquidation value."},"Prjctd Lk Ahd Mntnnc Mrgn":{"type":"string","description":"If it is 3:00 pm ET, the next calculation you're looking ahead to is after the close, or the Overnight Initial Margin. If it's 3:00 am ET, the next calculation will be at the market's open.\n * `Securities` - Projected maintenance margin requirement as of next period's margin change, in the base currency of the account. \n * `Commodities` - Maintenance margin requirement as of next period's margin change in the base currency of the account based on current margin requirements, which are subject to change. This value depends on when you are viewing your margin requirements.\n"},"projected_overnight_initial_margin":{"type":"string","description":"Overnight refers to the window of time after the local market trading day is closed. \n  * Securities - Projected overnight initial margin requirement in the base currency of the account. \n  * Commodities - Overnight initial margin requirement in the base currency of the account based on current margin requirements, which are subject to change.\n"},"Prjctd Ovrnght Mntnnc Mrgn":{"type":"string","description":"Overnight refers to the window of time after the local market trading day is closed. \n  * `Securities` - Projected overnight maintenance margin requirement in the base currency of the account. \n  * `Commodities` - Overnight maintenance margin requirement in the base currency of the account based on current margin requirements, which are subject to change.\n"}},"title":"SummaryOfAccountMarginResponseCryptoAtPaxos"},"SummaryOfAccountMarginResponseCommodities":{"type":"object","properties":{"RegT Margin":{"type":"string","description":"The current RegT margin in use."},"current_initial":{"type":"string","description":"The minimum amount required to open a new position."},"Prdctd Pst-xpry Mrgn @ Opn":{"type":"string","description":"Provides a projected \"at expiration\" margin value based on the soon-to-expire contracts in your portfolio."},"current_maint":{"type":"string","description":"The amount of equity required to maintain your positions."},"projected_liquidity_inital_margin":{"type":"string","description":"Provides a projected \"liquid\" initial margin value based on account liquidation value."},"Prjctd Lk Ahd Mntnnc Mrgn":{"type":"string","description":"If it is 3:00 pm ET, the next calculation you're looking ahead to is after the close, or the Overnight Initial Margin. If it's 3:00 am ET, the next calculation will be at the market's open.\n * `Securities` - Projected maintenance margin requirement as of next period's margin change, in the base currency of the account. \n * `Commodities` - Maintenance margin requirement as of next period's margin change in the base currency of the account based on current margin requirements, which are subject to change. This value depends on when you are viewing your margin requirements.\n"},"projected_overnight_initial_margin":{"type":"string","description":"Overnight refers to the window of time after the local market trading day is closed. \n  * Securities - Projected overnight initial margin requirement in the base currency of the account. \n  * Commodities - Overnight initial margin requirement in the base currency of the account based on current margin requirements, which are subject to change.\n"},"Prjctd Ovrnght Mntnnc Mrgn":{"type":"string","description":"Overnight refers to the window of time after the local market trading day is closed. \n  * `Securities` - Projected overnight maintenance margin requirement in the base currency of the account. \n  * `Commodities` - Overnight maintenance margin requirement in the base currency of the account based on current margin requirements, which are subject to change.\n"}},"title":"SummaryOfAccountMarginResponseCommodities"},"SummaryOfAccountMarginResponseSecurities":{"type":"object","properties":{"current_initial":{"type":"string","description":"The minimum amount required to open a new position."},"Prdctd Pst-xpry Mrgn @ Opn":{"type":"string","description":"Provides a projected \"at expiration\" margin value based on the soon-to-expire contracts in your portfolio."},"current_maint":{"type":"string","description":"The amount of equity required to maintain your positions."},"projected_liquidity_inital_margin":{"type":"string","description":"Provides a projected \"liquid\" initial margin value based on account liquidation value."},"Prjctd Lk Ahd Mntnnc Mrgn":{"type":"string","description":"If it is 3:00 pm ET, the next calculation you're looking ahead to is after the close, or the Overnight Initial Margin. If it's 3:00 am ET, the next calculation will be at the market's open.\n * `Securities` - Projected maintenance margin requirement as of next period's margin change, in the base currency of the account. \n * `Commodities` - Maintenance margin requirement as of next period's margin change in the base currency of the account based on current margin requirements, which are subject to change. This value depends on when you are viewing your margin requirements.\n"},"projected_overnight_initial_margin":{"type":"string","description":"Overnight refers to the window of time after the local market trading day is closed. \n  * Securities - Projected overnight initial margin requirement in the base currency of the account. \n  * Commodities - Overnight initial margin requirement in the base currency of the account based on current margin requirements, which are subject to change.\n"},"Prjctd Ovrnght Mntnnc Mrgn":{"type":"string","description":"Overnight refers to the window of time after the local market trading day is closed. \n  * `Securities` - Projected overnight maintenance margin requirement in the base currency of the account. \n  * `Commodities` - Overnight maintenance margin requirement in the base currency of the account based on current margin requirements, which are subject to change.  \n"}},"title":"SummaryOfAccountMarginResponseSecurities"},"summaryOfAccountMarginResponse":{"type":"object","properties":{"total":{"$ref":"#/components/schemas/SummaryOfAccountMarginResponseTotal"},"Crypto at Paxos":{"$ref":"#/components/schemas/SummaryOfAccountMarginResponseCryptoAtPaxos"},"commodities":{"$ref":"#/components/schemas/SummaryOfAccountMarginResponseCommodities"},"securities":{"$ref":"#/components/schemas/SummaryOfAccountMarginResponseSecurities"}},"title":"summaryOfAccountMarginResponse"},"SummaryMarketValueResponseCurrency":{"type":"object","properties":{"total_cash":{"type":"string","description":"Lists the total cash held for the given currency."},"settled_cash":{"type":"string","description":"Cash recognized at the time of settlement minus the purchases at time of trade, commissions, taxes, and fees."},"MTD Interest":{"type":"string","description":"Total Month-to-date interest."},"stock":{"type":"string","description":"Total cash value of stocks held."},"options":{"type":"string","description":"Total cash value of options held."},"futures":{"type":"string","description":"Total cash value of futures held."},"future_options":{"type":"string","description":"Total cash value of future options held."},"funds":{"type":"string","description":"Total cash value of funds held."},"dividends_receivable":{"type":"string","description":"Total cash value of receivable dividends."},"mutual_funds":{"type":"string","description":"Total cash value of mutual funds held."},"money_market":{"type":"string","description":"Total cash value of money market securities held."},"bonds":{"type":"string","description":"Total cash value of bonds held."},"Govt Bonds":{"type":"string","description":"Total cash value of goverment bonds held."},"t_bills":{"type":"string","description":"Total cash value of t-bill bonds held."},"warrants":{"type":"string","description":"Total cash value of warrants held."},"issuer_option":{"type":"string","description":"Total cash value of issuer options held."},"commodity":{"type":"string","description":"Total cash value of commodities held."},"Notional CFD":{"type":"string","description":"Total cash value of notional CFDs held."},"cfd":{"type":"string","description":"Total cash value of CFDs held."},"Cryptocurrency":{"type":"string","description":"Total cash value of Cryptocurrencies held."},"net_liquidation":{"type":"string","description":"Total cash value of your net liquidty."},"unrealized_pnl":{"type":"string","description":"Total daily unrealized profit and loss."},"realized_pnl":{"type":"string","description":"Total daily realized profit and loss."},"Exchange Rate":{"type":"string","description":"Exchange rate of the labeled currency to the base currency."}},"description":"Returns an object containing market value details of the currency and positions held using that currency.","title":"SummaryMarketValueResponseCurrency"},"summaryMarketValueResponse":{"type":"object","properties":{"currency":{"$ref":"#/components/schemas/SummaryMarketValueResponseCurrency","description":"Returns an object containing market value details of the currency and positions held using that currency."}},"title":"summaryMarketValueResponse"},"AccountSummaryResponseCashBalancesItems":{"type":"object","properties":{"currency":{"type":"string","description":"The currency the values represent. Base currency represented as \"Total (in {BaseCurrency})\"\n"},"balance":{"type":"number","format":"double","description":"The total available currency held in the account."},"settledCash":{"type":"number","format":"double","description":"The available settled cash that can be withdrawn from the account."}},"title":"AccountSummaryResponseCashBalancesItems"},"accountSummaryResponse":{"type":"object","properties":{"accountType":{"type":"string","description":"Describes the unique account type. For standard individual accounts, an empty string is returned."},"status":{"type":"string","description":"If the account is currently non-tradeable, a status message will be dispalyed."},"balance":{"type":"number","format":"double","description":"Returns the total account balance."},"SMA":{"type":"number","format":"double","description":"Simple Moving Average of the account."},"buyingPower":{"type":"number","format":"double","description":"Total buying power available for the account."},"availableFunds":{"type":"number","format":"double","description":"The amount of equity you have available for trading. For both the Securities and Commodities segments, this is calculated as: Equity with Loan Value - Initial Margin."},"excessLiquidity":{"type":"number","format":"double","description":"The amount of cash in excess of the usual requirement in your account."},"netLiquidationValue":{"type":"number","format":"double","description":"The basis for determining the price of the assets in your account."},"equityWithLoanValue":{"type":"number","format":"double","description":"The basis for determining whether you have the necessary assets to either initiate or maintain security assets."},"regTLoan":{"type":"number","format":"double","description":"The Federal Reserve Board regulation governing the amount of credit that broker dealers may extend to clients who borrow money to buy securities on margin."},"securitiesGVP":{"type":"number","format":"double","description":"Absolute value of the Long Stock Value + Short Stock Value + Long Option Value + Short Option Value + Fund Value."},"totalCashValue":{"type":"number","format":"double","description":"Cash recognized at the time of trade + futures P&L. This value reflects real-time currency positions, including:\n *  Trades executed directly through the FX market.\n *  Trades executed as a result of automatic IB conversions, which occur when you trade a product in a non-base currency.\n *  Trades deliberately executed to close non-base currency positions using the FXCONV destination.\n"},"accruedInterest":{"type":"number","format":"double","description":"Accrued interest is the interest accruing on a security since the previous coupon date. If a security is sold between two payment dates, the buyer usually compensates the seller for the interest accrued, either within the price or as a separate payment."},"regTMargin":{"type":"number","format":"double","description":"The initial margin requirements calculated under US Regulation T rules for both the securities and commodities segment of your account."},"initialMargin":{"type":"number","format":"double","description":"The available initial margin for the account."},"maintenanceMargin":{"type":"number","format":"double","description":"The available maintenance margin for the account."},"cashBalances":{"type":"array","items":{"$ref":"#/components/schemas/AccountSummaryResponseCashBalancesItems"},"description":"An array containing balance information for all currencies held by the account."}},"description":"Successful return contianing an array of at-a-glance account details.","title":"accountSummaryResponse"},"AvailableFundsResponseTotal":{"type":"object","properties":{"current_available":{"type":"string","description":"Describes currently avialable funds in your account for trading."},"current_excess":{"type":"string","description":"Describes total value of the account."},"Prdctd Pst-xpry Excss":{"type":"string","description":"Displays predicted post-expiration account value."},"Lk Ahd Avlbl Fnds":{"type":"string","description":"This value reflects your available funds at the next margin change."},"Lk Ahd Excss Lqdty":{"type":"string","description":"* `Securities` - Equity with loan value. Look ahead maintenance margin.\n * `Commodities` - Net Liquidation value. Look ahead maintenance margin.\n"},"overnight_available":{"type":"string","description":"Describes available funds for overnight trading."},"overnight_excess":{"type":"string","description":"Overnight refers to the window of time after the local market trading day is closed. \n  * `Securities` - Equivalent to regular trading hours. \n   * `Commodities` - Commodities Net Liquidation value. Overnight Maintenance margin.\n"},"buying_power":{"type":"string","description":"Describes the total buying power of the account including existing balance with margin."},"leverage":{"type":"string","description":"Describes the total combined leverage."},"Lk Ahd Nxt Chng":{"type":"string","description":"Describes when the next 'Look Ahead' calculation will take place."},"day_trades_left":{"type":"string","description":"Describes the number of trades remaining before flagging the Pattern Day Trader status. \"Unlimited\" is used for existing Pattern Day Traders."}},"description":"total values","title":"AvailableFundsResponseTotal"},"funds":{"type":"object","properties":{"current_available":{"type":"string","description":"Describes currently avialable funds in your account for trading."},"current_excess":{"type":"string","description":"Describes total value of the account."},"Prdctd Pst-xpry Excss":{"type":"string","description":"Displays predicted post-expiration account value."},"Lk Ahd Avlbl Fnds":{"type":"string","description":"This value reflects your available funds at the next margin change."},"overnight_available":{"type":"string","description":"Describes available funds for overnight trading."},"overnight_excess":{"type":"string","description":"Overnight refers to the window of time after the local market trading day is closed. \n  * `Securities` - Equivalent to regular trading hours. \n   * `Commodities` - Commodities Net Liquidation value. Overnight Maintenance margin.\n"}},"description":"Contains commodities specific fund values.","title":"funds"},"AvailableFundsResponseSecurities":{"type":"object","properties":{"current_available":{"type":"string","description":"Describes currently avialable funds in your account for trading."},"current_excess":{"type":"string","description":"Describes total value of the account."},"Prdctd Pst-xpry Excss":{"type":"string","description":"Displays predicted post-expiration account value."},"SMA":{"type":"string"},"Lk Ahd Avlbl Fnds":{"type":"string","description":"This value reflects your available funds at the next margin change."},"Lk Ahd Excss Lqdty":{"type":"string","description":"* `Securities` - Equity with loan value. Look ahead maintenance margin.\n * `Commodities` - Net Liquidation value. Look ahead maintenance margin.\n"},"overnight_available":{"type":"string","description":"Describes available funds for overnight trading."},"overnight_excess":{"type":"string","description":"Overnight refers to the window of time after the local market trading day is closed. \n  * `Securities` - Equivalent to regular trading hours. \n   * `Commodities` - Commodities Net Liquidation value. Overnight Maintenance margin.\n"},"leverage":{"type":"string","description":"Describes the total combined leverage."}},"description":"Contains an overview of Security specific fund values.","title":"AvailableFundsResponseSecurities"},"availableFundsResponse":{"type":"object","properties":{"total":{"$ref":"#/components/schemas/AvailableFundsResponseTotal","description":"total values"},"Crypto at Paxos":{"$ref":"#/components/schemas/funds"},"commodities":{"$ref":"#/components/schemas/funds"},"securities":{"$ref":"#/components/schemas/AvailableFundsResponseSecurities","description":"Contains an overview of Security specific fund values."}},"description":"Contains a combined overview of Commidity, Security and Crypto fund values.","title":"availableFundsResponse"},"AlertActivationRequestAlertActive":{"type":"string","enum":["1","0"],"description":"Set whether or not the alert should be active (1) or inactive (0).","title":"AlertActivationRequestAlertActive"},"alertActivationRequest":{"type":"object","properties":{"alertId":{"type":"integer","format":"int64","description":"The alert Identifier"},"alertActive":{"$ref":"#/components/schemas/AlertActivationRequestAlertActive","description":"Set whether or not the alert should be active (1) or inactive (0)."}},"required":["alertId","alertActive"],"title":"alertActivationRequest"},"alertActivationResponse":{"type":"object","properties":{"request_id":{"type":"integer","format":"int64"},"order_id":{"type":"integer","format":"int64","description":"The tracking number of the alert. Occasssionally referenced as the alertId or alert_id.\n"},"success":{"type":"boolean","description":"Displays result status of alert request"},"text":{"type":"string","description":"Response message to clarify success status reason."},"failure_list":{"type":"string","description":"If \"success\" returns false, will list failed order Ids"}},"title":"alertActivationResponse"},"alertDeletionResponse":{"type":"object","properties":{"request_id":{"type":"integer","format":"int64","description":"Not applicable"},"order_id":{"type":"integer","format":"int64","description":"The tracking number of the alert. Occasssionally referenced as the alertId or alert_id.\n"},"success":{"type":"boolean","description":"Displays result status of alert request"},"text":{"type":"string","description":"Response message to clarify success status reason."},"failure_list":{"type":"string","description":"If \"success\" returns false, will list failed order Ids"}},"title":"alertDeletionResponse"},"AlertDetailsAlertActive":{"type":"string","enum":["1","0"],"description":"Returns if the alert is active [1] or disabled [0].","title":"AlertDetailsAlertActive"},"AlertDetailsOrderStatus":{"type":"string","enum":["Presubmitted","Submitted"],"description":"represent order statusAlways returns \"Presubmitted\".","title":"AlertDetailsOrderStatus"},"alertCondition":{"type":"object","properties":{"condition_type":{"type":"integer","format":"int64","description":"The type of condition set."},"conidex":{"type":"string","description":"Returns conid and exchange in the format \"conid@exchange\""},"contract_description_1":{"type":"string","description":"Includes relevant descriptions (if applicable)."},"condition_operator":{"type":"string","description":"Condition operator set for alert."},"condition_trigger_method":{"type":"integer","format":"int64","description":"TriggerMethod value set."},"condition_value":{"type":"string","description":"Condition value set."},"condition_logic_bind":{"type":"boolean","description":"Condition logic_bind value set."},"condition_time_zone":{"type":"string","description":"Condition timeZone value set."}},"title":"alertCondition"},"alertDetails":{"type":"object","properties":{"account":{"type":"string","description":"Requestor's account ID"},"order_id":{"type":"integer","format":"int64","description":"Alert's tracking ID. Can be used for modifying or deleting alerts."},"alertName":{"type":"string","description":"Human readable name of the alert."},"tif":{"type":"string","description":"Time in Force effective for the Alert"},"expire_time":{"type":"string","description":"Returns the UTC formatted date used in GTD orders."},"alert_active":{"$ref":"#/components/schemas/AlertDetailsAlertActive","description":"Returns if the alert is active [1] or disabled [0]."},"alert_repeatable":{"type":"integer","format":"int64","description":"Returns if the alert can be sent more than once."},"alert_email":{"type":"string","description":"Returns the designated email address for sendMessage functionality."},"alert_send_message":{"type":"integer","format":"int64","description":"Returns whether or not the alert will send an email."},"alert_message":{"type":"string","description":"Returns the body content of what your alert will report once triggered"},"alert_show_popup":{"type":"integer","format":"int64","description":"Returns whether or not the alert will trigger TWS Pop-up messages"},"alert_play_audio":{"type":"integer","format":"int64","description":"Returns whether or not the alert will play audio"},"order_status":{"$ref":"#/components/schemas/AlertDetailsOrderStatus","description":"represent order statusAlways returns \"Presubmitted\"."},"alert_triggered":{"type":"integer","format":"int64","description":"Returns whether or not the alert was triggered yet."},"fg_color":{"type":"string","description":"Foreground color. Not applicable to API."},"bg_color":{"type":"string","description":"Background color. Not applicable to API."},"order_not_editable":{"type":"boolean","description":"Returns if the order can be edited."},"itws_orders_only":{"type":"integer","format":"int64","description":"Returns whether or not the alert will trigger mobile notifications."},"alert_mta_currency":{"type":"string","description":"Returns currency set for MTA alerts. Only valid for alert type 8 & 9."},"alert_mta_defaults":{"type":"string","description":"Returns current MTA default values."},"tool_id":{"type":"integer","format":"int64","description":"Tracking ID for MTA alerts only. Returns 'null' for standard alerts."},"time_zone":{"type":"string","description":"Returned for time-specific conditions."},"alert_default_type":{"type":"integer","format":"int64","description":"Returns default type set for alerts. Configured in Client Portal."},"condition_size":{"type":"integer","format":"int64","description":"Returns the total number of conditions in the alert."},"condition_outside_rth":{"type":"integer","format":"int64","description":"Returns whether or not the alert will trigger outside of regular trading hours."},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/alertCondition"},"description":"Returns all conditions"}},"description":"details of the specified alert","title":"alertDetails"},"V1ApiIserverAccountAlertAlertIdGetParametersType":{"type":"string","enum":["Q"],"description":"queryType","title":"V1ApiIserverAccountAlertAlertIdGetParametersType"},"AlertAlertActive":{"type":"string","enum":["1","0"],"description":"Determines if the alert is active [1] or not [0]","title":"AlertAlertActive"},"AlertAlertRepeatable":{"type":"string","enum":["1","0"],"description":"Confirms if the alert is enabled to occur more than once.","title":"AlertAlertRepeatable"},"alert":{"type":"object","properties":{"order_id":{"type":"integer","format":"int64","description":"The order id (alert id)"},"account":{"type":"string","description":"The account the alert was attributed to."},"alert_name":{"type":"string","description":"The requested name for the alert."},"alert_active":{"$ref":"#/components/schemas/AlertAlertActive","description":"Determines if the alert is active [1] or not [0]"},"order_time":{"type":"string","description":"UTC-formatted time of the alert's creation."},"alert_triggered":{"type":"boolean","description":"Confirms if the order is triggered or not."},"alert_repeatable":{"$ref":"#/components/schemas/AlertAlertRepeatable","description":"Confirms if the alert is enabled to occur more than once."}},"description":"An array containing all alerts as separate objects.","title":"alert"},"alerts":{"type":"array","items":{"$ref":"#/components/schemas/alert"},"title":"alerts"},"CurrencyPairsItems":{"type":"object","properties":{"symbol":{"type":"string","description":"The official symbol of the given currency pair."},"conid":{"type":"integer","format":"int64","description":"The official contract identifier of the given currency pair."},"ccyPair":{"type":"string","description":"Returns the symbol counterpart."}},"title":"CurrencyPairsItems"},"currencyPairs":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/CurrencyPairsItems"}},"title":"currencyPairs"},"Trading Contracts_getExchangeRates_Response_200":{"type":"object","properties":{"rate":{"type":"number","format":"double","description":"Returns the exchange rate for the currency pair."}},"title":"Trading Contracts_getExchangeRates_Response_200"},"contractInfo":{"type":"object","properties":{"cfi_code":{"type":"string","description":"Classification of Financial Instrument codes"},"symbol":{"type":"string","description":"Underlying symbol"},"cusip":{"type":["string","null"],"description":"Returns the CUSIP for the given instrument. Only used in BOND trading."},"expiry_full":{"type":"string","description":"Returns the expiration month of the contract."},"con_id":{"type":"integer","format":"int64","description":"Indicates the contract identifier of the given contract."},"maturity_date":{"type":"string","description":"Indicates the final maturity date of the given contract."},"industry":{"type":"string","description":"Specific group of companies or businesses."},"instrument_type":{"type":"string","description":"Asset class of the instrument."},"trading_class":{"type":"string","description":"Designated trading class of the contract."},"valid_exchanges":{"type":"string","description":"Comma separated list of support exchanges or trading venues."},"allow_sell_long":{"type":"boolean","description":"Allowed to sell shares you own."},"is_zero_commission_security":{"type":"boolean","description":"Indicates if the contract supports zero commission trading."},"local_symbol":{"type":"string","description":"Contract's symbol from primary exchange. For options it is the OCC symbol."},"contract_clarification_type":{"type":"string"},"classifier":{"type":"string"},"currency":{"type":"string","description":"Base currency contract is traded in."},"text":{"type":"string","description":"Indicates the display name of the contract, as shown with Client Portal."},"underlying_con_id":{"type":"integer","format":"int64","description":"Underlying contract identifier for the requested contract."},"r_t_h":{"type":"boolean","description":"Indicates if the contract can be traded outside regular trading hours or not."},"multiplier":{"type":"string","description":"Indicates the multiplier of the contract."},"underlying_issuer":{"type":"string","description":"Indicates the issuer of the underlying."},"contract_month":{"type":"string","description":"Indicates the year and month the contract expires."},"company_name":{"type":"string","description":"Indicates the name of the company or index."},"smart_available":{"type":"boolean","description":"Indicates if the contract can be smart routed or not."},"exchange":{"type":"string","description":"Indicates the primary exchange for which the contract can be traded."},"category":{"type":"string","description":"Indicates the industry category of the instrument."}},"title":"contractInfo"},"V1ApiIserverSecdefInfoGetParametersRight":{"type":"string","enum":["C","P"],"description":"Set the right for the given contract. * `C` - for Call options. * `P` - for Put options.\n","title":"V1ApiIserverSecdefInfoGetParametersRight"},"SecDefInfoResponseRight":{"type":"string","enum":["P","C"],"description":"Set the right for the given contract. * `C` - for Call options. * `P` - for Put options.\n","title":"SecDefInfoResponseRight"},"secDefInfoResponse":{"type":"object","properties":{"conid":{"type":"integer","format":"int64","description":"Contract Identifier of the given contract."},"ticker":{"type":"string","description":"Ticker symbol for the given contract"},"secType":{"type":"string","description":"Security type for the given contract."},"listingExchange":{"type":"string","description":"Primary listing exchange for the given contract."},"exchange":{"type":"string","description":"Exchange requesting data for."},"companyName":{"type":"string","description":"Name of the company for the given contract."},"currency":{"type":"string","description":"Traded currency allowed for the given contract."},"validExchanges":{"type":"string","description":"Series of all valid exchanges the contract can be traded on in a single comma-separated string."},"priceRendering":{"type":["string","null"]},"maturityDate":{"type":["string","null"],"description":"Date of expiration for the given contract."},"right":{"$ref":"#/components/schemas/SecDefInfoResponseRight","description":"Set the right for the given contract. * `C` - for Call options. * `P` - for Put options.\n"},"strike":{"type":"number","format":"double","description":"Returns the given strike value for the given contract."}},"title":"secDefInfoResponse"},"TrsrvSecDefResponseSecdefItemsIncrementRulesItems":{"type":"object","properties":{"lowerEdge":{"type":"number","format":"double","description":"If the current mark price of the instrument is at or above the lower edge, the given increment value is used for order prices."},"increment":{"type":"number","format":"double","description":"The price of the instrument must be submitted as a mulitple of the increment value."}},"title":"TrsrvSecDefResponseSecdefItemsIncrementRulesItems"},"TrsrvSecDefResponseSecdefItemsDisplayRuleItemsDisplayRuleStepItems":{"type":"object","properties":{"decimalDigits":{"type":"integer","format":"int64","description":"Displays the total number of digits used after the decimal value."},"lowerEdge":{"type":"number","format":"double","description":"The lowerEdge display value to correspond to increment rules."},"wholeDigits":{"type":"integer","format":"int64","description":"Displays valid display prices for before and after the decimal value."}},"title":"TrsrvSecDefResponseSecdefItemsDisplayRuleItemsDisplayRuleStepItems"},"TrsrvSecDefResponseSecdefItemsDisplayRuleItems":{"type":"object","properties":{"magnification":{"type":"integer","format":"int64","description":"If the displayed contract information is multiplied based on a given magnitude, the value will be reflected here."},"displayRuleStep":{"type":"array","items":{"$ref":"#/components/schemas/TrsrvSecDefResponseSecdefItemsDisplayRuleItemsDisplayRuleStepItems"}}},"title":"TrsrvSecDefResponseSecdefItemsDisplayRuleItems"},"TrsrvSecDefResponseSecdefItems":{"type":"object","properties":{"conid":{"type":"integer","format":"int64","description":"The conID"},"currency":{"type":"string","description":"The traded currency for the contract."},"time":{"type":"integer","format":"int64","description":"Amount of time in ms to generate the data."},"chineseName":{"type":"string","description":"The Chinese characters for the symbol."},"allExchanges":{"type":"string","description":"A series of exchanges the given symbol can trade on."},"listingExchange":{"type":"string","description":"The primary or listing exchange the contract is hosted on."},"countryCode":{"type":"string","description":"The country code the contract is traded on."},"name":{"type":"string","description":"The company name."},"assetClass":{"type":"string","description":"The asset class or security type of the contract."},"expiry":{"type":["string","null"],"description":"The expiry of the contract. Returns null for non-expiry instruments."},"lastTradingDay":{"type":["string","null"],"description":"The last trading day of the contract."},"group":{"type":"string","description":"The group or industry the contract is affilated with."},"putOrCall":{"type":["string","null"],"description":"a Put or Call option."},"sector":{"type":"string","description":"The contract's sector."},"sectorGroup":{"type":"string","description":"The sector's group."},"strike":{"type":"string","description":"The strike of the contract."},"ticker":{"type":"string","description":"The ticker symbol of the traded contract."},"undConid":{"type":"integer","format":"int64","description":"The contract's underlyer."},"multiplier":{"type":"integer","format":"int64","description":"The contract multiplier."},"type":{"type":"string","description":"Stock type."},"hasOptions":{"type":"boolean","description":"contract has tradable options contracts."},"fullName":{"type":"string","description":"Returns symbol name for requested contract."},"isUS":{"type":"boolean","description":"The contract is US based or not."},"incrementRules":{"type":"array","items":{"$ref":"#/components/schemas/TrsrvSecDefResponseSecdefItemsIncrementRulesItems"},"description":"Indicates increment rule values including lowerEdge and increment value."},"displayRule":{"type":"array","items":{"$ref":"#/components/schemas/TrsrvSecDefResponseSecdefItemsDisplayRuleItems"},"description":"Returns rules regarding incrementation for order placement. Not functional for all exchanges. Please see /iserver/contract/rules for more accurate rule details."},"isEventContract":{"type":"boolean","description":"The contract is an event contract or not."},"pageSize":{"type":"integer","format":"int64","description":"Returns the content size of the request."}},"title":"TrsrvSecDefResponseSecdefItems"},"trsrvSecDefResponse":{"type":"object","properties":{"secdef":{"type":"array","items":{"$ref":"#/components/schemas/TrsrvSecDefResponseSecdefItems"}}},"description":"a contract's security definition","title":"trsrvSecDefResponse"},"ContractRulesOrderTypesItems":{"type":"string","enum":["limit","midprice","market","stop","stop_limit","mit","lit","trailing_stop","trailing_stop_limit","relative","marketonclose","limitonclose"],"title":"ContractRulesOrderTypesItems"},"ContractRulesIbAlgoTypesItems":{"type":"string","enum":["limit","stop_limit","lit","trailing_stop_limit","relative","marketonclose","limitonclose"],"title":"ContractRulesIbAlgoTypesItems"},"ContractRulesFraqTypesItems":{"type":"string","enum":["limit","market","stop","stop_limit","mit","lit","trailing_stop","trailing_stop_limit"],"title":"ContractRulesFraqTypesItems"},"ContractRulesCqtTypesItems":{"type":"string","enum":["limit","market","stop","stop_limit","mit","lit","trailing_stop","trailing_stop_limit"],"title":"ContractRulesCqtTypesItems"},"ContractRulesOrderDefaultsLmt":{"type":"object","properties":{"LP":{"type":"string","description":"Indicates a Limit Price default value."}},"title":"ContractRulesOrderDefaultsLmt"},"ContractRulesOrderDefaults":{"type":"object","properties":{"LMT":{"$ref":"#/components/schemas/ContractRulesOrderDefaultsLmt"}},"description":"Indicates default order type for the given security type.","title":"ContractRulesOrderDefaults"},"ContractRulesOrderTypesOutsideItems":{"type":"string","enum":["limit","stop_limit","lit","trailing_stop_limit","relative"],"title":"ContractRulesOrderTypesOutsideItems"},"ContractRulesTifDefaults":{"type":"object","properties":{"TIF":{"type":"string","description":"The default TIF type for orders."},"SIZE":{"type":"string","description":"The default size value for orders."},"DEFAULT_ACCT":{"type":"string","description":"default account (multi account only)"},"PMALGO":{"type":"boolean"}},"description":"Object containing details about your TIF value defaults. These defaults can be viewed and modified in TWS's within the Global Configuration.\n","title":"ContractRulesTifDefaults"},"ContractRulesIncrementRulesItems":{"type":"object","properties":{"lowerEdge":{"type":"integer","format":"int64","description":"If the current mark price of the instrument is at or above the lower edge, the given increment value is used for order prices."},"increment":{"type":"integer","format":"int64","description":"The price of the instrument must be submitted as a mulitple of the increment value."}},"title":"ContractRulesIncrementRulesItems"},"contractRules":{"type":"object","properties":{"algoEligible":{"type":"boolean","description":"Indicates if the contract can trade algos or not."},"allOrNoneEligible":{"type":"boolean","description":"indicates all or non option is eligible for given contract."},"costReport":{"type":"boolean","description":"Indicates whether or not a cost report has been requested (Client Portal only)."},"canTradeAcctIds":{"type":"array","items":{"type":"string"},"description":"Indicates permitted accountIDs that may trade the contract."},"error":{"type":["string","null"],"description":"If rules information can not be received for any reason, it will be expressed here."},"orderTypes":{"type":"array","items":{"$ref":"#/components/schemas/ContractRulesOrderTypesItems"},"description":"Indicates permitted order types for use with standard quantity trading."},"ibAlgoTypes":{"type":"array","items":{"$ref":"#/components/schemas/ContractRulesIbAlgoTypesItems"},"description":"Indicates permitted algo types for use with the given contract."},"fraqTypes":{"type":"array","items":{"$ref":"#/components/schemas/ContractRulesFraqTypesItems"},"description":"Indicates permitted order types for use with fractional trading."},"forceOrderPreview":{"type":"boolean","description":"Indicates if the order preview is forced upon the user before submission."},"cqtTypes":{"type":"array","items":{"$ref":"#/components/schemas/ContractRulesCqtTypesItems"},"description":"Indicates accepted order types for use with cash quantity."},"orderDefaults":{"$ref":"#/components/schemas/ContractRulesOrderDefaults","description":"Indicates default order type for the given security type."},"orderTypesOutside":{"type":"array","items":{"$ref":"#/components/schemas/ContractRulesOrderTypesOutsideItems"},"description":"Indicates permitted order types for use outside of regular trading hours."},"defaultSize":{"type":"integer","format":"int64","description":"Default total quantity value for orders."},"cashSize":{"type":"integer","format":"int64","description":"Default cash value quantity."},"sizeIncrement":{"type":"integer","format":"int64","description":"Indicates quantity increase for the contract."},"tifTypes":{"type":"array","items":{"type":"string"},"description":"Indicates allowed tif types supported for the contract."},"tifDefaults":{"$ref":"#/components/schemas/ContractRulesTifDefaults","description":"Object containing details about your TIF value defaults. These defaults can be viewed and modified in TWS's within the Global Configuration.\n"},"limitPrice":{"type":"number","format":"double","description":"Default limit price for the given contract."},"stopPrice":{"type":"number","format":"double","description":"Default stop price for the given contract."},"orderOrigination":{"type":["string","null"],"description":"Order origin designation for US securities options and Options Clearing Corporation"},"preview":{"type":"boolean","description":"Indicates if the order preview is required (for client portal only)"},"displaySize":{"type":["integer","null"],"format":"int64","description":"Standard display increment rule for the instrument."},"fraqInt":{"type":"integer","format":"int64","description":"Indicates decimal places for fractional order size."},"cashCcy":{"type":"string","description":"Indicates base currency for the instrument."},"cashQtyIncr":{"type":"integer","format":"int64","description":"Indicates cash quantity increment rules."},"priceMagnifier":{"type":["integer","null"],"format":"int64","description":"Signifies the magnifier of a given contract. This is separate from the price multiplier, and will typically return 'null'\n"},"negativeCapable":{"type":"boolean","description":"Indicates if the value of the contract can be negative (true) or if it is always positive (false)."},"incrementType":{"type":"integer","format":"int64","description":"Indicates the type of increment style."},"incrementRules":{"type":"array","items":{"$ref":"#/components/schemas/ContractRulesIncrementRulesItems"},"description":"Indicates increment rule values including lowerEdge and increment value."},"hasSecondary":{"type":"boolean"},"modTypes":{"type":"array","items":{"description":"Any type"},"description":"Lists the available order types supported when modifying the order."},"increment":{"type":"number","format":"double","description":"Minimum increment values for prices"},"incrementDigits":{"type":"integer","format":"int64","description":"Number of decimal places to indicate the increment value."}},"description":"detailed contract information","title":"contractRules"},"Trading Contracts_getInfoAndRules_Response_200":{"type":"object","properties":{"cfi_code":{"type":"string","description":"Classification of Financial Instrument codes"},"symbol":{"type":"string","description":"Underlying symbol"},"cusip":{"type":["string","null"],"description":"Returns the CUSIP for the given instrument. Only used in BOND trading."},"expiry_full":{"type":"string","description":"Returns the expiration month of the contract."},"con_id":{"type":"integer","format":"int64","description":"Indicates the contract identifier of the given contract."},"maturity_date":{"type":"string","description":"Indicates the final maturity date of the given contract."},"industry":{"type":"string","description":"Specific group of companies or businesses."},"instrument_type":{"type":"string","description":"Asset class of the instrument."},"trading_class":{"type":"string","description":"Designated trading class of the contract."},"valid_exchanges":{"type":"string","description":"Comma separated list of support exchanges or trading venues."},"allow_sell_long":{"type":"boolean","description":"Allowed to sell shares you own."},"is_zero_commission_security":{"type":"boolean","description":"Indicates if the contract supports zero commission trading."},"local_symbol":{"type":"string","description":"Contract's symbol from primary exchange. For options it is the OCC symbol."},"contract_clarification_type":{"type":"string"},"classifier":{"type":"string"},"currency":{"type":"string","description":"Base currency contract is traded in."},"text":{"type":"string","description":"Indicates the display name of the contract, as shown with Client Portal."},"underlying_con_id":{"type":"integer","format":"int64","description":"Underlying contract identifier for the requested contract."},"r_t_h":{"type":"boolean","description":"Indicates if the contract can be traded outside regular trading hours or not."},"multiplier":{"type":"string","description":"Indicates the multiplier of the contract."},"underlying_issuer":{"type":"string","description":"Indicates the issuer of the underlying."},"contract_month":{"type":"string","description":"Indicates the year and month the contract expires."},"company_name":{"type":"string","description":"Indicates the name of the company or index."},"smart_available":{"type":"boolean","description":"Indicates if the contract can be smart routed or not."},"exchange":{"type":"string","description":"Indicates the primary exchange for which the contract can be traded."},"category":{"type":"string","description":"Indicates the industry category of the instrument."},"rules":{"$ref":"#/components/schemas/contractRules"}},"title":"Trading Contracts_getInfoAndRules_Response_200"},"V1ApiTrsrvAllConidsGetResponsesContentApplicationJsonSchemaItems":{"type":"object","properties":{"ticker":{"type":"string","description":"The ticker symbol of the contract."},"conid":{"type":"integer","format":"int64","description":"The contract identifier of the returned contract."},"exchange":{"type":"string","description":"The primary exchange of the returned contract."}},"title":"V1ApiTrsrvAllConidsGetResponsesContentApplicationJsonSchemaItems"},"V1ApiIserverContractConidAlgosGetParametersAlgos":{"type":"string","enum":["Adaptive","Vwap"],"description":"List of algo ids delimited by \";\" to filter by. Max of 8 algos ids can be specified. Case sensitive to algo id.\n","title":"V1ApiIserverContractConidAlgosGetParametersAlgos"},"V1ApiIserverContractConidAlgosGetParametersAddDescription":{"type":"string","enum":["0","1"],"description":"Whether or not to add algo descriptions to response. Set to 1 for yes, 0 for no.","title":"V1ApiIserverContractConidAlgosGetParametersAddDescription"},"V1ApiIserverContractConidAlgosGetParametersAddParams":{"type":"string","enum":["0","1"],"description":"Whether or not to show algo parameters. Set to 1 for yes, 0 for no.","title":"V1ApiIserverContractConidAlgosGetParametersAddParams"},"AlgoParamDefaultValue":{"oneOf":[{"type":"string"},{"type":"integer","format":"int64"},{"type":"boolean"},{"type":"number","format":"double"}],"description":"Default parameter value. Type defined in valueClassName field","title":"AlgoParamDefaultValue"},"AlgoParamValueClassName":{"type":"string","enum":["String","Boolean","Time","Double","Integer"],"description":"Returns the variable type of the parameter.","title":"AlgoParamValueClassName"},"algoParam":{"type":"object","properties":{"guiRank":{"type":"integer","format":"int64","description":"Positional ranking for the algo. Used for Client Portal."},"defaultValue":{"$ref":"#/components/schemas/AlgoParamDefaultValue","description":"Default parameter value. Type defined in valueClassName field"},"minValue":{"type":"integer","format":"int64"},"maxValue":{"type":"integer","format":"int64"},"name":{"type":"string","description":"Parameter name."},"id":{"type":"string","description":"Parameter identifier for the algo."},"description":{"type":"string"},"legalStrings":{"type":"array","items":{"type":"string"},"description":"Allowed values for the parameter."},"required":{"type":"boolean","description":"States whether the parameter is required for the given algo order to place."},"valueClassName":{"$ref":"#/components/schemas/AlgoParamValueClassName","description":"Returns the variable type of the parameter."}},"title":"algoParam"},"AlgosResponseAlgosItems":{"type":"object","properties":{"name":{"type":"string","description":"Common name of the algo"},"id":{"type":"string","description":"Algo identifier used for requests."},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/algoParam"}}},"required":["name","id"],"title":"AlgosResponseAlgosItems"},"algosResponse":{"type":"object","properties":{"algos":{"type":"array","items":{"$ref":"#/components/schemas/AlgosResponseAlgosItems"},"description":"Contains all relevant algos for the contract."}},"description":"available algos","title":"algosResponse"},"BondFiltersResponseBondFiltersItemsDisplayText":{"type":"string","enum":["Maturity Date","Issue Date","Coupon","Currency"],"description":"An identifier used to document returned options/values. This can be thought of as a key value.","title":"BondFiltersResponseBondFiltersItemsDisplayText"},"BondFiltersResponseBondFiltersItemsOptionsItems":{"type":"object","properties":{"text":{"type":"string","description":"In some instances, a text value will be returned, which indicates the standardized value format such as plaintext dates, rather than solely numerical values."},"value":{"type":"string","description":"Returns value directly correlating to the displayText key. This may include exchange, maturity date, issue date, coupon, or currency."}},"required":["value"],"title":"BondFiltersResponseBondFiltersItemsOptionsItems"},"BondFiltersResponseBondFiltersItems":{"type":"object","properties":{"displayText":{"$ref":"#/components/schemas/BondFiltersResponseBondFiltersItemsDisplayText","description":"An identifier used to document returned options/values. This can be thought of as a key value."},"columnId":{"type":"integer","format":"int64","description":"Used for user interfaces. Internal use only."},"options":{"type":"array","items":{"$ref":"#/components/schemas/BondFiltersResponseBondFiltersItemsOptionsItems"},"description":"Contains all objects with values corresponding to the parent displayText key."}},"title":"BondFiltersResponseBondFiltersItems"},"bondFiltersResponse":{"type":"object","properties":{"bondFilters":{"type":"array","items":{"$ref":"#/components/schemas/BondFiltersResponseBondFiltersItems"},"description":"Contains all filters pertaining to the given issuerId"}},"title":"bondFiltersResponse"},"FeaturesSymbolItems":{"type":"object","properties":{"symbol":{"type":"string","description":"The requested symbol value."},"conid":{"type":"integer","format":"int64","description":"Contract identifier for the specific symbol"},"underlyingConid":{"type":"integer","format":"int64","description":"Contract identifier for the future's underlying contract."},"expirationDate":{"type":"integer","format":"int64","description":"Expiration date of the specific future contract."},"ltd":{"type":"integer","format":"int64","description":"Last trade date of the future contract."},"shortFuturesCutOff":{"type":"integer","format":"int64","description":"Represents the final day for contract rollover for shorted futures."},"longFuturesCutOff":{"type":"integer","format":"int64","description":"Represents the final day for contract rollover for long futures."}},"title":"FeaturesSymbolItems"},"features":{"type":"object","properties":{"symbol":{"type":"array","items":{"$ref":"#/components/schemas/FeaturesSymbolItems"},"description":"Displayed as the string of your symbol Contains a series of objects for each symbol that matches the requested.\n"}},"title":"features"},"V1ApiIserverSecdefSearchGetParametersSecType":{"type":"string","enum":["STK","IND","BOND"],"default":"STK","title":"V1ApiIserverSecdefSearchGetParametersSecType"},"SecdefSearchResponseItemsSectionsItems":{"type":"object","properties":{"secType":{"type":"string"},"months":{"type":"string","description":"semicolon separated list of months"},"exchange":{"type":"string","description":"semicolon separated list of exchanges"}},"title":"SecdefSearchResponseItemsSectionsItems"},"SecdefSearchResponseItemsIssuersItems":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"title":"SecdefSearchResponseItemsIssuersItems"},"SecdefSearchResponseItems":{"type":"object","properties":{"bondid":{"type":"integer","format":"int64","description":"applicable for bonds"},"conid":{"type":"string","description":"Contract identifier for the unique contract."},"companyHeader":{"type":"string","description":"Company Name - Exchange"},"companyName":{"type":["string","null"],"description":"Formal name of the company."},"symbol":{"type":"string","description":"Underlying ticker symbol."},"description":{"type":"string","description":"Primary exchange of the contract"},"restricted":{"type":["boolean","null"],"description":"Returns if the contract is available for trading."},"fop":{"type":["string","null"],"description":"Returns a string of dates, separated by semicolons."},"opt":{"type":["string","null"],"description":"Returns a string of dates, separated by semicolons."},"war":{"type":["string","null"],"description":"Returns a string of dates, separated by semicolons."},"sections":{"type":"array","items":{"$ref":"#/components/schemas/SecdefSearchResponseItemsSectionsItems"}},"issuers":{"type":"array","items":{"$ref":"#/components/schemas/SecdefSearchResponseItemsIssuersItems"}}},"title":"SecdefSearchResponseItems"},"secdefSearchResponse":{"type":"array","items":{"$ref":"#/components/schemas/SecdefSearchResponseItems"},"title":"secdefSearchResponse"},"V1ApiIserverSecdefSearchPostRequestBodyContentApplicationJsonSchemaSecType":{"type":"string","enum":["STK","IND","BOND"],"default":"STK","description":"Available underlying security types:\n  * `STK` - Represents an underlying as a Stock security type.\n  * `IND` - Represents an underlying as an Index security type.\n  * `BOND` - Represents an underlying as a Bond security type.\n","title":"V1ApiIserverSecdefSearchPostRequestBodyContentApplicationJsonSchemaSecType"},"StocksItemsContractsItems":{"type":"object","properties":{"conid":{"type":"integer","format":"int64","description":"Contract ID for the specific contract."},"exchange":{"type":"string","description":"Primary exchange for the given contract."},"isUS":{"type":"boolean","description":"States whether the contract is hosted in the United States or not."}},"title":"StocksItemsContractsItems"},"StocksItems":{"type":"object","properties":{"name":{"type":"string","description":"Full company name for the given contract."},"chineseName":{"type":"string","description":"Chinese name for the given company as unicode."},"assetClass":{"type":"string","description":"Asset class for the given company."},"contracts":{"type":"array","items":{"$ref":"#/components/schemas/StocksItemsContractsItems"},"description":"A series of arrays pertaining to the same company listed by \"name\". Typically differentiated based on currency of the primary exchange.\n"}},"description":"Contains a series of objects for each symbol that matches the requested","title":"StocksItems"},"stocks":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/StocksItems"}},"title":"stocks"},"V1ApiIserverSecdefStrikesGetParametersSectype":{"type":"string","enum":["OPT","FOP","WAR"],"description":"Security type of the requested contract of interest. Valid asset classes are:\n * `FOP` - Futures Option\n * `OPT` - Option\n * `WAR` - Warrant\n","title":"V1ApiIserverSecdefStrikesGetParametersSectype"},"Trading Contracts_getContractStrikes_Response_200":{"type":"object","properties":{"call":{"type":"array","items":{"type":"number","format":"double"},"description":"Array containing a series of comma separated values representing potential call strikes for the instrument."},"put":{"type":"array","items":{"type":"number","format":"double"},"description":"Array containing a series of comma separated values representing potential put strikes for the instrument."}},"title":"Trading Contracts_getContractStrikes_Response_200"},"V1ApiTrsrvSecdefScheduleGetParametersAssetClass":{"type":"string","enum":["STK","OPT","FUT","CFD","WAR","SWP","FND","BND","ICS"],"description":"Specify the security type of the given contract. Valid asset classes are:\n * `STK` - Stock\n * `OPT` - Option\n * `FUT` - Future\n * `CFD` - Contract for Difference\n * `WAR` - Warrant\n * `SWP` - Forex\n * `FND` - Mutual Fund\n * `BND` - Bond\n * `ICS` - Inter-Commodity Spread\n","title":"V1ApiTrsrvSecdefScheduleGetParametersAssetClass"},"TradingScheduleItemsSchedulesItemsSessionsItems":{"type":"object","properties":{"openingTime":{"type":"string","description":"Opening date time of the session."},"closingTime":{"type":"string","description":"Closing date time of the sesion."},"prop":{"type":"string","description":"If the whole trading day is considered LIQUID then the value 'LIQUID' is returned."}},"title":"TradingScheduleItemsSchedulesItemsSessionsItems"},"TradingScheduleItemsSchedulesItemsTradingTimesItems":{"type":"object","properties":{"openingTime":{"type":"string","description":"Opening time of the trading day."},"closingTime":{"type":"string","description":"Closing time of the trading day."},"prop":{"type":"string"},"cancelDayOrders":{"type":"string","description":"Cancel time for day orders."}},"title":"TradingScheduleItemsSchedulesItemsTradingTimesItems"},"TradingScheduleItemsSchedulesItems":{"type":"object","properties":{"clearingCycleEndTime":{"type":"string","description":"End time of clearing cycle."},"tradingScheduleDate":{"type":"string","description":"Date of the clearing schedule. 20000101 stands for any Sat, 20000102 stands for any Sun, … 20000107 stands for any Fri.  Any other date stands for itself.\n"},"sessions":{"type":"array","items":{"$ref":"#/components/schemas/TradingScheduleItemsSchedulesItemsSessionsItems"},"description":"Lists the avialble trading sessions. This displays the regular trading hours. If the LIQUID hours differs from the total trading day then a separate 'session' tag is returned."},"tradingTimes":{"type":"array","items":{"$ref":"#/components/schemas/TradingScheduleItemsSchedulesItemsTradingTimesItems"},"description":"Object containing trading times."}},"title":"TradingScheduleItemsSchedulesItems"},"TradingScheduleItems":{"type":"object","properties":{"id":{"type":"string","description":"Exchange parameter id"},"tradeVenueId":{"type":"string","description":"Reference on a trade venue of given exchange parameter"},"exchange":{"type":"string","description":"short exchange name"},"description":{"type":"string","description":"exchange description"},"timezone":{"type":"string","description":"References the time zone corresponding to the listed dates and times."},"schedules":{"type":"array","items":{"$ref":"#/components/schemas/TradingScheduleItemsSchedulesItems"},"description":"Always contains at least one 'tradingTime' and zero or more 'sessionTime' tags"}},"title":"TradingScheduleItems"},"tradingSchedule":{"type":"array","items":{"$ref":"#/components/schemas/TradingScheduleItems"},"description":"trading's schedules","title":"tradingSchedule"},"CategoryTreeResponseCategoriesCategoryId":{"type":"object","properties":{"name":{"type":"string","description":"Category name."},"parent_id":{"type":"string","description":"Identifier of parent category (if applicable)."},"markets":{"type":"array","items":{"description":"Any type"},"description":"List of affiliated markets (if applicable)."}},"description":"Category identifier.","title":"CategoryTreeResponseCategoriesCategoryId"},"CategoryTreeResponseCategories":{"type":"object","properties":{"categoryId":{"$ref":"#/components/schemas/CategoryTreeResponseCategoriesCategoryId","description":"Category identifier."}},"description":"A JSON object containing all category IDs and their relevant information.","title":"CategoryTreeResponseCategories"},"categoryTreeResponse":{"type":"object","properties":{"categories":{"$ref":"#/components/schemas/CategoryTreeResponseCategories","description":"A JSON object containing all category IDs and their relevant information."}},"title":"categoryTreeResponse"},"forecastDetailsResponse":{"type":"object","properties":{"conid_yes":{"type":"integer","format":"int64","description":"Contract identifier of \"yes\" contract"},"conid_no":{"type":"integer","format":"int64","description":"Contract identifier of \"no\" contract"},"question":{"type":"string","description":"Contract question (i.e. \"Will this happen on this date?\")"},"side":{"type":"string","description":"\"Y\" or \"N\", yes or no contract."},"strike_label":{"type":"string","description":"Strike label to display."},"strike":{"type":"integer","format":"int64","description":"Contract strike."},"exchange":{"type":"string","description":"Contract exchange."},"expiration":{"type":"string","description":"Contract expiration date in YYYYMMDD format."},"symbol":{"type":"string","description":"Contract symbol."},"category":{"type":"string","description":"The affiliated market category declared in /forecast/category/tree."},"logo_category":{"type":"string","description":"Logo category to use in logo service to get image."},"measured_period":{"type":"string","description":"measured period"},"market_name":{"type":"string","description":"name of contract's market."},"underlying_conid":{"type":"integer","format":"int64","description":"Immediate underlier to contract (i.e. future conid for FOPs)"},"payout":{"type":"number","format":"double","description":"Ratio of payout scaling."}},"title":"forecastDetailsResponse"},"forecastRulesResponse":{"type":"object","properties":{"asset_class":{"type":"string","description":"Product asset class."},"description":{"type":"string","description":"Long product description."},"market_name":{"type":"string","description":"Name of the contract's market."},"measured_period":{"type":"string","description":"Measured period of the contract."},"threshold":{"type":"string","description":"Either strike or strike label depending on contract type."},"source_agency":{"type":"string","description":"Name of the contract's source agency."},"data_and_resolution_link":{"type":"string","description":"Link to data from source agency."},"last_trade_time":{"type":"integer","format":"int64","description":"last trade time in epoch seconds."},"product_code":{"type":"string","description":"Product code (symbol)."},"market_rules_link":{"type":"string","description":"Link to market rules document."},"release_time":{"type":"integer","format":"int64","description":"Release time in epoch seconds."},"payout_time":{"type":"integer","format":"int64","description":"Payout time in epoch seconds."},"payout":{"type":"string","description":"Formatted payout amount."},"price_increment":{"type":"string","description":"Formatted price increment amount."},"exchange_timezone":{"type":"string","description":"Exchange timezone."}},"title":"forecastRulesResponse"},"ForecastSchedulesResponseTradingSchedulesItemsTradingTimesItems":{"type":"object","properties":{"open":{"type":"string","description":"The opening time for the given trading session."},"close":{"type":"string","description":"The closing time for the given trading session."}},"title":"ForecastSchedulesResponseTradingSchedulesItemsTradingTimesItems"},"ForecastSchedulesResponseTradingSchedulesItems":{"type":"object","properties":{"day_of_week":{"type":"string","description":"Provides the day of the week corresponding to the trading schedule."},"trading_times":{"type":"array","items":{"$ref":"#/components/schemas/ForecastSchedulesResponseTradingSchedulesItemsTradingTimesItems"},"description":"List containing the opening times for the event contract. Multiple trading blocks may be returned if the contract has an intraday trading closure."}},"title":"ForecastSchedulesResponseTradingSchedulesItems"},"forecastSchedulesResponse":{"type":"object","properties":{"timezone":{"type":"string","description":"Exchange timezone of event contract."},"trading_schedules":{"type":"array","items":{"$ref":"#/components/schemas/ForecastSchedulesResponseTradingSchedulesItems"},"description":"List containing trading objects for each date."}},"title":"forecastSchedulesResponse"},"ForecastMarketResponseContractsItems":{"type":"object","properties":{"conid":{"type":"integer","format":"int64","description":"Market contract identifier."},"side":{"type":"string","description":"\"Y\" or \"N\" denoting a Yes or No contract."},"expiration":{"type":"string","description":"Contract expiration date in YYYYMMDD format."},"strike":{"type":"integer","format":"int64","description":"Contract strike price."},"strike_label":{"type":"string","description":"Strike label to display."},"expiry_label":{"type":"string","description":"Label UI to show for the expiration tabs."},"underlying_conid":{"type":"integer","format":"int64","description":"Immediate underlier to contract (i.e. future conid for FOPs)."},"time_specifier":{"type":"string","description":"Specified date of expiration."}},"title":"ForecastMarketResponseContractsItems"},"forecastMarketResponse":{"type":"object","properties":{"market_name":{"type":"string","description":"Market contract identifier."},"exchange":{"type":"string","description":"Exchange that was passed in request or determined internally."},"symbol":{"type":"string","description":"Market symbol."},"logo_category":{"type":"string","description":"Logo category to use in logo service to retrieve image."},"exclude_historical_data":{"type":"boolean","description":"Indicates whether UI should or should not display underlying chart."},"payout":{"type":"number","format":"double","description":"Ratio of payout scaling."},"contracts":{"type":"array","items":{"$ref":"#/components/schemas/ForecastMarketResponseContractsItems"},"description":"List of contracts matching the requested market."}},"title":"forecastMarketResponse"},"V1ApiIserverAccountAllocationGroupPostRequestBodyContentApplicationJsonSchemaAccountsItems":{"type":"object","properties":{"name":{"type":"string","description":"The accountId of a given sub-account."},"amount":{"type":"integer","format":"int64","description":"The total distribution value for each sub-account for user-defined allocation methods."}},"required":["name"],"title":"V1ApiIserverAccountAllocationGroupPostRequestBodyContentApplicationJsonSchemaAccountsItems"},"allocationMethod":{"type":"string","enum":["A","E","N","C","P","R","S"],"default":"N","description":"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:\n  * `A` - Available Equity\n  * `E` - Equal\n  * `N` - Net Liquidation Value\n\nUser-specified allocation methods:\n  * `C` - Cash Quantity\n  * `P` - Percentage\n  * `R` - Ratios\n  * `S` - Shares\n","title":"allocationMethod"},"Trading FA Allocation Management_createAllocationGroup_Response_200":{"type":"object","properties":{"success":{"type":"boolean"}},"title":"Trading FA Allocation Management_createAllocationGroup_Response_200"},"Trading FA Allocation Management_deleteAllocationGroup_Response_200":{"type":"object","properties":{"success":{"type":"boolean"}},"title":"Trading FA Allocation Management_deleteAllocationGroup_Response_200"},"AllocationGroupsDataItems":{"type":"object","properties":{"allocation_method":{"$ref":"#/components/schemas/allocationMethod","default":"N"},"size":{"type":"integer","format":"int64","description":"Represents the total number of sub-accounts within the group."},"name":{"type":"string","description":"The name set for the given allocation group."}},"title":"AllocationGroupsDataItems"},"allocationGroups":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AllocationGroupsDataItems"},"description":"array, which contains all allocation groups under the advisor account"}},"title":"allocationGroups"},"SubAccountsAccountsItemsDataItemsKey":{"type":"string","enum":["AvailableEquity","NetLiquidation"],"description":"Defines the value of the object\n * `AvailableEquity` - Indicates the value relates to the Available Equity held within the account\n * `NetLiquidation` - Indicates the value relates to the Net Liquidation held within the account\n","title":"SubAccountsAccountsItemsDataItemsKey"},"SubAccountsAccountsItemsDataItems":{"type":"object","properties":{"value":{"type":"string","description":"Contains the price value affiliated with the key."},"key":{"$ref":"#/components/schemas/SubAccountsAccountsItemsDataItemsKey","description":"Defines the value of the object\n * `AvailableEquity` - Indicates the value relates to the Available Equity held within the account\n * `NetLiquidation` - Indicates the value relates to the Net Liquidation held within the account\n"}},"title":"SubAccountsAccountsItemsDataItems"},"SubAccountsAccountsItems":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SubAccountsAccountsItemsDataItems"},"description":"Contains Net liquidation and available equity of the given account Id."},"name":{"type":"string","description":"Returns the account ID affiliated with the balance data."}},"title":"SubAccountsAccountsItems"},"subAccounts":{"type":"object","properties":{"accounts":{"type":"array","items":{"$ref":"#/components/schemas/SubAccountsAccountsItems"},"description":"An array containing all sub-accounts held by the advisor."}},"title":"subAccounts"},"V1ApiIserverAccountAllocationGroupPutRequestBodyContentApplicationJsonSchemaAccountsItems":{"type":"object","properties":{"name":{"type":"string","description":"The accountId of a given sub-account."},"amount":{"type":"integer","format":"int64","description":"The total distribution value for each sub-account for user-defined allocation methods."}},"required":["name"],"title":"V1ApiIserverAccountAllocationGroupPutRequestBodyContentApplicationJsonSchemaAccountsItems"},"Trading FA Allocation Management_modifyAllocationGroup_Response_200":{"type":"object","properties":{"success":{"type":"boolean"}},"title":"Trading FA Allocation Management_modifyAllocationGroup_Response_200"},"PresetsDefaultMethodForAll":{"type":"string","enum":["AvailableEquity","E","N","C","P","R","S"],"description":"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:\n  * `A` - Available Equity\n  * `E` - Equal\n  * `N` - Net Liquidation Value\n\nUser-specified allocation methods:\n  * `C` - Cash Quantity\n  * `P` - Percentage\n  * `R` - Ratios\n  * `S` - Shares\n","title":"PresetsDefaultMethodForAll"},"presets":{"type":"object","properties":{"group_auto_close_positions":{"type":"boolean","description":"Determines if allocation groups should prioritize closing positions over equal distribution."},"default_method_for_all":{"$ref":"#/components/schemas/PresetsDefaultMethodForAll","description":"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:\n  * `A` - Available Equity\n  * `E` - Equal\n  * `N` - Net Liquidation Value\n\nUser-specified allocation methods:\n  * `C` - Cash Quantity\n  * `P` - Percentage\n  * `R` - Ratios\n  * `S` - Shares\n"},"profiles_auto_close_positions":{"type":"boolean","description":"Determines if allocation profiles should prioritize closing positions over equal distribution."},"strict_credit_check":{"type":"boolean","description":"Determines if the system should always check user credit before beginning the order process every time, or only at the time of order placement and execution."},"group_proportional_allocation":{"type":"boolean","description":"Determines if the system should keep allocation groups proportional for scaling."}},"title":"presets"},"AllocationGroupAccountsItems":{"type":"object","properties":{"amount":{"type":"integer","format":"int64","description":"The total distribution value for each sub-account for user-defined allocation methods."},"name":{"type":"string","description":"The accountId of a given sub-account."}},"title":"AllocationGroupAccountsItems"},"allocationGroup":{"type":"object","properties":{"name":{"type":"string","description":"Name used to refer to your allocation group. This will be used while placing orders."},"accounts":{"type":"array","items":{"$ref":"#/components/schemas/AllocationGroupAccountsItems"},"description":"Contains a series of objects depicting which accounts are involved and, for user-defined allocation methods, the distribution value for each sub-account."},"default_method":{"$ref":"#/components/schemas/allocationMethod","default":"N"}},"title":"allocationGroup"},"Trading FA Allocation Management_setAllocationPreset_Response_200":{"type":"object","properties":{"success":{"type":"boolean","description":"Signifies that the request was successfully submitted."}},"title":"Trading FA Allocation Management_setAllocationPreset_Response_200"},"modelPresetsResponse":{"type":"object","properties":{"avoidNegativeCashInIndependent":{"type":"boolean","description":"Avoid negative offsetting cash in Independent"},"closeDivestIndependentPosition":{"type":"boolean","description":"Close out the full position while divesting."},"fullyInvestExistingLongPositions":{"type":"boolean","description":"Use the maximum avialble funds to increase long positions."},"keepModelOpen":{"type":"boolean","description":"Keep model open for fully divested accounts."},"preferCrossWithIndependent":{"type":"boolean","description":"Transfer positions to Independent instead of liquidating."},"preferTransferFromIndependent":{"type":"boolean","description":"Transfer positions from Independent structure when possible."},"reqID":{"type":"integer","format":"int64","description":"Request identifier to uniquely track a request."},"roundAllocationQuantityToExchangeBoardLot":{"type":"boolean","description":"Determine if allocation quantities should be handled by lot size."},"subscriptionStatus":{"type":"integer","format":"int64","description":"Describes if the model is in polling mode."},"useNonBaseCcy":{"type":"boolean","description":"Use non-base balances when available."},"useToleranceRange":{"type":"boolean","description":"Designate of tolerance ranges should be used for rebalancing."}},"title":"modelPresetsResponse"},"V1ApiFaModelAccountsDetailsPostResponsesContentApplicationJsonSchemaAccountInfoListItems":{"type":"object","properties":{"account":{"type":"string","description":"Account identifier."},"accountImbalance":{"type":"string","description":"Account's imbalance from the target allocation."},"alias":{"type":"string","description":"Account alias."},"baseCcyAccount":{"type":"string","description":"Base currency of the account."},"costBasis":{"type":"string","description":"Cost basis."},"exchangeRate":{"type":"number","format":"double","description":"Exchange rate of the account base currency to the model base currency."},"nlv":{"type":"string","description":"The net liquidation value of the instrument."},"numInstrumentsOutsideRange":{"type":"integer","format":"int64","description":"The number of instruments held by the account outside of the alloted range from the presets."},"unrealizedPnL":{"type":"string","description":"The unrealized profit and loss of the model within the account."}},"title":"V1ApiFaModelAccountsDetailsPostResponsesContentApplicationJsonSchemaAccountInfoListItems"},"Trading FA Model Portfolios_getAccountsInModel_Response_200":{"type":"object","properties":{"accountInfoList":{"type":"array","items":{"$ref":"#/components/schemas/V1ApiFaModelAccountsDetailsPostResponsesContentApplicationJsonSchemaAccountInfoListItems"},"description":"Collection of accounts held in the model."},"baseCcyMaster":{"type":"string","description":"Base currency of the model."},"model":{"type":"string","description":"Model retrieving accounts from."},"reqID":{"type":"integer","format":"int64","description":"Unique identifier for the request."}},"title":"Trading FA Model Portfolios_getAccountsInModel_Response_200"},"V1ApiFaModelInvestDivestPostRequestBodyContentApplicationJsonSchemaAccountListItems":{"type":"object","properties":{"account":{"type":"string","description":"Account identifier to invest."},"amtToInvest":{"type":"number","format":"double","description":"Amount of cash to invest in the model from the account."}},"title":"V1ApiFaModelInvestDivestPostRequestBodyContentApplicationJsonSchemaAccountListItems"},"Trading FA Model Portfolios_setAccountinvestmentInModel_Response_200":{"type":"object","properties":{"reqID":{"type":"string","description":"Request identifier to uniquely track a request."},"subscriptionStatus":{"type":"integer","format":"int64","description":"Describes if the model is in polling mode."}},"title":"Trading FA Model Portfolios_setAccountinvestmentInModel_Response_200"},"ModelListResponseModelsItems":{"type":"object","properties":{"bootstrapped":{"type":"boolean","description":"Used internally for client portal designation. Should be ignored."},"customIndex":{"type":"boolean","description":"Used internally for client portal. Should be ignored."},"desc":{"type":"string","description":"Personal description of model to read in IBKR GUI elements."},"isStatic":{"type":"boolean","description":"Determine if investing and rebalancing should be handled statically or dynamically. * `true` - Static models will always use the original targets. * `false` - Dynamic models will adjust allocation in response to market movements.\n"},"mismatch":{"type":"boolean","description":"Notes if the Actual allocation has become misalligned with the Target."},"model":{"type":"string","description":"Name of the model."},"nlv":{"type":"number","format":"double","description":"Market value of the model."},"numAccounts":{"type":"integer","format":"int64","description":"Lists the number of accounts held within the model."}},"title":"ModelListResponseModelsItems"},"modelListResponse":{"type":"object","properties":{"baseCcy":{"type":"string","description":"Base currency of the established model."},"masterAccount":{"type":"string","description":"Advisor account responsible for the model."},"models":{"type":"array","items":{"$ref":"#/components/schemas/ModelListResponseModelsItems"},"description":"List of all models held under the masterAccount."},"reqID":{"type":"integer","format":"int64","description":"Request identifier to uniquely track a request."},"subscriptionStatus":{"type":"integer","format":"int64","description":"Describes if the model is in polling mode."}},"title":"modelListResponse"},"V1ApiFaModelPositionsPostRequestBodyContentApplicationJsonSchemaSortField":{"type":"string","enum":["actual","actualRangeMax","actualRangeMin","ccy","conid","dlv","instrumentImbalance","instrument","mismatchType","mv","position","target"],"description":"Field to sort the response by.\n  * `actual` - Current actual model allocation for the instrument.\n  * `actualRangeMax` - Maximum actual model allocation allowed for the instrument.\n  * `actualRangeMin` - Minimum actual model allocation allowed for the instrument.\n  * `ccy` - Currency of the instrument.\n  * `conid` - Contract identifier, or conid.\n  * `dlv` - Market value.\n  * `instrumentImbalance` - How far an instrument's actual allocation is from its model.\n  * `instrument` - Symbol of the security.\n  * `mv` - Market value of the model position.\n  * `position` - Number of shares held by the model.\n  * `target` - Target percentage of an instrument held within a model.\n","title":"V1ApiFaModelPositionsPostRequestBodyContentApplicationJsonSchemaSortField"},"V1ApiFaModelPositionsPostRequestBodyContentApplicationJsonSchemaSortDirection":{"type":"string","enum":["ASC","DESC"],"description":"Direction to sort the request by.\n * `ASC` - Sort from greatest to smallest.\n * `DESC` - Sort from smallest to greatest.\n","title":"V1ApiFaModelPositionsPostRequestBodyContentApplicationJsonSchemaSortDirection"},"ModelPositionResponseCashItems":{"type":"object","properties":{"actual":{"type":"number","format":"double","description":"Actual percent of the model held in the postion."},"ccy":{"type":"string","description":"Currency symbol."},"exchangeRate":{"type":"number","format":"double","description":"Exchange rate of the account base currency to the model base currency."},"instrumentImbalance":{"type":"number","format":"double","description":"Describes the percentage of imbalance of the actual allocation from the model."},"mv":{"type":"number","format":"double","description":"Market value of the position."},"target":{"type":"number","format":"double","description":"Target percentage of the model to hold in the position."}},"title":"ModelPositionResponseCashItems"},"ModelPositionResponsePositionListItems":{"type":"object","properties":{"actual":{"type":"number","format":"double","description":"Actual percent of the model held in the postion."},"actualRangeMax":{"type":"number","format":"double","description":"Maximum accepted tolerance above the target."},"actualRangeMin":{"type":"number","format":"double","description":"Minimum accepted tolerance below the target."},"ccy":{"type":"string","description":"Currency symbol."},"conid":{"type":"integer","format":"int64","description":"Contract identifier for the instrument."},"dlv":{"type":"number","format":"double","description":"Displayed liquidation value."},"exchangeRate":{"type":"integer","format":"int64","description":"Used internally for client portal. Should be ignored."},"flags":{"type":"integer","format":"int64","description":"Used internally for client portal. Should be ignored."},"instrumentImbalance":{"type":"number","format":"double","description":"Describes the percentage of imbalance of the actual allocation from the model."},"instrument":{"type":"string","description":"Symbol of the position."},"mismatchType":{"type":"number","format":"double","description":"Used internally for client portal. Should be ignored."},"mv":{"type":"number","format":"double","description":"Market Value."},"position":{"type":"number","format":"double","description":"The total size of the position held in the model."},"target":{"type":"number","format":"double","description":"The desired allocation percentage of the position in the model."}},"title":"ModelPositionResponsePositionListItems"},"modelPositionResponse":{"type":"object","properties":{"cash":{"type":"array","items":{"$ref":"#/components/schemas/ModelPositionResponseCashItems"},"description":"An object representing each currency held in the model."},"mismatched":{"type":"boolean","description":"Notes if the Actual allocation has become misalligned with the Target."},"model":{"type":"string","description":"Name of the model."},"nlv":{"type":"number","format":"double","description":"Market value of the model."},"positionList":{"type":"array","items":{"$ref":"#/components/schemas/ModelPositionResponsePositionListItems"},"description":"List of object containing each equity in the model."},"positionTs":{"type":"integer","format":"int64","description":"Epoch timestamp when the position was retrieved."},"reqID":{"type":"integer","format":"int64","description":"Request identifier to uniquely track a request."},"stkOnly":{"type":"boolean","description":"Describes if the model contains only stocks."},"subscriptionStatus":{"type":"integer","format":"int64","description":"Describes if the model is in polling mode."},"totalDlv":{"type":"number","format":"double","description":"Diplayed total liquidation value of the model."},"totalMv":{"type":"number","format":"double","description":"Market value of the entire position."}},"title":"modelPositionResponse"},"modelSummaryResponse":{"type":"object","properties":{"bootstrapped":{"type":"boolean","description":"Used internally for client portal designation. Should be ignored."},"customIndex":{"type":"boolean","description":"Used internally for client portal. Should be ignored."},"desc":{"type":"string","description":"Personal description of model to read in IBKR GUI elements."},"isStatic":{"type":"boolean","description":"Determine if investing and rebalancing should be handled statically or dynamically. * `true` - Static models will always use the original targets. * `false` - Dynamic models will adjust allocation in response to market movements.\n"},"mismatch":{"type":"boolean","description":"Notes if the Actual allocation has become misalligned with the Target."},"model":{"type":"string","description":"Name of the model."},"nlv":{"type":"number","format":"double","description":"Net Liquidation of the model."},"numAccounts":{"type":"integer","format":"int64","description":"Lists the number of accounts held within the model."},"reqID":{"type":"integer","format":"int64","description":"Request identifier to uniquely track a request."},"subscriptionStatus":{"type":"integer","format":"int64","description":"Describes if the model is in polling mode."}},"title":"modelSummaryResponse"},"V1ApiFaModelSavePostRequestBodyContentApplicationJsonSchemaCashTargetsItems":{"type":"object","properties":{"ccy":{"type":"string","description":"Currency code to hold positions."},"target":{"type":"number","format":"double","description":"Percentage of model to distribute to the given currency."}},"title":"V1ApiFaModelSavePostRequestBodyContentApplicationJsonSchemaCashTargetsItems"},"V1ApiFaModelSavePostRequestBodyContentApplicationJsonSchemaPositionTargetsItems":{"type":"object","properties":{"conid":{"type":"integer","format":"int64","description":"Contract identifier, conid, to designate which security to hold."},"target":{"type":"number","format":"double","description":"Percentage of model to distribute to the given currency."}},"title":"V1ApiFaModelSavePostRequestBodyContentApplicationJsonSchemaPositionTargetsItems"},"Trading FA Model Portfolios_setModelTargetPositions_Response_200":{"type":"object","properties":{"reqID":{"type":"integer","format":"int64","description":"Request identifier to uniquely track a request."},"success":{"type":"boolean","description":"Signifies that the request was successfully submitted."}},"title":"Trading FA Model Portfolios_setModelTargetPositions_Response_200"},"Trading FA Model Portfolios_setModelPresets_Response_200":{"type":"object","properties":{"error":{"type":"string","description":"Report the behavior when attempting to save."},"reqID":{"type":"integer","format":"int64","description":"Request identifier to uniquely track a request."},"subscriptionStatus":{"type":"integer","format":"int64","description":"Describes if the model is in polling mode."},"success":{"type":"boolean","description":"Signifies that the request was successfully submitted."}},"title":"Trading FA Model Portfolios_setModelPresets_Response_200"},"Trading FA Model Portfolios_submitModelOrders_Response_200":{"type":"object","properties":{"reqID":{"type":"integer","format":"int64","description":"Request identifier to uniquely track a request."},"success":{"type":"boolean","description":"Signifies that the request was successfully submitted."}},"title":"Trading FA Model Portfolios_submitModelOrders_Response_200"},"GetInvestedAccountsSummaryAccountListItems":{"type":"object","properties":{"account":{"type":"string","description":"Account identifier (account number)"},"accountModelNlv":{"type":"string","description":"Net liquidation value for positions in the current model portfolio"},"accountOtherModelsNlv":{"type":"string","description":"Net liquidation value for positions in other model portfolios"},"alias":{"type":"string","description":"User-defined alias for the account (empty string if not set)"},"baseCcyAccount":{"type":"string","description":"Base currency for this account (ISO 4217 currency code)"},"baseCcyAccountPrecision":{"type":"string","description":"Precision for the account base currency (decimal places)"},"exchangeRate":{"type":"number","format":"double","description":"Exchange rate from account base currency to master base currency"},"cashInIndependentNlv":{"type":"string","description":"Individual cash net liquidation value in base currency"},"positionsInIndependentNlv":{"type":"string","description":"Individual position net liquidation value in base currency"},"nlv":{"type":"string","description":"Total net liquidation value (cash + positions) in base currency"}},"title":"GetInvestedAccountsSummaryAccountListItems"},"GetInvestedAccountsSummarySubscriptionStatus":{"type":"string","enum":["0","1"],"description":"Market data subscription status (1 = active, 0 = inactive)","title":"GetInvestedAccountsSummarySubscriptionStatus"},"getInvestedAccountsSummary":{"type":"object","properties":{"accountList":{"type":"array","items":{"$ref":"#/components/schemas/GetInvestedAccountsSummaryAccountListItems"},"description":"Array of account details with net liquidation values and currency information"},"baseCcyMaster":{"type":"string","description":"Base currency for the master account (ISO 4217 currency code)"},"baseCcyMasterPrecision":{"type":"string","description":"Precision for the master account base currency (decimal places)"},"model":{"type":"string","description":"Model portfolio identifier associated with this account list"},"reqID":{"type":"integer","format":"int64","description":"Unique request identifier for tracking API calls"},"subscriptionStatus":{"$ref":"#/components/schemas/GetInvestedAccountsSummarySubscriptionStatus","description":"Market data subscription status (1 = active, 0 = inactive)"}},"title":"getInvestedAccountsSummary"},"Trading FYIs and Notifications_deleteFyiDevice_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Trading FYIs and Notifications_deleteFyiDevice_Response_200"},"DeliveryOptionsEItems":{"type":"object","properties":{"NM":{"type":"string","description":"Returns the human readable device name."},"I":{"type":"string","description":"Returns the deice identifier."},"UI":{"type":"string","description":"Returns the unique device ID."},"A":{"type":"string","description":"Device is enabled or not."}},"title":"DeliveryOptionsEItems"},"deliveryOptions":{"type":"object","properties":{"E":{"type":"array","items":{"$ref":"#/components/schemas/DeliveryOptionsEItems"},"description":"Returns an array of device information."},"M":{"type":"integer","format":"int64","description":"Email option is enabled or not."}},"title":"deliveryOptions"},"typecodes":{"type":"string","enum":["BA","CA","DA","EA","MF","OE","PR","SE","SG","SM","T2","TO","UA","M8","PS","DL","PT","CB","MS","TD","ST","TI","CT"],"description":"Many FYI endpoints reference a \"typecode\" value. The table below lists the available codes and what they correspond to.\n  * `BA` - Borrow Availability\n  * `CA` - Comparable Algo\n  * `DA` - Dividends Advisory\n  * `EA` - Upcoming Earnings\n  * `MF` - Mutual Fund Advisory\n  * `OE` - Option Expiration\n  * `PR` - Portfolio Builder Rebalance\n  * `SE` - Suspend Order on Economic Event\n  * `SG` - Short Term Gain turning Long Term\n  * `SM` - System Messages\n  * `T2` - Assignment Realizing Long-Term Gains\n  * `TO` - Takeover\n  * `UA` - User Alert\n  * `M8` - M871 Trades\n  * `PS` - Platform Use Suggestions\n  * `DL` - Unexercised Option Loss Prevention Reminder\n  * `PT` - Position Transfer\n  * `CB` - Missing Cost Basis\n  * `MS` - Milestones\n  * `TD` - MiFID || 10% Deprecation Notice\n  * `ST` - Save Taxes\n  * `TI` - Trade Idea\n  * `CT` - Cash Transfer\n","title":"typecodes"},"disclaimerInfo":{"type":"object","properties":{"FC":{"type":"string","description":"Returns the Typecode for the given disclaimer."},"DT":{"type":"string","description":"Returns the Disclaimer message."}},"title":"disclaimerInfo"},"FyiSettingsItems":{"type":"object","properties":{"A":{"type":"integer","format":"int64","description":"Returns ony if the subscription can be disabled/enabled manually. See /fyi/settings/{typecode} for how to enable/disable.\n"},"FC":{"type":"string","description":"Fyi code for enabling or disabling the notification."},"H":{"type":"integer","format":"int64","description":"Disclaimer if the notification was read."},"FD":{"type":"string","description":"Returns a detailed description of the topic."},"FN":{"type":"string","description":"Returns a human readable title for the notification."}},"title":"FyiSettingsItems"},"fyiSettings":{"type":"array","items":{"$ref":"#/components/schemas/FyiSettingsItems"},"title":"fyiSettings"},"Trading FYIs and Notifications_getUnreadFyis_Response_200":{"type":"object","properties":{"BN":{"type":"integer","format":"int64","description":"Returns the number of unread notifications."}},"title":"Trading FYIs and Notifications_getUnreadFyis_Response_200"},"GetUnreadFyisRequestLockedError":{"type":"object","properties":{"status":{"type":"string"}},"title":"GetUnreadFyisRequestLockedError"},"NotificationsItems":{"type":"object","properties":{"R":{"type":"string","description":"Return if the notification was read or not. Value Format: 0: Disabled; 1: Enabled.\n"},"D":{"type":"string","description":"Notification date as an epoch string."},"MS":{"type":"string","description":"Title of notification."},"MD":{"type":"string","description":"Content of notification."},"ID":{"type":"string","description":"Unique way to reference the notification."},"HT":{"type":"integer","format":"int64","description":"HT"},"FC":{"type":"string","description":"FYI code, we can use it to find whether the disclaimer is accepted or not in settings"}},"title":"NotificationsItems"},"notifications":{"type":"array","items":{"$ref":"#/components/schemas/NotificationsItems"},"title":"notifications"},"fyiVT":{"type":"object","properties":{"V":{"type":"integer","format":"int64","description":"Returns 1 to state message was acknowledged."},"T":{"type":"integer","format":"int64","description":"Returns the time in ms to complete the edit."}},"title":"fyiVT"},"NotificationReadAcknowledgeP":{"type":"object","properties":{"R":{"type":"integer","format":"int64","description":"Returns if the message was read (1) or unread (0)."},"ID":{"type":"string","description":"Returns the ID for the notification."}},"description":"Returns details about the notification read status.","title":"NotificationReadAcknowledgeP"},"notificationReadAcknowledge":{"type":"object","properties":{"V":{"type":"integer","format":"int64","description":"Returns 1 to state message was acknowledged."},"T":{"type":"integer","format":"int64","description":"Returns the time in ms to complete the edit."},"P":{"$ref":"#/components/schemas/NotificationReadAcknowledgeP","description":"Returns details about the notification read status."}},"title":"notificationReadAcknowledge"},"fyiEnableDeviceOption":{"type":"object","properties":{"deviceName":{"type":"string"},"deviceId":{"type":"string"},"uiName":{"type":"string"},"enabled":{"type":"boolean","description":"enable or disable device"}},"title":"fyiEnableDeviceOption"},"Trading Market Data_closeMdStream_Response_200":{"type":"object","properties":{"success":{"type":"boolean","description":"The sole key 'success' will have boolean value true."}},"description":"Acknowledges a successful request.","title":"Trading Market Data_closeMdStream_Response_200"},"Trading Market Data_closeAllMdStreams_Response_200":{"type":"object","properties":{"unsubscribed":{"type":"boolean","description":"The sole key 'unsubscribed' will have boolean value true."}},"description":"Indicates a successful request to unsubscribe all streams.","title":"Trading Market Data_closeAllMdStreams_Response_200"},"utcDateTime":{"type":"string","description":"UTC datetime string in format YYYYMMDD-hh:mm:ss.","title":"utcDateTime"},"V1ApiIserverMarketdataHistoryGetParametersDirection":{"type":"string","enum":["-1","1"],"title":"V1ApiIserverMarketdataHistoryGetParametersDirection"},"IserverHistoryBidAskResponseDirection":{"type":"string","enum":["-1"],"description":"Indicates how the period is applied in relation to the startTime. Value will always be -1, indicating that the period extends from the startTime forward into the future.","title":"IserverHistoryBidAskResponseDirection"},"singleHistoricalBarBidAsk":{"type":"object","properties":{"o":{"type":"number","format":"double","description":"Opening value of the bar. Indicates the time average bid during the bar."},"c":{"type":"number","format":"double","description":"Closing value of the bar. Indicates the time average ask during the bar."},"h":{"type":"number","format":"double","description":"High value of the bar. Indicates the highest ask price during the bar."},"l":{"type":"number","format":"double","description":"Low value of the bar. Indicates the lowest bid price during the bar."},"v":{"type":"number","format":"double","description":"Volume value of the bar. Always returns 0."},"t":{"type":"integer","format":"int64","description":"Unix timestamp of the start (chronologically earlier) of the bar."}},"description":"Object containing Bid and Ask data for a single OHLC bar.","title":"singleHistoricalBarBidAsk"},"iserverHistoryBidAskResponse":{"type":"object","properties":{"serverId":{"type":"string","description":"Internal use. Identifier of the request."},"symbol":{"type":"string","description":"Symbol of the request instrument."},"text":{"type":"string","description":"Description or company name of the instrument."},"priceFactor":{"type":"integer","format":"int64","description":"Internal use. Used to scale Client Portal chart Y-axis."},"startTime":{"type":"string","description":"UTC date and time of the start (chronologically earlier) of the complete period in format YYYYMMDD-hh:mm:ss."},"high":{"type":"string","description":"Internal use. Delivers highest price value in total interval. Used for chart scaling. A string constructed as 'highestPrice*priceFactor/totalVolume*volumeFactor/minutesFromStartTime'."},"low":{"type":"string","description":"Internal use. Delivers lowest price value in total interval. Used for chart scaling. A string constructed as 'lowestPrice*priceFactor/totalVolume*volumeFactor/minutesFromStartTime'."},"timePeriod":{"type":"string","description":"The client-specified period value."},"barLength":{"type":"integer","format":"int64","description":"The client-specified bar width, represented in seconds."},"mdAvailability":{"type":"string","description":"A three-character string reflecting the nature of available data. R = Realtime, D = Delayed, Z = Frozen, Y = Frozen Delayed, N = Not Subscribed. P = Snapshot, p = Consolidated. B = Top of book."},"outsideRth":{"type":"boolean","description":"Indicates whether data from outside regular trading hours is included in the response."},"tradingDayDuration":{"type":"integer","format":"int64","description":"Length of instrument's trading day in seconds."},"volumeFactor":{"type":"integer","format":"int64","description":"Internal use. Used to scale volume histograms."},"priceDisplayRule":{"type":"integer","format":"int64","description":"Internal use. Governs application of pricing display rule."},"priceDisplayValue":{"type":"string","description":"Internal use. Governs rendering of displayed pricing."},"chartPanStartTime":{"type":"string","description":"Internal use. UTC datetime string used to center Client Portal charts. Format YYYYMMDD-hh:mm:ss."},"direction":{"$ref":"#/components/schemas/IserverHistoryBidAskResponseDirection","description":"Indicates how the period is applied in relation to the startTime. Value will always be -1, indicating that the period extends from the startTime forward into the future."},"negativeCapable":{"type":"boolean","description":"Indicates whether instrument is capable of negative pricing."},"messageVersion":{"type":"integer","format":"int64","description":"Internal use. Reflects the version of the response schema used."},"travelTime":{"type":"integer","format":"int64","description":"Internal time in flight to serve the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/singleHistoricalBarBidAsk"},"description":"Array containing OHLC bars for the requested period."},"points":{"type":"integer","format":"int64","description":"Count of the number of bars returned in the data array."},"mktDataDelay":{"type":"integer","format":"int64","description":"Number of milliseconds taken to satisfy this historical data request."}},"description":"Object containing the requested historical data and related metadata.","title":"iserverHistoryBidAskResponse"},"IserverHistoryLastResponseDirection":{"type":"string","enum":["-1"],"description":"Indicates how the period is applied in relation to the startTime. Value will always be -1, indicating that the period extends from the startTime forward into the future.","title":"IserverHistoryLastResponseDirection"},"singleHistoricalBarLast":{"type":"object","properties":{"o":{"type":"number","format":"double","description":"Opening value of the bar. Indicates first traded price of the bar."},"c":{"type":"number","format":"double","description":"Closing value of the bar. Indicates the final traded price of the bar."},"h":{"type":"number","format":"double","description":"High value of the bar. Indicates the highest traded price of the bar."},"l":{"type":"number","format":"double","description":"Low value of the bar. Indicates the lowest traded price of the bar."},"v":{"type":"number","format":"double","description":"Volume value of the bar, returned only for \"Last\" barType."},"t":{"type":"integer","format":"int64","description":"Unix timestamp of the start (chronologically earlier) of the bar."}},"description":"Object containing Last or Trades data for a single OHLC bar.","title":"singleHistoricalBarLast"},"iserverHistoryLastResponse":{"type":"object","properties":{"serverId":{"type":"string","description":"Internal use. Identifier of the request."},"symbol":{"type":"string","description":"Symbol of the request instrument."},"text":{"type":"string","description":"Description or company name of the instrument."},"priceFactor":{"type":"integer","format":"int64","description":"Internal use. Used to scale Client Portal chart Y-axis."},"startTime":{"type":"string","description":"UTC date and time of the start (chronologically earlier) of the complete period in format YYYYMMDD-hh:mm:ss."},"high":{"type":"string","description":"Internal use. Delivers highest price value in total interval. Used for chart scaling. A string constructed as 'highestPrice*priceFactor/totalVolume*volumeFactor/minutesFromStartTime'."},"low":{"type":"string","description":"Internal use. Delivers lowest price value in total interval. Used for chart scaling. A string constructed as 'lowestPrice*priceFactor/totalVolume*volumeFactor/minutesFromStartTime'."},"timePeriod":{"type":"string","description":"The client-specified period value."},"barLength":{"type":"integer","format":"int64","description":"The client-specified bar width, represented in seconds."},"mdAvailability":{"type":"string","description":"A three-character string reflecting the nature of available data. R = Realtime, D = Delayed, Z = Frozen, Y = Frozen Delayed, N = Not Subscribed. P = Snapshot, p = Consolidated. B = Top of book."},"outsideRth":{"type":"boolean","description":"Indicates whether data from outside regular trading hours is included in the response."},"tradingDayDuration":{"type":"integer","format":"int64","description":"Length of instrument's trading day in seconds."},"volumeFactor":{"type":"integer","format":"int64","description":"Internal use. Used to scale volume histograms."},"priceDisplayRule":{"type":"integer","format":"int64","description":"Internal use. Governs application of pricing display rule."},"priceDisplayValue":{"type":"string","description":"Internal use. Governs rendering of displayed pricing."},"chartPanStartTime":{"type":"string","description":"Internal use. UTC datetime string used to center Client Portal charts. Format YYYYMMDD-hh:mm:ss."},"direction":{"$ref":"#/components/schemas/IserverHistoryLastResponseDirection","description":"Indicates how the period is applied in relation to the startTime. Value will always be -1, indicating that the period extends from the startTime forward into the future."},"negativeCapable":{"type":"boolean","description":"Indicates whether instrument is capable of negative pricing."},"messageVersion":{"type":"integer","format":"int64","description":"Internal use. Reflects the version of the response schema used."},"travelTime":{"type":"integer","format":"int64","description":"Internal time in flight to serve the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/singleHistoricalBarLast"},"description":"Array containing OHLC bars for the requested period."},"points":{"type":"integer","format":"int64","description":"Count of the number of bars returned in the data array."},"mktDataDelay":{"type":"integer","format":"int64","description":"Number of milliseconds taken to satisfy this historical data request."}},"description":"Object containing the requested historical data and related metadata.","title":"iserverHistoryLastResponse"},"IserverHistoryMidpointResponseDirection":{"type":"string","enum":["-1"],"description":"Indicates how the period is applied in relation to the startTime. Value will always be -1, indicating that the period extends from the startTime forward into the future.","title":"IserverHistoryMidpointResponseDirection"},"singleHistoricalBarMidpoint":{"type":"object","properties":{"o":{"type":"number","format":"double","description":"Opening value of the bar. Indicates the starting midpoint price traded price during the bar."},"c":{"type":"number","format":"double","description":"Closing value of the bar. Indicates the last midpoint price traded price during the bar."},"h":{"type":"number","format":"double","description":"High value of the bar. Indicates the highest midpoint price traded price during the bar."},"l":{"type":"number","format":"double","description":"Low value of the bar. Indicates the lowest midpoint price traded price during the bar."},"v":{"type":"number","format":"double","description":"Volume value of the bar. Always returns 0."},"t":{"type":"integer","format":"int64","description":"Unix timestamp of the start (chronologically earlier) of the bar."}},"description":"Object containing Midpoint data for a single OHLC bar.","title":"singleHistoricalBarMidpoint"},"iserverHistoryMidpointResponse":{"type":"object","properties":{"serverId":{"type":"string","description":"Internal use. Identifier of the request."},"symbol":{"type":"string","description":"Symbol of the request instrument."},"text":{"type":"string","description":"Description or company name of the instrument."},"priceFactor":{"type":"integer","format":"int64","description":"Internal use. Used to scale Client Portal chart Y-axis."},"startTime":{"type":"string","description":"UTC date and time of the start (chronologically earlier) of the complete period in format YYYYMMDD-hh:mm:ss."},"high":{"type":"string","description":"Internal use. Delivers highest price value in total interval. Used for chart scaling. A string constructed as 'highestPrice*priceFactor/totalVolume*volumeFactor/minutesFromStartTime'."},"low":{"type":"string","description":"Internal use. Delivers lowest price value in total interval. Used for chart scaling. A string constructed as 'lowestPrice*priceFactor/totalVolume*volumeFactor/minutesFromStartTime'."},"timePeriod":{"type":"string","description":"The client-specified period value."},"barLength":{"type":"integer","format":"int64","description":"The client-specified bar width, represented in seconds."},"mdAvailability":{"type":"string","description":"A three-character string reflecting the nature of available data. R = Realtime, D = Delayed, Z = Frozen, Y = Frozen Delayed, N = Not Subscribed. P = Snapshot, p = Consolidated. B = Top of book."},"outsideRth":{"type":"boolean","description":"Indicates whether data from outside regular trading hours is included in the response."},"tradingDayDuration":{"type":"integer","format":"int64","description":"Length of instrument's trading day in seconds."},"volumeFactor":{"type":"integer","format":"int64","description":"Internal use. Used to scale volume histograms."},"priceDisplayRule":{"type":"integer","format":"int64","description":"Internal use. Governs application of pricing display rule."},"priceDisplayValue":{"type":"string","description":"Internal use. Governs rendering of displayed pricing."},"chartPanStartTime":{"type":"string","description":"Internal use. UTC datetime string used to center Client Portal charts. Format YYYYMMDD-hh:mm:ss."},"direction":{"$ref":"#/components/schemas/IserverHistoryMidpointResponseDirection","description":"Indicates how the period is applied in relation to the startTime. Value will always be -1, indicating that the period extends from the startTime forward into the future."},"negativeCapable":{"type":"boolean","description":"Indicates whether instrument is capable of negative pricing."},"messageVersion":{"type":"integer","format":"int64","description":"Internal use. Reflects the version of the response schema used."},"travelTime":{"type":"integer","format":"int64","description":"Internal time in flight to serve the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/singleHistoricalBarMidpoint"},"description":"Array containing OHLC bars for the requested period."},"points":{"type":"integer","format":"int64","description":"Count of the number of bars returned in the data array."},"mktDataDelay":{"type":"integer","format":"int64","description":"Number of milliseconds taken to satisfy this historical data request."}},"description":"Object containing the requested historical data and related metadata.","title":"iserverHistoryMidpointResponse"},"Trading Market Data_getMdHistory_Response_200":{"oneOf":[{"$ref":"#/components/schemas/iserverHistoryBidAskResponse"},{"$ref":"#/components/schemas/iserverHistoryLastResponse"},{"$ref":"#/components/schemas/iserverHistoryMidpointResponse"}],"title":"Trading Market Data_getMdHistory_Response_200"},"mdFields":{"type":"string","description":"Market Data fields enumerating tick ids to their respective value. May provide a comma-separated series of fields. A maximum of 50 fields may be specified at one time.\n  * `31` - Last Price. The last price at which the contract traded. May contain one of the following prefixes: C - Previous day's closing price. H - Trading has halted.\n  * `55` - Symbol. \n  * `58` - Text. \n  * `70` - High. Current day high price\n  * `71` - Low. Current day low price\n  * `73` - Market Value. The current market value of your position in the security. Market Value is calculated with real time market data (even when not subscribed to market data).\n  * `74` - Avg Price. The average price of the position.\n  * `75` - Unrealized PnL. Unrealized profit or loss. Unrealized PnL is calculated with real time market data (even when not subscribed to market data).\n  * `76` - Formatted position. \n  * `77` - Formatted Unrealized PnL. \n  * `78` - Daily PnL. Your profit or loss of the day since prior close. Daily PnL is calculated with real time market data (even when not subscribed to market data).\n  * `79` - Realized PnL. Realized profit or loss. Realized PnL is calculated with real time market data (even when not subscribed to market data).\n  * `80` - Unrealized PnL %. Unrealized profit or loss expressed in percentage.\n  * `82` - Change. The difference between the last price and the close on the previous trading day\n  * `83` - Change %. The difference between the last price and the close on the previous trading day in percentage.\n  * `84` - Bid Price. The highest-priced bid on the contract.\n  * `85` - Ask Size. The number of contracts or shares offered at the ask price. For US stocks\n  * `86` - Ask Price. The lowest-priced offer on the contract.\n  * `87` - Volume. Volume for the day\n  * `88` - Bid Size. The number of contracts or shares bid for at the bid price. For US stocks\n  * `201` - Right. Declares the Right of the Option, Call or Put.\n  * `6004` - Exchange. \n  * `6008` - Conid. Contract identifier from IBKR's database.\n  * `6070` - SecType. The asset class of the instrument.\n  * `6072` - Months. \n  * `6073` - Regular Expiry. \n  * `6119` - Marker for market data delivery method (similar to request id). \n  * `6457` - Underlying Conid. Use /trsrv/secdef to get more information about the security. \n  * `6508` - Service Params.. \n  * `6509` - Market Data Availability. The field may contain three chars. First char defines: R = RealTime, D = Delayed, Z = Frozen, Y = Frozen Delayed, N = Not Subscribed, i - incomplete, v - VDR Exempt (Vendor Display Rule 603c). Second char defines: P = Snapshot, p = Consolidated. Third char defines: B = Book. RealTime Data is relayed back in real time without delay, market data subscription(s) are required. Delayed - Data is relayed back 15-20 min delayed. Frozen - Last recorded data at market close.  relayed back in real time. Frozen Delayed - Last recorded data at market close, relayed back delayed. Not Subscribed - User does not have the required market data subscription(s) to relay back either real time or delayed data. Snapshot - Snapshot request is available for contract. Consolidated - Market data is aggregated across multiple exchanges or venues. Book - Top of the book data is available for contract.\n  * `7051` - Company name. \n  * `7057` - Ask Exch. Displays the exchange(s) offering the SMART price. A=AMEX, C=CBOE, I=ISE, X=PHLX, N=PSE, B=BOX, Q=NASDAQOM, Z=BATS, W=CBOE2, T=NASDAQBX, M=MIAX, H=GEMINI, E=EDGX, J=MERCURY\n  * `7058` - Last Exch. Displays the exchange(s) offering the SMART price. A=AMEX, C=CBOE, I=ISE, X=PHLX, N=PSE, B=BOX, Q=NASDAQOM, Z=BATS, W=CBOE2, T=NASDAQBX, M=MIAX, H=GEMINI, E=EDGX, J=MERCURY\n  * `7059` - Last Size. The number of unites traded at the last price\n  * `7068` - Bid Exch. Displays the exchange(s) offering the SMART price. A=AMEX, C=CBOE, I=ISE, X=PHLX, N=PSE, B=BOX, Q=NASDAQOM, Z=BATS, W=CBOE2, T=NASDAQBX, M=MIAX, H=GEMINI, E=EDGX, J=MERCURY\n  * `7084` - Implied Vol./Hist. Vol %. The ratio of the implied volatility over the historical volatility, expressed as a percentage.\n  * `7085` - Total Put option open interest divided by the Call option open interest for the trading day. May only be used on underlyings.\n  * `7086` - Put/Call Volume. Put option volume/call option volume for the trading day.\n  * `7087` - Hist. Vol. %. 30-day real-time historical volatility.\n  * `7088` - Hist. Vol. Close %. Shows the historical volatility based on previous close price.\n  * `7089` - Opt. Volume. Option Volume\n  * `7094` - Conid + Exchange.\n  * `7184` - canBeTraded. If contract is a trade-able instrument. Returns 1(true) or 0(false).\n  * `7219` - Contract Description.\n  * `7220` - Contract Description.\n  * `7221` - Listing Exchange.\n  * `7280` - Industry. Displays the type of industry under which the underlying company can be categorized.\n  * `7281` - Category. Displays a more detailed level of description within the industry under which the underlying company can be categorized.\n  * `7282` - Average Volume. The average daily trading volume over 90 days.\n  * `7283` - Option Implied Vol. %. A prediction of how volatile an underlying will be in the future.At the market volatility estimated for a maturity thirty calendar days forward of the current trading day, and based on option prices from two consecutive expiration months. To query the Implied Vol. % of a specific strike refer to field 7633.\n  * `7284` - Historical volatility %. Deprecated\n  * `7285` - Put/Call Ratio.\n  * `7292` - Cost Basis. Your current position in this security multiplied by the average price and multiplier.        \n  * `7293` - 52 Week High. The highest price for the past 52 weeks.\n  * `7294` - 52 Week Low. The lowest price for the past 52 weeks.\n  * `7295` - Open. Today's opening price.\n  * `7296` - Close. Today's closing price.\n  * `7308` - Delta. The ratio of the change in the price of the option to the corresponding change in the price of the underlying.\n  * `7309` - Gamma. The rate of change for the delta with respect to the underlying asset's price.\n  * `7310` - Theta. A measure of the rate of decline the value of an option due to the passage of time.\n  * `7311` - Vega. The amount that the price of an option changes compared to a 1% change in the volatility.\n  * `7607` - Opt. Volume Change %. Today's option volume as a percentage of the average option volume.\n  * `7633` - Implied Vol. %. The implied volatility for the specific strike of the option in percentage. To query the Option Implied Vol. % from the underlying refer to field 7283.\n  * `7635` - Mark. The mark price is\n  * `7636` - Shortable Shares. Number of shares available for shorting.\n  * `7637` - Fee Rate. Interest rate charged on borrowed shares.\n  * `7638` - Option Open Interest. Available for Underlyings and Derivatives.\n  * `7639` - % of Mark Value. Displays the market value of the contract as a percentage of the total market value of the account. Mark Value is calculated with real time market data (even when not subscribed to market data).\n  * `7644` - Shortable. Describes the level of difficulty with which the security can be sold short.       \n  * `7671` - Dividends. This value is the total of the expected dividend payments over the next twelve months per share.\n  * `7672` - Dividends TTM. This value is the total of the expected dividend payments over the last twelve months per share.\n  * `7674` - EMA(200). Exponential moving average (N=200).\n  * `7675` - EMA(100). Exponential moving average (N=100).\n  * `7676` - EMA(50). Exponential moving average (N=50).\n  * `7677` - EMA(20). Exponential moving average (N=20).\n  * `7678` - Price/EMA(200). Price to Exponential moving average (N=200) ratio -1\n  * `7679` - Price/EMA(100). Price to Exponential moving average (N=100) ratio -1\n  * `7724` - Price/EMA(50). Price to Exponential moving average (N=50) ratio -1\n  * `7681` - Price/EMA(20). Price to Exponential moving average (N=20) ratio -1\n  * `7682` - Change Since Open. The difference between the last price and the open price.\n  * `7683` - Upcoming Event. Shows the next major company event. Requires Wall Street Horizon subscription.\n  * `7684` - Upcoming Event Date. The date of the next major company event. Requires Wall Street Horizon subscription. \n  * `7685` - Upcoming Analyst Meeting. The date and time of the next scheduled analyst meeting. Requires Wall Street Horizon subscription.\n  * `7686` - Upcoming Earnings. The date and time of the next scheduled earnings/earnings call event. Requires Wall Street Horizon subscription.\n  * `7687` - Upcoming Misc Event. The date and time of the next shareholder meeting\n  * `7688` - Recent Analyst Meeting. The date and time of the most recent analyst meeting. Requires Wall Street Horizon subscription.\n  * `7689` - Recent Earnings. The date and time of the most recent earnings/earning call event. Requires Wall Street Horizon subscription.\n  * `7690` - Recent Misc Event. The date and time of the most recent shareholder meeting\n  * `7694` - Probability of Max Return. Customer implied probability of maximum potential gain.\n  * `7695` - Break Even. Break even points\n  * `7696` - SPX Delta. Beta Weighted Delta is calculated using the formula; Delta x dollar adjusted beta\n  * `7697` - Futures Open Interest. Total number of outstanding futures contracts\n  * `7698` - Last Yield. Implied yield of the bond if it is purchased at the current last price. Last yield is calculated using the Last price on all possible call dates. It is assumed that prepayment occurs if the bond has call or put provisions and the issuer can offer a lower coupon rate based on current market rates. The yield to worst will be the lowest of the yield to maturity or yield to call (if the bond has prepayment provisions). Yield to worse may be the same as yield to maturity but never higher.\n  * `7699` - Bid Yield. Implied yield of the bond if it is purchased at the current bid price. Bid yield is calculated using the Ask on all possible call dates. It is assumed that prepayment occurs if the bond has call or put provisions and the issuer can offer a lower coupon rate based on current market rates. The yield to worst will be the lowest of the yield to maturity or yield to call (if the bond has prepayment provisions). Yield to worse may be the same as yield to maturity but never higher.\n  * `7700` - Probability of Max Return. Customer implied probability of maximum potential gain.\n  * `7702` - Probability of Max Loss. Customer implied probability of maximum potential loss.\n  * `7703` - Profit Probability. Customer implied probability of any gain.\n  * `7704` - Organization Type.\n  * `7705` - Debt Class.\n  * `7706` - Ratings. Ratings issued for bond contract.\n  * `7707` - Bond State Code.\n  * `7708` - Bond Type.\n  * `7714` - Last Trading Date.\n  * `7715` - Issue Date.\n  * `7720` - Ask Yield. Implied yield of the bond if it is purchased at the current offer. Ask yield is calculated using the Bid on all possible call dates. It is assumed that prepayment occurs if the bond has call or put provisions and the issuer can offer a lower coupon rate based on current market rates. The yield to worst will be the lowest of the yield to maturity or yield to call (if the bond has prepayment provisions). Yield to worse may be the same as yield to maturity but never higher.\n  * `7741` - Prior Close. Yesterday's closing price\n  * `7762` - Volume Long. High precision volume for the day. For formatted volume refer to field 87.\n  * `7768` - hasTradingPermissions. if user has trading permissions for specified contract. Returns 1(true) or 0(false).\n  * `7899` - Stock Type. Determines the stock type. Includes: Common, CORP, ADR, ETF, ETN, EFN, REIT, CEF, ETMF.\n  * `7920` - Daily PnL Raw. Your profit or loss of the day since prior close. Daily PnL is calculated with real-time market data (even when not subscribed to market data).\n  * `7921` - Cost Basis Raw. Your current position in this security multiplied by the average price and and multiplier.\n  * `7943` - Rebate Rate. Fed funds or other currency-relevant Benchmark rate minus the interest rate charged on borrowed shares.\n","title":"mdFields"},"IserverSnapshotItems":{"oneOf":[{"description":"Any type"}],"title":"IserverSnapshotItems"},"iserverSnapshot":{"type":"array","items":{"$ref":"#/components/schemas/IserverSnapshotItems"},"description":"Returns an object for each conId requested.","title":"iserverSnapshot"},"OrderCancelSuccessMsg":{"type":"string","enum":["Request was submitted"],"description":"Indicates success with value 'Request was submitted'","title":"OrderCancelSuccessMsg"},"orderCancelSuccess":{"type":"object","properties":{"msg":{"$ref":"#/components/schemas/OrderCancelSuccessMsg","description":"Indicates success with value 'Request was submitted'"},"order_id":{"type":"integer","format":"int64","description":"IB order ID of the order ticket requested for cancellation."},"conid":{"type":"string","description":"IB contract ID of the order ticket's instrument."},"account":{"type":["string","null"],"description":"IB account to which the order was originally set to clear."}},"description":"Acknowledges IB's acceptance of the request to cancel the order. Does not report whether the cancellation can or will ultimately be enacted.","title":"orderCancelSuccess"},"orderSubmitError":{"type":"object","properties":{"error":{"type":"string","description":"Message indicating that order submission was not successful."}},"description":"Indicates that the order reply message or submission was not accepted.","title":"orderSubmitError"},"Trading Orders_cancelOpenOrder_Response_200":{"oneOf":[{"$ref":"#/components/schemas/orderCancelSuccess"},{"$ref":"#/components/schemas/orderSubmitError"}],"title":"Trading Orders_cancelOpenOrder_Response_200"},"OrderSubmitSuccessItems":{"type":"object","properties":{"order_id":{"type":"string","description":"The order ID assigned to your order ticket by IB. Contains only numerals."},"order_status":{"type":"string","description":"Status describing where the order stands in its lifecycle."},"encrypt_message":{"type":"string","description":"Internal use only."}},"description":"Result of successful submission of one order ticket.","title":"OrderSubmitSuccessItems"},"orderSubmitSuccess":{"type":"array","items":{"$ref":"#/components/schemas/OrderSubmitSuccessItems"},"description":"A successful submission of one or more order tickets.","title":"orderSubmitSuccess"},"OrderReplyMessageItems":{"type":"object","properties":{"id":{"type":"string","description":"The replyId UUID of the order ticket's emitted order reply messages, used to confirm them and proceed. Use the POST /iserver/reply/{replyId} endpoint to confirm an order reply message.\n"},"isSuppressed":{"type":"boolean","description":"Internal use. Always delivers value 'false'."},"message":{"type":"array","items":{"type":"string"},"description":"An array containing the human-readable text of all order reply messages emitted for the order ticket."},"messageIds":{"type":"array","items":{"type":"string"},"description":"An array containing identifiers that categorize the types of order reply messages that have been emitted.  Elements of this array are ordered so that indicies match the corresponding human-readable text strings in the 'message' array. A messageId can typically be passed in the POST /iserver/questions/suppress endpoint to auto-accept a given warning message.\n"}},"description":"An object containing order reply messages emitted against a single order ticket.","title":"OrderReplyMessageItems"},"orderReplyMessage":{"type":"array","items":{"$ref":"#/components/schemas/OrderReplyMessageItems"},"description":"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.\n","title":"orderReplyMessage"},"orderReplyNotFound":{"type":"object","properties":{"error":{"type":"string","description":"Message indicating that order reply id was not found."}},"description":"Indicates that the order reply ID does not exist.","title":"orderReplyNotFound"},"advancedOrderReject":{"type":"object","properties":{"orderId":{"type":"integer","format":"int64","description":"The order ID assigned by IB to the rejected order ticket."},"reqId":{"type":"string","description":"IB's internal identifier assigned to the returned message."},"dismissable":{"type":"array","items":{"description":"Any type"},"description":"Indicates whether this prompt is dismissable."},"text":{"type":"string","description":"Human-readable text of the messages emitted by IB in response to order submission."},"options":{"type":"array","items":{"type":"string"},"description":"Choices available to the client in response to the rejection message."},"type":{"type":"string","description":"The specific type of message returned."},"messageId":{"type":"string","description":"IB internal identifier for the nature or category of the returned message."},"prompt":{"type":"boolean","description":"Indicates that the message is a prompt offering a set of decisions, one or more of which may permit the rejected order to be resubmitted."}},"description":"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.","title":"advancedOrderReject"},"Trading Orders_confirmOrderReply_Response_200":{"oneOf":[{"$ref":"#/components/schemas/orderSubmitSuccess"},{"$ref":"#/components/schemas/orderReplyMessage"},{"$ref":"#/components/schemas/orderSubmitError"},{"$ref":"#/components/schemas/orderReplyNotFound"},{"$ref":"#/components/schemas/advancedOrderReject"}],"title":"Trading Orders_confirmOrderReply_Response_200"},"V1ApiIserverAccountOrdersGetParametersFilters":{"type":"string","enum":["inactive","pending_submit","pre_submitted","submitted","filled","pending_cancel","cancelled","warn_state","sort_by_time"],"title":"V1ApiIserverAccountOrdersGetParametersFilters"},"LiveOrdersResponseOrdersItemsIsEventTrading":{"type":"string","enum":["0","1"],"description":"Indicates whether the order ticket is an Event Trading order.","title":"LiveOrdersResponseOrdersItemsIsEventTrading"},"LiveOrdersResponseOrdersItemsStatus":{"type":"string","enum":["Inactive","PendingSubmit","PreSubmitted","Submitted","Filled","PendingCancel","Cancelled","WarnState"],"description":"Status of the order ticket.","title":"LiveOrdersResponseOrdersItemsStatus"},"LiveOrdersResponseOrdersItemsSupportsTaxOpt":{"type":"string","enum":["0","1"],"description":"Indicates whether the order is supported by IB's Tax Optimization tool.","title":"LiveOrdersResponseOrdersItemsSupportsTaxOpt"},"LiveOrdersResponseOrdersItems":{"type":"object","properties":{"account":{"type":"string","description":"IB account ID to which the order was placed."},"acct":{"type":"string","description":"IB account ID to which the order was placed."},"avgPrice":{"type":"string","description":"Average price of fills against the order, if any."},"bgColor":{"type":"string","description":"Internal use. IB's UI background color in hex."},"cashCcy":{"type":"string","description":"Currency of the order ticket's Cash Quantity, if applicable."},"companyName":{"type":"string","description":"Name of business associated with instrument, or otherwise description of instrument."},"conid":{"type":"string","description":"Contract ID of the order's instrument."},"conidex":{"type":"string","description":"Contract ID and routing destination in format 123456@EXCHANGE."},"description1":{"type":"string","description":"Descriptive text, or additional details that specific the instrument."},"description2":{"type":"string","description":"Only present for derivatives. Shows Expiry, Strike, Right, And Exchange information."},"exchange":{"type":"string","description":"Routing destination of the order ticket."},"fgColor":{"type":"string","description":"Internal use. IB's UI foreground color in hex."},"filledQuantity":{"type":"string","description":"Quantity filled in units of the instrument."},"isEventTrading":{"$ref":"#/components/schemas/LiveOrdersResponseOrdersItemsIsEventTrading","description":"Indicates whether the order ticket is an Event Trading order."},"lastExecutionTime":{"type":"string","description":"Time of last execution against the order in format YYMMDDhhmmss."},"lastExecutionTime_r":{"type":"string","description":"Unix timestamp of the last execution against the order."},"listingExchange":{"type":"string","description":"Exchange on which the instrument is listed."},"orderDesc":{"type":"string","description":"Human-readable shorthand rendering of the order ticket."},"orderId":{"type":"integer","format":"int64","description":"IB-assigned order identifier."},"orderType":{"type":"string","description":"Order type of a working order ticket."},"order_cancellation_by_system_reason":{"type":"string","description":"Only present for Cancelled orders. Provides the reason for order to have been cancelled or rejected by the system.\n"},"order_ccp_status":{"type":"string","description":"IB internal order status."},"origOrderType":{"type":"string","description":"Order type of a filled order."},"price":{"type":"string","description":"Price of the order, if applicable to the order type."},"remainingQuantity":{"type":"string","description":"Quantity remaining to be filled in units of the instrument."},"secType":{"type":"string","description":"Asset class of the instrument."},"side":{"type":"string","description":"Side of the order."},"sizeAndFills":{"type":"string","description":"Human-readable shorthand rendering of the filled and total quantities of the order."},"status":{"$ref":"#/components/schemas/LiveOrdersResponseOrdersItemsStatus","description":"Status of the order ticket."},"supportsTaxOpt":{"$ref":"#/components/schemas/LiveOrdersResponseOrdersItemsSupportsTaxOpt","description":"Indicates whether the order is supported by IB's Tax Optimization tool."},"taxOptimizerId":{"type":"string","description":"Tax Optimizer id, identifies set of tax lots selected, for gains and losses management."},"ticker":{"type":"string","description":"Symbol or base product code of the instrument."},"timeInForce":{"type":"string","description":"Time of force of the order."},"totalCashSize":{"type":"string","description":"Total size of a cash quantity order."},"totalSize":{"type":"string","description":"Total size of an order in the instrument's units."}},"description":"Object representing one order.","title":"LiveOrdersResponseOrdersItems"},"liveOrdersResponse":{"type":"object","properties":{"orders":{"type":"array","items":{"$ref":"#/components/schemas/LiveOrdersResponseOrdersItems"},"description":"Array of orders that are currently working, or were filled/cancelled in the current brokerage session."},"snapshot":{"type":"boolean","description":"Whether the response is a snapshot."}},"title":"liveOrdersResponse"},"SingleOrderSubmissionRequestTrailingType":{"type":"string","enum":["amt","%"],"description":"Specifies the type of trailing used with a Trailing order.","title":"SingleOrderSubmissionRequestTrailingType"},"SingleOrderSubmissionRequestSide":{"type":"string","enum":["BUY","SELL"],"description":"Side of the order ticket.","title":"SingleOrderSubmissionRequestSide"},"SingleOrderSubmissionRequestTif":{"type":"string","enum":["DAY","IOC","GTC","OPG","PAX"],"description":"Time in force of the order ticket.","title":"SingleOrderSubmissionRequestTif"},"SingleOrderSubmissionRequestStrategyParameters":{"type":"object","properties":{"PLACEHOLDER":{"type":"string","description":"Placeholder -- these vary by algo (and not always type string, sometimes bool)"}},"description":"Parameters governing the selected algorithm, if applicable.","title":"SingleOrderSubmissionRequestStrategyParameters"},"SingleOrderSubmissionRequestJsonPayloadAllocationProfileAllocType":{"type":"string","enum":["SHARE","CASH"],"description":"The allocation type to define how shares should be distributed.  A warning message to be pre-approved.\n   * `SHARE` - Designate the allocation amounts as a quantity of shares.\n   * `CASH` - Designate the allocation amounts as a quantity of a cash quantity to allocate.\n","title":"SingleOrderSubmissionRequestJsonPayloadAllocationProfileAllocType"},"SingleOrderSubmissionRequestJsonPayloadAllocationProfileAllocationsItems":{"type":"object","properties":{"account":{"type":"string","description":"Account to allocate trades to."},"amount":{"type":"number","format":"double","description":"Allocation to the given account based on the alloc_type."}},"title":"SingleOrderSubmissionRequestJsonPayloadAllocationProfileAllocationsItems"},"SingleOrderSubmissionRequestJsonPayloadAllocationProfile":{"type":"object","properties":{"alloc_type":{"$ref":"#/components/schemas/SingleOrderSubmissionRequestJsonPayloadAllocationProfileAllocType","description":"The allocation type to define how shares should be distributed.  A warning message to be pre-approved.\n   * `SHARE` - Designate the allocation amounts as a quantity of shares.\n   * `CASH` - Designate the allocation amounts as a quantity of a cash quantity to allocate.\n"},"allocations":{"type":"array","items":{"$ref":"#/components/schemas/SingleOrderSubmissionRequestJsonPayloadAllocationProfileAllocationsItems"},"description":"List of accounts to allocate a trade and the affiliated quantity."}},"description":"The assigned contents for how the order should be allocated amongst subaccount(s).","title":"SingleOrderSubmissionRequestJsonPayloadAllocationProfile"},"SingleOrderSubmissionRequestJsonPayload":{"type":"object","properties":{"allocation_profile":{"$ref":"#/components/schemas/SingleOrderSubmissionRequestJsonPayloadAllocationProfile","description":"The assigned contents for how the order should be allocated amongst subaccount(s)."}},"title":"SingleOrderSubmissionRequestJsonPayload"},"singleOrderSubmissionRequest":{"type":"object","properties":{"acctId":{"type":"string","description":"Receiving account of the order ticket."},"conid":{"type":"integer","format":"int64","description":"IB contract ID of the instrument."},"conidex":{"type":"string","description":"Contract ID and routing destination together in format 123456@EXCHANGE."},"secType":{"type":"string","description":"IB asset class identifier."},"cOID":{"type":"string","description":"Client-configurable order identifier. The value must be unique for a 24 hour span. The value can be no longer than 64 characters. Should not be set for the child of a bracket order.\n"},"parentId":{"type":"string","description":"If the order ticket is a child order in a bracket, the parentId field must be set equal to the cOID provided for the parent order."},"listingExchange":{"type":"string","description":"The listing exchange of the instrument."},"isSingleGroup":{"type":"boolean","description":"Indicates that all orders in the containing array are to be treated as an OCA group."},"outsideRTH":{"type":"boolean","description":"Instructs IB to permit the order to execute outside of regular trading hours."},"allOrNone":{"type":"boolean","description":"Instructs IB to execute the order  entirely or not execute at all."},"auxPrice":{"type":"number","format":"double","description":"Additional price value used in certain order types, such as stop orders."},"ticker":{"type":"string","description":"Ticker symbol of the instrument."},"trailingAmt":{"type":"number","format":"double","description":"Offset used with Trailing orders."},"trailingType":{"$ref":"#/components/schemas/SingleOrderSubmissionRequestTrailingType","description":"Specifies the type of trailing used with a Trailing order."},"referrer":{"type":"string","description":"IB internal identifier for order entry UI element."},"cashQty":{"type":"number","format":"double","description":"Quantity of currency used with cash quantity orders."},"useAdaptive":{"type":"boolean","description":"Instructs IB to apply the Price Management Algo."},"isCcyConv":{"type":"boolean","description":"Indicates that a forex order is for currency conversion and should not entail a virtual forex position in the account, where applicable."},"orderType":{"type":"string","description":"IB order type identifier."},"price":{"type":"number","format":"double","description":"Price of the order ticket, where applicable."},"side":{"$ref":"#/components/schemas/SingleOrderSubmissionRequestSide","description":"Side of the order ticket."},"tif":{"$ref":"#/components/schemas/SingleOrderSubmissionRequestTif","description":"Time in force of the order ticket."},"quantity":{"type":"number","format":"double","description":"Quantity of the order ticket in units of the instrument."},"strategy":{"type":"string","description":"The name of an execution algorithm."},"strategyParameters":{"$ref":"#/components/schemas/SingleOrderSubmissionRequestStrategyParameters","description":"Parameters governing the selected algorithm, if applicable."},"extOperator":{"type":"string","description":"ExtOperator is used to identify external operator"},"manualIndicator":{"type":"boolean","description":"For all orders for US Futures products, clients must submit this flag to indicate whether the order was originated manually (by a natural person) or automatically (by an automated trading system transmitting orders without human intervention). Submit a True value to indicate a manually originated order, and submit a False value to indicate an automated order. Orders for USFUT products that do not include this field will be rejected."},"taxOptimizerId":{"type":"string","description":"Identifies set of tax lots selected, for gains and losses management."},"jsonPayload":{"$ref":"#/components/schemas/SingleOrderSubmissionRequestJsonPayload"}},"required":["conid","orderType","side","tif","quantity"],"description":"A single order ticket.","title":"singleOrderSubmissionRequest"},"Trading Orders_modifyOpenOrder_Response_200":{"oneOf":[{"$ref":"#/components/schemas/orderSubmitSuccess"},{"$ref":"#/components/schemas/orderSubmitError"},{"$ref":"#/components/schemas/orderReplyMessage"},{"$ref":"#/components/schemas/advancedOrderReject"}],"title":"Trading Orders_modifyOpenOrder_Response_200"},"ordersSubmissionRequest":{"type":"object","properties":{"orders":{"type":"array","items":{"$ref":"#/components/schemas/singleOrderSubmissionRequest"},"description":"Array of order tickets objects. Only one order ticket object may be submitted per request, unless constructing a bracket."}},"title":"ordersSubmissionRequest"},"OrderPreviewAmount":{"type":"object","properties":{"amount":{"type":"string","description":"Projected cost of the order, current reference price times total quantity."},"commission":{"type":"string","description":"Projected commissions and fees associated with the order."},"total":{"type":"string","description":"Sum of projected cost and commission values for the order."}},"description":"Describes the projected costs associated with the order ticket.","title":"OrderPreviewAmount"},"OrderPreviewEquity":{"type":"object","properties":{"current":{"type":"string","description":"Current equity."},"change":{"type":"string","description":"Difference between current and projected equity values."},"after":{"type":"string","description":"Projected equity after execution of the order."}},"description":"Describes the projected change to the account's equity.","title":"OrderPreviewEquity"},"OrderPreviewInitial":{"type":"object","properties":{"current":{"type":"string","description":"Current initial margin."},"change":{"type":"string","description":"Difference between current and projected initial margin values."},"after":{"type":"string","description":"Projected initial margin after execution of the order."}},"description":"Describes the projected change to initial margin.","title":"OrderPreviewInitial"},"OrderPreviewMaintenance":{"type":"object","properties":{"current":{"type":"string","description":"Current maintenance margin."},"change":{"type":"string","description":"Difference between current and projected maintenance margin values."},"after":{"type":"string","description":"Projected maintenance margin after execution of the order."}},"description":"Describes the projected change to maintenance margin.","title":"OrderPreviewMaintenance"},"OrderPreviewPosition":{"type":"object","properties":{"current":{"type":"string","description":"Current position in the instrument."},"change":{"type":"string","description":"Difference between current and projected position sizes."},"after":{"type":"string","description":"Projected position size after execution of the order."}},"description":"Describes the projected change to the account's position in the instrument.","title":"OrderPreviewPosition"},"orderPreview":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/OrderPreviewAmount","description":"Describes the projected costs associated with the order ticket."},"equity":{"$ref":"#/components/schemas/OrderPreviewEquity","description":"Describes the projected change to the account's equity."},"initial":{"$ref":"#/components/schemas/OrderPreviewInitial","description":"Describes the projected change to initial margin."},"maintenance":{"$ref":"#/components/schemas/OrderPreviewMaintenance","description":"Describes the projected change to maintenance margin."},"position":{"$ref":"#/components/schemas/OrderPreviewPosition","description":"Describes the projected change to the account's position in the instrument."},"warn":{"type":"string","description":"Human-readable text of warning message, if applicable. Otherwise null."},"error":{"type":["string","null"],"description":"Human-readable text of an error message, if applicable. Otherwise null."}},"description":"Projected costs and changes to margin and equity values in the account, if the order ticket were executed in full.","title":"orderPreview"},"Trading Orders_resetOrderSuppression_Response_200":{"type":"object","properties":{"status":{"type":"string","description":"Confirms the successful removal of suppression. Always returns \"Submitted\"."}},"description":"Confirms successful removal of suppression.","title":"Trading Orders_resetOrderSuppression_Response_200"},"OrderStatusSide":{"type":"string","enum":["BUY","SELL"],"description":"Side of the order ticket.","title":"OrderStatusSide"},"OrderStatusOrderStatus":{"type":"string","enum":["Inactive","PendingSubmit","PreSubmitted","Submitted","Filled","PendingCancel","Cancelled","WarnState"],"description":"Status of the order ticket.","title":"OrderStatusOrderStatus"},"OrderStatusTif":{"type":"string","enum":["DAY","IOC","GTC","OPG","PAX"],"description":"Time in force of the order ticket.","title":"OrderStatusTif"},"OrderStatusSecType":{"type":"string","enum":["STK","OPT","FUT","FOP","CASH","CRYPTO","BOND","WAR","FUND"],"description":"IB asset class identifier.","title":"OrderStatusSecType"},"OrderStatusAlertActive":{"type":"string","enum":["0","1"],"description":"Indicates that an alert is active for the order ticket.","title":"OrderStatusAlertActive"},"OrderStatusChildOrderType":{"type":"string","enum":["0","A","B"],"description":"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","title":"OrderStatusChildOrderType"},"orderStatus":{"type":"object","properties":{"sub_type":{"type":["string","null"],"description":"Internal use only."},"request_id":{"type":"string","description":"Internal use only. IB-assigned identifier for the status request."},"server_id":{"type":"string","description":"IB-assigned meta-identifier used to associate rejected and resubmitted orders following Server Prompts."},"order_id":{"type":"integer","format":"int64","description":"The IB-assigned order identifier of the order, as provided in the request path."},"conidex":{"type":"string","description":"Contract ID and routing destination in format 123456@EXCHANGE."},"conid":{"type":"integer","format":"int64","description":"Contract ID of the order's instrument."},"symbol":{"type":"string","description":"Symbol of the order ticket's instrument."},"side":{"$ref":"#/components/schemas/OrderStatusSide","description":"Side of the order ticket."},"contract_description_1":{"type":"string","description":"Human-readable description of the order's instrument."},"listing_exchange":{"type":"string","description":"Primary listing exchange of the order ticket's instrument."},"option_acct":{"type":"string","description":"Internal use only."},"company_name":{"type":"string","description":"Name of the company or asset associated with the instrument."},"size":{"type":"string","description":"Remaining unfilled size of the order ticket. Will reflect 0.0 if order is filled in full, cancelled, or otherwise resolved and no longer working."},"total_size":{"type":"string","description":"The total size of the order ticket."},"currency":{"type":"string","description":"The currency in which the instrument trades and executions are conducted."},"account":{"type":"string","description":"The account receiving executions against this order ticket."},"order_type":{"type":"string","description":"The order's  IB order type."},"cum_fill":{"type":"string","description":"Cumulative filled quantity of the instrument against the order ticket."},"order_status":{"$ref":"#/components/schemas/OrderStatusOrderStatus","description":"Status of the order ticket."},"order_ccp_status":{"type":"string","description":"IB internal order status."},"order_status_description":{"type":"string","description":"Human-readable rendering of the order's status meant for presentation in UI."},"tif":{"$ref":"#/components/schemas/OrderStatusTif","description":"Time in force of the order ticket."},"fgColor":{"type":"string","description":"Internal use. IB's UI foreground color in hex."},"bgColor":{"type":"string","description":"Internal use. IB's UI background color in hex."},"order_not_editable":{"type":"boolean","description":"Indicates whether the order ticket can be modified."},"editable_fields":{"type":"string","description":"Indicates which fields of the order ticket can be modified currently."},"cannot_cancel_order":{"type":"boolean","description":"Indicates whether the order ticket can be cancelled."},"deactivate_order":{"type":"boolean","description":"Indicates whether the order ticket can be deactivated."},"sec_type":{"$ref":"#/components/schemas/OrderStatusSecType","description":"IB asset class identifier."},"available_chart_periods":{"type":"string","description":"Internal use. Indicates chart periods available for the instrument."},"order_description":{"type":"string","description":"Human-readable description of the status or current result of the order ticket, meant for UI presentation."},"order_description_with_contract":{"type":"string","description":"Human-readable description of the status or current result of the order ticket, meant for UI presentation. Includes instrument name."},"alert_active":{"$ref":"#/components/schemas/OrderStatusAlertActive","description":"Indicates that an alert is active for the order ticket."},"child_order_type":{"$ref":"#/components/schemas/OrderStatusChildOrderType","description":"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_clearing_account":{"type":"string","description":"The IB account to which the order ticket clears."},"size_and_fills":{"type":"string","description":"A string reflecting the cumulative fills and total size of the order."},"exit_strategy_display_price":{"type":"string","description":"Internal use. The UI-displayed price associated with a Client Portal exist strategy."},"exit_strategy_chart_description":{"type":"string","description":"Internal use. A string describing an active Client Portal exit strategy, or the result of its execution."},"average_price":{"type":"string","description":"Average price of fills against the order, if any."},"exit_strategy_tool_availability":{"type":"string","description":"Internal use. Indicates the availability of Client Portal exit strategy tool for the order."},"allowed_duplicate_opposite":{"type":"boolean","description":"Indicates whether an identical order on the opposite side can be placed."},"order_time":{"type":"string","description":"Time of the order's submission in format YYMMDDhhmmss."}},"description":"Object containing information about the status of an order ticket.","title":"orderStatus"},"Trading Orders_getOrderStatus_Response_200":{"oneOf":[{"$ref":"#/components/schemas/orderStatus"}],"title":"Trading Orders_getOrderStatus_Response_200"},"Trading Orders_submitNewOrder_Response_200":{"oneOf":[{"$ref":"#/components/schemas/orderSubmitSuccess"},{"$ref":"#/components/schemas/orderReplyMessage"},{"$ref":"#/components/schemas/orderSubmitError"},{"$ref":"#/components/schemas/advancedOrderReject"}],"title":"Trading Orders_submitNewOrder_Response_200"},"V1ApiIserverQuestionsSuppressPostRequestBodyContentApplicationJsonSchemaMessageIdsItems":{"type":"string","enum":["o163","o354","o382","o383","o403","o451","o2136","o2137","o2165","o10082","o10138","o10151","o10152","o10153","o10164","o10223","o10288","o10331","o10332","o10333","o10334","o10335","o10336","p6","p12"],"description":"A warning message to be pre-approved.\n  * `o163` - The following order exceeds the price percentage limit\n  * `o354` - \"\"\"You are submitting an order without market data. We strongly recommend against this as it may result in erroneous and unexpected trades. Are you sure you want to submit this order?\"\"\"\n  * `o382` - The following value exceeds the tick size limit\n  * `o383` - \"\"\"The following order \\\"\"BUY 650 AAPL NASDAQ.NMS\\\"\" size exceeds the Size Limit of 500.\\nAre you sure you want to submit this order?\"\"\"\n  * `o403` - \"\"\"This order will most likely trigger and fill immediately.\\nAre you sure you want to submit this order?\"\"\"\n  * `o451` - \"\"\"The following order \\\"\"BUY 650 AAPL NASDAQ.NMS\\\"\" value estimate of 124,995.00 USD exceeds \\nthe Total Value Limit of 100,000 USD.\\nAre you sure you want to submit this order?\"\"\"\n  * `o2136` - Mixed allocation order warning\n  * `o2137` - Cross side order warning\n  * `o2165` - Warns that instrument does not support trading in fractions outside regular trading hours\n  * `o10082` - Called Bond warning\n  * `o10138` - The following order size modification exceeds the size modification limit.\n  * `o10151` - Warns about risks with Market Orders\n  * `o10152` - Warns about risks associated with stop orders once they become active\n  * `o10153` - <h4>Confirm Mandatory Cap Price</h4>To avoid trading at a price that is not consistent with a fair and orderly market, IB may set a cap (for a buy order) or sell order). THIS MAY CAUSE AN ORDER THAT WOULD OTHERWISE BE MARKETABLE TO NOT BE TRADED.\n  * `o10164` - \"\"\"Traders are responsible for understanding cash quantity details, which are provided on a best efforts basis only.\"\"\"\n  * `o10223` - \"\"\"<h4>Cash Quantity Order Confirmation</h4>Orders that express size using a monetary value (cash quantity) are provided on a non-guaranteed basis. The system simulates the order by cancelling it once the specified amount is spent (for buy orders) or collected (for sell orders). In addition to the monetary value, the order uses a maximum size that is calculated using the Cash Quantity Estimate Factor, which you can modify in Presets.\"\"\"\n  * `o10288` - Warns about risks associated with market orders for Crypto\n  * `o10331` - \"\"\"You are about to submit a stop order. Please be aware of the various stop order types available and the risks associated with each one.\\nAre you sure you want to submit this order?\"\"\"\n  * `o10332` - OSL Digital Securities LTD Crypto Order Warning\n  * `o10333` - Option Exercise at the Money warning\n  * `o10334` - Warns that order will be placed into current omnibus account instead of currently selected global account.\n  * `o10335` - Serves internal Rapid Entry window.\n  * `o10336` - This security has limited liquidity. If you choose to trade this security, there is a heightened risk that you may not be able to close your position at the time you wish, at a price you wish, and/or without incurring a loss. Confirm that you understand the risks of trading illiquid securities.\n  * `Are you sure you want to submit this order?\n  * `p6` - This order will be distributed over multiple accounts. We strongly suggest you familiarize yourself with our allocation facilities before submitting orders.\n  * `p12` - \"If your order is not immediately executable, our systems may, depending on market conditions, reject your order if its limit price is more than the allowed amount away from the reference price at that time. If this happens, you will not receive a fill. This is a control designed to ensure that we comply with our regulatory obligations to avoid submitting disruptive orders to the marketplace.\\\\nUse the Price Management Algo?\"\n","title":"V1ApiIserverQuestionsSuppressPostRequestBodyContentApplicationJsonSchemaMessageIdsItems"},"Trading Orders_suppressOrderReplies_Response_200":{"type":"object","properties":{"status":{"type":"string","description":"Confirms the successful suppression of specified messageIds. Always returns \"Submitted\"."}},"description":"Confirms successful reply to the server prompt.","title":"Trading Orders_suppressOrderReplies_Response_200"},"TradesResponseItemsSupportsTaxOpt":{"type":"string","enum":["0","1"],"description":"Indicates whether the order is supported by IB's Tax Optimization tool.","title":"TradesResponseItemsSupportsTaxOpt"},"TradesResponseItemsSide":{"type":"string","enum":["B","S"],"description":"Side of the execution.","title":"TradesResponseItemsSide"},"TradesResponseItemsSecType":{"type":"string","enum":["STK","OPT","FUT","FOP","CASH","CRYPTO","BOND","WAR","FUND"],"description":"IB asset class identifier.","title":"TradesResponseItemsSecType"},"TradesResponseItemsLiquidationTrade":{"type":"string","enum":["0","1"],"description":"Indicates whether the trade is the result of a liquidiation by IB.","title":"TradesResponseItemsLiquidationTrade"},"TradesResponseItemsIsEventTrading":{"type":"string","enum":["0","1"],"description":"Indicates whether the order ticket is an Event Trading order.","title":"TradesResponseItemsIsEventTrading"},"TradesResponseItems":{"type":"object","properties":{"execution_id":{"type":"string","description":"IB-assigned execution identifier."},"symbol":{"type":"string","description":"Symbol of the instrument involved in the execution."},"supports_tax_opt":{"$ref":"#/components/schemas/TradesResponseItemsSupportsTaxOpt","description":"Indicates whether the order is supported by IB's Tax Optimization tool."},"side":{"$ref":"#/components/schemas/TradesResponseItemsSide","description":"Side of the execution."},"order_description":{"type":"string","description":"Human-readable description of the outcome of the execution."},"trade_time":{"type":"string","description":"UTC date and time of the execution in format YYYYMMDD-hh:mm:ss."},"trade_time_r":{"type":"integer","format":"int64","description":"Unix timestamp of the execution time in milliseconds."},"size":{"type":"number","format":"double","description":"The size of the execution in units of the instrument."},"price":{"type":"string","description":"The price at which the execution occurred."},"order_ref":{"type":"string","description":"The client-provided customer order identifier. Specified via cOID during order submission in the Web API."},"submitter":{"type":"string","description":"The IB username that originated the order ticket against which the execution occurred."},"exchange":{"type":"string","description":"The exchange or other venue on which the execution occurred."},"commission":{"type":"string","description":"Commissions incurred by the execution. May also include"},"net_amount":{"type":"number","format":"double","description":"net_amount"},"account":{"type":"string","description":"The IB account ID of the account that received the execution."},"accountCode":{"type":"string","description":"The IB account ID of the account that received the execution."},"account_allocation_name":{"type":"string","description":"The IB account ID of the account that received the execution."},"company_name":{"type":"string","description":"Name of business associated with instrument, or otherwise description of instrument."},"contract_description_1":{"type":"string","description":"Human-readable description of the order's instrument."},"sec_type":{"$ref":"#/components/schemas/TradesResponseItemsSecType","description":"IB asset class identifier."},"listing_exchange":{"type":"string","description":"The primary exchange on which the instrument is listed."},"conid":{"type":"string","description":"Contract ID of the order's instrument."},"conidEx":{"type":"string","description":"Contract ID and routing destination in format 123456@EXCHANGE."},"clearing_id":{"type":"string","description":"Identifier of the firm clearing the trade. Value is \"IB\" if account is cleared by Interactive Brokers."},"clearing_name":{"type":"string","description":"Name of the firm clearing the trade. Value is \"IB\" if account is cleared by Interactive Brokers."},"liquidation_trade":{"$ref":"#/components/schemas/TradesResponseItemsLiquidationTrade","description":"Indicates whether the trade is the result of a liquidiation by IB."},"is_event_trading":{"$ref":"#/components/schemas/TradesResponseItemsIsEventTrading","description":"Indicates whether the order ticket is an Event Trading order."},"order_id":{"type":"integer","format":"int64","description":"Order ID"}},"description":"Object containing details of a single execution.","title":"TradesResponseItems"},"tradesResponse":{"type":"array","items":{"$ref":"#/components/schemas/TradesResponseItems"},"description":"Array of objects representing executions.","title":"tradesResponse"},"PortfolioAllocationsAssetClass":{"type":"object","properties":{"long":{"type":"object","additionalProperties":{"type":"number","format":"double"},"description":"Object containing value of long positions in the account aggregated by asset class."},"short":{"type":"object","additionalProperties":{"type":"number","format":"double"},"description":"Object containing value of short positions in the account aggregated by asset class."}},"description":"Object containing values of positions sorted by long/short and asset class.","title":"PortfolioAllocationsAssetClass"},"PortfolioAllocationsGroup":{"type":"object","properties":{"long":{"type":"object","additionalProperties":{"type":"number","format":"double"},"description":"Object containing value of long positions in the account aggregated by Sector Group."},"short":{"type":"object","additionalProperties":{"type":"number","format":"double"},"description":"Object containing value of short positions in the account aggregated by Sector Group."}},"description":"Object containing values of positions sorted by long/short and Sector Group.","title":"PortfolioAllocationsGroup"},"PortfolioAllocationsSector":{"type":"object","properties":{"long":{"type":"object","additionalProperties":{"type":"number","format":"double"},"description":"Object containing value of long positions in the account aggregated by Sector."},"short":{"type":"object","additionalProperties":{"type":"number","format":"double"},"description":"Object containing value of short positions in the account aggregated by Sector."}},"description":"Object containing values of positions sorted by long/short and Sector.","title":"PortfolioAllocationsSector"},"portfolioAllocations":{"type":"object","properties":{"assetClass":{"$ref":"#/components/schemas/PortfolioAllocationsAssetClass","description":"Object containing values of positions sorted by long/short and asset class."},"group":{"$ref":"#/components/schemas/PortfolioAllocationsGroup","description":"Object containing values of positions sorted by long/short and Sector Group."},"sector":{"$ref":"#/components/schemas/PortfolioAllocationsSector","description":"Object containing values of positions sorted by long/short and Sector."}},"title":"portfolioAllocations"},"AccountAttributesBusinessType":{"type":"string","enum":["IB_SALES","IB_PROSERVE","FA","FA_CLIENT","INTR_BROK","INTR_BROK_CLIENT","FD_CLIENT","INSTITUTIONAL","IB_DEVELOPERS"],"description":"A descriptor of the nature of the account, reflecting the responsible group within IB.","title":"AccountAttributesBusinessType"},"AccountAttributesClearingStatus":{"type":"string","enum":["A","N","O","C","P","R","E","Q"],"description":"Status of the account with respect to clearing at IB. O is open, P pending, N new, A abandoned, C closed, R rejected.","title":"AccountAttributesClearingStatus"},"AccountAttributesCurrency":{"type":"string","enum":["AED","AUD","CAD","CHF","CNH","CZK","DKK","EUR","GBP","HKD","HUF","ILS","JPY","MXN","NOK","NZD","PLN","SEK","SGD","USD"],"description":"Base currency of the account.","title":"AccountAttributesCurrency"},"AccountAttributesIbEntity":{"type":"string","enum":["IBLLC-US","IB-CAN","IB-UK","IB-IE","IB-AU","IB-HK","IB-IN","IB-JP","IB-SG"],"description":"IB business entity under which the account resides.","title":"AccountAttributesIbEntity"},"AccountAttributesParent":{"type":"object","properties":{"accountId":{"type":"string","description":"Account ID of the parent account in a multiplex account structure."},"isMChild":{"type":"boolean","description":"Indicates that the given account is a multiplex child account."},"isMParent":{"type":"boolean","description":"Indicates that the given account is itself a multiplex parent account."},"isMultiplex":{"type":"boolean","description":"Indicates that the account is a multiplex account."},"mmc":{"type":"array","items":{"description":"Any type"},"description":"Money manager client."}},"description":"Describes account relations in partitioned or multiplexed (segemented) account structures.","title":"AccountAttributesParent"},"AccountAttributesTradingType":{"type":"string","enum":["IRAMRGN","FUTNOPT","GPMRGN","PMRGN","STKCASH","STKMRGN","STKNOPT"],"description":"Internal identifier used by IB to reflect the trading permissions of the account.","title":"AccountAttributesTradingType"},"AccountAttributesType":{"type":"string","enum":["DEMO","DEMO-BROKER","DEMO-ADVISOR","FNF","INDIVIDUAL","COMPANY","STL","UTMA","PRO-ADV","IRA","TRUST"],"description":"Indicates whether the account exists in production, paper, or demo environments.","title":"AccountAttributesType"},"accountAttributes":{"type":"object","properties":{"PrepaidCrypto-P":{"type":"boolean","description":"Indicates whether account has a prepaid crypto segment (Crypto Plus) with PAXOS."},"PrepaidCrypto-Z":{"type":"boolean","description":"Indicates whether account has a prepaid crypto segment (Crypto Plus) with ZEROHASH."},"accountAlias":{"type":["string","null"],"description":"User-defined alias assigned to the account for easy identification."},"accountId":{"type":"string","description":"Indicates the identifying number for the account."},"accountStatus":{"type":"integer","format":"int64","description":"Unix epoch timestamp of account opening."},"accountTitle":{"type":"string","description":"A name assigned to the account, typically the account holder name or business entity."},"accountVan":{"type":"string","description":"The account's virtual account number, or otherwise its IB accountId if no VAN is set."},"acctCustType":{"type":"string","description":"Identifies the type of client with which the account is associated, such as an individual or LLC."},"brokerageAccess":{"type":"boolean","description":"Indicates whether account can receive live orders (do not mix with paper trading)."},"businessType":{"$ref":"#/components/schemas/AccountAttributesBusinessType","description":"A descriptor of the nature of the account, reflecting the responsible group within IB."},"category":{"type":"string","description":"Designated account category. Only used in non-standard account structures."},"clearingStatus":{"$ref":"#/components/schemas/AccountAttributesClearingStatus","description":"Status of the account with respect to clearing at IB. O is open, P pending, N new, A abandoned, C closed, R rejected."},"covestor":{"type":"boolean","description":"Indicates a Covestor account."},"currency":{"$ref":"#/components/schemas/AccountAttributesCurrency","description":"Base currency of the account."},"desc":{"type":"string","description":"Internal human-readable description of the account."},"displayName":{"type":"string","description":"Displayed name of the account in UI. Will reflect either the accountId or accountAlias, if set."},"faClient":{"type":"boolean","description":"Indicates that the account is managed by a financial advisor."},"ibEntity":{"$ref":"#/components/schemas/AccountAttributesIbEntity","description":"IB business entity under which the account resides."},"id":{"type":"string","description":"The account's IB accountId."},"noClientTrading":{"type":"boolean","description":"Indicates that trading by the client is disabled in the account."},"parent":{"$ref":"#/components/schemas/AccountAttributesParent","description":"Describes account relations in partitioned or multiplexed (segemented) account structures."},"trackVirtualFXPortfolio":{"type":"boolean","description":"Indicates that virtual forex positions are tracked in the account."},"tradingType":{"$ref":"#/components/schemas/AccountAttributesTradingType","description":"Internal identifier used by IB to reflect the trading permissions of the account."},"type":{"$ref":"#/components/schemas/AccountAttributesType","description":"Indicates whether the account exists in production, paper, or demo environments."}},"title":"accountAttributes"},"LedgerKey":{"type":"string","enum":["LedgerList"],"description":"Identifies the nature of data. Always takes values 'LedgerList'.","title":"LedgerKey"},"Ledger":{"type":"object","properties":{"acctcode":{"type":"string","description":"The Account ID of the requested account."},"cashbalance":{"type":"number","format":"double","description":"The given account's cash balance in this currency."},"cashbalancefxsegment":{"type":"number","format":"double","description":"The given account's cash balance in its dedicated forex segment in this currency, if applicable."},"commoditymarketvalue":{"type":"number","format":"double","description":"Market value of the given account's commodity positions in this currency."},"corporatebondsmarketvalue":{"type":"number","format":"double","description":"Market value of the given account's corporate bond positions in this currency."},"currency":{"type":"string","description":"Three-letter name of the currency reflected by this object, or 'BASE' for the account's base currency."},"dividends":{"type":"number","format":"double","description":"The given account's receivable (not yet disbursed) dividend balance in this currency."},"exchangerate":{"type":"integer","format":"int64","description":"Exchange rate of this currency relative to the account's base currency."},"funds":{"type":"number","format":"double","description":"The value of the given account's mutual fund holdings in this currency."},"futuremarketvalue":{"type":"number","format":"double","description":"Market value of the given account's futures positions in this currency."},"futureoptionmarketvalue":{"type":"number","format":"double","description":"Market value of the given account's futures options positions in this currency."},"futuresonlypnl":{"type":"number","format":"double","description":"PnL of the given account's futures positions in this currency."},"interest":{"type":"number","format":"double","description":"The given account's receivable interest balance in this currency."},"issueroptionsmarketvalue":{"type":"number","format":"double","description":"Market value of the given account's issuer options positions in this currency."},"key":{"$ref":"#/components/schemas/LedgerKey","description":"Identifies the nature of data. Always takes values 'LedgerList'."},"moneyfunds":{"type":"number","format":"double","description":"The value of the given account's money market fund holdings in this currency."},"netliquidationvalue":{"type":"number","format":"double","description":"The given account's net liquidation value of positions in this currency."},"realizedpnl":{"type":"number","format":"double","description":"The given account's realized PnL for positions in this currency."},"secondkey":{"type":"string","description":"Additional identifier of the currency reflected in this object. Always matches 'currency' field."},"sessionid":{"type":"integer","format":"int64"},"settledcash":{"type":"number","format":"double","description":"The given account's settled cash balance in this currency."},"severity":{"type":"integer","format":"int64"},"stockmarketvalue":{"type":"number","format":"double","description":"Market value of the given account's stock positions in this currency."},"stockoptionmarketvalue":{"type":"number","format":"double","description":"Market value of the given account's stock options positions in this currency."},"tbillsmarketvalue":{"type":"number","format":"double","description":"Market value of the given account's treasury bill positions in this currency."},"tbondsmarketvalue":{"type":"number","format":"double","description":"Market value of the given account's treasury bond positions in this currency."},"timestamp":{"type":"integer","format":"int64","description":"Timestamp of retrievable of this account ledger data."},"unrealizedpnl":{"type":"number","format":"double","description":"The given account's unrealied PnL for positions in this currency."},"warrantsmarketvalue":{"type":"number","format":"double","description":"Market value of the given account's warrant positions in this currency."}},"description":"Object describing the account's balances in its base currency, by asset class and account segments. Will be duplicated by another object in response bearing the currency's name.","title":"Ledger"},"ledger":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Ledger"},"description":"Contains objects reflecting all currencies in which the account's positions trade.","title":"ledger"},"PortfolioSummaryAccountcode":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"The Account ID of the requested account. (value)","title":"PortfolioSummaryAccountcode"},"PortfolioSummaryAccountready":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Indicates whether the account is fully open and tradable. (value)","title":"PortfolioSummaryAccountready"},"PortfolioSummaryAccounttype":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Identifies the type of client with which the account is associated, such as an individual or LLC. (value)","title":"PortfolioSummaryAccounttype"},"PortfolioSummaryAccruedcash":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Amount of cash accrued (not yet disbursed) for all segments in the account. (amount)","title":"PortfolioSummaryAccruedcash"},"PortfolioSummaryAccruedcashC":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Amount of cash accrued (not yet disbursed) for the commodities segment in the account. (amount)","title":"PortfolioSummaryAccruedcashC"},"PortfolioSummaryAccruedcashS":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Amount of cash accrued (not yet disbursed) for the securities segment in the account. (amount)","title":"PortfolioSummaryAccruedcashS"},"PortfolioSummaryAccrueddividend":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Amount of dividends accrued (not yet disbursed) for all segments in the account. (amount)","title":"PortfolioSummaryAccrueddividend"},"PortfolioSummaryAccrueddividendC":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Amount of dividends accrued (not yet disbursed) for the commodities segment in the account. (amount)","title":"PortfolioSummaryAccrueddividendC"},"PortfolioSummaryAccrueddividendS":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Amount of dividends accrued (not yet disbursed) for the securities segment in the account. (amount)","title":"PortfolioSummaryAccrueddividendS"},"PortfolioSummaryAvailablefunds":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Available funds (ELV minus Initial Margin) for all segments in the account. (amount)","title":"PortfolioSummaryAvailablefunds"},"PortfolioSummaryAvailablefundsC":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Available funds (ELV minus Initial Margin) for the commodities segment in the account. (amount)","title":"PortfolioSummaryAvailablefundsC"},"PortfolioSummaryAvailablefundsS":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Available funds (ELV minus Initial Margin) for the securities segment in the account. (amount)","title":"PortfolioSummaryAvailablefundsS"},"PortfolioSummaryAvailabletotrade":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Funds available for trading (ELV minus Initial Margin) for all segments in the account. (amount)","title":"PortfolioSummaryAvailabletotrade"},"PortfolioSummaryAvailabletotradeC":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Funds available for trading (ELV minus Initial Margin) for the commodities segment in the account. (amount)","title":"PortfolioSummaryAvailabletotradeC"},"PortfolioSummaryAvailabletotradeS":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Funds available for trading (ELV minus Initial Margin) for the securities segment in the account. (amount)","title":"PortfolioSummaryAvailabletotradeS"},"PortfolioSummaryAvailabletowithdraw":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Funds available for withdrawal for all segments in the account. (amount)","title":"PortfolioSummaryAvailabletowithdraw"},"PortfolioSummaryAvailabletowithdrawC":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Funds available for withdrawal for the commodities segment in the account. (amount)","title":"PortfolioSummaryAvailabletowithdrawC"},"PortfolioSummaryAvailabletowithdrawS":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Funds available for withdrawal for the securities segment in the account. (amount)","title":"PortfolioSummaryAvailabletowithdrawS"},"PortfolioSummaryBillable":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Billable commissions for all segments in the account. (amount)","title":"PortfolioSummaryBillable"},"PortfolioSummaryBillableC":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Billable commissions for the commodities segment in the account. (amount)","title":"PortfolioSummaryBillableC"},"PortfolioSummaryBillableS":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Billable commissions for the securities segment in the account. (amount)","title":"PortfolioSummaryBillableS"},"PortfolioSummaryBuyingpower":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Buying power (maximum value of securities that can be bought without adding funds) for the account. (amount)","title":"PortfolioSummaryBuyingpower"},"PortfolioSummaryColumnprioC":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"columnprio-c","title":"PortfolioSummaryColumnprioC"},"PortfolioSummaryColumnprioS":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"columnprio-s","title":"PortfolioSummaryColumnprioS"},"PortfolioSummaryCushion":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Margin cushion as a decimal ratio, (ELV-Maintenance)/ELV. (value)","title":"PortfolioSummaryCushion"},"PortfolioSummaryDaytradesremaining":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Number of day trades currently still available for 4-day pattern day trader period. (value)","title":"PortfolioSummaryDaytradesremaining"},"PortfolioSummaryDaytradesremainingt1":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Number of day trades available tomorrow for 4-day pattern day trader period. (value)","title":"PortfolioSummaryDaytradesremainingt1"},"PortfolioSummaryDaytradesremainingt2":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Number of day trades available in two days for 4-day pattern day trader period. (value)","title":"PortfolioSummaryDaytradesremainingt2"},"PortfolioSummaryDaytradesremainingt3":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Number of day trades available in three days for 4-day pattern day trader period. (value)","title":"PortfolioSummaryDaytradesremainingt3"},"PortfolioSummaryDaytradesremainingt4":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Number of day trades available in four days for 4-day pattern day trader period. (value)","title":"PortfolioSummaryDaytradesremainingt4"},"PortfolioSummaryDaytradingstatusS":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"daytradingstatus-s","title":"PortfolioSummaryDaytradingstatusS"},"PortfolioSummaryDepositoncredithold":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Indicates whether a deposit is on credit hold. (value)","title":"PortfolioSummaryDepositoncredithold"},"PortfolioSummaryEquitywithloanvalue":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Equity with Loan Value for all segments of the account. (amount)","title":"PortfolioSummaryEquitywithloanvalue"},"PortfolioSummaryEquitywithloanvalueC":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Equity with Loan Value for the commodities segment of the account. (amount)","title":"PortfolioSummaryEquitywithloanvalueC"},"PortfolioSummaryEquitywithloanvalueS":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Equity with Loan Value for the securities segment of the account. (amount)","title":"PortfolioSummaryEquitywithloanvalueS"},"PortfolioSummaryExcessliquidity":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Excess liquidity (ELV minus Maintenance Margin) for all segments of the account. (amount)","title":"PortfolioSummaryExcessliquidity"},"PortfolioSummaryExcessliquidityC":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Excess liquidity (ELV minus Maintenance Margin) for the commodities segment of the account. (amount)","title":"PortfolioSummaryExcessliquidityC"},"PortfolioSummaryExcessliquidityS":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Excess liquidity (ELV minus Maintenance Margin) for the securities segment of the account. (amount)","title":"PortfolioSummaryExcessliquidityS"},"PortfolioSummaryFullavailablefunds":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Full available funds for all segments of the account. (amount)","title":"PortfolioSummaryFullavailablefunds"},"PortfolioSummaryFullavailablefundsC":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Full available funds (NLV minus Initial Margin) for the commodities segment of the account. (amount)","title":"PortfolioSummaryFullavailablefundsC"},"PortfolioSummaryFullavailablefundsS":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Full available funds (ELV minus Initial Margin) for the securities segment of the account. (amount)","title":"PortfolioSummaryFullavailablefundsS"},"PortfolioSummaryFullexcessliquidity":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Full excess liquidity (ELV minus Maintenance Margin) for all segments of the account. (amount)","title":"PortfolioSummaryFullexcessliquidity"},"PortfolioSummaryFullexcessliquidityC":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Full excess liquidity (ELV minus Maintenance Margin) for the commodities segment of the account. (amount)","title":"PortfolioSummaryFullexcessliquidityC"},"PortfolioSummaryFullexcessliquidityS":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Full excess liquidity (ELV minus Maintenance Margin) for the securities segment of the account. (amount)","title":"PortfolioSummaryFullexcessliquidityS"},"PortfolioSummaryFullinitmarginreq":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Full Initial Margin requirement for all segments of the account. (amount)","title":"PortfolioSummaryFullinitmarginreq"},"PortfolioSummaryFullinitmarginreqC":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Full Initial Margin requirement for the commodities segment of the account. (amount)","title":"PortfolioSummaryFullinitmarginreqC"},"PortfolioSummaryFullinitmarginreqS":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Full Initial Margin requirement for the securities segment of the account. (amount)","title":"PortfolioSummaryFullinitmarginreqS"},"PortfolioSummaryFullmaintmarginreq":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Full Maintenance Margin requirement for all segments of the account. (amount)","title":"PortfolioSummaryFullmaintmarginreq"},"PortfolioSummaryFullmaintmarginreqC":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Full Maintenance Margin requirement for the commodities segment of the account. (amount)","title":"PortfolioSummaryFullmaintmarginreqC"},"PortfolioSummaryFullmaintmarginreqS":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Full Maintenance Margin requirement for the securities segment of the account. (amount)","title":"PortfolioSummaryFullmaintmarginreqS"},"PortfolioSummaryGrosspositionvalue":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Gross Position Value (sum of Long and Short position values for stocks and options) for all segments of the account. (amount)","title":"PortfolioSummaryGrosspositionvalue"},"PortfolioSummaryGrosspositionvalueS":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"grosspositionvalue-s","title":"PortfolioSummaryGrosspositionvalueS"},"PortfolioSummaryGuarantee":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"For accounts that clear away, value of Guarantee for all segments of the account. (amount)","title":"PortfolioSummaryGuarantee"},"PortfolioSummaryGuaranteeC":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"For accounts that clear away, value of Guarantee for the commodities segment of the account. (amount)","title":"PortfolioSummaryGuaranteeC"},"PortfolioSummaryGuaranteeS":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"For accounts that clear away, value of Guarantee for the securities segment of the account. (amount)","title":"PortfolioSummaryGuaranteeS"},"PortfolioSummaryHighestseverity":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"highestseverity","title":"PortfolioSummaryHighestseverity"},"PortfolioSummaryIndianstockhaircut":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Indian Stock Haircut value for all segments of the account. (amount)","title":"PortfolioSummaryIndianstockhaircut"},"PortfolioSummaryIndianstockhaircutC":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Indian Stock Haircut value for the commodities segment of the account. (amount)","title":"PortfolioSummaryIndianstockhaircutC"},"PortfolioSummaryIndianstockhaircutS":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Indian Stock Haircut value for the securities segment of the account. (amount)","title":"PortfolioSummaryIndianstockhaircutS"},"PortfolioSummaryInitmarginreq":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Initial Margin requirement for all segments of the account. (amount)","title":"PortfolioSummaryInitmarginreq"},"PortfolioSummaryInitmarginreqC":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Initial Margin requirement for the commodities segment of the account. (amount)","title":"PortfolioSummaryInitmarginreqC"},"PortfolioSummaryInitmarginreqS":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Initial Margin requirement for the securities segment of the account. (amount)","title":"PortfolioSummaryInitmarginreqS"},"PortfolioSummaryLeverageS":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Leverage ratio (GPV/NLV) of the securities segment of the account. (value)","title":"PortfolioSummaryLeverageS"},"PortfolioSummaryLookaheadavailablefunds":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Look-ahead Available Funds for all segments of the account. (amount)","title":"PortfolioSummaryLookaheadavailablefunds"},"PortfolioSummaryLookaheadavailablefundsC":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Look-ahead Available Funds for the commodities segment of the account. (amount)","title":"PortfolioSummaryLookaheadavailablefundsC"},"PortfolioSummaryLookaheadavailablefundsS":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Look-ahead Available Funds for the securities segment of the account. (amount)","title":"PortfolioSummaryLookaheadavailablefundsS"},"PortfolioSummaryLookaheadexcessliquidity":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Look-ahead Excess Liquidity for all segments of the account. (amount)","title":"PortfolioSummaryLookaheadexcessliquidity"},"PortfolioSummaryLookaheadexcessliquidityC":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Look-ahead Excess Liquidity for the commodities segment of the account. (amount)","title":"PortfolioSummaryLookaheadexcessliquidityC"},"PortfolioSummaryLookaheadexcessliquidityS":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Look-ahead Excess Liquidity for the securities segment of the account. (amount)","title":"PortfolioSummaryLookaheadexcessliquidityS"},"PortfolioSummaryLookaheadinitmarginreq":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Look-ahead Intial Margin requirement (as of next margin period) for all segments of the account. (amount)","title":"PortfolioSummaryLookaheadinitmarginreq"},"PortfolioSummaryLookaheadinitmarginreqC":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Look-ahead Intial Margin requirement (as of next margin period) for the commodities segment of the account. (amount)","title":"PortfolioSummaryLookaheadinitmarginreqC"},"PortfolioSummaryLookaheadinitmarginreqS":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Look-ahead Intial Margin requirement (as of next margin period) for the securities segment of the account. (amount)","title":"PortfolioSummaryLookaheadinitmarginreqS"},"PortfolioSummaryLookaheadmaintmarginreq":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Look-ahead Maintenance Margin requirement (as of next margin period) for all segments of the account. (amount)","title":"PortfolioSummaryLookaheadmaintmarginreq"},"PortfolioSummaryLookaheadmaintmarginreqC":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Look-ahead Maintenance Margin requirement (as of next margin period) for the commodities segment of the account. (amount)","title":"PortfolioSummaryLookaheadmaintmarginreqC"},"PortfolioSummaryLookaheadmaintmarginreqS":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Look-ahead Maintenance Margin requirement (as of next margin period) for the securities segment of the account. (amount)","title":"PortfolioSummaryLookaheadmaintmarginreqS"},"PortfolioSummaryLookaheadnextchange":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Unix epoch timestamp in seconds of start of next margin period. (value)","title":"PortfolioSummaryLookaheadnextchange"},"PortfolioSummaryMaintmarginreq":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Maintenance Margin requirement for all segments of the account. (amount)","title":"PortfolioSummaryMaintmarginreq"},"PortfolioSummaryMaintmarginreqC":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Maintenance Margin requirement for the commodities segment of the account. (amount)","title":"PortfolioSummaryMaintmarginreqC"},"PortfolioSummaryMaintmarginreqS":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Maintenance Margin requirement for the securities segment of the account. (amount)","title":"PortfolioSummaryMaintmarginreqS"},"PortfolioSummaryNetliquidation":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Net Liquidation Value (NLV) for all segments of the account. (amount)","title":"PortfolioSummaryNetliquidation"},"PortfolioSummaryNetliquidationC":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Net Liquidation Value (sum of values of cash and commodities options) for the commodities segment of the account. (amount)","title":"PortfolioSummaryNetliquidationC"},"PortfolioSummaryNetliquidationS":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Net Liquidation Value (sum of values of cash, stocks, securities options, bonds) for the securities segment of the account. (amount)","title":"PortfolioSummaryNetliquidationS"},"PortfolioSummaryNetliquidationuncertainty":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Uncertainty of Net Liquidation Value associated with after-hours price changes. (amount)","title":"PortfolioSummaryNetliquidationuncertainty"},"PortfolioSummaryNlvandmargininreview":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Indicates whether the NLV and/or margin values for the account are in review. (value)","title":"PortfolioSummaryNlvandmargininreview"},"PortfolioSummaryPasharesvalue":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Personal Account shares value for all segments of the account. (amount)","title":"PortfolioSummaryPasharesvalue"},"PortfolioSummaryPasharesvalueC":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Personal Account shares value for the commodities segment of the account. (amount)","title":"PortfolioSummaryPasharesvalueC"},"PortfolioSummaryPasharesvalueS":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Personal Account shares value for the securities segment of the account. (amount)","title":"PortfolioSummaryPasharesvalueS"},"PortfolioSummaryPhysicalcertificatevalue":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Physical Certificate value for all segments of the account. (amount)","title":"PortfolioSummaryPhysicalcertificatevalue"},"PortfolioSummaryPhysicalcertificatevalueC":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Physical Certificate value for the commodities segment of the account. (amount)","title":"PortfolioSummaryPhysicalcertificatevalueC"},"PortfolioSummaryPhysicalcertificatevalueS":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Physical Certificate value for the securities segment of the account. (amount)","title":"PortfolioSummaryPhysicalcertificatevalueS"},"PortfolioSummaryPostexpirationexcess":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Projected at-expiration Excess Liquidity for all segments of the account. (amount)","title":"PortfolioSummaryPostexpirationexcess"},"PortfolioSummaryPostexpirationexcessC":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Projected at-expiration Excess Liquidity for the commodities segment of the account. (amount)","title":"PortfolioSummaryPostexpirationexcessC"},"PortfolioSummaryPostexpirationexcessS":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Projected at-expiration Excess Liquidity for the securities segment of the account. (amount)","title":"PortfolioSummaryPostexpirationexcessS"},"PortfolioSummaryPostexpirationmargin":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Projected at-expiration margin requirement for all segments of the account. (amount)","title":"PortfolioSummaryPostexpirationmargin"},"PortfolioSummaryPostexpirationmarginC":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Projected at-expiration margin requirement for the commodities segment of the account. (amount)","title":"PortfolioSummaryPostexpirationmarginC"},"PortfolioSummaryPostexpirationmarginS":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Projected at-expiration margin requirement for the securities segment of the account. (amount)","title":"PortfolioSummaryPostexpirationmarginS"},"PortfolioSummaryPreviousdayequitywithloanvalue":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Previous day's Equity with Loan Value (as of 16:00 US Eastern) for all segments of the account. (amount)","title":"PortfolioSummaryPreviousdayequitywithloanvalue"},"PortfolioSummaryPreviousdayequitywithloanvalueS":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Previous day's Equity with Loan Value (as of 16:00 US Eastern) for the securities segment of the account. (amount)","title":"PortfolioSummaryPreviousdayequitywithloanvalueS"},"PortfolioSummaryRegtequity":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Value of equity computed under Reg-T rules for all segments of the account. (amount)","title":"PortfolioSummaryRegtequity"},"PortfolioSummaryRegtequityS":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Value of equity computed under Reg-T rules for the securities segment of the account. (amount)","title":"PortfolioSummaryRegtequityS"},"PortfolioSummaryRegtmargin":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Margin computed under Reg-T rules for all segments of the account. (amount)","title":"PortfolioSummaryRegtmargin"},"PortfolioSummaryRegtmarginS":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Margin computed under Reg-T rules for the securities segment of the account. (amount)","title":"PortfolioSummaryRegtmarginS"},"PortfolioSummarySegmenttitleC":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Human-readable title of the commodities account segment to which the '-c' postfix character refers. (value)","title":"PortfolioSummarySegmenttitleC"},"PortfolioSummarySegmenttitleS":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Human-readable title of the securities account segment to which the '-s' postfix character refers. (value)","title":"PortfolioSummarySegmenttitleS"},"PortfolioSummarySma":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Value of the Reg-T Special Memoradum Account for all account segments, reflecting credit extended when the market value of the account's positions increases. (amount)","title":"PortfolioSummarySma"},"PortfolioSummarySmaS":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Value of the Reg-T Special Memoradum Account for the securities account segment, reflecting credit extended when the market value of the account's positions increases. (amount)","title":"PortfolioSummarySmaS"},"PortfolioSummaryTotalcashvalue":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Total cash value for all segments of the account (cash balance plus Futures PnL). (amount)","title":"PortfolioSummaryTotalcashvalue"},"PortfolioSummaryTotalcashvalueC":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Cash value of Futures PnL for the commodities account segment. (amount)","title":"PortfolioSummaryTotalcashvalueC"},"PortfolioSummaryTotalcashvalueS":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Cash balance in the securities account segment. (amount)","title":"PortfolioSummaryTotalcashvalueS"},"PortfolioSummaryTotaldebitcardpendingcharges":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Total pending debit card charges for all segments of the account. (amount)","title":"PortfolioSummaryTotaldebitcardpendingcharges"},"PortfolioSummaryTotaldebitcardpendingchargesC":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Total pending debit card charges for the commodities segment of the account. (amount)","title":"PortfolioSummaryTotaldebitcardpendingchargesC"},"PortfolioSummaryTotaldebitcardpendingchargesS":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Total pending debit card charges for the securities segment of the account. (amount)","title":"PortfolioSummaryTotaldebitcardpendingchargesS"},"PortfolioSummaryTradingtypeS":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Identifier used internally to reflect the trading capabilities of the account, with respect to asset classes. (value)","title":"PortfolioSummaryTradingtypeS"},"PortfolioSummaryWhatifpmenabled":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Numerical data for the associated key."},"currency":{"type":"number","format":"double","description":"The currency in which the value of the 'amount' field is denominated."},"isNull":{"type":"boolean","description":"Indicates whether the associated key's value does not exist, as opposed to a value of zero."},"severity":{"type":"integer","format":"int64","description":"severity"},"timestamp":{"type":"integer","format":"int64","description":"Unix epoch timestamp of returned data in milliseconds."},"value":{"type":"string","description":"String and boolean (non-numerical) data for the associated key."}},"description":"Indicates whether 'whatif' order preview functionality is enabled for a Portfolio-Margined account. (value)","title":"PortfolioSummaryWhatifpmenabled"},"portfolioSummary":{"type":"object","properties":{"accountcode":{"$ref":"#/components/schemas/PortfolioSummaryAccountcode","description":"The Account ID of the requested account. (value)"},"accountready":{"$ref":"#/components/schemas/PortfolioSummaryAccountready","description":"Indicates whether the account is fully open and tradable. (value)"},"accounttype":{"$ref":"#/components/schemas/PortfolioSummaryAccounttype","description":"Identifies the type of client with which the account is associated, such as an individual or LLC. (value)"},"accruedcash":{"$ref":"#/components/schemas/PortfolioSummaryAccruedcash","description":"Amount of cash accrued (not yet disbursed) for all segments in the account. (amount)"},"accruedcash-c":{"$ref":"#/components/schemas/PortfolioSummaryAccruedcashC","description":"Amount of cash accrued (not yet disbursed) for the commodities segment in the account. (amount)"},"accruedcash-s":{"$ref":"#/components/schemas/PortfolioSummaryAccruedcashS","description":"Amount of cash accrued (not yet disbursed) for the securities segment in the account. (amount)"},"accrueddividend":{"$ref":"#/components/schemas/PortfolioSummaryAccrueddividend","description":"Amount of dividends accrued (not yet disbursed) for all segments in the account. (amount)"},"accrueddividend-c":{"$ref":"#/components/schemas/PortfolioSummaryAccrueddividendC","description":"Amount of dividends accrued (not yet disbursed) for the commodities segment in the account. (amount)"},"accrueddividend-s":{"$ref":"#/components/schemas/PortfolioSummaryAccrueddividendS","description":"Amount of dividends accrued (not yet disbursed) for the securities segment in the account. (amount)"},"availablefunds":{"$ref":"#/components/schemas/PortfolioSummaryAvailablefunds","description":"Available funds (ELV minus Initial Margin) for all segments in the account. (amount)"},"availablefunds-c":{"$ref":"#/components/schemas/PortfolioSummaryAvailablefundsC","description":"Available funds (ELV minus Initial Margin) for the commodities segment in the account. (amount)"},"availablefunds-s":{"$ref":"#/components/schemas/PortfolioSummaryAvailablefundsS","description":"Available funds (ELV minus Initial Margin) for the securities segment in the account. (amount)"},"availabletotrade":{"$ref":"#/components/schemas/PortfolioSummaryAvailabletotrade","description":"Funds available for trading (ELV minus Initial Margin) for all segments in the account. (amount)"},"availabletotrade-c":{"$ref":"#/components/schemas/PortfolioSummaryAvailabletotradeC","description":"Funds available for trading (ELV minus Initial Margin) for the commodities segment in the account. (amount)"},"availabletotrade-s":{"$ref":"#/components/schemas/PortfolioSummaryAvailabletotradeS","description":"Funds available for trading (ELV minus Initial Margin) for the securities segment in the account. (amount)"},"availabletowithdraw":{"$ref":"#/components/schemas/PortfolioSummaryAvailabletowithdraw","description":"Funds available for withdrawal for all segments in the account. (amount)"},"availabletowithdraw-c":{"$ref":"#/components/schemas/PortfolioSummaryAvailabletowithdrawC","description":"Funds available for withdrawal for the commodities segment in the account. (amount)"},"availabletowithdraw-s":{"$ref":"#/components/schemas/PortfolioSummaryAvailabletowithdrawS","description":"Funds available for withdrawal for the securities segment in the account. (amount)"},"billable":{"$ref":"#/components/schemas/PortfolioSummaryBillable","description":"Billable commissions for all segments in the account. (amount)"},"billable-c":{"$ref":"#/components/schemas/PortfolioSummaryBillableC","description":"Billable commissions for the commodities segment in the account. (amount)"},"billable-s":{"$ref":"#/components/schemas/PortfolioSummaryBillableS","description":"Billable commissions for the securities segment in the account. (amount)"},"buyingpower":{"$ref":"#/components/schemas/PortfolioSummaryBuyingpower","description":"Buying power (maximum value of securities that can be bought without adding funds) for the account. (amount)"},"columnprio-c":{"$ref":"#/components/schemas/PortfolioSummaryColumnprioC","description":"columnprio-c"},"columnprio-s":{"$ref":"#/components/schemas/PortfolioSummaryColumnprioS","description":"columnprio-s"},"cushion":{"$ref":"#/components/schemas/PortfolioSummaryCushion","description":"Margin cushion as a decimal ratio, (ELV-Maintenance)/ELV. (value)"},"daytradesremaining":{"$ref":"#/components/schemas/PortfolioSummaryDaytradesremaining","description":"Number of day trades currently still available for 4-day pattern day trader period. (value)"},"daytradesremainingt+1":{"$ref":"#/components/schemas/PortfolioSummaryDaytradesremainingt1","description":"Number of day trades available tomorrow for 4-day pattern day trader period. (value)"},"daytradesremainingt+2":{"$ref":"#/components/schemas/PortfolioSummaryDaytradesremainingt2","description":"Number of day trades available in two days for 4-day pattern day trader period. (value)"},"daytradesremainingt+3":{"$ref":"#/components/schemas/PortfolioSummaryDaytradesremainingt3","description":"Number of day trades available in three days for 4-day pattern day trader period. (value)"},"daytradesremainingt+4":{"$ref":"#/components/schemas/PortfolioSummaryDaytradesremainingt4","description":"Number of day trades available in four days for 4-day pattern day trader period. (value)"},"daytradingstatus-s":{"$ref":"#/components/schemas/PortfolioSummaryDaytradingstatusS","description":"daytradingstatus-s"},"depositoncredithold":{"$ref":"#/components/schemas/PortfolioSummaryDepositoncredithold","description":"Indicates whether a deposit is on credit hold. (value)"},"equitywithloanvalue":{"$ref":"#/components/schemas/PortfolioSummaryEquitywithloanvalue","description":"Equity with Loan Value for all segments of the account. (amount)"},"equitywithloanvalue-c":{"$ref":"#/components/schemas/PortfolioSummaryEquitywithloanvalueC","description":"Equity with Loan Value for the commodities segment of the account. (amount)"},"equitywithloanvalue-s":{"$ref":"#/components/schemas/PortfolioSummaryEquitywithloanvalueS","description":"Equity with Loan Value for the securities segment of the account. (amount)"},"excessliquidity":{"$ref":"#/components/schemas/PortfolioSummaryExcessliquidity","description":"Excess liquidity (ELV minus Maintenance Margin) for all segments of the account. (amount)"},"excessliquidity-c":{"$ref":"#/components/schemas/PortfolioSummaryExcessliquidityC","description":"Excess liquidity (ELV minus Maintenance Margin) for the commodities segment of the account. (amount)"},"excessliquidity-s":{"$ref":"#/components/schemas/PortfolioSummaryExcessliquidityS","description":"Excess liquidity (ELV minus Maintenance Margin) for the securities segment of the account. (amount)"},"fullavailablefunds":{"$ref":"#/components/schemas/PortfolioSummaryFullavailablefunds","description":"Full available funds for all segments of the account. (amount)"},"fullavailablefunds-c":{"$ref":"#/components/schemas/PortfolioSummaryFullavailablefundsC","description":"Full available funds (NLV minus Initial Margin) for the commodities segment of the account. (amount)"},"fullavailablefunds-s":{"$ref":"#/components/schemas/PortfolioSummaryFullavailablefundsS","description":"Full available funds (ELV minus Initial Margin) for the securities segment of the account. (amount)"},"fullexcessliquidity":{"$ref":"#/components/schemas/PortfolioSummaryFullexcessliquidity","description":"Full excess liquidity (ELV minus Maintenance Margin) for all segments of the account. (amount)"},"fullexcessliquidity-c":{"$ref":"#/components/schemas/PortfolioSummaryFullexcessliquidityC","description":"Full excess liquidity (ELV minus Maintenance Margin) for the commodities segment of the account. (amount)"},"fullexcessliquidity-s":{"$ref":"#/components/schemas/PortfolioSummaryFullexcessliquidityS","description":"Full excess liquidity (ELV minus Maintenance Margin) for the securities segment of the account. (amount)"},"fullinitmarginreq":{"$ref":"#/components/schemas/PortfolioSummaryFullinitmarginreq","description":"Full Initial Margin requirement for all segments of the account. (amount)"},"fullinitmarginreq-c":{"$ref":"#/components/schemas/PortfolioSummaryFullinitmarginreqC","description":"Full Initial Margin requirement for the commodities segment of the account. (amount)"},"fullinitmarginreq-s":{"$ref":"#/components/schemas/PortfolioSummaryFullinitmarginreqS","description":"Full Initial Margin requirement for the securities segment of the account. (amount)"},"fullmaintmarginreq":{"$ref":"#/components/schemas/PortfolioSummaryFullmaintmarginreq","description":"Full Maintenance Margin requirement for all segments of the account. (amount)"},"fullmaintmarginreq-c":{"$ref":"#/components/schemas/PortfolioSummaryFullmaintmarginreqC","description":"Full Maintenance Margin requirement for the commodities segment of the account. (amount)"},"fullmaintmarginreq-s":{"$ref":"#/components/schemas/PortfolioSummaryFullmaintmarginreqS","description":"Full Maintenance Margin requirement for the securities segment of the account. (amount)"},"grosspositionvalue":{"$ref":"#/components/schemas/PortfolioSummaryGrosspositionvalue","description":"Gross Position Value (sum of Long and Short position values for stocks and options) for all segments of the account. (amount)"},"grosspositionvalue-s":{"$ref":"#/components/schemas/PortfolioSummaryGrosspositionvalueS","description":"grosspositionvalue-s"},"guarantee":{"$ref":"#/components/schemas/PortfolioSummaryGuarantee","description":"For accounts that clear away, value of Guarantee for all segments of the account. (amount)"},"guarantee-c":{"$ref":"#/components/schemas/PortfolioSummaryGuaranteeC","description":"For accounts that clear away, value of Guarantee for the commodities segment of the account. (amount)"},"guarantee-s":{"$ref":"#/components/schemas/PortfolioSummaryGuaranteeS","description":"For accounts that clear away, value of Guarantee for the securities segment of the account. (amount)"},"highestseverity":{"$ref":"#/components/schemas/PortfolioSummaryHighestseverity","description":"highestseverity"},"indianstockhaircut":{"$ref":"#/components/schemas/PortfolioSummaryIndianstockhaircut","description":"Indian Stock Haircut value for all segments of the account. (amount)"},"indianstockhaircut-c":{"$ref":"#/components/schemas/PortfolioSummaryIndianstockhaircutC","description":"Indian Stock Haircut value for the commodities segment of the account. (amount)"},"indianstockhaircut-s":{"$ref":"#/components/schemas/PortfolioSummaryIndianstockhaircutS","description":"Indian Stock Haircut value for the securities segment of the account. (amount)"},"initmarginreq":{"$ref":"#/components/schemas/PortfolioSummaryInitmarginreq","description":"Initial Margin requirement for all segments of the account. (amount)"},"initmarginreq-c":{"$ref":"#/components/schemas/PortfolioSummaryInitmarginreqC","description":"Initial Margin requirement for the commodities segment of the account. (amount)"},"initmarginreq-s":{"$ref":"#/components/schemas/PortfolioSummaryInitmarginreqS","description":"Initial Margin requirement for the securities segment of the account. (amount)"},"leverage-s":{"$ref":"#/components/schemas/PortfolioSummaryLeverageS","description":"Leverage ratio (GPV/NLV) of the securities segment of the account. (value)"},"lookaheadavailablefunds":{"$ref":"#/components/schemas/PortfolioSummaryLookaheadavailablefunds","description":"Look-ahead Available Funds for all segments of the account. (amount)"},"lookaheadavailablefunds-c":{"$ref":"#/components/schemas/PortfolioSummaryLookaheadavailablefundsC","description":"Look-ahead Available Funds for the commodities segment of the account. (amount)"},"lookaheadavailablefunds-s":{"$ref":"#/components/schemas/PortfolioSummaryLookaheadavailablefundsS","description":"Look-ahead Available Funds for the securities segment of the account. (amount)"},"lookaheadexcessliquidity":{"$ref":"#/components/schemas/PortfolioSummaryLookaheadexcessliquidity","description":"Look-ahead Excess Liquidity for all segments of the account. (amount)"},"lookaheadexcessliquidity-c":{"$ref":"#/components/schemas/PortfolioSummaryLookaheadexcessliquidityC","description":"Look-ahead Excess Liquidity for the commodities segment of the account. (amount)"},"lookaheadexcessliquidity-s":{"$ref":"#/components/schemas/PortfolioSummaryLookaheadexcessliquidityS","description":"Look-ahead Excess Liquidity for the securities segment of the account. (amount)"},"lookaheadinitmarginreq":{"$ref":"#/components/schemas/PortfolioSummaryLookaheadinitmarginreq","description":"Look-ahead Intial Margin requirement (as of next margin period) for all segments of the account. (amount)"},"lookaheadinitmarginreq-c":{"$ref":"#/components/schemas/PortfolioSummaryLookaheadinitmarginreqC","description":"Look-ahead Intial Margin requirement (as of next margin period) for the commodities segment of the account. (amount)"},"lookaheadinitmarginreq-s":{"$ref":"#/components/schemas/PortfolioSummaryLookaheadinitmarginreqS","description":"Look-ahead Intial Margin requirement (as of next margin period) for the securities segment of the account. (amount)"},"lookaheadmaintmarginreq":{"$ref":"#/components/schemas/PortfolioSummaryLookaheadmaintmarginreq","description":"Look-ahead Maintenance Margin requirement (as of next margin period) for all segments of the account. (amount)"},"lookaheadmaintmarginreq-c":{"$ref":"#/components/schemas/PortfolioSummaryLookaheadmaintmarginreqC","description":"Look-ahead Maintenance Margin requirement (as of next margin period) for the commodities segment of the account. (amount)"},"lookaheadmaintmarginreq-s":{"$ref":"#/components/schemas/PortfolioSummaryLookaheadmaintmarginreqS","description":"Look-ahead Maintenance Margin requirement (as of next margin period) for the securities segment of the account. (amount)"},"lookaheadnextchange":{"$ref":"#/components/schemas/PortfolioSummaryLookaheadnextchange","description":"Unix epoch timestamp in seconds of start of next margin period. (value)"},"maintmarginreq":{"$ref":"#/components/schemas/PortfolioSummaryMaintmarginreq","description":"Maintenance Margin requirement for all segments of the account. (amount)"},"maintmarginreq-c":{"$ref":"#/components/schemas/PortfolioSummaryMaintmarginreqC","description":"Maintenance Margin requirement for the commodities segment of the account. (amount)"},"maintmarginreq-s":{"$ref":"#/components/schemas/PortfolioSummaryMaintmarginreqS","description":"Maintenance Margin requirement for the securities segment of the account. (amount)"},"netliquidation":{"$ref":"#/components/schemas/PortfolioSummaryNetliquidation","description":"Net Liquidation Value (NLV) for all segments of the account. (amount)"},"netliquidation-c":{"$ref":"#/components/schemas/PortfolioSummaryNetliquidationC","description":"Net Liquidation Value (sum of values of cash and commodities options) for the commodities segment of the account. (amount)"},"netliquidation-s":{"$ref":"#/components/schemas/PortfolioSummaryNetliquidationS","description":"Net Liquidation Value (sum of values of cash, stocks, securities options, bonds) for the securities segment of the account. (amount)"},"netliquidationuncertainty":{"$ref":"#/components/schemas/PortfolioSummaryNetliquidationuncertainty","description":"Uncertainty of Net Liquidation Value associated with after-hours price changes. (amount)"},"nlvandmargininreview":{"$ref":"#/components/schemas/PortfolioSummaryNlvandmargininreview","description":"Indicates whether the NLV and/or margin values for the account are in review. (value)"},"pasharesvalue":{"$ref":"#/components/schemas/PortfolioSummaryPasharesvalue","description":"Personal Account shares value for all segments of the account. (amount)"},"pasharesvalue-c":{"$ref":"#/components/schemas/PortfolioSummaryPasharesvalueC","description":"Personal Account shares value for the commodities segment of the account. (amount)"},"pasharesvalue-s":{"$ref":"#/components/schemas/PortfolioSummaryPasharesvalueS","description":"Personal Account shares value for the securities segment of the account. (amount)"},"physicalcertificatevalue":{"$ref":"#/components/schemas/PortfolioSummaryPhysicalcertificatevalue","description":"Physical Certificate value for all segments of the account. (amount)"},"physicalcertificatevalue-c":{"$ref":"#/components/schemas/PortfolioSummaryPhysicalcertificatevalueC","description":"Physical Certificate value for the commodities segment of the account. (amount)"},"physicalcertificatevalue-s":{"$ref":"#/components/schemas/PortfolioSummaryPhysicalcertificatevalueS","description":"Physical Certificate value for the securities segment of the account. (amount)"},"postexpirationexcess":{"$ref":"#/components/schemas/PortfolioSummaryPostexpirationexcess","description":"Projected at-expiration Excess Liquidity for all segments of the account. (amount)"},"postexpirationexcess-c":{"$ref":"#/components/schemas/PortfolioSummaryPostexpirationexcessC","description":"Projected at-expiration Excess Liquidity for the commodities segment of the account. (amount)"},"postexpirationexcess-s":{"$ref":"#/components/schemas/PortfolioSummaryPostexpirationexcessS","description":"Projected at-expiration Excess Liquidity for the securities segment of the account. (amount)"},"postexpirationmargin":{"$ref":"#/components/schemas/PortfolioSummaryPostexpirationmargin","description":"Projected at-expiration margin requirement for all segments of the account. (amount)"},"postexpirationmargin-c":{"$ref":"#/components/schemas/PortfolioSummaryPostexpirationmarginC","description":"Projected at-expiration margin requirement for the commodities segment of the account. (amount)"},"postexpirationmargin-s":{"$ref":"#/components/schemas/PortfolioSummaryPostexpirationmarginS","description":"Projected at-expiration margin requirement for the securities segment of the account. (amount)"},"previousdayequitywithloanvalue":{"$ref":"#/components/schemas/PortfolioSummaryPreviousdayequitywithloanvalue","description":"Previous day's Equity with Loan Value (as of 16:00 US Eastern) for all segments of the account. (amount)"},"previousdayequitywithloanvalue-s":{"$ref":"#/components/schemas/PortfolioSummaryPreviousdayequitywithloanvalueS","description":"Previous day's Equity with Loan Value (as of 16:00 US Eastern) for the securities segment of the account. (amount)"},"regtequity":{"$ref":"#/components/schemas/PortfolioSummaryRegtequity","description":"Value of equity computed under Reg-T rules for all segments of the account. (amount)"},"regtequity-s":{"$ref":"#/components/schemas/PortfolioSummaryRegtequityS","description":"Value of equity computed under Reg-T rules for the securities segment of the account. (amount)"},"regtmargin":{"$ref":"#/components/schemas/PortfolioSummaryRegtmargin","description":"Margin computed under Reg-T rules for all segments of the account. (amount)"},"regtmargin-s":{"$ref":"#/components/schemas/PortfolioSummaryRegtmarginS","description":"Margin computed under Reg-T rules for the securities segment of the account. (amount)"},"segmenttitle-c":{"$ref":"#/components/schemas/PortfolioSummarySegmenttitleC","description":"Human-readable title of the commodities account segment to which the '-c' postfix character refers. (value)"},"segmenttitle-s":{"$ref":"#/components/schemas/PortfolioSummarySegmenttitleS","description":"Human-readable title of the securities account segment to which the '-s' postfix character refers. (value)"},"sma":{"$ref":"#/components/schemas/PortfolioSummarySma","description":"Value of the Reg-T Special Memoradum Account for all account segments, reflecting credit extended when the market value of the account's positions increases. (amount)"},"sma-s":{"$ref":"#/components/schemas/PortfolioSummarySmaS","description":"Value of the Reg-T Special Memoradum Account for the securities account segment, reflecting credit extended when the market value of the account's positions increases. (amount)"},"totalcashvalue":{"$ref":"#/components/schemas/PortfolioSummaryTotalcashvalue","description":"Total cash value for all segments of the account (cash balance plus Futures PnL). (amount)"},"totalcashvalue-c":{"$ref":"#/components/schemas/PortfolioSummaryTotalcashvalueC","description":"Cash value of Futures PnL for the commodities account segment. (amount)"},"totalcashvalue-s":{"$ref":"#/components/schemas/PortfolioSummaryTotalcashvalueS","description":"Cash balance in the securities account segment. (amount)"},"totaldebitcardpendingcharges":{"$ref":"#/components/schemas/PortfolioSummaryTotaldebitcardpendingcharges","description":"Total pending debit card charges for all segments of the account. (amount)"},"totaldebitcardpendingcharges-c":{"$ref":"#/components/schemas/PortfolioSummaryTotaldebitcardpendingchargesC","description":"Total pending debit card charges for the commodities segment of the account. (amount)"},"totaldebitcardpendingcharges-s":{"$ref":"#/components/schemas/PortfolioSummaryTotaldebitcardpendingchargesS","description":"Total pending debit card charges for the securities segment of the account. (amount)"},"tradingtype-s":{"$ref":"#/components/schemas/PortfolioSummaryTradingtypeS","description":"Identifier used internally to reflect the trading capabilities of the account, with respect to asset classes. (value)"},"whatifpmenabled":{"$ref":"#/components/schemas/PortfolioSummaryWhatifpmenabled","description":"Indicates whether 'whatif' order preview functionality is enabled for a Portfolio-Margined account. (value)"}},"title":"portfolioSummary"},"IndividualPositionDisplayRuleDisplayRuleStepItems":{"type":"object","properties":{"decimalDigits":{"type":"integer","format":"int64","description":"Number of decimal digits to display."},"lowerEdge":{"type":"number","format":"double","description":"Lower edge from which the display rule is effective."},"wholeDigits":{"type":"integer","format":"int64","description":"Number of integer digits to display."}},"description":"A single display rule increment.","title":"IndividualPositionDisplayRuleDisplayRuleStepItems"},"IndividualPositionDisplayRule":{"type":"object","properties":{"displayRuleStep":{"type":"array","items":{"$ref":"#/components/schemas/IndividualPositionDisplayRuleDisplayRuleStepItems"},"description":"Array containing objects corresponding to display rule increments."},"magnification":{"type":"integer","format":"int64","description":"Magnifier applied to pricing, if applicable."}},"description":"Object defining minimum increments used in displaying market data for the instrument.","title":"IndividualPositionDisplayRule"},"IndividualPositionExchs":{"type":"object","properties":{},"title":"IndividualPositionExchs"},"IndividualPositionIncrementRulesItems":{"type":"object","properties":{"increment":{"type":"number","format":"double","description":"The pricing increment."},"lowerEdge":{"type":"number","format":"double","description":"Lower edge from which the price increment rule is effective."}},"description":"Objects describing a single increment rule.","title":"IndividualPositionIncrementRulesItems"},"IndividualPositionPutOrCall":{"type":"string","enum":["P","C"],"description":"The right of an options contract, if applicable.","title":"IndividualPositionPutOrCall"},"individualPosition":{"type":"object","properties":{"acctId":{"type":"string","description":"IB accountId of an account with a position in the requested conid."},"allExchanges":{"type":"string","description":"Comma separated all exchanges on which the instrument trades."},"assetClass":{"type":"string","description":"Asset class of the requested instrument."},"avgCost":{"type":"number","format":"double","description":"The account's average cost for its position."},"avgPrice":{"type":"number","format":"double","description":"The account's average price for its position."},"baseAvgCost":{"type":"number","format":"double","description":"Average cost in the account's base currency."},"baseAvgPrice":{"type":"number","format":"double","description":"Average price in the account's base currency."},"baseMktPrice":{"type":"number","format":"double","description":"Market price of instrument in the account's base currency."},"baseMktValue":{"type":"number","format":"double","description":"Market value of the position in the account's base currency."},"baseRealizedPnl":{"type":"number","format":"double","description":"Realized PnL for the instrument in the account's base currency."},"baseUnrealizedPnl":{"type":"number","format":"double","description":"Unrealized PnL for the instrument in the account's base currency."},"chineseName":{"type":"string","description":"Chinese name of the instrument."},"conExchMap":{"type":"array","items":{"description":"Any type"}},"conid":{"type":"integer","format":"int64","description":"IB contract ID for the instrument."},"contractDesc":{"type":"string","description":"Human-readable description of the instrument."},"countryCode":{"type":"string","description":"Country in which the instrument is issued."},"currency":{"type":"string","description":"Currency in which the instrument trades."},"displayRule":{"$ref":"#/components/schemas/IndividualPositionDisplayRule","description":"Object defining minimum increments used in displaying market data for the instrument."},"exchs":{"oneOf":[{"$ref":"#/components/schemas/IndividualPositionExchs"},{"type":"null"}]},"exerciseStyle":{"type":["string","null"],"description":"Style of exercise for options."},"expiry":{"type":["string","null"],"description":"Expiration of instrument, if applicable."},"fullName":{"type":"string","description":"Full display name of the instrument."},"group":{"type":"string","description":"Industry sub-categorization of the instrument."},"hasOptions":{"type":"boolean","description":"Indicates whether instrument has options contracts available for trading at IB."},"incrementRules":{"type":"array","items":{"$ref":"#/components/schemas/IndividualPositionIncrementRulesItems"},"description":"Array containing increment rules used when pricing orders for the instrument."},"isEventContract":{"type":"boolean","description":"Indicates whether the instrument is an Event Contract."},"isUS":{"type":"boolean","description":"Indicates whether the instrument is issued in the US."},"lastTradingDay":{"type":"string","description":"Last day of trading in the instrument, if applicable. Formatted `YYYYMMDD`."},"listingExchange":{"type":"string","description":"The exchange on which the instrument is listed, or the primary exchange recognized by IB for the instrument."},"mktPrice":{"type":"number","format":"double","description":"Current market price of the instrument, in the instrument's currency."},"mktValue":{"type":"number","format":"double","description":"Current market value of the account's position in the instrument, in the instrument's currency."},"model":{"type":"string","description":"Name of the model portfolio in which the account is invested that contributes this position."},"multiplier":{"type":"number","format":"double","description":"Instrument's multiplier, if applicable."},"name":{"type":"string","description":"Formal name of the entity or asset to which the instrument relates."},"pageSize":{"type":"integer","format":"int64","description":"Maximum number of accounts that can be returned in a single request."},"position":{"type":"number","format":"double","description":"Size of position in units of instrument."},"putOrCall":{"$ref":"#/components/schemas/IndividualPositionPutOrCall","description":"The right of an options contract, if applicable."},"realizedPnl":{"type":"number","format":"double","description":"Realized PnL for the instrument in the instrument's currency."},"sector":{"type":"string","description":"Industry sector categorization of the instrument."},"sectorGroup":{"type":"string","description":"Industry sub-categorization of the instrument."},"strike":{"type":"string","description":"Strike price, if applicable. Returned as string."},"ticker":{"type":"string","description":"Symbol associated with the instrument."},"time":{"type":"integer","format":"int64","description":"Time taken to retrieve position data in milliseconds."},"type":{"type":"string","description":"Description of instrument, used to differentiate classes, if applicable."},"undConid":{"type":"integer","format":"int64","description":"Contract ID of underlying instrument, if applicable."},"unrealizedPnl":{"type":"number","format":"double","description":"Unrealized PnL for the instrument in the account."}},"description":"A specific account's position in the requested conid.","title":"individualPosition"},"individualPositionArray":{"type":"array","items":{"$ref":"#/components/schemas/individualPosition"},"title":"individualPositionArray"},"V1ApiPortfolio2AccountIdPositionsGetParametersDirection":{"type":"string","enum":["a","d"],"default":"a","description":"The chronologic order of orders to sort by.\n  * `a` - Display in ascending order.\n  * `d` - Display in descending order.\n","title":"V1ApiPortfolio2AccountIdPositionsGetParametersDirection"},"Portfolio2PositionsItems":{"type":"object","properties":{"assetClass":{"type":"string","description":"Asset class of the requested instrument."},"avgCost":{"description":"The account's average cost for its position."},"avgPrice":{"type":"number","format":"double","description":"The account's average price for its position."},"conid":{"type":"integer","format":"int64","description":"IB contract ID for the instrument."},"currency":{"type":"string","description":"Currency in which the instrument trades."},"description":{"type":"string","description":"Contract's local symbol"},"group":{"type":"string","description":"Industry sub-categorization of the instrument."},"isLastToLoq":{"type":"boolean"},"marketPrice":{"type":"number","format":"double","description":"Current market price of the instrument, in the instrument's currency."},"marketValue":{"type":"number","format":"double","description":"Current market value of the account's position in the instrument, in the instrument's currency."},"model":{"type":"string","description":"Name of the model portfolio in which the account is invested that contributes this position."},"position":{"type":"number","format":"double","description":"Size of position in units of instrument."},"realizedPnl":{"type":"number","format":"double","description":"Realized PnL for the instrument in the instrument's currency."},"secType":{"type":"string","description":"The security type of the instrument."},"sector":{"type":"string","description":"Industry sector categorization of the instrument."},"timestamp":{"type":"integer","format":"int64","description":"Time taken to retrieve position data in milliseconds."},"unrealizedPnl":{"type":"number","format":"double","description":"Unrealized PnL for the instrument in the account."}},"title":"Portfolio2PositionsItems"},"portfolio2Positions":{"type":"array","items":{"$ref":"#/components/schemas/Portfolio2PositionsItems"},"description":"Array of position objects, each defining a position held in the account.","title":"portfolio2Positions"},"ComboPositionResponseItemsLegsItems":{"type":"object","properties":{"conid":{"type":"string","description":"Contract identifier of the given leg."},"ratio":{"type":"integer","format":"int64","description":"Ratio of the leg compared to the quantity."}},"title":"ComboPositionResponseItemsLegsItems"},"IndividualComboPositionExchs":{"type":"object","properties":{},"title":"IndividualComboPositionExchs"},"IndividualComboPositionPutOrCall":{"type":"string","enum":["P","C","None"],"description":"The right of an options contract, if applicable.","title":"IndividualComboPositionPutOrCall"},"individualComboPosition":{"type":"object","properties":{"acctId":{"type":"string","description":"IB accountId of an account with a position in the requested conid."},"assetClass":{"type":"string","description":"Asset class of the requested instrument."},"avgCost":{"type":"number","format":"double","description":"The account's average cost for its position."},"avgPrice":{"type":"number","format":"double","description":"The account's average price for its position."},"conExchMap":{"type":"array","items":{"description":"Any type"}},"conid":{"type":"integer","format":"int64","description":"IB contract ID for the instrument."},"contractDesc":{"type":"string","description":"Human-readable description of the instrument."},"currency":{"type":"string","description":"Currency in which the instrument trades."},"exchs":{"oneOf":[{"$ref":"#/components/schemas/IndividualComboPositionExchs"},{"type":"null"}]},"exerciseStyle":{"type":["string","null"],"description":"Style of exercise for options."},"expiry":{"type":"string","description":"Expiration of instrument, if applicable."},"mktPrice":{"type":"number","format":"double","description":"Current market price of the instrument, in the instrument's currency."},"mktValue":{"type":"number","format":"double","description":"Current market value of the account's position in the instrument, in the instrument's currency."},"multiplier":{"type":"number","format":"double","description":"Instrument's multiplier, if applicable."},"position":{"type":"number","format":"double","description":"Size of position in units of instrument."},"putOrCall":{"$ref":"#/components/schemas/IndividualComboPositionPutOrCall","description":"The right of an options contract, if applicable."},"realizedPnl":{"type":"number","format":"double","description":"Realized PnL for the instrument in the instrument's currency."},"strike":{"type":"string","description":"Strike price, if applicable. Returned as string."},"undConid":{"type":"integer","format":"int64","description":"Contract ID of underlying instrument, if applicable."},"unrealizedPnl":{"type":"number","format":"double","description":"Unrealized PnL for the instrument in the account."}},"title":"individualComboPosition"},"ComboPositionResponseItems":{"type":"object","properties":{"description":{"type":"string","description":"The ratio and conids included in the position."},"legs":{"type":"array","items":{"$ref":"#/components/schemas/ComboPositionResponseItemsLegsItems"},"description":"List of the legs that make up a position."},"name":{"type":"string","description":"Internal identifier of a combination position."},"positions":{"type":"array","items":{"$ref":"#/components/schemas/individualComboPosition"},"description":"List of the positions that make up a combination."}},"title":"ComboPositionResponseItems"},"comboPositionResponse":{"type":"array","items":{"$ref":"#/components/schemas/ComboPositionResponseItems"},"description":"Array of objects each containing a single combo position.","title":"comboPositionResponse"},"Subaccounts2ResponseMetadata":{"type":"object","properties":{"pageNum":{"type":"integer","format":"int64","description":"The active page number."},"pageSize":{"type":"integer","format":"int64","description":"Items contained in the returning page."},"total":{"type":"integer","format":"int64","description":"The total number of accounts returned for the page."}},"description":"Metadata container describing the subaccounts.","title":"Subaccounts2ResponseMetadata"},"subaccounts2Response":{"type":"object","properties":{"metadata":{"$ref":"#/components/schemas/Subaccounts2ResponseMetadata","description":"Metadata container describing the subaccounts."},"subaccounts":{"type":"array","items":{"$ref":"#/components/schemas/accountAttributes"},"description":"List containing all subaccounts of the account structure."}},"title":"subaccounts2Response"},"Trading Portfolio_invalidatePositionCache_Response_200":{"type":"object","properties":{"message":{"type":"string","description":"Indicates success or failure of request to discard cached positions."}},"title":"Trading Portfolio_invalidatePositionCache_Response_200"},"V1ApiPaPerformancePostRequestBodyContentApplicationJsonSchemaPeriod":{"type":"string","enum":["1D","7D","MTD","1M","3M","6M","12M","YTD"],"default":"12M","description":"Specify the period for which the account should be analyzed. Available period lengths:\n  * `1D` - The last 24 hours.\n  * `7D` - The last 7 full days.\n  * `MTD` - Performance since the 1st of the month.\n  * `1M` - A full calendar month from the last full trade day.\n  * `3M` - 3 full calendar months from the last full trade day.\n  * `6M` - 6 full calendar months from the last full trade day.\n  * `12M` - 12 full calendar month from the last full trade day.\n  * `YTD` - Performance since January 1st.\n","title":"V1ApiPaPerformancePostRequestBodyContentApplicationJsonSchemaPeriod"},"PerformanceResponseNavDataItemsStartNav":{"type":"object","properties":{"date":{"type":"string","description":"Returns the starting date for the request."},"val":{"type":"integer","format":"int64","description":"Returns the Net Asset Value of the account."}},"description":"Returns the intiial NAV available.","title":"PerformanceResponseNavDataItemsStartNav"},"PerformanceResponseNavDataItems":{"type":"object","properties":{"idType":{"type":"string","description":"Returns how identifiers are determined."},"navs":{"type":"array","items":{"description":"Any type"},"description":"Returns sequential data points corresponding to the net asset value between the \"start\" and \"end\" days."},"start":{"type":"string","description":"Returns the first available date for data."},"end":{"type":"string","description":"Returns the end of the available frequency."},"id":{"type":"string","description":"Returns the account identifier."},"startNAV":{"$ref":"#/components/schemas/PerformanceResponseNavDataItemsStartNav","description":"Returns the intiial NAV available."},"baseCurrency":{"type":"string","description":"Returns the base currency used in the account."}},"title":"PerformanceResponseNavDataItems"},"PerformanceResponseNav":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PerformanceResponseNavDataItems"},"description":"Contains the affiliated 'nav' data."},"freq":{"type":"string","description":"Displays the values corresponding to a given frequency."},"dates":{"type":"array","items":{"description":"Any type"},"description":"Returns the array of dates formatted as strings corresponding to your frequency, the length should be same as the length of returns inside data."}},"description":"Net asset value data for the account or consolidated accounts. NAV data is not applicable to benchmarks.","title":"PerformanceResponseNav"},"PerformanceResponseCpsDataItems":{"type":"object","properties":{"idType":{"type":"string","description":"Returns the key value of the request."},"start":{"type":"string","description":"Returns the starting value of the value range."},"end":{"type":"string","description":"Returns the ending value of the value range."},"returns":{"type":"array","items":{"description":"Any type"},"description":"Returns all cps values in order between the start and end times."},"id":{"type":"string","description":"Returns the account identifier."},"baseCurrency":{"type":"string","description":"Returns the base curency for the account."}},"title":"PerformanceResponseCpsDataItems"},"PerformanceResponseCps":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PerformanceResponseCpsDataItems"},"description":"Returns the array of cps data available."},"freq":{"type":"string","description":"Returns the determining frequency of the data range."},"dates":{"type":"array","items":{"description":"Any type"},"description":"Returns the dates corresponding to the frequency of data."}},"description":"Returns the object containing the Cumulative performance data.","title":"PerformanceResponseCps"},"PerformanceResponseTppsDataItems":{"type":"object","properties":{"idType":{"type":"string","description":"Returns the key value of the request."},"start":{"type":"string","description":"Returns the starting value of the value range."},"end":{"type":"string","description":"Returns the ending value of the value range."},"returns":{"type":"array","items":{"description":"Any type"},"description":"Returns all cps values in order between the start and end times."},"id":{"type":"string","description":"Returns the account identifier."},"baseCurrency":{"type":"string","description":"Returns the base curency for the account."}},"title":"PerformanceResponseTppsDataItems"},"PerformanceResponseTpps":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PerformanceResponseTppsDataItems"},"description":"Object containing all data about tpps."},"freq":{"type":"string","description":"Returns the determining frequency of the data range."},"dates":{"type":"array","items":{"description":"Any type"},"description":"Returns the dates corresponding to the frequency of data."}},"description":"Returns the time period performance data.","title":"PerformanceResponseTpps"},"performanceResponse":{"type":"object","properties":{"currencyType":{"type":"string","description":"Confirms if the currency type. If trading exclusively in your base currency, \"base\" will be returned."},"rc":{"type":"integer","format":"int64","description":"Returns the data identifier (Internal Use Only)."},"nav":{"$ref":"#/components/schemas/PerformanceResponseNav","description":"Net asset value data for the account or consolidated accounts. NAV data is not applicable to benchmarks."},"nd":{"type":"integer","format":"int64","description":"Returns the total data points."},"cps":{"$ref":"#/components/schemas/PerformanceResponseCps","description":"Returns the object containing the Cumulative performance data."},"tpps":{"$ref":"#/components/schemas/PerformanceResponseTpps","description":"Returns the time period performance data."},"id":{"type":"string","description":"Returns the request identifier, getPerformanceData."},"included":{"type":"array","items":{"description":"Any type"},"description":"Returns an array containing accounts reviewed."},"pm":{"type":"string","description":"Portfolio Measure. Used to indicate TWR or MWR values returned."}},"title":"performanceResponse"},"detailedContractInformation":{"type":"object","properties":{"currencyType":{"type":"string","description":"Confirms if the currency type. If trading exclusively in your base currency, \"base\" will be returned."},"rc":{"type":"integer","format":"int64","description":"Returns the data identifier (Internal Use Only)."},"view":{"type":"array","items":{"type":"string"},"description":"Returns the accountIds being viewed and returned."},"nd":{"type":"integer","format":"int64","description":"Returns the total data points."},"id":{"type":"string","description":"Returns the request identifier, getPerformanceAllPeriods."},"included":{"type":"array","items":{"type":"string"},"description":"Returns an array containing accounts reviewed."},"pm":{"type":"string","description":"Portfolio Measure. Used to indicate TWR or MWR values returned."}},"title":"detailedContractInformation"},"V1ApiPaAllocationPostRequestBodyContentApplicationJsonSchemaType":{"type":"string","enum":["FINANCIAL_INSTRUMENT","ASSET_CLASS","SECTOR","REGION","COUNTRY","ALL"],"description":"The allocation category type. One of FINANCIAL_INSTRUMENT, ASSET_CLASS, SECTOR, REGION, COUNTRY, or ALL. Case insensitive. When ALL is specified, the response includes allocations for every category type.\n","title":"V1ApiPaAllocationPostRequestBodyContentApplicationJsonSchemaType"},"AllocationResponseAllocationsLongTotal":{"type":"object","properties":{"nav":{"type":"number","format":"double","description":"Total NAV for long positions."},"weight":{"type":"number","format":"double","description":"Total weight for long positions. Multiply by 100 to get as percentage."}},"title":"AllocationResponseAllocationsLongTotal"},"AllocationResponseAllocationsLongItemsItems":{"type":"object","properties":{"id":{"type":"string","description":"Identifier for the category."},"name":{"type":"string","description":"English display name of the category."},"nav":{"type":"number","format":"double","description":"Amount held in this category. Precision 8."},"weight":{"type":"number","format":"double","description":"Proportion of the long portfolio held in this category. Multiply by 100 to get as percentage."},"color":{"type":"string","description":"RGB color code in hex format."}},"title":"AllocationResponseAllocationsLongItemsItems"},"AllocationResponseAllocationsLong":{"type":"object","properties":{"total":{"$ref":"#/components/schemas/AllocationResponseAllocationsLongTotal"},"items":{"type":"array","items":{"$ref":"#/components/schemas/AllocationResponseAllocationsLongItemsItems"},"description":"Long allocation entries."}},"description":"Long positions allocation breakdown.","title":"AllocationResponseAllocationsLong"},"AllocationResponseAllocationsShortTotal":{"type":"object","properties":{"nav":{"type":"number","format":"double","description":"Total NAV for short positions."},"weight":{"type":"number","format":"double","description":"Total weight for short positions. Multiply by 100 to get as percentage."}},"title":"AllocationResponseAllocationsShortTotal"},"AllocationResponseAllocationsShortItemsItems":{"type":"object","properties":{"id":{"type":"string","description":"Identifier for the category."},"name":{"type":"string","description":"English display name of the category."},"nav":{"type":"number","format":"double","description":"Amount held in this category. Precision 8."},"weight":{"type":"number","format":"double","description":"Proportion of the short portfolio held in this category. Multiply by 100 to get as percentage."},"color":{"type":"string","description":"RGB color code in hex format."}},"title":"AllocationResponseAllocationsShortItemsItems"},"AllocationResponseAllocationsShort":{"type":"object","properties":{"total":{"$ref":"#/components/schemas/AllocationResponseAllocationsShortTotal"},"items":{"type":"array","items":{"$ref":"#/components/schemas/AllocationResponseAllocationsShortItemsItems"},"description":"Short allocation entries."}},"description":"Short positions allocation breakdown.","title":"AllocationResponseAllocationsShort"},"AllocationResponseAllocations":{"type":"object","properties":{"long":{"$ref":"#/components/schemas/AllocationResponseAllocationsLong","description":"Long positions allocation breakdown."},"short":{"$ref":"#/components/schemas/AllocationResponseAllocationsShort","description":"Short positions allocation breakdown."}},"title":"AllocationResponseAllocations"},"allocationResponse":{"type":"object","properties":{"id":{"type":"string","description":"Response identifier."},"currency":{"type":"string","description":"Three character currency code. Currency of NAV values, as specified in the request."},"realtime":{"type":"boolean","description":"true indicates the response is for current day data."},"date":{"type":"string","description":"The as-of date for the NAV and allocations. Formatted as yyyymmdd."},"allocations":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AllocationResponseAllocations"},"description":"Object keyed by allocation type (FINANCIAL_INSTRUMENT, ASSET_CLASS, SECTOR, REGION, or COUNTRY). When type=ALL is requested, multiple keys may be present.\n"},"excluded":{"type":"array","items":{"type":"string"},"description":"Requested accounts that were not included in the result due to an error."},"warning":{"type":"string","description":"Warning message, if any."}},"title":"allocationResponse"},"TransactionsResponseRpnlItemsSide":{"type":"string","enum":["L","G"],"description":"Determines if the day was a loss or gain * `L` - LOSS * `G` - GAIN\n","title":"TransactionsResponseRpnlItemsSide"},"TransactionsResponseRpnlItems":{"type":"object","properties":{"date":{"type":"string","description":"Specifies the date for the transaction."},"cur":{"type":"string","description":"Specifies the currency of the realized value."},"fxRate":{"type":"integer","format":"int64","description":"Returns the foreign exchnage rate."},"side":{"$ref":"#/components/schemas/TransactionsResponseRpnlItemsSide","description":"Determines if the day was a loss or gain * `L` - LOSS * `G` - GAIN\n"},"acctid":{"type":"string","description":"Returns the account ID the trade transacted on."},"amt":{"type":"string","description":"Returns the amount gained or lost on the day."},"conid":{"type":"string","description":"Returns the contract ID of the transaction."}},"title":"TransactionsResponseRpnlItems"},"TransactionsResponseRpnl":{"type":"object","properties":{"data":{"type":"array","items":{"description":"Any type"},"description":"Returns an array of realized pnl objects."},"items":{"$ref":"#/components/schemas/TransactionsResponseRpnlItems"},"amt":{"type":"string","description":"Provides the total amount gained or lost from all days returned"}},"description":"Returns the object containing the realized pnl for the contract on the date.","title":"TransactionsResponseRpnl"},"TransactionsResponseTransactionsItems":{"type":"object","properties":{"date":{"type":"string","description":"Reutrns the human-readable datetime of the transaction."},"cur":{"type":"string","description":"Returns the currency of the traded insturment."},"fxRate":{"type":"integer","format":"int64","description":"Returns the forex conversion rate."},"pr":{"type":"integer","format":"int64","description":"Returns the price per share of the transaction."},"qty":{"type":"integer","format":"int64","description":"Returns the total quantity traded. Will display a negative value for sell orders, and a positive value for buy orders.\n"},"acctid":{"type":"string","description":"Returns the account which made the transaction."},"amt":{"type":"integer","format":"int64","description":"Returns the total value of the trade."},"conid":{"type":"integer","format":"int64","description":"Returns the contract identifier."},"type":{"type":"string","description":"Returns the order side."},"desc":{"type":"string","description":"Returns the long name for the company."}},"title":"TransactionsResponseTransactionsItems"},"transactionsResponse":{"type":"object","properties":{"rc":{"type":"integer","format":"int64","description":"Client portal use only"},"nd":{"type":"integer","format":"int64","description":"Client portal use only"},"rpnl":{"$ref":"#/components/schemas/TransactionsResponseRpnl","description":"Returns the object containing the realized pnl for the contract on the date."},"currency":{"type":"string","description":"Returns the currency the account is traded in."},"from":{"type":"integer","format":"int64","description":"Returns the epoch time for the start of requests."},"id":{"type":"string","description":"Returns the request identifier, getTransactions."},"to":{"type":"integer","format":"int64","description":"Returns the epoch time for the end of requests."},"includesRealTime":{"type":"boolean","description":"Returns if the trades are up to date or not."},"transactions":{"type":"array","items":{"$ref":"#/components/schemas/TransactionsResponseTransactionsItems"},"description":"Lists all supported transaction values."}},"title":"transactionsResponse"},"IserverScannerParamsScanTypeListItems":{"type":"object","properties":{"display_name":{"type":"string","description":"Human readable name for the scanner \"type\""},"code":{"type":"string","description":"Value used for the market scanner request."},"instruments":{"type":"array","items":{"description":"Any type"},"description":"Returns all instruments the scanner type can be used with."}},"title":"IserverScannerParamsScanTypeListItems"},"IserverScannerParamsInstrumentListItems":{"type":"object","properties":{"display_name":{"type":"string","description":"Human readable representation of the instrument type."},"type":{"type":"string","description":"Value used for the market scanner request."},"filters":{"type":"array","items":{"description":"Any type"},"description":"Returns an array of all filters uniquely avaliable to that instrument type."}},"title":"IserverScannerParamsInstrumentListItems"},"IserverScannerParamsFilterListItemsComboValuesItemsVendor":{"type":"object","properties":{},"title":"IserverScannerParamsFilterListItemsComboValuesItemsVendor"},"IserverScannerParamsFilterListItemsComboValuesItems":{"type":"object","properties":{"default":{"type":"boolean"},"vendor":{"$ref":"#/components/schemas/IserverScannerParamsFilterListItemsComboValuesItemsVendor"}},"title":"IserverScannerParamsFilterListItemsComboValuesItems"},"IserverScannerParamsFilterListItems":{"type":"object","properties":{"group":{"type":"string","description":"Returns the group of filters the request is affiliated with."},"display_name":{"type":"string","description":"Returns the human-readable identifier for the filter."},"code":{"type":"string","description":"Value used for the market scanner request."},"type":{"type":"string","description":"Returns the type of value to be used in the request. This can indicate a range based value, or if it should be a single value."},"combo_values":{"type":"array","items":{"$ref":"#/components/schemas/IserverScannerParamsFilterListItemsComboValuesItems"},"description":"combo values when type equals to combo"}},"title":"IserverScannerParamsFilterListItems"},"IserverScannerParamsLocationTreeItemsLocationsItemsLocationsItems":{"type":"object","properties":{"display_name":{"type":"string"},"type":{"type":"string"}},"title":"IserverScannerParamsLocationTreeItemsLocationsItemsLocationsItems"},"IserverScannerParamsLocationTreeItemsLocationsItems":{"type":"object","properties":{"display_name":{"type":"string","description":"Returns the human-readable value of the market scanner's location value."},"type":{"type":"string","description":"Returns the code value of the market scanner location value."},"locations":{"type":"array","items":{"$ref":"#/components/schemas/IserverScannerParamsLocationTreeItemsLocationsItemsLocationsItems"}}},"title":"IserverScannerParamsLocationTreeItemsLocationsItems"},"IserverScannerParamsLocationTreeItems":{"type":"object","properties":{"display_name":{"type":"string","description":"Returns the overarching instrument type to designate the location."},"type":{"type":"string","description":"Returns the code value of the market scanner instrument type value."},"locations":{"type":"array","items":{"$ref":"#/components/schemas/IserverScannerParamsLocationTreeItemsLocationsItems"}}},"title":"IserverScannerParamsLocationTreeItems"},"iserverScannerParams":{"type":"object","properties":{"scan_type_list":{"type":"array","items":{"$ref":"#/components/schemas/IserverScannerParamsScanTypeListItems"},"description":"Contains all values used as the scanner \"type\" in the request."},"instrument_list":{"type":"array","items":{"$ref":"#/components/schemas/IserverScannerParamsInstrumentListItems"},"description":"Contains all values relevant to the scanner \"instrument\" request field."},"filter_list":{"type":"array","items":{"$ref":"#/components/schemas/IserverScannerParamsFilterListItems"}},"location_tree":{"type":"array","items":{"$ref":"#/components/schemas/IserverScannerParamsLocationTreeItems"},"description":"Contains all values relevant to the location field of the market scanner request."}},"title":"iserverScannerParams"},"IserverScannerRunRequestFilterItemsValue":{"oneOf":[{"type":"string"},{"type":"integer","format":"int64"},{"type":"boolean"},{"type":"number","format":"double"}],"description":"Value corresponding to the input for \"code\".","title":"IserverScannerRunRequestFilterItemsValue"},"IserverScannerRunRequestFilterItems":{"type":"object","properties":{"code":{"type":"string","description":"Code value of the filter. Based on the \"code\" value within the \"filter_list\" section of the /iserver/scanner/params response."},"value":{"$ref":"#/components/schemas/IserverScannerRunRequestFilterItemsValue","description":"Value corresponding to the input for \"code\"."}},"title":"IserverScannerRunRequestFilterItems"},"iserverScannerRunRequest":{"type":"object","properties":{"instrument":{"type":"string","description":"Instrument type as the target of the market scanner request. Found in the \"instrument_list\" section of the /iserver/scanner/params response."},"type":{"type":"string","description":"Scanner value the market scanner is sorted by. Based on the \"scan_type_list\" section of the /iserver/scanner/params response."},"location":{"type":"string","description":"Location value the market scanner is searching through. Based on the \"location_tree\" section of the /iserver/scanner/params response."},"filter":{"type":"array","items":{"$ref":"#/components/schemas/IserverScannerRunRequestFilterItems"},"description":"Contains any additional filters that should apply to response."}},"title":"iserverScannerRunRequest"},"IserverScannerRunResponseContractsItems":{"type":"object","properties":{"server_id":{"type":"string","description":"Contract's index in relation to the market scanner type's sorting priority."},"column_name":{"type":"string","description":"Always returned for the first contract."},"symbol":{"type":"string","description":"Returns the contract's ticker symbol."},"conidex":{"type":"string","description":"Returns the contract ID of the contract."},"con_id":{"type":"integer","format":"int64","description":"Returns the contract ID of the contract."},"available_chart_periods":{"type":"string","description":"Internal Use Only"},"company_name":{"type":"string","description":"Returns the company long name."},"contract_description_1":{"type":"string","description":"For derivatives like Futures, the local symbol of the contract will be returned."},"listing_exchange":{"type":"string","description":"Returns the primary listing exchange of the contract."},"sec_type":{"type":"string","description":"Returns the security type of the contract."}},"title":"IserverScannerRunResponseContractsItems"},"iserverScannerRunResponse":{"type":"object","properties":{"contracts":{"type":"array","items":{"$ref":"#/components/schemas/IserverScannerRunResponseContractsItems"},"description":"Contains contracts related to the market scanner request."},"scan_data_column_name":{"type":"string","description":"Internal Use Only"}},"title":"iserverScannerRunResponse"},"SuccessfulTickleResponseHmds":{"type":"object","properties":{"error":{"type":"string","description":"Relays any internal connection errors."},"authStatus":{"type":"array","items":{"description":"Any type"},"description":"Returns authentication details."}},"description":"Returns connection details for the historical market data server.","title":"SuccessfulTickleResponseHmds"},"BrokerageSessionStatusServerInfo":{"type":"object","properties":{"serverName":{"type":"string","description":"IBKR server information. Internal use only."},"serverVersion":{"type":"string","description":"IBKR version information. Internal use only."}},"title":"BrokerageSessionStatusServerInfo"},"brokerageSessionStatus":{"type":"object","properties":{"authenticated":{"type":"boolean","description":"Returns whether your brokerage session is authenticated or not."},"established":{"type":"boolean","description":"Returns whether your brokerage session is fully established and ready to handle requests. Set to true when the login message is received from underlying brokerage infrastructure, indicating authentication is complete and account information is loaded."},"competing":{"type":"boolean","description":"Returns whether you have a competing brokerage session in another connection."},"connected":{"type":"boolean","description":"Returns whether you are connected to the gateway or not."},"message":{"type":"string","description":"A message about your authenticate status if any."},"MAC":{"type":"string","description":"Device MAC information."},"serverInfo":{"$ref":"#/components/schemas/BrokerageSessionStatusServerInfo"},"hardware_info":{"type":"string","description":"Client Portal use only."},"fail":{"type":"string","description":"Returns the reason for failing to retrieve authentication status."}},"title":"brokerageSessionStatus"},"SuccessfulTickleResponseIserver":{"type":"object","properties":{"authStatus":{"$ref":"#/components/schemas/brokerageSessionStatus"}},"title":"SuccessfulTickleResponseIserver"},"successfulTickleResponse":{"type":"object","properties":{"session":{"type":"string","description":"Returns the session token of the contract."},"ssoExpires":{"type":"integer","format":"int64","description":"Returns the number of milliseconds until the current sso session expires."},"collission":{"type":"boolean","description":"(Internal Use Only)"},"userId":{"type":"integer","format":"int64","description":"(Internal Use Only)"},"hmds":{"$ref":"#/components/schemas/SuccessfulTickleResponseHmds","description":"Returns connection details for the historical market data server."},"iserver":{"$ref":"#/components/schemas/SuccessfulTickleResponseIserver"}},"title":"successfulTickleResponse"},"failedTickleResponse":{"type":"object","properties":{"error":{"type":"string","description":"reason why tickle was accepted by not processed"}},"title":"failedTickleResponse"},"tickleResponse":{"oneOf":[{"$ref":"#/components/schemas/successfulTickleResponse"},{"$ref":"#/components/schemas/failedTickleResponse"}],"title":"tickleResponse"},"brokerageSessionInitRequest":{"type":"object","properties":{"publish":{"type":"boolean","description":"publish brokerage session token at the same time when brokerage session initialized. If set false, then session token should be published before calling init. Setting true is preferred way."},"compete":{"type":"boolean","description":"Determines if other brokerage sessions should be disconnected to prioritize this connection."}},"title":"brokerageSessionInitRequest"},"Trading Session_logout_Response_200":{"type":"object","properties":{"status":{"type":"boolean","description":"Confirms that the logout action was performed successfully."}},"title":"Trading Session_logout_Response_200"},"SsoValidateResponseFeatures":{"type":"object","properties":{"envs":{"type":"string","description":"Returns the connecting environment to distinguish production or paper."},"wlms":{"type":"boolean","description":"Internal Use Only"},"realtime":{"type":"boolean","description":"Returns if realtime market data is available"},"bond":{"type":"boolean","description":"Returns if bonds can be traded."},"optionChains":{"type":"boolean","description":"Returns if option chains can be retrieved in the account."},"calendar":{"type":"boolean","description":"Returns if trading calendars are enabled"},"newMf":{"type":"boolean","description":"Internal Use Only"}},"description":"Returns supported features such as bonds and option trading.","title":"SsoValidateResponseFeatures"},"ssoValidateResponse":{"type":"object","properties":{"USER_ID":{"type":"integer","format":"int64","description":"Internal user identifier."},"USER_NAME":{"type":"string","description":"current username logged in for the session."},"RESULT":{"type":"boolean","description":"Confirms if validation was successful. True if session was validated; false if not."},"AUTH_TIME":{"type":"integer","format":"int64","description":"Returns the time of authentication in epoch time."},"SF_ENABLED":{"type":"boolean","description":"(Internal use only)"},"IS_FREE_TRIAL":{"type":"boolean","description":"Returns if the account is a trial account or a funded account."},"CREDENTIAL":{"type":"string","description":"Returns the underlying username of the account."},"IP":{"type":"string","description":"Internal use only. Does not reflect the IP address of the user."},"EXPIRES":{"type":"integer","format":"int64","description":"Returns the time until SSO session expiration in milliseconds."},"QUALIFIED_FOR_MOBILE_AUTH":{"type":"boolean","description":"Returns if the customer requires two factor authentication."},"LANDING_APP":{"type":"string","description":"Used for Client Portal (Internal use only)"},"IS_MASTER":{"type":"boolean","description":"Returns whether the account is a master account (true) or subaccount (false)."},"lastAccessed":{"type":"integer","format":"int64","description":"Returns the last time the user was accessed in epoch time."},"loginType":{"type":"integer","format":"int64","description":"Returns the login type. 1 for Live, 2 for Paper"},"PAPER_USER_NAME":{"type":"string","description":"Returns the paper username for the account."},"features":{"$ref":"#/components/schemas/SsoValidateResponseFeatures","description":"Returns supported features such as bonds and option trading."},"region":{"type":"string","description":"Returns the region connected to internally."}},"title":"ssoValidateResponse"},"V1ApiIserverWatchlistPostRequestBodyContentApplicationJsonSchemaRowsItems":{"type":"object","properties":{"C":{"type":"string","description":"Conid as string."}},"title":"V1ApiIserverWatchlistPostRequestBodyContentApplicationJsonSchemaRowsItems"},"Trading Watchlists_postNewWatchlist_Response_200":{"type":"object","properties":{"id":{"type":"string","description":"The submitted watchlist ID."},"hash":{"type":"string","description":"IB's internal hash of the submitted watchlist."},"name":{"type":"string","description":"The submitted human-readable watchlist name."},"readOnly":{"type":"boolean","description":"Indicates whether watchlist is write-restricted. User-created watchlists will always show false."},"instruments":{"type":"array","items":{"description":"Any type"},"description":"Array will always be empty. Contents can be queried via `GET /iserver/watchlist?id=`"}},"title":"Trading Watchlists_postNewWatchlist_Response_200"},"WatchlistDeleteSuccessData":{"type":"object","properties":{"deleted":{"type":"string","description":"Watchlist ID of the deleted watchlist."}},"title":"WatchlistDeleteSuccessData"},"WatchlistDeleteSuccessAction":{"type":"string","enum":["context"],"description":"Internal use. Always has value 'context'.","title":"WatchlistDeleteSuccessAction"},"watchlistDeleteSuccess":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WatchlistDeleteSuccessData"},"action":{"$ref":"#/components/schemas/WatchlistDeleteSuccessAction","description":"Internal use. Always has value 'context'."},"MID":{"type":"string","description":"Internal use. Number of times endpoint has been visited during session."}},"description":"Object detailing the successful deletion of a watchlist.","title":"watchlistDeleteSuccess"},"SingleWatchlistEntrySt":{"type":"string","enum":["STK","OPT","FUT","BOND","FUND","WAR","CASH","CRYPTO"],"description":"All-capital, shorthand security type identifier of the instrument.","title":"SingleWatchlistEntrySt"},"SingleWatchlistEntryAssetClass":{"type":"string","enum":["STK","OPT","FUT","BOND","FUND","WAR","CASH","CRYPTO"],"description":"All-capital, shorthand security type identifier of the instrument.","title":"SingleWatchlistEntryAssetClass"},"singleWatchlistEntry":{"type":"object","properties":{"ST":{"$ref":"#/components/schemas/SingleWatchlistEntrySt","description":"All-capital, shorthand security type identifier of the instrument."},"C":{"type":"string","description":"Instrument conid as a string."},"conid":{"type":"integer","format":"int64","description":"IB contract ID of the instrument."},"name":{"type":"string","description":"Complete display name of the instrument."},"fullName":{"type":"string","description":"Full display presentation of the instrument symbol."},"assetClass":{"$ref":"#/components/schemas/SingleWatchlistEntryAssetClass","description":"All-capital, shorthand security type identifier of the instrument."},"ticker":{"type":"string","description":"Symbol of the instrument."},"chineseName":{"type":"string","description":"Rendering of the instrument name in Chinese."}},"description":"Object containing watchlist entry for a single instrument.","title":"singleWatchlistEntry"},"singleWatchlist":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of the watchlist."},"hash":{"type":"string","description":"Internal use. Unique hash of the watchlist."},"name":{"type":"string","description":"Human-readable display name of the watchlist."},"readOnly":{"type":"boolean","description":"Indicates whether the watchlist can be edited."},"instruments":{"type":"array","items":{"$ref":"#/components/schemas/singleWatchlistEntry"},"description":"Array of instruments contained in the watchlist."}},"description":"Object detailing a single watchlist.","title":"singleWatchlist"},"V1ApiIserverWatchlistsGetParametersSc":{"type":"string","enum":["USER_WATCHLIST"],"title":"V1ApiIserverWatchlistsGetParametersSc"},"WatchlistsResponseDataUserListsItemsType":{"type":"string","enum":["watchlist"],"description":"Always has value 'watchlist'.","title":"WatchlistsResponseDataUserListsItemsType"},"WatchlistsResponseDataUserListsItems":{"type":"object","properties":{"is_open":{"type":"boolean","description":"Internal use. Indicates if the watchlist is currently in use."},"read_only":{"type":"boolean","description":"Indicates if the watchlist can be edited."},"name":{"type":"string","description":"Display name of the watchlist."},"modified":{"type":"integer","format":"int64","description":"Unix timestamp in milliseconds of the last modification of the watchlist."},"id":{"type":"string","description":"Watchlist ID of the watchlist."},"type":{"$ref":"#/components/schemas/WatchlistsResponseDataUserListsItemsType","description":"Always has value 'watchlist'."}},"description":"Details of a single watchlist.","title":"WatchlistsResponseDataUserListsItems"},"WatchlistsResponseData":{"type":"object","properties":{"scanners_only":{"type":"boolean","description":"Indicates if query results contain only market scanners."},"show_scanners":{"type":"boolean","description":"Indicates if market scanners are included in query results."},"bulk_delete":{"type":"boolean","description":"Indicates if username's watchlists can be bulk-deleted."},"user_lists":{"type":"array","items":{"$ref":"#/components/schemas/WatchlistsResponseDataUserListsItems"},"description":"Array of objects detailing the watchlists saved for the username in use in the current Web API session."}},"description":"Contains the watchlist query results.","title":"WatchlistsResponseData"},"WatchlistsResponseAction":{"type":"string","enum":["content"],"description":"Internal use. Always has value 'content'.","title":"WatchlistsResponseAction"},"watchlistsResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WatchlistsResponseData","description":"Contains the watchlist query results."},"action":{"$ref":"#/components/schemas/WatchlistsResponseAction","description":"Internal use. Always has value 'content'."},"MID":{"type":"string","description":"Internal use. Number of times endpoint has been visited during session."}},"description":"Object containing a successful query for watchlists saved for the username in use in the current Web API session.","title":"watchlistsResponse"},"TaskActionResponse":{"type":"object","properties":{"accountId":{"type":"string"},"formNumber":{"type":"integer","format":"int64"},"status":{"type":"string"},"message":{"type":"string"}},"title":"TaskActionResponse"},"StatusResponseProblemDetail":{"type":"object","properties":{},"title":"StatusResponseProblemDetail"},"FileDataData":{"type":"object","properties":{},"title":"FileDataData"},"FileData":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/FileDataData"},"name":{"type":"string"}},"title":"FileData"},"StatusResponse":{"type":"object","properties":{"requestId":{"type":"integer","format":"int64"},"problemDetail":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/StatusResponseProblemDetail"}},"dateSubmitted":{"type":"string","format":"date-time"},"fileData":{"$ref":"#/components/schemas/FileData"}},"title":"StatusResponse"},"AccountData":{"type":"object","properties":{"accountId":{"type":"string"},"masterAccountId":{"type":"string"},"mainAccount":{"type":"string"},"sourceAccountId":{"type":"string"},"primaryUser":{"type":"string"},"clearingStatus":{"type":"string"},"clearingStatusDescription":{"type":"string"},"stateCode":{"type":"string"},"optionLevel":{"type":"integer","format":"int64"},"baseCurrency":{"type":"string"},"dateBegun":{"type":"string","format":"date-time"},"dateApproved":{"type":"string","format":"date-time"},"dateOpened":{"type":"string","format":"date-time"},"dateFunded":{"type":"string","format":"date-time"},"dateClosed":{"type":"string","format":"date-time"},"dateLinked":{"type":"string","format":"date-time"},"dateDelinked":{"type":"string","format":"date-time"},"accountTitle":{"type":"string"},"officialTitle":{"type":"string"},"accountAlias":{"type":"string"},"emailAddress":{"type":"string"},"margin":{"type":"string"},"applicantType":{"type":"string"},"subType":{"type":"string"},"stockYieldProgram":{"type":"object","additionalProperties":{"type":"string"}},"feeTemplate":{"type":"object","additionalProperties":{"type":"string"}},"capabilities":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"limitedOptionTrading":{"type":"string"},"investmentObjectives":{"type":"array","items":{"type":"string"}},"dividendReinvestment":{"type":"object","additionalProperties":{"type":"boolean"}},"externalId":{"type":"string"},"mifidCategory":{"type":"string"},"mifirStatus":{"type":"string"},"equity":{"type":"number","format":"double"},"household":{"type":"string"},"propertyProfile":{"type":"string"},"processType":{"type":"string"},"riskScore":{"type":"integer","format":"int64"},"class_action_program":{"type":"string"},"trustType":{"type":"string"},"orgType":{"type":"string"},"businessDescription":{"type":"string"},"usTaxPurposeType":{"type":"string"},"tradeIntentionType":{"type":"string"},"registeredAddress":{"type":"object","additionalProperties":{"type":"string"}},"mailing":{"type":"object","additionalProperties":{"type":"string"}},"countryOfCorporation":{"type":"string"},"lei":{"type":"string"},"taxIds":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"}}},"taxTreatyDetails":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"}}},"signatures":{"type":"array","items":{"type":"string"}}},"title":"AccountData"},"AssociatedPersonEmploymentDetails":{"type":"object","properties":{},"title":"AssociatedPersonEmploymentDetails"},"AssociatedPersonSubscribedServicesItems":{"type":"object","properties":{},"title":"AssociatedPersonSubscribedServicesItems"},"AssociatedPerson":{"type":"object","properties":{"entityId":{"type":"integer","format":"int64"},"externalCode":{"type":"string"},"firstName":{"type":"string"},"middleName":{"type":"string"},"middleInitial":{"type":"string"},"lastName":{"type":"string"},"suffix":{"type":"string"},"username":{"type":"string"},"passwordDate":{"type":"string"},"userStatus":{"type":"string"},"userStatusTrading":{"type":"string"},"lastLogin":{"type":"string"},"gender":{"type":"string"},"maritalStatus":{"type":"string"},"salutation":{"type":"string"},"ownershipPercentage":{"type":"number","format":"double"},"email":{"type":"string"},"countryOfCitizenship":{"type":"string"},"countryOfBirth":{"type":"string"},"dateOfBirth":{"type":"string"},"motersMaidenName":{"type":"string"},"numberOfDependents":{"type":"integer","format":"int64"},"securityDevice":{"type":"string"},"commercial":{"type":"string"},"countryOfLegalResidence":{"type":"string"},"stateOfLegalResidence":{"type":"string"},"mdSubscriberStatus":{"type":"string"},"phones":{"type":"object","additionalProperties":{"type":"string"}},"residence":{"type":"object","additionalProperties":{"type":"string"}},"mailing":{"type":"object","additionalProperties":{"type":"string"}},"associations":{"type":"array","items":{"type":"string"}},"identityDocuments":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"}}},"employmentType":{"type":"string"},"employmentDetails":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AssociatedPersonEmploymentDetails"}},"subscribedServices":{"type":"array","items":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AssociatedPersonSubscribedServicesItems"}}},"taxTreatyDetails":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"}}}},"title":"AssociatedPerson"},"AssociatedEntity":{"type":"object","properties":{"entityId":{"type":"integer","format":"int64"},"externalCode":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"},"organizationCountry":{"type":"string"},"phones":{"type":"object","additionalProperties":{"type":"string"}},"residence":{"type":"object","additionalProperties":{"type":"string"}},"mailing":{"type":"object","additionalProperties":{"type":"string"}},"associations":{"type":"array","items":{"type":"string"}},"identityDocuments":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"}}},"taxTreatyDetails":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"}}},"AssociatedPersons":{"type":"array","items":{"$ref":"#/components/schemas/AssociatedPerson"}}},"title":"AssociatedEntity"},"AccountDetailsResponseFinancialInformation":{"type":"object","properties":{},"title":"AccountDetailsResponseFinancialInformation"},"AccountDetailsResponseSourcesOfWealthItems":{"type":"object","properties":{},"title":"AccountDetailsResponseSourcesOfWealthItems"},"IndividualIRABene":{"type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"dateOfBirth":{"type":"string"},"type":{"type":"string"},"identification":{"type":"object","additionalProperties":{"type":"string"}},"location":{"type":"object","additionalProperties":{"type":"string"}},"relationship":{"type":"string"},"ownership":{"type":"integer","format":"int64"},"perStripes":{"type":"string"}},"title":"IndividualIRABene"},"EntityIRABene":{"type":"object","properties":{"name":{"type":"string"},"entityType":{"type":"string"},"type":{"type":"string"},"location":{"type":"object","additionalProperties":{"type":"string"}},"articleOfWill":{"type":"string"}},"title":"EntityIRABene"},"RestrictionInfo":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"byIB":{"type":"boolean"},"name":{"type":"string"}},"title":"RestrictionInfo"},"AccountDetailsResponse":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/ErrorResponse"},"hasError":{"type":"boolean"},"errorDescription":{"type":"string"},"account":{"$ref":"#/components/schemas/AccountData"},"associatedPersons":{"type":"array","items":{"$ref":"#/components/schemas/AssociatedPerson"}},"associatedEntities":{"type":"array","items":{"$ref":"#/components/schemas/AssociatedEntity"}},"withHoldingStatement":{"type":"object","additionalProperties":{"type":"string"}},"marketData":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"}}},"financialInformation":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AccountDetailsResponseFinancialInformation"}},"sourcesOfWealth":{"type":"array","items":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AccountDetailsResponseSourcesOfWealthItems"}}},"tradeBundles":{"type":"array","items":{"type":"string"}},"individualIRABeneficiaries":{"type":"array","items":{"$ref":"#/components/schemas/IndividualIRABene"}},"entityIRABeneficiaries":{"type":"array","items":{"$ref":"#/components/schemas/EntityIRABene"}},"decedents":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"}}},"restrictions":{"type":"array","items":{"$ref":"#/components/schemas/RestrictionInfo"}}},"title":"AccountDetailsResponse"},"AccountStatusRequestStatus":{"type":"string","enum":["N","O","P","C","A","E","F","I","J","L","M","R","W","Q"],"title":"AccountStatusRequestStatus"},"AccountStatusRequest":{"type":"object","properties":{"startDate":{"type":"string","format":"date"},"endDate":{"type":"string","format":"date"},"offset":{"type":"integer","format":"int64","minimum":0},"limit":{"type":"integer","format":"int64","minimum":1,"maximum":1000},"status":{"$ref":"#/components/schemas/AccountStatusRequestStatus"}},"required":["startDate","endDate"],"title":"AccountStatusRequest"},"AccountStatusResponse":{"type":"object","properties":{"dateOpened":{"type":"string","format":"date-time"},"dateStarted":{"type":"string","format":"date-time"},"dateClosed":{"type":"string","format":"date-time"},"accountId":{"type":"string"},"status":{"type":"string"},"description":{"type":"string"},"masterAccountId":{"type":"string"},"adminAccountId":{"type":"string"},"state":{"type":"string"},"message":{"type":"string"}},"title":"AccountStatusResponse"},"AccountStatusBulkResponse":{"type":"object","properties":{"accounts":{"type":"array","items":{"$ref":"#/components/schemas/AccountStatusResponse"}},"offset":{"type":"integer","format":"int64"},"limit":{"type":"integer","format":"int64"},"total":{"type":"integer","format":"int64"}},"title":"AccountStatusBulkResponse"},"LoginMessage":{"type":"object","properties":{"recordDate":{"type":"string","format":"date-time"},"id":{"type":"integer","format":"int64"},"username":{"type":"string"},"messageType":{"type":"string"},"contentId":{"type":"integer","format":"int64"},"state":{"type":"string"},"description":{"type":"string"},"tasks":{"type":"array","items":{"type":"integer","format":"int64"}}},"title":"LoginMessage"},"LoginMessageResponse":{"type":"object","properties":{"accountId":{"type":"string"},"clearingStatus":{"type":"string"},"clearingStatusDescription":{"type":"string"},"loginMessages":{"type":"array","items":{"$ref":"#/components/schemas/LoginMessage"}},"loginMessagePresent":{"type":"boolean"}},"title":"LoginMessageResponse"},"LoginMessageRequestStatus":{"type":"string","enum":["N","O","P","C","A","E","F","I","J","L","M","R","W","Q"],"title":"LoginMessageRequestStatus"},"LoginMessageRequest":{"type":"object","properties":{"startDate":{"type":"string","format":"date"},"endDate":{"type":"string","format":"date"},"offset":{"type":"integer","format":"int64","minimum":0},"limit":{"type":"integer","format":"int64","minimum":1,"maximum":1000},"status":{"$ref":"#/components/schemas/LoginMessageRequestStatus"},"type":{"type":"string"}},"required":["startDate","endDate"],"title":"LoginMessageRequest"},"GwApiV1AccountsAccountIdTasksGetParametersType":{"type":"string","enum":["pending","registration"],"default":"registration","title":"GwApiV1AccountsAccountIdTasksGetParametersType"},"RegistrationTask":{"type":"object","properties":{"externalId":{"type":"string"},"formNumber":{"type":"integer","format":"int64"},"formName":{"type":"string"},"action":{"type":"string"},"dateCompleted":{"type":"string","format":"date-time"},"state":{"type":"string"},"questionIds":{"type":"array","items":{"type":"integer","format":"int64"}},"warning":{"type":"string"},"isRequiredForApproval":{"type":"boolean"},"isCompleted":{"type":"boolean"},"isDeclined":{"type":"boolean"}},"title":"RegistrationTask"},"RegistrationTasksResponse":{"type":"object","properties":{"registrationTaskPresent":{"type":"boolean"},"empty":{"type":"boolean"},"error":{"$ref":"#/components/schemas/ErrorResponse"},"hasError":{"type":"boolean"},"errorDescription":{"type":"string"},"accountId":{"type":"string"},"status":{"type":"string"},"description":{"type":"string"},"state":{"type":"string"},"registrationTasks":{"type":"array","items":{"$ref":"#/components/schemas/RegistrationTask"}}},"title":"RegistrationTasksResponse"},"PendingTask":{"type":"object","properties":{"taskNumber":{"type":"integer","format":"int64"},"formNumber":{"type":"integer","format":"int64"},"formName":{"type":"string"},"action":{"type":"string"},"externalId":{"type":"string"},"state":{"type":"string"},"documentRejectReason":{"type":"array","items":{"type":"string"}},"url":{"type":"string"},"startDate":{"type":"string","format":"date-time"},"au10tixCreatedDate":{"type":"string","format":"date-time"},"au10tixExpiryDate":{"type":"string","format":"date-time"},"entityId":{"type":"integer","format":"int64"},"onlineTask":{"type":"boolean"},"requiredForApproval":{"type":"boolean"},"requiredForTrading":{"type":"boolean"},"questionIds":{"type":"array","items":{"type":"integer","format":"int64"}}},"title":"PendingTask"},"PendingTasksResponse":{"type":"object","properties":{"empty":{"type":"boolean"},"error":{"$ref":"#/components/schemas/ErrorResponse"},"hasError":{"type":"boolean"},"errorDescription":{"type":"string"},"accountId":{"type":"string"},"status":{"type":"string"},"description":{"type":"string"},"state":{"type":"string"},"pendingTasks":{"type":"array","items":{"$ref":"#/components/schemas/PendingTask"}},"pendingTaskPresent":{"type":"boolean"}},"title":"PendingTasksResponse"},"Account Management Accounts_getAccountsTasks_Response_200":{"oneOf":[{"$ref":"#/components/schemas/RegistrationTasksResponse"},{"$ref":"#/components/schemas/PendingTasksResponse"}],"title":"Account Management Accounts_getAccountsTasks_Response_200"},"Au10TixDetailResponse":{"type":"object","properties":{"startDate":{"type":"string","format":"date-time"},"expiryDate":{"type":"string","format":"date-time"},"error":{"$ref":"#/components/schemas/ErrorResponse"},"hasError":{"type":"boolean"},"errorDescription":{"type":"string"},"url":{"type":"string"},"externalId":{"type":"string"},"entityId":{"type":"integer","format":"int64"},"state":{"type":"string"}},"title":"Au10TixDetailResponse"},"FileDetailsResponse":{"type":"object","properties":{"accountId":{"type":"string"},"requestFileName":{"type":"string"},"responseFileName":{"type":"string"}},"title":"FileDetailsResponse"},"ResponseFileResponseData":{"type":"object","properties":{},"title":"ResponseFileResponseData"},"ResponseFileResponse":{"type":"object","properties":{"isProcessed":{"type":"boolean"},"name":{"type":"string"},"data":{"$ref":"#/components/schemas/ResponseFileResponseData"},"error":{"$ref":"#/components/schemas/ErrorResponse"},"hasError":{"type":"boolean"},"errorDescription":{"type":"string"}},"title":"ResponseFileResponse"},"Account Management Accounts_listAccounts_Response_200":{"oneOf":[{"$ref":"#/components/schemas/FileDetailsResponse"},{"$ref":"#/components/schemas/ResponseFileResponse"}],"title":"Account Management Accounts_listAccounts_Response_200"},"FormStatusUpdateStatus":{"type":"string","enum":["ACCEPTED","REJECTED","PENDING","RECEIVED"],"title":"FormStatusUpdateStatus"},"FormStatusUpdate":{"type":"object","properties":{"formNumber":{"type":"integer","format":"int64"},"status":{"$ref":"#/components/schemas/FormStatusUpdateStatus"}},"title":"FormStatusUpdate"},"GwApiV1InstructionsCancelPostRequestBodyContentApplicationJsonSchemaInstructionType":{"type":"string","enum":["CANCEL_INSTRUCTION"],"title":"GwApiV1InstructionsCancelPostRequestBodyContentApplicationJsonSchemaInstructionType"},"CancelInstruction":{"type":"object","properties":{"clientInstructionId":{"type":"number","format":"double"},"instructionId":{"type":"number","format":"double"},"reason":{"type":"string","minLength":1,"maxLength":256}},"required":["clientInstructionId","instructionId","reason"],"title":"CancelInstruction"},"InstructionResultInstructionType":{"type":"string","enum":["ACH_INSTRUCTION","CANCEL_INSTRUCTION","COMPLEX_ASSET_TRANSFER","DELETE_BANK_INSTRUCTION","DEPOSIT","DWAC","EXTERNAL_POSITION_TRANSFER","FOP","QUERY_RECENT_INSTRUCTIONS","QUERY_WITHDRAWABLE_FUNDS","INTERNAL_POSITION_TRANSFER","INTERNAL_CASH_TRANSFER","MICRO_AMOUNT","PREDEFINED_DESTINATION_INSTRUCTION","TRADITIONAL_BANK_INSTRUCTION_VERIFICATION","WITHDRAWAL","QUERY_IRA_CONTRIBUTIONS","EDDA_INSTRUCTION","QUERY_RECENT_RECURRING_EVENTS","QUERY_RECURRING_INSTRUCTIONS","QUERY_ACCOUNT_BALANCES","QUERY_BANK_INSTRUCTION","QUERY_WITHDRAWABLE_CASH_EQUITY","ISA_TRANSFER"],"title":"InstructionResultInstructionType"},"InstructionResultInstructionStatus":{"type":"string","enum":["PENDING","PROCESSED","REJECTED","PENDING_VERIFICATION"],"title":"InstructionResultInstructionStatus"},"InstructionResult":{"type":"object","properties":{"clientInstructionId":{"type":"number","format":"double"},"instructionType":{"$ref":"#/components/schemas/InstructionResultInstructionType"},"instructionStatus":{"$ref":"#/components/schemas/InstructionResultInstructionStatus"},"instructionId":{"type":"number","format":"double"},"ibReferenceId":{"type":"number","format":"double"},"description":{"type":"string"},"processedTimestamp":{"type":"string","format":"date-time"}},"required":["clientInstructionId","instructionType","instructionStatus","instructionId"],"title":"InstructionResult"},"SynchronousInstructionResponse":{"type":"object","properties":{"status":{"type":"number","format":"double"},"instructionSetId":{"type":"number","format":"double"},"instructionResult":{"$ref":"#/components/schemas/InstructionResult"}},"required":["status","instructionSetId"],"title":"SynchronousInstructionResponse"},"InstructionErrorResultError":{"type":"object","properties":{"errorCode":{"type":"string"},"errorMessage":{"type":"string"}},"required":["errorCode","errorMessage"],"title":"InstructionErrorResultError"},"InstructionErrorResult":{"type":"object","properties":{"clientInstructionId":{"type":"number","format":"double"},"instructionType":{"$ref":"#/components/schemas/InstructionResultInstructionType"},"instructionStatus":{"$ref":"#/components/schemas/InstructionResultInstructionStatus"},"instructionId":{"type":"number","format":"double"},"ibReferenceId":{"type":"number","format":"double"},"description":{"type":"string"},"processedTimestamp":{"type":"string","format":"date-time"},"error":{"$ref":"#/components/schemas/InstructionErrorResultError"}},"required":["clientInstructionId","instructionType","instructionStatus","instructionId","error"],"title":"InstructionErrorResult"},"ForbiddenInstructionResponse":{"type":"object","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer","format":"int64"},"detail":{"type":"string"},"instructionSetId":{"type":"integer","format":"int64"},"instructionResult":{"$ref":"#/components/schemas/InstructionErrorResult"}},"required":["type","title","status","detail","instructionSetId","instructionResult"],"title":"ForbiddenInstructionResponse"},"BusinessRejectResponse":{"type":"object","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer","format":"int64"},"instructionSetId":{"type":"integer","format":"int64"},"instructionResult":{"$ref":"#/components/schemas/InstructionErrorResult"}},"required":["type","title","status","instructionSetId"],"title":"BusinessRejectResponse"},"GwApiV1BankInstructionsBulkPostRequestBodyContentApplicationJsonSchemaInstructionType":{"type":"string","enum":["ACH_INSTRUCTION","OPEN_BANKING_INSTRUCTION","TRADITIONAL_BANK_INSTRUCTION_VERIFICATION","DELETE_BANK_INSTRUCTION","PREDEFINED_DESTINATION_INSTRUCTION","EDDA_INSTRUCTION"],"title":"GwApiV1BankInstructionsBulkPostRequestBodyContentApplicationJsonSchemaInstructionType"},"AsynchronousInstructionSetResponseInstructionResultsItems":{"type":"object","properties":{"status":{"type":"integer","format":"int64"},"instructionSetId":{"type":"number","format":"double"},"instructionResult":{"$ref":"#/components/schemas/InstructionResult"}},"required":["status","instructionSetId","instructionResult"],"title":"AsynchronousInstructionSetResponseInstructionResultsItems"},"AsynchronousInstructionSetResponse":{"type":"object","properties":{"status":{"type":"integer","format":"int64"},"instructionSetId":{"type":"number","format":"double"},"instructionResults":{"type":"array","items":{"$ref":"#/components/schemas/AsynchronousInstructionSetResponseInstructionResultsItems"}}},"required":["status","instructionSetId"],"title":"AsynchronousInstructionSetResponse"},"GwApiV1InstructionsCancelBulkPostRequestBodyContentApplicationJsonSchemaInstructionType":{"type":"string","enum":["CANCEL_INSTRUCTION"],"title":"GwApiV1InstructionsCancelBulkPostRequestBodyContentApplicationJsonSchemaInstructionType"},"GwApiV1ExternalAssetTransfersBulkPostRequestBodyContentApplicationJsonSchemaInstructionType":{"type":"string","enum":["DWAC","FOP","COMPLEX_ASSET_TRANSFER","EXTERNAL_POSITION_TRANSFER"],"title":"GwApiV1ExternalAssetTransfersBulkPostRequestBodyContentApplicationJsonSchemaInstructionType"},"GwApiV2ExternalAssetTransfersBulkPostRequestBodyContentApplicationJsonSchemaInstructionType":{"type":"string","enum":["DWAC","FOP","COMPLEX_ASSET_TRANSFER"],"title":"GwApiV2ExternalAssetTransfersBulkPostRequestBodyContentApplicationJsonSchemaInstructionType"},"GwApiV1ExternalCashTransfersBulkPostRequestBodyContentApplicationJsonSchemaInstructionType":{"type":"string","enum":["DEPOSIT","WITHDRAWAL"],"title":"GwApiV1ExternalCashTransfersBulkPostRequestBodyContentApplicationJsonSchemaInstructionType"},"GwApiV1InternalAssetTransfersBulkPostRequestBodyContentApplicationJsonSchemaInstructionType":{"type":"string","enum":["INTERNAL_POSITION_TRANSFER"],"title":"GwApiV1InternalAssetTransfersBulkPostRequestBodyContentApplicationJsonSchemaInstructionType"},"GwApiV1InternalCashTransfersBulkPostRequestBodyContentApplicationJsonSchemaInstructionType":{"type":"string","enum":["INTERNAL_CASH_TRANSFER"],"title":"GwApiV1InternalCashTransfersBulkPostRequestBodyContentApplicationJsonSchemaInstructionType"},"PollingInstructionResultInstructionType":{"type":"string","enum":["ACH_INSTRUCTION","CANCEL_INSTRUCTION","COMPLEX_ASSET_TRANSFER","DELETE_BANK_INSTRUCTION","DEPOSIT","DWAC","EXTERNAL_POSITION_TRANSFER","FOP","QUERY_RECENT_INSTRUCTIONS","QUERY_WITHDRAWABLE_FUNDS","INTERNAL_POSITION_TRANSFER","INTERNAL_CASH_TRANSFER","MICRO_AMOUNT","PREDEFINED_DESTINATION_INSTRUCTION","TRADITIONAL_BANK_INSTRUCTION_VERIFICATION","WITHDRAWAL","QUERY_IRA_CONTRIBUTIONS","EDDA_INSTRUCTION","QUERY_RECENT_RECURRING_EVENTS","QUERY_RECURRING_INSTRUCTIONS","QUERY_ACCOUNT_BALANCES","QUERY_BANK_INSTRUCTION","QUERY_WITHDRAWABLE_CASH_EQUITY","ISA_TRANSFER"],"title":"PollingInstructionResultInstructionType"},"PollingInstructionResultInstructionStatus":{"type":"string","enum":["PENDING","REJECTED","PROCESSED"],"title":"PollingInstructionResultInstructionStatus"},"PollingInstructionResultError":{"type":"object","properties":{"errorCode":{"type":"string"},"errorMessage":{"type":"string"}},"required":["errorCode","errorMessage"],"title":"PollingInstructionResultError"},"PollingInstructionResult":{"type":"object","properties":{"clientInstructionId":{"type":"number","format":"double"},"instructionType":{"$ref":"#/components/schemas/PollingInstructionResultInstructionType"},"instructionStatus":{"$ref":"#/components/schemas/PollingInstructionResultInstructionStatus"},"instructionId":{"type":"number","format":"double"},"ibReferenceId":{"type":"number","format":"double"},"description":{"type":"string"},"error":{"$ref":"#/components/schemas/PollingInstructionResultError"},"processedTimestamp":{"type":"string","format":"date-time"}},"required":["clientInstructionId","instructionType","instructionStatus","instructionId"],"title":"PollingInstructionResult"},"InstructionPollingResponse":{"type":"object","properties":{"status":{"type":"number","format":"double"},"instructionSetId":{"type":"number","format":"double"},"instructionResult":{"$ref":"#/components/schemas/PollingInstructionResult"}},"required":["status","instructionSetId"],"title":"InstructionPollingResponse"},"InstructionResponse":{"type":"object","properties":{"status":{"type":"number","format":"double"},"instructionSetId":{"type":"number","format":"double"},"instructionResult":{"$ref":"#/components/schemas/InstructionResult"}},"required":["status","instructionSetId"],"title":"InstructionResponse"},"QueryRecentInstructionResultInstructionType":{"type":"string","enum":["ACH_INSTRUCTION","CANCEL_INSTRUCTION","COMPLEX_ASSET_TRANSFER","DELETE_BANK_INSTRUCTION","DEPOSIT","DWAC","EXTERNAL_POSITION_TRANSFER","FOP","QUERY_RECENT_INSTRUCTIONS","QUERY_WITHDRAWABLE_FUNDS","INTERNAL_POSITION_TRANSFER","INTERNAL_CASH_TRANSFER","MICRO_AMOUNT","PREDEFINED_DESTINATION_INSTRUCTION","TRADITIONAL_BANK_INSTRUCTION_VERIFICATION","WITHDRAWAL","QUERY_IRA_CONTRIBUTIONS","EDDA_INSTRUCTION","QUERY_RECENT_RECURRING_EVENTS","QUERY_RECURRING_INSTRUCTIONS","QUERY_ACCOUNT_BALANCES","QUERY_BANK_INSTRUCTION","QUERY_WITHDRAWABLE_CASH_EQUITY","ISA_TRANSFER"],"title":"QueryRecentInstructionResultInstructionType"},"QueryRecentInstructionResultInstructionStatus":{"type":"string","enum":["PENDING","REJECTED","PROCESSED"],"title":"QueryRecentInstructionResultInstructionStatus"},"QueryRecentInstructionResultError":{"type":"object","properties":{"errorCode":{"type":"string"},"errorMessage":{"type":"string"}},"required":["errorCode","errorMessage"],"title":"QueryRecentInstructionResultError"},"QueryRecentInstructionResultInstructionHistory":{"type":"object","properties":{"historyMaxDepthNumberOfDays":{"type":"integer","format":"int64"},"historyMaxDepthNumberOfInstruction":{"type":"integer","format":"int64"},"result":{"type":"array","items":{"type":"string"}}},"required":["historyMaxDepthNumberOfDays","historyMaxDepthNumberOfInstruction","result"],"title":"QueryRecentInstructionResultInstructionHistory"},"QueryRecentInstructionResult":{"type":"object","properties":{"clientInstructionId":{"type":"number","format":"double"},"instructionType":{"$ref":"#/components/schemas/QueryRecentInstructionResultInstructionType"},"instructionStatus":{"$ref":"#/components/schemas/QueryRecentInstructionResultInstructionStatus"},"instructionId":{"type":"number","format":"double"},"ibReferenceId":{"type":"number","format":"double"},"description":{"type":"string"},"error":{"$ref":"#/components/schemas/QueryRecentInstructionResultError"},"processedTimestamp":{"type":"string","format":"date-time"},"instructionHistory":{"$ref":"#/components/schemas/QueryRecentInstructionResultInstructionHistory"}},"required":["clientInstructionId","instructionType","instructionStatus","instructionId","instructionHistory"],"title":"QueryRecentInstructionResult"},"QueryRecentInstructionResponse":{"type":"object","properties":{"status":{"type":"number","format":"double"},"instructionSetId":{"type":"number","format":"double"},"instructionResult":{"$ref":"#/components/schemas/QueryRecentInstructionResult"}},"required":["status","instructionSetId"],"title":"QueryRecentInstructionResponse"},"DepositFundsPollingResultInstructionType":{"type":"string","enum":["ACH_INSTRUCTION","CANCEL_INSTRUCTION","COMPLEX_ASSET_TRANSFER","DELETE_BANK_INSTRUCTION","DEPOSIT","DWAC","EXTERNAL_POSITION_TRANSFER","FOP","QUERY_RECENT_INSTRUCTIONS","QUERY_WITHDRAWABLE_FUNDS","INTERNAL_POSITION_TRANSFER","INTERNAL_CASH_TRANSFER","MICRO_AMOUNT","PREDEFINED_DESTINATION_INSTRUCTION","TRADITIONAL_BANK_INSTRUCTION_VERIFICATION","WITHDRAWAL","QUERY_IRA_CONTRIBUTIONS","EDDA_INSTRUCTION","QUERY_RECENT_RECURRING_EVENTS","QUERY_RECURRING_INSTRUCTIONS","QUERY_ACCOUNT_BALANCES","QUERY_BANK_INSTRUCTION","QUERY_WITHDRAWABLE_CASH_EQUITY","ISA_TRANSFER"],"title":"DepositFundsPollingResultInstructionType"},"DepositFundsPollingResultInstructionStatus":{"type":"string","enum":["PENDING","REJECTED","PROCESSED"],"title":"DepositFundsPollingResultInstructionStatus"},"DepositFundsPollingResultError":{"type":"object","properties":{"errorCode":{"type":"string"},"errorMessage":{"type":"string"}},"required":["errorCode","errorMessage"],"title":"DepositFundsPollingResultError"},"DepositFundsPollingResultDepositDetailsOpenBankingProviderResponse":{"type":"object","properties":{},"title":"DepositFundsPollingResultDepositDetailsOpenBankingProviderResponse"},"DepositFundsPollingResultDepositDetailsOpenBanking":{"type":"object","properties":{"serviceProvider":{"type":"string"},"providerResponse":{"$ref":"#/components/schemas/DepositFundsPollingResultDepositDetailsOpenBankingProviderResponse"}},"title":"DepositFundsPollingResultDepositDetailsOpenBanking"},"DepositFundsPollingResultDepositDetails":{"type":"object","properties":{"amount":{"type":"number","format":"double"},"currency":{"type":"string"},"whenAvailable":{"type":"string","format":"date"},"openBanking":{"$ref":"#/components/schemas/DepositFundsPollingResultDepositDetailsOpenBanking"}},"title":"DepositFundsPollingResultDepositDetails"},"DepositFundsPollingResult":{"type":"object","properties":{"clientInstructionId":{"type":"number","format":"double"},"instructionType":{"$ref":"#/components/schemas/DepositFundsPollingResultInstructionType"},"instructionStatus":{"$ref":"#/components/schemas/DepositFundsPollingResultInstructionStatus"},"instructionId":{"type":"number","format":"double"},"ibReferenceId":{"type":"number","format":"double"},"description":{"type":"string"},"error":{"$ref":"#/components/schemas/DepositFundsPollingResultError"},"processedTimestamp":{"type":"string","format":"date-time"},"depositDetails":{"$ref":"#/components/schemas/DepositFundsPollingResultDepositDetails"}},"required":["clientInstructionId","instructionType","instructionStatus","instructionId"],"title":"DepositFundsPollingResult"},"DepositFundsPollingResponse":{"type":"object","properties":{"status":{"type":"number","format":"double"},"instructionSetId":{"type":"number","format":"double"},"instructionResult":{"$ref":"#/components/schemas/DepositFundsPollingResult"}},"required":["status","instructionSetId"],"title":"DepositFundsPollingResponse"},"QueryIraContributionsResultInstructionType":{"type":"string","enum":["ACH_INSTRUCTION","CANCEL_INSTRUCTION","COMPLEX_ASSET_TRANSFER","DELETE_BANK_INSTRUCTION","DEPOSIT","DWAC","EXTERNAL_POSITION_TRANSFER","FOP","QUERY_RECENT_INSTRUCTIONS","QUERY_WITHDRAWABLE_FUNDS","INTERNAL_POSITION_TRANSFER","INTERNAL_CASH_TRANSFER","MICRO_AMOUNT","PREDEFINED_DESTINATION_INSTRUCTION","TRADITIONAL_BANK_INSTRUCTION_VERIFICATION","WITHDRAWAL","QUERY_IRA_CONTRIBUTIONS","EDDA_INSTRUCTION","QUERY_RECENT_RECURRING_EVENTS","QUERY_RECURRING_INSTRUCTIONS","QUERY_ACCOUNT_BALANCES","QUERY_BANK_INSTRUCTION","QUERY_WITHDRAWABLE_CASH_EQUITY","ISA_TRANSFER"],"title":"QueryIraContributionsResultInstructionType"},"QueryIraContributionsResultInstructionStatus":{"type":"string","enum":["PENDING","REJECTED","PROCESSED"],"title":"QueryIraContributionsResultInstructionStatus"},"QueryIraContributionsResultError":{"type":"object","properties":{"errorCode":{"type":"string"},"errorMessage":{"type":"string"}},"required":["errorCode","errorMessage"],"title":"QueryIraContributionsResultError"},"QueryIraContributionsResultContributionsItems":{"type":"object","properties":{"maximumContributionLimit":{"type":"number","format":"double"},"yearToDateContribution":{"type":"number","format":"double"},"allowedContributionLimit":{"type":"number","format":"double"}},"required":["maximumContributionLimit","yearToDateContribution","allowedContributionLimit"],"title":"QueryIraContributionsResultContributionsItems"},"QueryIRAContributionsResult":{"type":"object","properties":{"clientInstructionId":{"type":"number","format":"double"},"instructionType":{"$ref":"#/components/schemas/QueryIraContributionsResultInstructionType"},"instructionStatus":{"$ref":"#/components/schemas/QueryIraContributionsResultInstructionStatus"},"instructionId":{"type":"number","format":"double"},"ibReferenceId":{"type":"number","format":"double"},"description":{"type":"string"},"error":{"$ref":"#/components/schemas/QueryIraContributionsResultError"},"processedTimestamp":{"type":"string","format":"date-time"},"accountId":{"type":"string"},"year":{"type":"string"},"iraType":{"type":"string"},"contributions":{"type":"array","items":{"$ref":"#/components/schemas/QueryIraContributionsResultContributionsItems"}}},"required":["clientInstructionId","instructionType","instructionStatus","instructionId","accountId","year","iraType","contributions"],"title":"QueryIRAContributionsResult"},"QueryIRAContributionsResponse":{"type":"object","properties":{"status":{"type":"number","format":"double"},"instructionSetId":{"type":"number","format":"double"},"instructionResult":{"$ref":"#/components/schemas/QueryIRAContributionsResult"}},"required":["status","instructionSetId"],"title":"QueryIRAContributionsResponse"},"Account Management Banking_getClientInstructions_Response_200":{"oneOf":[{"$ref":"#/components/schemas/InstructionPollingResponse"},{"$ref":"#/components/schemas/InstructionResponse"},{"$ref":"#/components/schemas/QueryRecentInstructionResponse"},{"$ref":"#/components/schemas/DepositFundsPollingResponse"},{"$ref":"#/components/schemas/QueryIRAContributionsResponse"}],"title":"Account Management Banking_getClientInstructions_Response_200"},"NoSuchInstructionResponse":{"type":"object","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer","format":"int64"},"detail":{"type":"string"}},"required":["type","title","status"],"title":"NoSuchInstructionResponse"},"Account Management Banking_getInstructions_Response_200":{"oneOf":[{"$ref":"#/components/schemas/InstructionPollingResponse"},{"$ref":"#/components/schemas/InstructionResponse"},{"$ref":"#/components/schemas/QueryRecentInstructionResponse"},{"$ref":"#/components/schemas/DepositFundsPollingResponse"},{"$ref":"#/components/schemas/QueryIRAContributionsResponse"}],"title":"Account Management Banking_getInstructions_Response_200"},"BulkMultiStatusResponse":{"type":"object","properties":{"status":{"type":"integer","format":"int64"},"instructionSetId":{"type":"number","format":"double"},"instructionResults":{"type":"array","items":{"description":"Any type"}}},"required":["status","instructionSetId"],"title":"BulkMultiStatusResponse"},"NoSuchInstructionSetResponse":{"type":"object","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer","format":"int64"},"detail":{"type":"string"},"instructionSetId":{"type":"integer","format":"int64"}},"required":["type","title","status","instructionSetId"],"title":"NoSuchInstructionSetResponse"},"GwApiV1InstructionsQueryPostRequestBodyContentApplicationJsonSchemaInstructionType":{"type":"string","enum":["QUERY_RECENT_INSTRUCTIONS"],"title":"GwApiV1InstructionsQueryPostRequestBodyContentApplicationJsonSchemaInstructionType"},"QueryRecentInstructionsTransactionHistoryTransactionType":{"type":"string","enum":["ALL","ACH_INSTRUCTION","PREDEFINED_DESTINATION_INSTRUCTION","WITHDRAWAL","DEPOSIT","DWAC","FOP","EDDA_INSTRUCTION","TRADITIONAL_BANK_INSTRUCTION_VERIFICATION","CANCEL_INSTRUCTION","DELETE_BANK_INSTRUCTION","EXTERNAL_POSITION_TRANSFER","INTERNAL_CASH_TRANSFER","INTERNAL_POSITION_TRANSFER","COMPLEX_ASSET_TRANSFER"],"title":"QueryRecentInstructionsTransactionHistoryTransactionType"},"QueryRecentInstructionsTransactionHistory":{"type":"object","properties":{"daysToGoBack":{"type":"number","format":"double","minimum":1},"transactionType":{"$ref":"#/components/schemas/QueryRecentInstructionsTransactionHistoryTransactionType"}},"required":["daysToGoBack"],"title":"QueryRecentInstructionsTransactionHistory"},"QueryRecentInstructions":{"type":"object","properties":{"clientInstructionId":{"type":"number","format":"double"},"accountId":{"type":"string"},"transactionHistory":{"$ref":"#/components/schemas/QueryRecentInstructionsTransactionHistory"}},"required":["clientInstructionId","accountId","transactionHistory"],"title":"QueryRecentInstructions"},"AsynchronousInstructionResponse":{"type":"object","properties":{"status":{"type":"number","format":"double"},"instructionSetId":{"type":"number","format":"double"},"instructionResult":{"$ref":"#/components/schemas/InstructionResult"}},"required":["status","instructionSetId"],"title":"AsynchronousInstructionResponse"},"GwApiV1BankInstructionsPostRequestBodyContentApplicationJsonSchemaInstructionType":{"type":"string","enum":["ACH_INSTRUCTION","OPEN_BANKING_INSTRUCTION","WITHDRAWAL_INSTRUCTION","TRADITIONAL_BANK_INSTRUCTION_VERIFICATION","DELETE_BANK_INSTRUCTION","PREDEFINED_DESTINATION_INSTRUCTION","EDDA_INSTRUCTION"],"title":"GwApiV1BankInstructionsPostRequestBodyContentApplicationJsonSchemaInstructionType"},"TraditionalBankInstructionVerificationBankInstructionCode":{"type":"string","enum":["USACH","CAACH","ACHUS","WIRE"],"title":"TraditionalBankInstructionVerificationBankInstructionCode"},"TraditionalBankInstructionVerification":{"type":"object","properties":{"clientInstructionId":{"type":"number","format":"double"},"bankInstructionCode":{"$ref":"#/components/schemas/TraditionalBankInstructionVerificationBankInstructionCode"},"bankInstructionName":{"type":"string","minLength":1,"maxLength":100},"accountId":{"type":"string","minLength":1,"maxLength":32},"pendingInstructionId":{"type":"number","format":"double"},"creditAmount1":{"type":"number","format":"double"},"creditAmount2":{"type":"number","format":"double"}},"required":["clientInstructionId","bankInstructionCode","bankInstructionName","accountId","pendingInstructionId","creditAmount1","creditAmount2"],"title":"TraditionalBankInstructionVerification"},"AchInstructionBankInstructionCode":{"type":"string","enum":["CAACH","USACH"],"title":"AchInstructionBankInstructionCode"},"AchInstructionAchType":{"type":"string","enum":["DEBIT","CREDIT","DEBIT_CREDIT"],"title":"AchInstructionAchType"},"AchInstructionClientAccountInfoBankAccountTypeCode":{"type":"string","enum":["0","1","2"],"title":"AchInstructionClientAccountInfoBankAccountTypeCode"},"AchInstructionClientAccountInfo":{"type":"object","properties":{"bankRoutingNumber":{"type":"string","minLength":1,"maxLength":24},"bankAccountNumber":{"type":"string","minLength":1,"maxLength":32},"bankName":{"type":"string","minLength":1,"maxLength":100},"bankAccountTypeCode":{"$ref":"#/components/schemas/AchInstructionClientAccountInfoBankAccountTypeCode"}},"required":["bankRoutingNumber","bankAccountNumber","bankName","bankAccountTypeCode"],"title":"AchInstructionClientAccountInfo"},"AchInstruction":{"type":"object","properties":{"clientInstructionId":{"type":"number","format":"double"},"bankInstructionCode":{"$ref":"#/components/schemas/AchInstructionBankInstructionCode"},"achType":{"$ref":"#/components/schemas/AchInstructionAchType"},"bankInstructionName":{"type":"string","minLength":1,"maxLength":100},"currency":{"type":"string","minLength":1,"maxLength":3},"accountId":{"type":"string","minLength":1,"maxLength":32},"clientAccountInfo":{"$ref":"#/components/schemas/AchInstructionClientAccountInfo"}},"required":["clientInstructionId","bankInstructionCode","achType","bankInstructionName","currency","accountId","clientAccountInfo"],"title":"AchInstruction"},"OpenBankingInstructionServiceProvider":{"type":"string","enum":["PLAID"],"title":"OpenBankingInstructionServiceProvider"},"OpenBankingInstructionPlaidOptions":{"type":"object","properties":{"completionRedirectUri":{"type":"string","minLength":0,"description":"This should be a URI with a custom scheme and this can be any value you'd like, as long as it isn't a reserved one such as http or tel. By convention, it's often one associated with the name of your application."},"linkDisplayName":{"type":"string","description":"Client Name displayed on Plaid Link UI"},"isMobileApp":{"type":"boolean"}},"title":"OpenBankingInstructionPlaidOptions"},"OpenBankingInstruction":{"type":"object","properties":{"clientInstructionId":{"type":"number","format":"double"},"currency":{"type":"string","minLength":1,"maxLength":3},"accountId":{"type":"string","minLength":1,"maxLength":32},"serviceProvider":{"$ref":"#/components/schemas/OpenBankingInstructionServiceProvider"},"plaidOptions":{"$ref":"#/components/schemas/OpenBankingInstructionPlaidOptions"}},"required":["clientInstructionId","currency","accountId","serviceProvider"],"title":"OpenBankingInstruction"},"WithdrawalBankInstructionSourceDepositInstructionType":{"type":"string","enum":["OPEN_BANKING"],"title":"WithdrawalBankInstructionSourceDepositInstructionType"},"WithdrawalBankInstructionSourceDepositInstruction":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100},"type":{"$ref":"#/components/schemas/WithdrawalBankInstructionSourceDepositInstructionType"},"ibReferenceId":{"type":"number","format":"double"}},"required":["type"],"title":"WithdrawalBankInstructionSourceDepositInstruction"},"WithdrawalBankInstruction":{"type":"object","properties":{"clientInstructionId":{"type":"number","format":"double"},"currency":{"type":"string","minLength":1,"maxLength":3},"accountId":{"type":"string","minLength":1,"maxLength":32},"sourceDepositInstruction":{"$ref":"#/components/schemas/WithdrawalBankInstructionSourceDepositInstruction"}},"required":["clientInstructionId","currency","accountId","sourceDepositInstruction"],"title":"WithdrawalBankInstruction"},"DeleteBankInstructionBankInstructionMethod":{"type":"string","enum":["WIRE","ACH"],"title":"DeleteBankInstructionBankInstructionMethod"},"DeleteBankInstruction":{"type":"object","properties":{"clientInstructionId":{"type":"number","format":"double"},"accountId":{"type":"string","minLength":1,"maxLength":32},"bankInstructionName":{"type":"string","minLength":1,"maxLength":150},"bankInstructionMethod":{"$ref":"#/components/schemas/DeleteBankInstructionBankInstructionMethod"},"currency":{"type":"string","minLength":1,"maxLength":3}},"required":["clientInstructionId","accountId","bankInstructionName","bankInstructionMethod","currency"],"title":"DeleteBankInstruction"},"PredefinedDestinationInstructionBankInstructionMethod":{"type":"string","enum":["LVP","SEPA","WIRE","ACH","CPA"],"title":"PredefinedDestinationInstructionBankInstructionMethod"},"PredefinedDestinationInstructionFinancialInstitutionBranchCodeType":{"type":"string","enum":["BSB_AUD","BANK_CODE_CAD","NONE"],"title":"PredefinedDestinationInstructionFinancialInstitutionBranchCodeType"},"PredefinedDestinationInstructionFinancialInstitutionIdentifierType":{"type":"string","enum":["BIC","IFSC"],"title":"PredefinedDestinationInstructionFinancialInstitutionIdentifierType"},"PredefinedDestinationInstructionFinancialInstitution":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100},"branchCode":{"type":"string","minLength":0,"maxLength":32},"branchCodeType":{"$ref":"#/components/schemas/PredefinedDestinationInstructionFinancialInstitutionBranchCodeType"},"identifier":{"type":"string","minLength":1,"maxLength":24},"identifierType":{"$ref":"#/components/schemas/PredefinedDestinationInstructionFinancialInstitutionIdentifierType"},"clientAccountId":{"type":"string","minLength":1,"maxLength":32}},"required":["name","identifier","identifierType","clientAccountId"],"title":"PredefinedDestinationInstructionFinancialInstitution"},"PredefinedDestinationInstruction":{"type":"object","properties":{"clientInstructionId":{"type":"number","format":"double"},"bankInstructionName":{"type":"string","minLength":1,"maxLength":100},"bankInstructionMethod":{"$ref":"#/components/schemas/PredefinedDestinationInstructionBankInstructionMethod"},"accountId":{"type":"string","minLength":1,"maxLength":10},"currency":{"type":"string","minLength":3,"maxLength":3},"financialInstitution":{"$ref":"#/components/schemas/PredefinedDestinationInstructionFinancialInstitution"}},"required":["clientInstructionId","bankInstructionName","bankInstructionMethod","accountId","currency","financialInstitution"],"title":"PredefinedDestinationInstruction"},"EddaInstructionDebtorIdentificationDocumentType":{"type":"string","enum":["hkId","passport","chinaId","hkMacaoEntryPermit"],"title":"EddaInstructionDebtorIdentificationDocumentType"},"EddaInstruction":{"type":"object","properties":{"clientInstructionId":{"type":"number","format":"double"},"bankInstructionName":{"type":"string","minLength":1,"maxLength":100},"currency":{"type":"string","minLength":1,"maxLength":3},"accountId":{"type":"string","minLength":1,"maxLength":32},"bankBranchCode":{"type":"string","minLength":1,"maxLength":3},"bankAccountNumber":{"type":"string","minLength":1,"maxLength":32},"bankClearingCode":{"type":"string","minLength":1,"maxLength":3},"debtorIdentificationDocumentType":{"$ref":"#/components/schemas/EddaInstructionDebtorIdentificationDocumentType"}},"required":["clientInstructionId","bankInstructionName","currency","accountId","bankBranchCode","bankAccountNumber","bankClearingCode","debtorIdentificationDocumentType"],"title":"EddaInstruction"},"GwApiV1BankInstructionsPostRequestBodyContentApplicationJsonSchemaInstruction":{"oneOf":[{"$ref":"#/components/schemas/TraditionalBankInstructionVerification"},{"$ref":"#/components/schemas/AchInstruction"},{"$ref":"#/components/schemas/OpenBankingInstruction"},{"$ref":"#/components/schemas/WithdrawalBankInstruction"},{"$ref":"#/components/schemas/DeleteBankInstruction"},{"$ref":"#/components/schemas/PredefinedDestinationInstruction"},{"$ref":"#/components/schemas/EddaInstruction"}],"title":"GwApiV1BankInstructionsPostRequestBodyContentApplicationJsonSchemaInstruction"},"GwApiV1ExternalCashTransfersPostRequestBodyContentApplicationJsonSchemaInstructionType":{"type":"string","enum":["DEPOSIT","WITHDRAWAL"],"title":"GwApiV1ExternalCashTransfersPostRequestBodyContentApplicationJsonSchemaInstructionType"},"DepositFundsInstructionBankInstructionMethod":{"type":"string","enum":["ACH","WIRE","eDDA","OPEN_BANKING"],"title":"DepositFundsInstructionBankInstructionMethod"},"DepositFundsInstructionOpenBankingServiceProvider":{"type":"string","enum":["PLAID"],"title":"DepositFundsInstructionOpenBankingServiceProvider"},"DepositFundsInstructionOpenBankingPlaidOptions":{"type":"object","properties":{"completionRedirectUri":{"type":"string","minLength":0,"description":"This should be a URI with a custom scheme and this can be any value you'd like, as long as it isn't a reserved one such as http or tel. By convention, it's often one associated with the name of your application."},"linkDisplayName":{"type":"string","description":"Client Name displayed on Plaid Link UI"},"isMobileApp":{"type":"boolean"}},"title":"DepositFundsInstructionOpenBankingPlaidOptions"},"DepositFundsInstructionOpenBanking":{"type":"object","properties":{"serviceProvider":{"$ref":"#/components/schemas/DepositFundsInstructionOpenBankingServiceProvider"},"plaidOptions":{"$ref":"#/components/schemas/DepositFundsInstructionOpenBankingPlaidOptions"}},"required":["serviceProvider"],"title":"DepositFundsInstructionOpenBanking"},"DepositFundsInstructionIraDepositDetailIraContributionType":{"type":"string","enum":["ROLLOVER","LATE_ROLLOVER","DIRECT_ROLLOVER","CONTRIBUTION","SPOUSAL_CONTRIBUTION","EMPLOYER_SEP_CONTRIBUTION"],"title":"DepositFundsInstructionIraDepositDetailIraContributionType"},"DepositFundsInstructionIraDepositDetailIraTaxYearType":{"type":"string","enum":["CURRENT","PRIOR"],"title":"DepositFundsInstructionIraDepositDetailIraTaxYearType"},"DepositFundsInstructionIraDepositDetailFromIraType":{"type":"string","enum":["NONE","TRADITIONAL","ROLLOVER","ROTH","SEP","EDUCATION","TRADITIONAL_INHERITED","ROTH_INHERITED","SEP_INHERITED","RETIREMENT_SAVING_PLAN","SPOUSAL_RETIREMENT_SAVING_PLAN","TAX_FREE_SAVING_ACCOUNT"],"title":"DepositFundsInstructionIraDepositDetailFromIraType"},"DepositFundsInstructionIraDepositDetail":{"type":"object","properties":{"iraContributionType":{"$ref":"#/components/schemas/DepositFundsInstructionIraDepositDetailIraContributionType"},"iraTaxYearType":{"$ref":"#/components/schemas/DepositFundsInstructionIraDepositDetailIraTaxYearType"},"fromIraType":{"$ref":"#/components/schemas/DepositFundsInstructionIraDepositDetailFromIraType"}},"required":["iraContributionType","iraTaxYearType","fromIraType"],"title":"DepositFundsInstructionIraDepositDetail"},"RecurringInstructionDetailRefFrequency":{"type":"string","enum":["MONTHLY","QUARTERLY","YEARLY"],"title":"RecurringInstructionDetailRefFrequency"},"RecurringInstructionDetailRef":{"type":"object","properties":{"instructionName":{"type":"string","minLength":1,"maxLength":64},"frequency":{"$ref":"#/components/schemas/RecurringInstructionDetailRefFrequency"},"startDate":{"type":"string"},"endDate":{"type":"string"}},"required":["instructionName","frequency","startDate"],"title":"RecurringInstructionDetailRef"},"DepositFundsInstruction":{"type":"object","properties":{"clientInstructionId":{"type":"number","format":"double"},"accountId":{"type":"string","minLength":1,"maxLength":32},"currency":{"type":"string","minLength":1,"maxLength":3},"amount":{"type":"number","format":"double","multipleOf":0.01},"bankInstructionMethod":{"$ref":"#/components/schemas/DepositFundsInstructionBankInstructionMethod"},"openBanking":{"$ref":"#/components/schemas/DepositFundsInstructionOpenBanking"},"sendingInstitution":{"type":"string","minLength":0,"maxLength":128},"identifier":{"type":"string","minLength":0,"maxLength":64,"description":"Represents the remitter's bank account number. This field is mandatory for WIRE deposits with following currencies: ILS, AED, AUD, and INR."},"specialInstruction":{"type":"string","minLength":0,"maxLength":128},"bankInstructionName":{"type":"string","minLength":0,"maxLength":150},"senderInstitutionName":{"type":"string","minLength":0,"maxLength":128},"iraDepositDetail":{"$ref":"#/components/schemas/DepositFundsInstructionIraDepositDetail"},"recurringInstructionDetail":{"$ref":"#/components/schemas/RecurringInstructionDetailRef"}},"required":["clientInstructionId","accountId","currency","amount","bankInstructionMethod"],"title":"DepositFundsInstruction"},"WithdrawFundsInstructionBankInstructionMethod":{"type":"string","enum":["ACH","WIRE","SEPA"],"title":"WithdrawFundsInstructionBankInstructionMethod"},"WithdrawFundsInstructionIraWithdrawalDetailIraWithholdType":{"type":"string","enum":["DIRECT_ROLLOVER","ROTH_DISTRIBUTION","NORMAL","EARLY","DEATH","EXCESS_CY","EXCESS_PY","EXCESS_SC"],"title":"WithdrawFundsInstructionIraWithdrawalDetailIraWithholdType"},"WithdrawFundsInstructionIraWithdrawalDetail":{"type":"object","properties":{"fedIncomeTaxPercentage":{"type":"number","format":"double"},"stateIncomeTaxPercentage":{"type":"number","format":"double"},"stateCd":{"type":"string","minLength":1,"maxLength":2},"iraWithholdType":{"$ref":"#/components/schemas/WithdrawFundsInstructionIraWithdrawalDetailIraWithholdType"}},"required":["fedIncomeTaxPercentage","stateIncomeTaxPercentage","stateCd","iraWithholdType"],"title":"WithdrawFundsInstructionIraWithdrawalDetail"},"WithdrawFundsInstruction":{"type":"object","properties":{"clientInstructionId":{"type":"number","format":"double"},"accountId":{"type":"string","minLength":1,"maxLength":32},"currency":{"type":"string","minLength":1,"maxLength":3},"amount":{"type":"number","format":"double","multipleOf":0.01},"bankInstructionName":{"type":"string","minLength":1,"maxLength":150},"bankInstructionMethod":{"$ref":"#/components/schemas/WithdrawFundsInstructionBankInstructionMethod"},"dateTimeToOccur":{"type":"string","format":"date-time"},"iraWithdrawalDetail":{"$ref":"#/components/schemas/WithdrawFundsInstructionIraWithdrawalDetail"},"recurringInstructionDetail":{"$ref":"#/components/schemas/RecurringInstructionDetailRef"}},"required":["clientInstructionId","accountId","currency","amount","bankInstructionName","bankInstructionMethod"],"title":"WithdrawFundsInstruction"},"GwApiV1ExternalCashTransfersPostRequestBodyContentApplicationJsonSchemaInstruction":{"oneOf":[{"$ref":"#/components/schemas/DepositFundsInstruction"},{"$ref":"#/components/schemas/WithdrawFundsInstruction"}],"title":"GwApiV1ExternalCashTransfersPostRequestBodyContentApplicationJsonSchemaInstruction"},"GwApiV1InternalCashTransfersPostRequestBodyContentApplicationJsonSchemaInstructionType":{"type":"string","enum":["INTERNAL_CASH_TRANSFER"],"title":"GwApiV1InternalCashTransfersPostRequestBodyContentApplicationJsonSchemaInstructionType"},"InternalCashTransferInstruction":{"type":"object","properties":{"clientInstructionId":{"type":"number","format":"double"},"sourceAccountId":{"type":"string","minLength":1,"maxLength":32},"targetAccountId":{"type":"string","minLength":1,"maxLength":32},"amount":{"type":"number","format":"double","multipleOf":0.01},"currency":{"type":"string","minLength":1,"maxLength":3},"clientNote":{"type":"string","minLength":1,"maxLength":64},"dateTimeToOccur":{"type":"string","format":"date-time"}},"required":["clientInstructionId","sourceAccountId","targetAccountId","amount","currency"],"title":"InternalCashTransferInstruction"},"GwApiV1ExternalAssetTransfersPostRequestBodyContentApplicationJsonSchemaInstructionType":{"type":"string","enum":["DWAC","FOP","COMPLEX_ASSET_TRANSFER","EXTERNAL_POSITION_TRANSFER","ISA_TRANSFER"],"title":"GwApiV1ExternalAssetTransfersPostRequestBodyContentApplicationJsonSchemaInstructionType"},"FopInstructionDirection":{"type":"string","enum":["IN","OUT"],"title":"FopInstructionDirection"},"TradingInstrumentRef0":{"type":"object","properties":{"conid":{"type":"number","format":"double"}},"required":["conid"],"title":"TradingInstrumentRef0"},"TradingInstrumentRefOneOf1TradingInstrumentDescriptionSecurityIdType":{"type":"string","enum":["CUSIP","ISIN","CASH"],"title":"TradingInstrumentRefOneOf1TradingInstrumentDescriptionSecurityIdType"},"TradingInstrumentRefOneOf1TradingInstrumentDescriptionAssetType":{"type":"string","enum":["STK","CASH","UNKNOWN","BILL","BOND","FUND","OPT","WAR"],"title":"TradingInstrumentRefOneOf1TradingInstrumentDescriptionAssetType"},"TradingInstrumentRefOneOf1TradingInstrumentDescription":{"type":"object","properties":{"securityIdType":{"$ref":"#/components/schemas/TradingInstrumentRefOneOf1TradingInstrumentDescriptionSecurityIdType"},"securityId":{"type":"string"},"assetType":{"$ref":"#/components/schemas/TradingInstrumentRefOneOf1TradingInstrumentDescriptionAssetType"}},"required":["securityIdType","securityId","assetType"],"title":"TradingInstrumentRefOneOf1TradingInstrumentDescription"},"TradingInstrumentRef1":{"type":"object","properties":{"tradingInstrumentDescription":{"$ref":"#/components/schemas/TradingInstrumentRefOneOf1TradingInstrumentDescription"}},"required":["tradingInstrumentDescription"],"title":"TradingInstrumentRef1"},"TradingInstrumentRef":{"oneOf":[{"$ref":"#/components/schemas/TradingInstrumentRef0"},{"$ref":"#/components/schemas/TradingInstrumentRef1"}],"title":"TradingInstrumentRef"},"FopInstruction":{"type":"object","properties":{"clientInstructionId":{"type":"number","format":"double"},"direction":{"$ref":"#/components/schemas/FopInstructionDirection"},"accountId":{"type":"string","minLength":1,"maxLength":32},"contraBrokerAccountId":{"type":"string","minLength":1,"maxLength":20},"contraBrokerDtcCode":{"type":"string","minLength":1,"maxLength":20},"quantity":{"type":"number","format":"double"},"tradingInstrument":{"$ref":"#/components/schemas/TradingInstrumentRef"}},"required":["clientInstructionId","direction","accountId","contraBrokerAccountId","contraBrokerDtcCode","quantity","tradingInstrument"],"title":"FopInstruction"},"DwacInstructionDirection":{"type":"string","enum":["IN"],"title":"DwacInstructionDirection"},"DwacInstruction":{"type":"object","properties":{"clientInstructionId":{"type":"number","format":"double"},"direction":{"$ref":"#/components/schemas/DwacInstructionDirection"},"accountId":{"type":"string","minLength":1,"maxLength":32},"contraBrokerAccountId":{"type":"string","minLength":1,"maxLength":20},"contraBrokerTaxId":{"type":"string","minLength":1,"maxLength":25},"quantity":{"type":"number","format":"double"},"tradingInstrument":{"$ref":"#/components/schemas/TradingInstrumentRef"},"accountTitle":{"type":"string","minLength":0,"maxLength":140},"referenceId":{"type":"string","minLength":0,"maxLength":20}},"required":["clientInstructionId","direction","accountId","contraBrokerAccountId","contraBrokerTaxId","quantity","tradingInstrument"],"title":"DwacInstruction"},"ComplexAssetTransferInstructionDirection":{"type":"string","enum":["IN","OUT"],"title":"ComplexAssetTransferInstructionDirection"},"ContraBrokerInfoRef":{"type":"object","properties":{"accountType":{"type":"string","minLength":1,"maxLength":32},"brokerName":{"type":"string","minLength":1,"maxLength":128},"depositoryId":{"type":"string","minLength":1,"maxLength":64},"brokerAccountId":{"type":"string","minLength":1,"maxLength":64},"country":{"type":"string","minLength":1,"maxLength":64},"contactName":{"type":"string","minLength":1,"maxLength":64},"contactEmail":{"type":"string","minLength":1,"maxLength":64},"contactPhone":{"type":"string","minLength":1,"maxLength":16},"accountTitle":{"type":"string","minLength":1,"maxLength":128}},"required":["accountType","brokerName","brokerAccountId","country","contactEmail","contactPhone"],"title":"ContraBrokerInfoRef"},"NonDisclosedDetailRef":{"type":"object","properties":{"tradeDate":{"type":"string"},"settleDate":{"type":"string"},"psetBic":{"type":"string","minLength":0,"maxLength":64},"reagDeagBic":{"type":"string","minLength":0,"maxLength":64},"buyerSellBic":{"type":"string","minLength":0,"maxLength":64},"memberAccountId":{"type":"string","minLength":0,"maxLength":64},"safeKeepingAccountId":{"type":"string","minLength":0,"maxLength":64}},"required":["tradeDate","settleDate"],"title":"NonDisclosedDetailRef"},"ComplexAssetTransferInstruction":{"type":"object","properties":{"clientInstructionId":{"type":"number","format":"double"},"direction":{"$ref":"#/components/schemas/ComplexAssetTransferInstructionDirection"},"accountId":{"type":"string","minLength":1,"maxLength":32},"accountIdAtCurrentBroker":{"type":"string","minLength":1,"maxLength":64},"quantity":{"type":"number","format":"double"},"tradingInstrument":{"$ref":"#/components/schemas/TradingInstrumentRef"},"contraBrokerInfo":{"$ref":"#/components/schemas/ContraBrokerInfoRef"},"nonDisclosedDetail":{"$ref":"#/components/schemas/NonDisclosedDetailRef"}},"required":["clientInstructionId","direction","accountId","quantity","tradingInstrument","contraBrokerInfo"],"title":"ComplexAssetTransferInstruction"},"ExternalPositionTransferType":{"type":"string","enum":["FULL"],"title":"ExternalPositionTransferType"},"ExternalPositionTransferSubType":{"type":"string","enum":["ACATS","ATON"],"title":"ExternalPositionTransferSubType"},"ExternalPositionTransferSourceIraType":{"type":"string","enum":["RO","RI","RT","SP","ED","TH","RH","SH"],"title":"ExternalPositionTransferSourceIraType"},"ExternalPositionTransfer":{"type":"object","properties":{"clientInstructionId":{"type":"number","format":"double"},"type":{"$ref":"#/components/schemas/ExternalPositionTransferType"},"subType":{"$ref":"#/components/schemas/ExternalPositionTransferSubType"},"brokerId":{"type":"string","minLength":1,"maxLength":20},"brokerName":{"type":"string","minLength":1,"maxLength":256},"accountAtBroker":{"type":"string","minLength":1,"maxLength":34},"sourceIRAType":{"$ref":"#/components/schemas/ExternalPositionTransferSourceIraType"},"accountId":{"type":"string","minLength":1,"maxLength":32},"signature":{"type":"string","minLength":1,"maxLength":140}},"required":["clientInstructionId","type","subType","brokerId","brokerName","accountAtBroker","accountId","signature"],"title":"ExternalPositionTransfer"},"IsaTransferInstruction":{"type":"object","properties":{"clientInstructionId":{"type":"number","format":"double"},"accountId":{"type":"string","minLength":1,"maxLength":32},"providerName":{"type":"string","minLength":1,"maxLength":128},"accountAtProvider":{"type":"string","minLength":1,"maxLength":64},"totalAmountTransferredInGBP":{"type":"number","format":"double","minimum":0},"authorizationType":{"type":"string"},"signature":{"type":"string","minLength":1,"maxLength":128}},"required":["clientInstructionId","accountId","providerName","accountAtProvider","totalAmountTransferredInGBP","authorizationType","signature"],"title":"IsaTransferInstruction"},"GwApiV1ExternalAssetTransfersPostRequestBodyContentApplicationJsonSchemaInstruction":{"oneOf":[{"$ref":"#/components/schemas/FopInstruction"},{"$ref":"#/components/schemas/DwacInstruction"},{"$ref":"#/components/schemas/ComplexAssetTransferInstruction"},{"$ref":"#/components/schemas/ExternalPositionTransfer"},{"$ref":"#/components/schemas/IsaTransferInstruction"}],"title":"GwApiV1ExternalAssetTransfersPostRequestBodyContentApplicationJsonSchemaInstruction"},"GwApiV2ExternalAssetTransfersPostRequestBodyContentApplicationJsonSchemaInstructionType":{"type":"string","enum":["DWAC","FOP","COMPLEX_ASSET_TRANSFER"],"title":"GwApiV2ExternalAssetTransfersPostRequestBodyContentApplicationJsonSchemaInstructionType"},"FopInstructionV2Direction":{"type":"string","enum":["IN","OUT"],"title":"FopInstructionV2Direction"},"TradingInstrumentV20":{"type":"object","properties":{"conid":{"type":"number","format":"double"}},"required":["conid"],"title":"TradingInstrumentV20"},"TradingInstrumentV2OneOf1TradingInstrumentDescriptionSecurityIdType":{"type":"string","enum":["CUSIP","ISIN","CASH"],"title":"TradingInstrumentV2OneOf1TradingInstrumentDescriptionSecurityIdType"},"TradingInstrumentV2OneOf1TradingInstrumentDescriptionAssetType":{"type":"string","enum":["STK","CASH","UNKNOWN","BILL","BOND","FUND","OPT","WAR"],"title":"TradingInstrumentV2OneOf1TradingInstrumentDescriptionAssetType"},"TradingInstrumentV2OneOf1TradingInstrumentDescription":{"type":"object","properties":{"securityIdType":{"$ref":"#/components/schemas/TradingInstrumentV2OneOf1TradingInstrumentDescriptionSecurityIdType"},"securityId":{"type":"string"},"assetType":{"$ref":"#/components/schemas/TradingInstrumentV2OneOf1TradingInstrumentDescriptionAssetType"}},"required":["securityIdType","securityId","assetType"],"title":"TradingInstrumentV2OneOf1TradingInstrumentDescription"},"TradingInstrumentV21":{"type":"object","properties":{"tradingInstrumentDescription":{"$ref":"#/components/schemas/TradingInstrumentV2OneOf1TradingInstrumentDescription"}},"required":["tradingInstrumentDescription"],"title":"TradingInstrumentV21"},"TradingInstrumentV2":{"oneOf":[{"$ref":"#/components/schemas/TradingInstrumentV20"},{"$ref":"#/components/schemas/TradingInstrumentV21"}],"title":"TradingInstrumentV2"},"FopInstructionV2":{"type":"object","properties":{"clientInstructionId":{"type":"number","format":"double"},"direction":{"$ref":"#/components/schemas/FopInstructionV2Direction"},"accountId":{"type":"string","minLength":1,"maxLength":32},"contraBrokerAccountId":{"type":"string","minLength":1,"maxLength":20},"contraBrokerDtcCode":{"type":"string","minLength":1,"maxLength":20},"currency":{"type":"string","minLength":1,"maxLength":3},"positions":{"type":"array","items":{"$ref":"#/components/schemas/TradingInstrumentV2"}}},"required":["clientInstructionId","direction","accountId","contraBrokerAccountId","contraBrokerDtcCode","currency","positions"],"title":"FopInstructionV2"},"DwacInstructionV2Direction":{"type":"string","enum":["IN"],"title":"DwacInstructionV2Direction"},"DwacInstructionV2":{"type":"object","properties":{"clientInstructionId":{"type":"number","format":"double"},"direction":{"$ref":"#/components/schemas/DwacInstructionV2Direction"},"accountId":{"type":"string","minLength":1,"maxLength":32},"contraBrokerAccountId":{"type":"string","minLength":1,"maxLength":20},"contraBrokerTaxId":{"type":"string","minLength":1,"maxLength":25},"currency":{"type":"string","minLength":1,"maxLength":3},"positions":{"type":"array","items":{"$ref":"#/components/schemas/TradingInstrumentV2"}},"accountTitle":{"type":"string","minLength":0,"maxLength":140},"referenceId":{"type":"string","minLength":0,"maxLength":20}},"required":["clientInstructionId","direction","accountId","contraBrokerAccountId","contraBrokerTaxId","currency","positions"],"title":"DwacInstructionV2"},"ComplexAssetTransferInstructionV2Direction":{"type":"string","enum":["IN","OUT"],"title":"ComplexAssetTransferInstructionV2Direction"},"ComplexAssetTransferInstructionV2":{"type":"object","properties":{"clientInstructionId":{"type":"number","format":"double"},"direction":{"$ref":"#/components/schemas/ComplexAssetTransferInstructionV2Direction"},"accountId":{"type":"string","minLength":1,"maxLength":32},"accountIdAtCurrentBroker":{"type":"string","minLength":1,"maxLength":64},"currency":{"type":"string","minLength":1,"maxLength":3},"positions":{"type":"array","items":{"$ref":"#/components/schemas/TradingInstrumentV2"}},"contraBrokerInfo":{"$ref":"#/components/schemas/ContraBrokerInfoRef"},"nonDisclosedDetail":{"$ref":"#/components/schemas/NonDisclosedDetailRef"}},"required":["clientInstructionId","direction","accountId","currency","positions","contraBrokerInfo"],"title":"ComplexAssetTransferInstructionV2"},"GwApiV2ExternalAssetTransfersPostRequestBodyContentApplicationJsonSchemaInstruction":{"oneOf":[{"$ref":"#/components/schemas/FopInstructionV2"},{"$ref":"#/components/schemas/DwacInstructionV2"},{"$ref":"#/components/schemas/ComplexAssetTransferInstructionV2"}],"title":"GwApiV2ExternalAssetTransfersPostRequestBodyContentApplicationJsonSchemaInstruction"},"GwApiV1InternalAssetTransfersPostRequestBodyContentApplicationJsonSchemaInstructionType":{"type":"string","enum":["INTERNAL_POSITION_TRANSFER"],"title":"GwApiV1InternalAssetTransfersPostRequestBodyContentApplicationJsonSchemaInstructionType"},"InternalPositionTransferInstruction":{"type":"object","properties":{"clientInstructionId":{"type":"number","format":"double"},"sourceAccountId":{"type":"string","minLength":1},"targetAccountId":{"type":"string","minLength":1},"transferQuantity":{"type":"number","format":"double"},"tradingInstrument":{"$ref":"#/components/schemas/TradingInstrumentRef"},"transferPrice":{"type":"number","format":"double","multipleOf":1e-9,"description":"If transferPrice is provided then tradeDate and settleDate are also required"},"tradeDate":{"type":"string","description":"If tradeDate is provided then settleDate is also required"},"settleDate":{"type":"string","description":"If settleDate is provided then tradeDate is also required"}},"required":["clientInstructionId","sourceAccountId","targetAccountId","transferQuantity","tradingInstrument"],"title":"InternalPositionTransferInstruction"},"GwApiV1BankInstructionsQueryPostRequestBodyContentApplicationJsonSchemaInstructionType":{"type":"string","enum":["QUERY_BANK_INSTRUCTION","QUERY_RECENT_RECURRING_EVENTS","QUERY_RECURRING_INSTRUCTIONS"],"title":"GwApiV1BankInstructionsQueryPostRequestBodyContentApplicationJsonSchemaInstructionType"},"QueryBankInstructionBankInstructionMethod":{"type":"string","enum":["ACH","WIRE","USACH","CAACH","SEPA","eDDA","eGIRO","OPEN_BANKING"],"title":"QueryBankInstructionBankInstructionMethod"},"QueryBankInstruction":{"type":"object","properties":{"clientInstructionId":{"type":"number","format":"double"},"accountId":{"type":"string","minLength":1},"bankInstructionMethod":{"$ref":"#/components/schemas/QueryBankInstructionBankInstructionMethod"}},"required":["clientInstructionId","accountId","bankInstructionMethod"],"title":"QueryBankInstruction"},"QueryRecentRecurringEvents":{"type":"object","properties":{"clientInstructionId":{"type":"number","format":"double"},"ibReferenceId":{"type":"number","format":"double","minimum":0},"numberOfTransactions":{"type":"number","format":"double","minimum":1}},"required":["clientInstructionId","ibReferenceId"],"title":"QueryRecentRecurringEvents"},"QueryRecurringInstructions":{"type":"object","properties":{"clientInstructionId":{"type":"number","format":"double"},"accountId":{"type":"string","minLength":1}},"required":["clientInstructionId","accountId"],"title":"QueryRecurringInstructions"},"GwApiV1BankInstructionsQueryPostRequestBodyContentApplicationJsonSchemaInstruction":{"oneOf":[{"$ref":"#/components/schemas/QueryBankInstruction"},{"$ref":"#/components/schemas/QueryRecentRecurringEvents"},{"$ref":"#/components/schemas/QueryRecurringInstructions"}],"title":"GwApiV1BankInstructionsQueryPostRequestBodyContentApplicationJsonSchemaInstruction"},"QueryRecentRecurringEventResultTransactionHistoryResultItems":{"type":"object","properties":{"ibRequestId":{"type":"integer","format":"int64"},"status":{"type":"string"}},"title":"QueryRecentRecurringEventResultTransactionHistoryResultItems"},"QueryRecentRecurringEventResultTransactionHistory":{"type":"object","properties":{"maxNumberOfTransactions":{"type":"integer","format":"int64"},"result":{"type":"array","items":{"$ref":"#/components/schemas/QueryRecentRecurringEventResultTransactionHistoryResultItems"}}},"title":"QueryRecentRecurringEventResultTransactionHistory"},"QueryRecentRecurringEventResult":{"type":"object","properties":{"clientInstructionId":{"type":"number","format":"double"},"instructionType":{"$ref":"#/components/schemas/InstructionResultInstructionType"},"instructionStatus":{"$ref":"#/components/schemas/InstructionResultInstructionStatus"},"instructionId":{"type":"number","format":"double"},"ibReferenceId":{"type":"number","format":"double"},"description":{"type":"string"},"processedTimestamp":{"type":"string","format":"date-time"},"recurringInstructionName":{"type":"string"},"recurringTransactionType":{"type":"string"},"recurringTransactionStatus":{"type":"string"},"amount":{"type":"number","format":"double"},"currency":{"type":"string"},"method":{"type":"string"},"transactionHistory":{"$ref":"#/components/schemas/QueryRecentRecurringEventResultTransactionHistory"}},"required":["clientInstructionId","instructionType","instructionStatus","instructionId","recurringInstructionName","recurringTransactionType","recurringTransactionStatus","amount","currency","method","transactionHistory"],"title":"QueryRecentRecurringEventResult"},"QueryRecentRecurringEventResponse":{"type":"object","properties":{"status":{"type":"number","format":"double"},"instructionSetId":{"type":"number","format":"double"},"instructionResult":{"$ref":"#/components/schemas/QueryRecentRecurringEventResult"}},"required":["status","instructionSetId"],"title":"QueryRecentRecurringEventResponse"},"QueryBankInstructionResultBankInstructionMethod":{"type":"string","enum":["WIRE","ACH","USACH","CAACH","SEPA","eDDA","eGIRO","OPEN_BANKING"],"title":"QueryBankInstructionResultBankInstructionMethod"},"QueryBankInstructionResultBankInstructionDetailsItems":{"type":"object","properties":{"instructionName":{"type":"string"},"type":{"type":"string"},"currency":{"type":"string"},"instructionStatus":{"type":"string"},"bankRoutingNumber":{"type":"string"},"bankAccountNumber":{"type":"string"}},"required":["instructionName","type","currency","instructionStatus","bankRoutingNumber","bankAccountNumber"],"title":"QueryBankInstructionResultBankInstructionDetailsItems"},"QueryBankInstructionResult":{"type":"object","properties":{"clientInstructionId":{"type":"number","format":"double"},"instructionType":{"$ref":"#/components/schemas/InstructionResultInstructionType"},"instructionStatus":{"$ref":"#/components/schemas/InstructionResultInstructionStatus"},"instructionId":{"type":"number","format":"double"},"ibReferenceId":{"type":"number","format":"double"},"description":{"type":"string"},"processedTimestamp":{"type":"string","format":"date-time"},"accountId":{"type":"string"},"bankInstructionMethod":{"$ref":"#/components/schemas/QueryBankInstructionResultBankInstructionMethod"},"bankInstructionDetails":{"type":"array","items":{"$ref":"#/components/schemas/QueryBankInstructionResultBankInstructionDetailsItems"}}},"required":["clientInstructionId","instructionType","instructionStatus","instructionId","accountId","bankInstructionMethod","bankInstructionDetails"],"title":"QueryBankInstructionResult"},"QueryBankInstructionResponse":{"type":"object","properties":{"status":{"type":"number","format":"double"},"instructionSetId":{"type":"number","format":"double"},"instructionResult":{"$ref":"#/components/schemas/QueryBankInstructionResult"}},"required":["status","instructionSetId"],"title":"QueryBankInstructionResponse"},"QueryRecurringInstructionsResultRecurringInstructionsItems":{"type":"object","properties":{"requestId":{"type":"integer","format":"int64"},"bankInstructionName":{"type":"string"},"transactionType":{"type":"string"},"bankInstructionMethod":{"type":"string"},"amount":{"type":"number","format":"double"},"currency":{"type":"string"},"frequency":{"type":"string"},"startDate":{"type":"string","format":"date"},"endDate":{"type":"string","format":"date"}},"title":"QueryRecurringInstructionsResultRecurringInstructionsItems"},"QueryRecurringInstructionsResult":{"type":"object","properties":{"clientInstructionId":{"type":"number","format":"double"},"instructionType":{"$ref":"#/components/schemas/InstructionResultInstructionType"},"instructionStatus":{"$ref":"#/components/schemas/InstructionResultInstructionStatus"},"instructionId":{"type":"number","format":"double"},"ibReferenceId":{"type":"number","format":"double"},"description":{"type":"string"},"processedTimestamp":{"type":"string","format":"date-time"},"accountId":{"type":"string"},"recurringInstructions":{"type":"array","items":{"$ref":"#/components/schemas/QueryRecurringInstructionsResultRecurringInstructionsItems"}}},"required":["clientInstructionId","instructionType","instructionStatus","instructionId","accountId","recurringInstructions"],"title":"QueryRecurringInstructionsResult"},"QueryRecurringInstructionsResponse":{"type":"object","properties":{"instructionResult":{"$ref":"#/components/schemas/QueryRecurringInstructionsResult"}},"title":"QueryRecurringInstructionsResponse"},"Account Management Banking_createBankInstructionsQuery_Response_201":{"oneOf":[{"$ref":"#/components/schemas/QueryRecentRecurringEventResponse"},{"$ref":"#/components/schemas/QueryBankInstructionResponse"},{"$ref":"#/components/schemas/QueryRecurringInstructionsResponse"}],"title":"Account Management Banking_createBankInstructionsQuery_Response_201"},"GwApiV1ExternalCashTransfersQueryPostRequestBodyContentApplicationJsonSchemaInstructionType":{"type":"string","enum":["QUERY_WITHDRAWABLE_FUNDS","QUERY_IRA_CONTRIBUTIONS"],"title":"GwApiV1ExternalCashTransfersQueryPostRequestBodyContentApplicationJsonSchemaInstructionType"},"QueryWithdrawableFunds":{"type":"object","properties":{"clientInstructionId":{"type":"number","format":"double"},"accountId":{"type":"string","minLength":1},"currency":{"type":"string","minLength":1},"bankRoutingNumber":{"type":"string","minLength":1,"description":"If bankRoutingNumber is provided then bankAccountNumber is also required, cannot be passed with bankInstructionName"},"bankAccountNumber":{"type":"string","minLength":1,"description":"If bankAccountNumber is provided then bankRoutingNumber is also required, cannot be passed with bankInstructionName"},"bankInstructionName":{"type":"string","minLength":1,"description":"bankInstructionName cannot be passed with (bankAccountNumber or bankRoutingNumber)"}},"required":["clientInstructionId","accountId","currency"],"title":"QueryWithdrawableFunds"},"QueryIRAContributions":{"type":"object","properties":{"clientInstructionId":{"type":"number","format":"double"},"accountId":{"type":"string","minLength":1},"year":{"type":"string","minLength":4,"maxLength":4}},"required":["clientInstructionId","accountId","year"],"title":"QueryIRAContributions"},"GwApiV1ExternalCashTransfersQueryPostRequestBodyContentApplicationJsonSchemaInstruction":{"oneOf":[{"$ref":"#/components/schemas/QueryWithdrawableFunds"},{"$ref":"#/components/schemas/QueryIRAContributions"}],"title":"GwApiV1ExternalCashTransfersQueryPostRequestBodyContentApplicationJsonSchemaInstruction"},"QueryWithdrawableAmountsInstructionResultInstructionType":{"type":"string","enum":["ACH_INSTRUCTION","CANCEL_INSTRUCTION","COMPLEX_ASSET_TRANSFER","DELETE_BANK_INSTRUCTION","DEPOSIT","DWAC","EXTERNAL_POSITION_TRANSFER","FOP","QUERY_RECENT_INSTRUCTIONS","QUERY_WITHDRAWABLE_FUNDS","INTERNAL_POSITION_TRANSFER","INTERNAL_CASH_TRANSFER","MICRO_AMOUNT","PREDEFINED_DESTINATION_INSTRUCTION","TRADITIONAL_BANK_INSTRUCTION_VERIFICATION","WITHDRAWAL","QUERY_IRA_CONTRIBUTIONS","EDDA_INSTRUCTION","QUERY_RECENT_RECURRING_EVENTS","QUERY_RECURRING_INSTRUCTIONS","QUERY_ACCOUNT_BALANCES","QUERY_BANK_INSTRUCTION","QUERY_WITHDRAWABLE_CASH_EQUITY","ISA_TRANSFER"],"title":"QueryWithdrawableAmountsInstructionResultInstructionType"},"QueryWithdrawableAmountsInstructionResultInstructionStatus":{"type":"string","enum":["PENDING","REJECTED","PROCESSED"],"title":"QueryWithdrawableAmountsInstructionResultInstructionStatus"},"QueryWithdrawableAmountsInstructionResultError":{"type":"object","properties":{"errorCode":{"type":"string"},"errorMessage":{"type":"string"}},"required":["errorCode","errorMessage"],"title":"QueryWithdrawableAmountsInstructionResultError"},"QueryWithdrawableAmountsInstructionResult":{"type":"object","properties":{"clientInstructionId":{"type":"number","format":"double"},"instructionType":{"$ref":"#/components/schemas/QueryWithdrawableAmountsInstructionResultInstructionType"},"instructionStatus":{"$ref":"#/components/schemas/QueryWithdrawableAmountsInstructionResultInstructionStatus"},"instructionId":{"type":"number","format":"double"},"ibReferenceId":{"type":"number","format":"double"},"description":{"type":"string"},"error":{"$ref":"#/components/schemas/QueryWithdrawableAmountsInstructionResultError"},"processedTimestamp":{"type":"string","format":"date-time"},"accountId":{"type":"string"},"currency":{"type":"string"},"withdrawableAmount":{"type":"number","format":"double"},"withdrawableAmountNoBorrow":{"type":"number","format":"double"},"allowedTransferAmountToMaster":{"type":"number","format":"double"},"allowedTransferAmountToMasterNoBorrow":{"type":"number","format":"double"}},"required":["clientInstructionId","instructionType","instructionStatus","instructionId","accountId","currency","withdrawableAmount","withdrawableAmountNoBorrow","allowedTransferAmountToMaster","allowedTransferAmountToMasterNoBorrow"],"title":"QueryWithdrawableAmountsInstructionResult"},"QueryWithdrawableAmountsResponse":{"type":"object","properties":{"status":{"type":"number","format":"double"},"instructionSetId":{"type":"number","format":"double"},"instructionResult":{"$ref":"#/components/schemas/QueryWithdrawableAmountsInstructionResult"}},"required":["status","instructionSetId"],"title":"QueryWithdrawableAmountsResponse"},"QueryWithdrawableAmountsWithoutOriginHoldResultInstructionType":{"type":"string","enum":["ACH_INSTRUCTION","CANCEL_INSTRUCTION","COMPLEX_ASSET_TRANSFER","DELETE_BANK_INSTRUCTION","DEPOSIT","DWAC","EXTERNAL_POSITION_TRANSFER","FOP","QUERY_RECENT_INSTRUCTIONS","QUERY_WITHDRAWABLE_FUNDS","INTERNAL_POSITION_TRANSFER","INTERNAL_CASH_TRANSFER","MICRO_AMOUNT","PREDEFINED_DESTINATION_INSTRUCTION","TRADITIONAL_BANK_INSTRUCTION_VERIFICATION","WITHDRAWAL","QUERY_IRA_CONTRIBUTIONS","EDDA_INSTRUCTION","QUERY_RECENT_RECURRING_EVENTS","QUERY_RECURRING_INSTRUCTIONS","QUERY_ACCOUNT_BALANCES","QUERY_BANK_INSTRUCTION","QUERY_WITHDRAWABLE_CASH_EQUITY","ISA_TRANSFER"],"title":"QueryWithdrawableAmountsWithoutOriginHoldResultInstructionType"},"QueryWithdrawableAmountsWithoutOriginHoldResultInstructionStatus":{"type":"string","enum":["PENDING","REJECTED","PROCESSED"],"title":"QueryWithdrawableAmountsWithoutOriginHoldResultInstructionStatus"},"QueryWithdrawableAmountsWithoutOriginHoldResultError":{"type":"object","properties":{"errorCode":{"type":"string"},"errorMessage":{"type":"string"}},"required":["errorCode","errorMessage"],"title":"QueryWithdrawableAmountsWithoutOriginHoldResultError"},"QueryWithdrawableAmountsWithoutOriginHoldResult":{"type":"object","properties":{"clientInstructionId":{"type":"number","format":"double"},"instructionType":{"$ref":"#/components/schemas/QueryWithdrawableAmountsWithoutOriginHoldResultInstructionType"},"instructionStatus":{"$ref":"#/components/schemas/QueryWithdrawableAmountsWithoutOriginHoldResultInstructionStatus"},"instructionId":{"type":"number","format":"double"},"ibReferenceId":{"type":"number","format":"double"},"description":{"type":"string"},"error":{"$ref":"#/components/schemas/QueryWithdrawableAmountsWithoutOriginHoldResultError"},"processedTimestamp":{"type":"string","format":"date-time"},"accountId":{"type":"string"},"currency":{"type":"string"},"withdrawableAmountWithoutOriginationHold":{"type":"number","format":"double"},"withdrawableAmountWithoutOriginationHoldNoBorrow":{"type":"number","format":"double"}},"required":["clientInstructionId","instructionType","instructionStatus","instructionId","accountId","currency","withdrawableAmountWithoutOriginationHold","withdrawableAmountWithoutOriginationHoldNoBorrow"],"title":"QueryWithdrawableAmountsWithoutOriginHoldResult"},"QueryWithdrawableAmountsWithoutOriginHoldResponse":{"type":"object","properties":{"status":{"type":"number","format":"double"},"instructionSetId":{"type":"number","format":"double"},"instructionResult":{"$ref":"#/components/schemas/QueryWithdrawableAmountsWithoutOriginHoldResult"}},"required":["status","instructionSetId"],"title":"QueryWithdrawableAmountsWithoutOriginHoldResponse"},"Account Management Banking_createExternalCashTransfersQuery_Response_201":{"oneOf":[{"$ref":"#/components/schemas/QueryWithdrawableAmountsResponse"},{"$ref":"#/components/schemas/QueryWithdrawableAmountsWithoutOriginHoldResponse"}],"title":"Account Management Banking_createExternalCashTransfersQuery_Response_201"},"AvailableStatementDatesDataValueDaily":{"type":"object","properties":{"startDate":{"type":"string","description":"daily report start date"},"endDate":{"type":"string","description":"daily report end date"}},"title":"AvailableStatementDatesDataValueDaily"},"AvailableStatementDatesDataValue":{"type":"object","properties":{"daily":{"$ref":"#/components/schemas/AvailableStatementDatesDataValueDaily"},"monthly":{"type":"array","items":{"type":"string"},"description":"monthly available reports"},"annual":{"type":"array","items":{"type":"string"},"description":"annual available reports"}},"title":"AvailableStatementDatesDataValue"},"AvailableStatementDatesData":{"type":"object","properties":{"dataType":{"type":"string"},"value":{"$ref":"#/components/schemas/AvailableStatementDatesDataValue"}},"title":"AvailableStatementDatesData"},"GetAvailableStmtDatesResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AvailableStatementDatesData"}},"title":"GetAvailableStmtDatesResponse"},"UnauthorizedAccessResponse":{"type":"object","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer","format":"int64"},"detail":{"type":"string"}},"required":["type","title","status"],"title":"UnauthorizedAccessResponse"},"TaxFormType":{"type":"object","properties":{"isForm":{"type":"boolean"},"taxFormName":{"type":"string"},"formats":{"type":"array","items":{"type":"string"},"description":"available tax form formats"}},"title":"TaxFormType"},"AvailableTaxFormsDataValue":{"type":"object","properties":{"forms":{"type":"array","items":{"$ref":"#/components/schemas/TaxFormType"},"description":"available tax forms"}},"title":"AvailableTaxFormsDataValue"},"AvailableTaxFormsData":{"type":"object","properties":{"dataType":{"type":"string"},"value":{"$ref":"#/components/schemas/AvailableTaxFormsDataValue"}},"title":"AvailableTaxFormsData"},"GetAvailableTaxFormsResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AvailableTaxFormsData"}},"title":"GetAvailableTaxFormsResponse"},"GetAvailableTradeConfirmationDatesResponseData":{"type":"object","properties":{"dataType":{"type":"string"},"value":{"type":"array","items":{"type":"string"},"description":"available trade confirmation dates"}},"title":"GetAvailableTradeConfirmationDatesResponseData"},"GetAvailableTradeConfirmationDatesResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/GetAvailableTradeConfirmationDatesResponseData"}},"title":"GetAvailableTradeConfirmationDatesResponse"},"TaxFormRequest":{"type":"object","properties":{"accountId":{"type":"string","description":"Account id"},"year":{"type":"string","description":"Tax Year"},"type":{"type":"string","description":"Tax Form Type (can retrieve available tax documents via /api/v1/tax-documents/available)"},"format":{"type":"string","description":"format"},"gzip":{"type":"boolean","default":false,"description":"to gzip the whole response pass true"}},"required":["accountId","year","type","format"],"title":"TaxFormRequest"},"TaxFormResponseData":{"type":"object","properties":{"dataType":{"type":"string","description":"the data type of the value after decoding"},"encoding":{"type":"string","description":"encoding used for the value"},"value":{"type":"string","description":"Base 64 encoded String of byte[]. Byte[] represents compressed data when gzip is true"},"mimeType":{"type":"string","description":"mimeType of document after decoding and serializing the value"},"gzip":{"type":"boolean","description":"content encoding flag. Represents whether the response is compressed"},"accept":{"type":"string","description":"specify response media types that are acceptable"}},"title":"TaxFormResponseData"},"TaxFormResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TaxFormResponseData"}},"title":"TaxFormResponse"},"TradeConfirmationRequest":{"type":"object","properties":{"accountId":{"type":"string","description":"accound id"},"startDate":{"type":"string","description":"from date"},"endDate":{"type":"string","description":"to date"},"mimeType":{"type":"string","description":"output format"}},"required":["accountId","startDate","endDate"],"title":"TradeConfirmationRequest"},"TradeConfirmationResponseData":{"type":"object","properties":{"dataType":{"type":"string","description":"the data type of the value after decoding"},"encoding":{"type":"string","description":"encoding used for the value"},"value":{"type":"string","description":"Base 64 encoded String of byte[]. Byte[] represents compressed data when gzip is true"},"mimeType":{"type":"string","description":"mimeType of document after decoding and serializing the value"},"gzip":{"type":"boolean","description":"content encoding flag. Represents whether the response is compressed"},"accept":{"type":"string","description":"specify response media types that are acceptable"}},"title":"TradeConfirmationResponseData"},"TradeConfirmationResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TradeConfirmationResponseData"}},"title":"TradeConfirmationResponse"},"StmtRequest":{"type":"object","properties":{"accountId":{"type":"string","description":"account id"},"accountIds":{"type":"array","items":{"type":"string"},"description":"array of account id's"},"startDate":{"type":"string","description":"from date"},"endDate":{"type":"string","description":"to date"},"multiAccountFormat":{"type":"string","description":"possible values are consolidate, concatenate, or customConsolidate"},"cryptoConsolIfAvailable":{"type":"boolean","default":false,"description":"crypto consolidate flag, If request contains any accounts with crypto segment, will turn request into Crypto Consolidated"},"mimeType":{"type":"string","description":"output format"},"language":{"type":"string","default":"en","description":"two character ISO language code"},"gzip":{"type":"boolean","default":false,"description":"to gzip the whole response pass true"}},"required":["accountId","startDate","endDate"],"title":"StmtRequest"},"GetStatementsResponseData":{"type":"object","properties":{"dataType":{"type":"string","description":"the data type of the value after decoding"},"encoding":{"type":"string","description":"encoding used for the value"},"value":{"type":"string","description":"Base 64 encoded String of byte[]. Byte[] represents compressed data when gzip is true"},"mimeType":{"type":"string","description":"mimeType of document after decoding and serializing the value"},"gzip":{"type":"boolean","description":"content encoding flag. Represents whether the response is compressed"},"accept":{"type":"string","description":"specify response media types that are acceptable"}},"title":"GetStatementsResponseData"},"GetStatementsResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/GetStatementsResponseData"}},"title":"GetStatementsResponse"},"GetBrokerListResponse":{"type":"object","properties":{"instructionType":{"type":"string"},"brokers":{"type":"array","items":{"type":"string","minLength":1}}},"required":["instructionType","brokers"],"title":"GetBrokerListResponse"},"EnumerationType":{"type":"string","enum":["exchange-bundles","business-and-occupation","employee-track","fin-info-ranges","acats","aton","market-data","edd-avt","prohibited-country","employee-plans","questionnaires","security-questions","quiz-questions","wire-instructions","product-country-bundles","countries","states"],"description":"<ul><li>exchange-bundles - query most up to date list of exchange-bundles for tradingPermissions</li><li>business-and-occupation - list of occupation and employerBusiness for employmentDetails</li><li>employee-track - query most up to date companyId for account. For affiliation details, if company has an existing IBKR Employee Track account</li><li>fin-info-ranges - query most up to date range IDs by currency for annualNetIncome, netWorth, liquidNetWorth</li><li>acats - query most up to date values for brokerId and brokerName. Used if funding via US ACATS extPositionsTransfers</li><li>aton - query most up to date values for brokerId and brokerName. Used if funding via US ACATS extPositionsTransfers</li><li>market-data - query most up to date values for brokerId and brokerName. Used if funding via ATON Canada extPositionsTransfers</li><li>edd-avt - query questions associated with EDD (Enhanced Due Diligence) or AVT (Additional Verification) tasks assigned to an account</li><li>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</li><li>employee-plans - view EPA that are linked to master account (applicable IF offering SEP IRA accounts)</li><li>questionnaires - obtain list of questionnaires</li><li>security-questions - obtain list of questions supported for IBKR security questions</li><li>quiz-questions - obtain list of questions associated with IBKR knowledge assessment</li><li>wire-instructions - obtain list of wire instructions</li><li>product-country-bundles - obtain list of product country bundles</li><li>countries - obtain list of countries</li><li>states - obtain list of states</li></ul>","title":"EnumerationType"},"GwApiV1EnumerationsEnumerationTypeGetParametersLanguage":{"type":"string","enum":["en","ar","de","es","fr","he","hu","it","ja","nl","pt","ru","zh_CN","zh_TW"],"title":"GwApiV1EnumerationsEnumerationTypeGetParametersLanguage"},"ArrayNode":{"type":"object","properties":{},"title":"ArrayNode"},"EnumerationResponse":{"type":"object","properties":{"enumerationsType":{"type":"string"},"formNumber":{"type":"string"},"jsonData":{"$ref":"#/components/schemas/ArrayNode"}},"title":"EnumerationResponse"},"GwApiV1FormsGetParametersProjection":{"type":"string","enum":["PAYLOAD","DOCS","NONE"],"default":"NONE","title":"GwApiV1FormsGetParametersProjection"},"FormPayload":{"type":"object","properties":{"mimeType":{"type":"string"},"data":{"type":"string"}},"title":"FormPayload"},"AnswerResponse":{"type":"object","properties":{"answerId":{"type":"integer","format":"int64"},"answer":{"type":"string"},"dependentQuestionId":{"type":"integer","format":"int64"},"dependentAnswerId":{"type":"integer","format":"int64"},"multiAnswerDetail":{"type":"array","items":{"type":"string"}}},"title":"AnswerResponse"},"QuestionnaireResponse":{"type":"object","properties":{"questionId":{"type":"integer","format":"int64"},"question":{"type":"string"},"isMandatoryToAnswer":{"type":"boolean"},"questionType":{"type":"string"},"answers":{"type":"array","items":{"$ref":"#/components/schemas/AnswerResponse"}}},"title":"QuestionnaireResponse"},"FormDetails":{"type":"object","properties":{"formNumber":{"type":"integer","format":"int64"},"sha1Checksum":{"type":"string"},"dateModified":{"type":"string","format":"date-time"},"fileName":{"type":"string"},"language":{"type":"string"},"formName":{"type":"string"},"payload":{"$ref":"#/components/schemas/FormPayload"},"apiSupportedTask":{"type":"boolean"},"type":{"type":"string"},"action":{"type":"string"},"acceptableDocs":{"type":"array","items":{"type":"string"}},"questionnaire":{"type":"array","items":{"$ref":"#/components/schemas/QuestionnaireResponse"}},"error":{"$ref":"#/components/schemas/ErrorResponse"},"hasError":{"type":"boolean"},"errorDescription":{"type":"string"},"fileLength":{"type":"integer","format":"int64"}},"title":"FormDetails"},"FormFileResponse":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/ErrorResponse"},"hasError":{"type":"boolean"},"errorDescription":{"type":"string"},"fileData":{"$ref":"#/components/schemas/FileData"},"formDetails":{"type":"array","items":{"$ref":"#/components/schemas/FormDetails"}},"timestamp":{"type":"string","format":"date-time"}},"title":"FormFileResponse"},"GetParticipatingListResponseParticipatingBanksItems":{"type":"object","properties":{"institutionName":{"type":"string"},"clearingCode":{"type":"string"},"BIC":{"type":"string"}},"required":["institutionName","clearingCode","BIC"],"title":"GetParticipatingListResponseParticipatingBanksItems"},"GetParticipatingListResponse":{"type":"object","properties":{"type":{"type":"string"},"participatingBanks":{"type":"array","items":{"$ref":"#/components/schemas/GetParticipatingListResponseParticipatingBanksItems"}}},"required":["type","participatingBanks"],"title":"GetParticipatingListResponse"},"RequestDetailsRequestStatus":{"type":"string","enum":["N","O","P","C","A","E","F","I","J","L","M","R","W","Q"],"title":"RequestDetailsRequestStatus"},"RequestDetailsRequest":{"type":"object","properties":{"startDate":{"type":"string","format":"date"},"endDate":{"type":"string","format":"date"},"offset":{"type":"integer","format":"int64","minimum":0},"limit":{"type":"integer","format":"int64","minimum":1,"maximum":1000},"status":{"$ref":"#/components/schemas/RequestDetailsRequestStatus"}},"required":["startDate","endDate"],"title":"RequestDetailsRequest"},"RequestDetail":{"type":"object","properties":{"requestId":{"type":"integer","format":"int64"},"dateSubmitted":{"type":"string"},"status":{"type":"string"},"accountID":{"type":"string"},"requestType":{"type":"string"}},"title":"RequestDetail"},"RequestDetailsResponse":{"type":"object","properties":{"requestDetails":{"type":"array","items":{"$ref":"#/components/schemas/RequestDetail"}},"offset":{"type":"integer","format":"int64"},"limit":{"type":"integer","format":"int64"},"total":{"type":"integer","format":"int64"}},"title":"RequestDetailsResponse"},"RequiredFormsRequest":{"type":"object","properties":{"residenceCountry":{"type":"string"},"accountType":{"type":"string"},"applicantType":{"type":"string"},"processType":{"type":"string"},"ira":{"type":"boolean"},"iraType":{"type":"string"},"requestedSYEP":{"type":"boolean"},"requestedFCBP":{"type":"boolean"},"additionalAccount":{"type":"boolean"},"additionalApplicant":{"type":"boolean"},"mifidCategory":{"type":"string"},"tradingPermissions":{"type":"array","items":{"type":"string"}},"capability":{"type":"array","items":{"type":"string"}},"faTradingAccount":{"type":"boolean"}},"title":"RequiredFormsRequest"},"RequiredFormsResponse":{"type":"object","properties":{"forms":{"type":"array","items":{"type":"string"}},"error":{"$ref":"#/components/schemas/ErrorResponse"},"hasError":{"type":"boolean"},"errorDescription":{"type":"string"}},"title":"RequiredFormsResponse"},"GwApiV1RequestsRequestIdStatusGetParametersType":{"type":"string","enum":["response","update"],"title":"GwApiV1RequestsRequestIdStatusGetParametersType"},"AmRequestStatusResponse":{"type":"object","properties":{"requestId":{"type":"string"},"requestType":{"type":"string"},"status":{"type":"string"},"message":{"type":"string"},"acctId":{"type":"string"}},"title":"AmRequestStatusResponse"},"Account Management Utilities_getRequestsStatus_Response_200":{"oneOf":[{"$ref":"#/components/schemas/AmRequestStatusResponse"},{"$ref":"#/components/schemas/StatusResponse"}],"title":"Account Management Utilities_getRequestsStatus_Response_200"},"UserNameAvailableResponse":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/ErrorResponse"},"hasError":{"type":"boolean"},"errorDescription":{"type":"string"},"isValid":{"type":"boolean"},"isAvailable":{"type":"boolean"},"suggestedUserName":{"type":"array","items":{"type":"string"}}},"title":"UserNameAvailableResponse"},"CsvResponseMessage":{"oneOf":[{"type":"string"},{"type":"object","additionalProperties":{"description":"Any type"}}],"description":"`OK` on success. On failure, either a plain string describing the error or a JSON object for structured bridge validation errors.","title":"CsvResponseMessage"},"CSVResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the operation succeeded."},"requestId":{"type":"integer","format":"int64","description":"Echoed from the request. Absent only on early apply failures (inactive body token, missing payload) where the `requestId` has not yet been parsed."},"message":{"$ref":"#/components/schemas/CsvResponseMessage","description":"`OK` on success. On failure, either a plain string describing the error or a JSON object for structured bridge validation errors."}},"required":["success"],"description":"Response body for all CSV endpoints. Always returned with HTTP 200.","title":"CSVResponse"},"ListEntryParams":{"type":"object","properties":{"symbol":{"type":"string","description":"Instrument identifier. Format depends on entry type."},"symboldesc":{"type":"string","description":"Human-readable instrument description."},"val":{"type":"string","description":"Internal entity identifier."}},"description":"Instrument identifier parameters. Keys depend on entry type: ISSUER/CONID entries use `symbol`, `symboldesc`, `val`; INDUSTRY entries use `indgroup`; other types may use different keys.","title":"ListEntryParams"},"ListEntry":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Entry ID."},"type":{"type":"string","description":"Example values: ISSUER, CONID, SYMBOL, INDUSTRY."},"createdAt":{"type":"integer","format":"int64","description":"Creation timestamp in epoch milliseconds."},"params":{"$ref":"#/components/schemas/ListEntryParams"}},"description":"A single instrument entry in a list.","title":"ListEntry"},"ListDetailsResponse":{"type":"object","properties":{"status":{"type":"string","description":"Always `ok` on success."},"listId":{"type":"integer","format":"int64","minimum":1,"maximum":2147483647,"description":"Range 1-2147483647."},"type":{"type":"string","description":"Example values: SYMBOL, CONID, EXCHANGE, SECTOR, ISSUERORCONID."},"name":{"type":"string","description":"List name."},"description":{"type":["string","null"],"description":"List description."},"entries":{"type":"array","items":{"$ref":"#/components/schemas/ListEntry"},"description":"Instrument entries. Empty array when none."}},"required":["status","listId","entries"],"description":"Response body for GET /external/listdetails.","title":"ListDetailsResponse"},"MasterListEntry":{"type":"object","properties":{"listId":{"type":"integer","format":"int64","description":"List ID."},"byOperator":{"type":"boolean","description":"`true` if created by an IB operator (Compliance/Risk role); `false` if created by the Client (Customer role)."}},"description":"A single list ID with its creator-type flag.","title":"MasterListEntry"},"MasterListIdsResponse":{"type":"object","properties":{"status":{"type":"string","description":"Always `ok` on success."},"masterUserName":{"type":"string","description":"Echoed from the request."},"lists":{"type":"array","items":{"$ref":"#/components/schemas/MasterListEntry"},"description":"Lists created by the caller's master account (or employer, in emp-track mode). Empty array when none."}},"required":["status","masterUserName","lists"],"description":"Response body for GET /external/listids","title":"MasterListIdsResponse"},"RuleParam":{"type":"object","additionalProperties":{"type":"string"},"description":"Rule parameter as a single key-value object. The key is the parameter name (e.g. `orderside`) and the value is the parameter value (e.g. `ALL`).","title":"RuleParam"},"RestrictionRule":{"type":"object","properties":{"ruleId":{"type":"integer","format":"int64","description":"Rule ID within the restriction."},"type":{"type":"string","description":"Example values: CLOSINGONLY, RESTRICTALLORDERS, CONCENTRATIONLIMIT, RESTRICTEDASSETCLASS, ISSUER, CONID, UNDERLYING, WHITELIST."},"validityType":{"type":"string","description":"GTC = Good Till Cancelled, GTD = Good Till Date."},"startDate":{"type":"string","description":"GTD rules only. Format: MM/dd/yyyy."},"endDate":{"type":"string","description":"GTD rules only. Format: MM/dd/yyyy."},"params":{"type":"array","items":{"$ref":"#/components/schemas/RuleParam"},"description":"Rule parameters. Absent when the rule has no parameters."}},"description":"A single rule within a restriction. Field order: `ruleId`, `type`, `validityType`, `startDate`/`endDate` (GTD only), `params` (absent when empty).","title":"RestrictionRule"},"RestrictionDetailsResponse":{"type":"object","properties":{"status":{"type":"string","description":"Always `ok` on success."},"restrictionId":{"type":"integer","format":"int64","description":"Echoed from the request."},"name":{"type":"string","description":"Restriction name."},"description":{"type":["string","null"],"description":"Restriction description."},"message":{"type":["string","null"],"description":"Shown to users when the restriction triggers."},"applicationType":{"type":"string","description":"Example values: Restrict."},"usageType":{"type":"string","description":"Example values: Trading, Compliance, Monitor."},"allowOnly":{"type":["string","null"],"description":"Null when not applicable. The value `F` returned by the database is normalized to null."},"matchAll":{"type":["string","null"],"description":"Null when not applicable. The value `F` returned by the database is normalized to null."},"isWhiteList":{"type":"string","description":"Whitelist flag."},"rules":{"type":"array","items":{"$ref":"#/components/schemas/RestrictionRule"},"description":"Rules attached to this restriction. Empty array when none."},"tmFrequency":{"type":"string","description":"Trade-monitoring recurrence. Present only when configured."},"tmFirstDate":{"type":"integer","format":"int64","description":"Trade-monitoring start timestamp in epoch milliseconds. Present only when configured."}},"required":["status","restrictionId","rules"],"description":"Response body for GET /external/restrdetails.","title":"RestrictionDetailsResponse"},"MasterRestrictionEntry":{"type":"object","properties":{"restrictionId":{"type":"integer","format":"int64","description":"Restriction ID."},"byOperator":{"type":"boolean","description":"`true` if created by an IB operator (Compliance/Risk role); `false` if created by the Client (Customer role)."}},"description":"A single restriction ID with its creator-type flag.","title":"MasterRestrictionEntry"},"MasterRestrictionsResponse":{"type":"object","properties":{"status":{"type":"string","description":"Always `ok` on success."},"masterUserName":{"type":"string","description":"Echoed from the request."},"restrictions":{"type":"array","items":{"$ref":"#/components/schemas/MasterRestrictionEntry"},"description":"Restrictions created by the caller's master account (or employer, in emp-track mode). Empty array when none."}},"required":["status","masterUserName","restrictions"],"description":"Response body for GET /external/restrids","title":"MasterRestrictionsResponse"},"UserRestrictionsResponse":{"type":"object","properties":{"status":{"type":"string","description":"Always `ok` on success."},"userName":{"type":"string","description":"Echoed from the request. If the supplied `userName` was an alias, the alias is returned as-is."},"restrictionIds":{"type":"array","items":{"type":"integer","format":"int64"},"description":"Restriction IDs for the user. Empty array when none."}},"required":["status","userName","restrictionIds"],"description":"Response body for GET /external/restridsforuser","title":"UserRestrictionsResponse"},"AccountRestrictionsResponse":{"type":"object","properties":{"status":{"type":"string","description":"Always `ok` on success."},"accountId":{"type":"string","description":"Echoed from the request."},"restrictionIds":{"type":"array","items":{"type":"integer","format":"int64"},"description":"Restriction IDs for the account. Empty array when none."}},"required":["status","accountId","restrictionIds"],"description":"Response body for GET /external/restridsforacct","title":"AccountRestrictionsResponse"},"VerifyRequest":{"type":"object","properties":{"userName":{"type":"string","minLength":1,"description":"IBKR username."},"requestId":{"type":"integer","format":"int64","description":"Unique request identifier."},"payload":{"type":"string","format":"byte","description":"Base64-encoded CSV content. Supported operations: `RESTR_ADD`, `RESTR_DELETE`, `RESTR_ASSOC_ADD`, `RESTR_ASSOC_DELETE`."},"isEmpTrack":{"type":"string","description":"Set to `T` for employer-track authorization."}},"required":["userName","requestId","payload"],"description":"CSV verification request body. Do not include `masterAcctId`; it is extracted from the Authorization JWT `accountId` claim automatically.","title":"VerifyRequest"},"GwApiV1BalancesQueryPostRequestBodyContentApplicationJsonSchemaInstructionType":{"type":"string","enum":["QUERY_WITHDRAWABLE_CASH_EQUITY"],"title":"GwApiV1BalancesQueryPostRequestBodyContentApplicationJsonSchemaInstructionType"},"QueryWithdrawableCashEquity":{"type":"object","properties":{"clientInstructionId":{"type":"number","format":"double"},"accountId":{"type":"string","minLength":1},"currency":{"type":"string","minLength":3,"maxLength":3}},"required":["clientInstructionId","accountId","currency"],"title":"QueryWithdrawableCashEquity"},"GwApiV1BalancesQueryPostRequestBodyContentApplicationJsonSchemaInstruction":{"oneOf":[{"$ref":"#/components/schemas/QueryWithdrawableCashEquity"}],"title":"GwApiV1BalancesQueryPostRequestBodyContentApplicationJsonSchemaInstruction"},"QueryWithdrawableCashEquityResultInstructionType":{"type":"string","enum":["ACH_INSTRUCTION","CANCEL_INSTRUCTION","COMPLEX_ASSET_TRANSFER","DELETE_BANK_INSTRUCTION","DEPOSIT","DWAC","EXTERNAL_POSITION_TRANSFER","FOP","QUERY_RECENT_INSTRUCTIONS","QUERY_WITHDRAWABLE_FUNDS","INTERNAL_POSITION_TRANSFER","INTERNAL_CASH_TRANSFER","MICRO_AMOUNT","PREDEFINED_DESTINATION_INSTRUCTION","TRADITIONAL_BANK_INSTRUCTION_VERIFICATION","WITHDRAWAL","QUERY_IRA_CONTRIBUTIONS","EDDA_INSTRUCTION","QUERY_RECENT_RECURRING_EVENTS","QUERY_RECURRING_INSTRUCTIONS","QUERY_ACCOUNT_BALANCES","QUERY_BANK_INSTRUCTION","QUERY_WITHDRAWABLE_CASH_EQUITY","ISA_TRANSFER"],"title":"QueryWithdrawableCashEquityResultInstructionType"},"QueryWithdrawableCashEquityResultInstructionStatus":{"type":"string","enum":["PENDING","REJECTED","PROCESSED"],"title":"QueryWithdrawableCashEquityResultInstructionStatus"},"QueryWithdrawableCashEquityResultError":{"type":"object","properties":{"errorCode":{"type":"string"},"errorMessage":{"type":"string"}},"required":["errorCode","errorMessage"],"title":"QueryWithdrawableCashEquityResultError"},"QueryWithdrawableCashEquityResult":{"type":"object","properties":{"clientInstructionId":{"type":"number","format":"double"},"instructionType":{"$ref":"#/components/schemas/QueryWithdrawableCashEquityResultInstructionType"},"instructionStatus":{"$ref":"#/components/schemas/QueryWithdrawableCashEquityResultInstructionStatus"},"instructionId":{"type":"number","format":"double"},"ibReferenceId":{"type":"number","format":"double"},"description":{"type":"string"},"error":{"$ref":"#/components/schemas/QueryWithdrawableCashEquityResultError"},"processedTimestamp":{"type":"string","format":"date-time"},"accountId":{"type":"string"},"currency":{"type":"string"},"withdrawableCashAmount":{"type":"number","format":"double"},"availableEquityValue":{"type":"number","format":"double"}},"required":["clientInstructionId","instructionType","instructionStatus","instructionId","accountId","currency","withdrawableCashAmount","availableEquityValue"],"title":"QueryWithdrawableCashEquityResult"},"QueryWithdrawableCashEquityResponse":{"type":"object","properties":{"status":{"type":"number","format":"double"},"instructionSetId":{"type":"number","format":"double"},"instructionResult":{"$ref":"#/components/schemas/QueryWithdrawableCashEquityResult"}},"required":["status","instructionSetId"],"title":"QueryWithdrawableCashEquityResponse"},"Third Parties Cash Balances_createBalancesQuery_Response_201":{"oneOf":[{"$ref":"#/components/schemas/QueryWithdrawableCashEquityResponse"}],"title":"Third Parties Cash Balances_createBalancesQuery_Response_201"},"TaxVoucherDTO":{"type":"object","properties":{"requestId":{"type":"string"},"custAcctId":{"type":"string"},"corpactionId":{"type":"string"},"requestState":{"type":"string"},"fee":{"type":"number","format":"double"},"divAmount":{"type":"number","format":"double"},"withHeldAmount":{"type":"number","format":"double"},"countryCode":{"type":"string"},"year":{"type":"integer","format":"int64"},"migratedCustAcctId":{"type":"string"}},"title":"TaxVoucherDTO"},"Third Parties Tax Vouchers_downloadFile_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Third Parties Tax Vouchers_downloadFile_Response_200"},"DividendDTO":{"type":"object","properties":{"currency":{"type":"string"},"exDate":{"type":"string"},"payDate":{"type":"string"},"corpactionId":{"type":"string"},"country":{"type":"string"},"isin":{"type":"string"},"securityDesc":{"type":"string"},"symbol":{"type":"string"},"voucher":{"$ref":"#/components/schemas/TaxVoucherDTO"}},"title":"DividendDTO"},"Country":{"type":"object","properties":{"country":{"type":"string"},"fee":{"type":"number","format":"double"},"currency":{"type":"string"},"countryCode":{"type":"string"},"disabled":{"type":"boolean"}},"title":"Country"},"EchoResponseRequestMethod":{"type":"string","enum":["GET","POST","PATCH","PUT"],"title":"EchoResponseRequestMethod"},"EchoResponseSecurityPolicy":{"type":"string","enum":["HTTPS","SIGNED_JWT","ENCRYPTED_JWE"],"title":"EchoResponseSecurityPolicy"},"EchoResponseQueryParameters":{"type":"object","properties":{},"title":"EchoResponseQueryParameters"},"EchoResponse":{"type":"object","properties":{"requestMethod":{"$ref":"#/components/schemas/EchoResponseRequestMethod"},"securityPolicy":{"$ref":"#/components/schemas/EchoResponseSecurityPolicy"},"queryParameters":{"$ref":"#/components/schemas/EchoResponseQueryParameters"}},"required":["requestMethod","securityPolicy"],"title":"EchoResponse"},"V1ApiWsGetParametersConnection":{"type":"string","enum":["Upgrade"],"title":"V1ApiWsGetParametersConnection"},"V1ApiWsGetParametersUpgrade":{"type":"string","enum":["websocket"],"title":"V1ApiWsGetParametersUpgrade"}}}}