Client Portal Web API You would need to set up certificates to use this client in production environment.
For local development, you can configure the gateway to turn off ssl validation
under clientportal.gw/root/conf.yaml, set
listenSsl: false
This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.
All URIs are relative to https://localhost:5000/v1/api
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- AccountApi | iserveraccountpnlpartitionedget | get /iserver/account/pnl/partitioned | PnL for the selected account AccountApi | iserveraccountpost | post /iserver/account | Switch Account AccountApi | iserveraccountsget | get /iserver/accounts | Brokerage Accounts AccountApi | portfolioaccountidledgerget | get /portfolio/{accountId}/ledger | Account Ledger AccountApi | portfolioaccountidmetaget | get /portfolio/{accountId}/meta | Account Information AccountApi | portfolioaccountidsummaryget | get /portfolio/{accountId}/summary | Account Summary AccountApi | portfolioaccountsget | get /portfolio/accounts | Portfolio Accounts AccountApi | portfoliosubaccountsget | get /portfolio/subaccounts | List of Sub-Accounts AlertApi | iserveraccountaccountidalertactivatepost | post /iserver/account/{accountId}/alert/activate | Activate or deactivate an alert AlertApi | iserveraccountaccountidalertalertiddelete | delete /iserver/account/{accountId}/alert/{alertId} | Delete an alert *AlertApi* | iserveraccountaccountidalertpost | post /iserver/account/{accountId}/alert | Create or modify alert AlertApi | iserveraccountaccountidalertsget | get /iserver/account/{accountId}/alerts | Get a list of available alerts *AlertApi* | iserveraccountalertidget | get /iserver/account/alert/:id | Get details of an alert *AlertApi* | iserveraccountmtaget | get /iserver/account/mta | Get MTA alert ContractApi | iservercontractconidinfoandrulesget | get /iserver/contract/{conid}/info-and-rules | Info and Rules ContractApi | iservercontractconidinfoget | get /iserver/contract/{conid}/info | Contract Details ContractApi | iserversecdefinfoget | get /iserver/secdef/info | Secdef Info *ContractApi* | iserversecdefsearchpost | post /iserver/secdef/search | Search by Symbol or Name ContractApi | iserversecdefstrikesget | get /iserver/secdef/strikes | Search Strikes *ContractApi* | trsrvfuturesget | get /trsrv/futures | Security Futures by Symbol *ContractApi* | trsrvsecdefpost | post /trsrv/secdef | Secdef by Conid *ContractApi* | trsrvsecdefscheduleget | get /trsrv/secdef/schedule | Get trading schedule for symbol ContractApi | trsrvstocksget | get /trsrv/stocks | Security Stocks by Symbol FYIApi | fyideliveryoptionsdeviceiddelete | delete /fyi/deliveryoptions/{deviceId} | Delete a device FYIApi | fyideliveryoptionsdevicepost | post /fyi/deliveryoptions/device | Enable/Disable device option *FYIApi* | fyideliveryoptionsemailput | put /fyi/deliveryoptions/email | Enable/Disable email option FYIApi | fyideliveryoptionsget | get /fyi/deliveryoptions | Get delivery options FYIApi | fyidisclaimertypecodeget | get /fyi/disclaimer/{typecode} | Get disclaimer for a certain kind of fyi *FYIApi* | fyidisclaimertypecodeput | put /fyi/disclaimer/{typecode} | Mark disclaimer read FYIApi | fyinotificationsget | get /fyi/notifications | Get a list of notifications FYIApi | fyinotificationsmoreget | get /fyi/notifications/more | Get more notifications based on a certain one *FYIApi* | fyinotificationsnotificationidput | put /fyi/notifications/{notificationId} | Get a list of notifications *FYIApi* | fyisettingsget | get /fyi/settings | Get a list of subscriptions *FYIApi* | fyisettingstypecodepost | post /fyi/settings/{typecode} | Enable/Disable certain subscription FYIApi | fyiunreadnumberget | get /fyi/unreadnumber | Get unread number of fyis. The HTTP method POST is also supported. IBCustApi | ibcustentityinfoget | get /ibcust/entity/info | IBCust Entity Info *MarketDataApi* | iservermarketdataconidunsubscribeget | get /iserver/marketdata/{conid}/unsubscribe | Market Data Cancel (Single) *MarketDataApi* | iservermarketdatahistoryget | get /iserver/marketdata/history | Market Data History MarketDataApi | iservermarketdatasnapshotget | get /iserver/marketdata/snapshot | Market Data *MarketDataApi* | iservermarketdataunsubscribeallget | get /iserver/marketdata/unsubscribeall | Market Data Cancel (All) OrderApi | iserveraccountaccountidorderorderiddelete | delete /iserver/account/{accountId}/order/{orderId} | Cancel Order *OrderApi* | iserveraccountaccountidorderorderidpost | post /iserver/account/{accountId}/order/{orderId} | Modify Order OrderApi | iserveraccountaccountidorderpost | post /iserver/account/{accountId}/order | Place Order *OrderApi* | iserveraccountaccountidorderwhatifpost | post /iserver/account/{accountId}/order/whatif | Preview Order *OrderApi* | iserveraccountaccountidorderspost | post /iserver/account/{accountId}/orders | Place Orders (Support bracket orders) OrderApi | iserveraccountordersfagrouppost | post /iserver/account/orders/{faGroup} | Place Orders for Financial Advisor Groups *OrderApi* | iserveraccountordersget | get /iserver/account/orders | Live Orders OrderApi | iserverreplyreplyidpost | post /iserver/reply/{replyid} | Place Order Reply *PnLApi* | iserveraccountpnlpartitionedget | get /iserver/account/pnl/partitioned | PnL for the selected account *PortfolioApi* | portfolioaccountidallocationget | get /portfolio/{accountId}/allocation | Account Allocation *PortfolioApi* | portfolioaccountidledgerget | get /portfolio/{accountId}/ledger | Account Ledger *PortfolioApi* | portfolioaccountidmetaget | get /portfolio/{accountId}/meta | Account Information *PortfolioApi* | portfolioaccountidpositionconidget | get /portfolio/{accountId}/position/{conid} | Position by Conid PortfolioApi | portfolioaccountidpositionsinvalidatepost | post /portfolio/{accountId}/positions/invalidate | Invalidates the backend cache of the Portfolio *PortfolioApi* | portfolioaccountidpositionspageidget | get /portfolio/{accountId}/positions/{pageId} | Portfolio Positions *PortfolioApi* | portfolioaccountidsummaryget | get /portfolio/{accountId}/summary | Account Summary *PortfolioApi* | portfolioaccountsget | get /portfolio/accounts | Portfolio Accounts *PortfolioApi* | portfolioallocationpost | post /portfolio/allocation | Account Alloction (All Accounts) *PortfolioApi* | portfoliopositionsconidget | get /portfolio/positions/{conid} | Positions by Conid PortfolioApi | portfoliosubaccountsget | get /portfolio/subaccounts | List of Sub-Accounts PortfolioAnalystApi | paperformancepost | post /pa/performance | Account Performance PortfolioAnalystApi | pasummarypost | post /pa/summary | Account Balance's Summary PortfolioAnalystApi | patransactionspost | post /pa/transactions | Position's Transaction History ScannerApi | iserverscannerparamsget | get /iserver/scanner/params | Scanner Parameters *ScannerApi* | iserverscannerrunpost | post /iserver/scanner/run | run scanner to get a list of contracts SessionApi | iserverauthstatuspost | post /iserver/auth/status | Authentication Status *SessionApi* | iserverreauthenticatepost | post /iserver/reauthenticate | Tries to re-authenticate to Brokerage *SessionApi* | logoutpost | post /logout | Ends the current session SessionApi | ssovalidateget | get /sso/validate | Validate SSO SessionApi | ticklepost | post /tickle | Ping the server to keep the session open *StreamingApi* | wspost | post /ws | Websocket Endpoint TradesApi | iserveraccounttrades_get | get /iserver/account/trades | List of Trades for the selected account
To get access to the crate's generated documentation, use:
cargo doc --open