Production version of the Client Portal Web API
This Python package is automatically generated by the Swagger Codegen project:
- API version: 1.0.0
- Package version: 1.0.0
- Build package: io.swagger.codegen.languages.PythonClientCodegen
Python 2.7 and 3.4+
If the python package is hosted on Github, you can install directly from Github
pip install git+https://github.com//.git
(you may need to run pip
with root permission: sudo pip install git+https://github.com//.git
)
Then import the package:
import swagger_client
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install
to install the package for all users)
Then import the package:
import swagger_client
Please follow the installation procedure and then run the following:
from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.AccountApi(swagger_client.ApiClient(configuration))
try:
# PnL for the selected account
api_response = api_instance.iserver_account_pnl_partitioned_get()
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountApi->iserver_account_pnl_partitioned_get: %s\n" % e)
All URIs are relative to https://localhost:5000/v1/portal
Class | Method | HTTP request | Description |
---|---|---|---|
AccountApi | iserver_account_pnl_partitioned_get | GET /iserver/account/pnl/partitioned | PnL for the selected account |
AccountApi | iserver_account_post | POST /iserver/account | Updates currently selected account to the provided account |
AccountApi | iserver_accounts_get | GET /iserver/accounts | Brokerage Accounts |
AccountApi | portfolio_account_id_ledger_get | GET /portfolio/{accountId}/ledger | Account Ledger |
AccountApi | portfolio_account_id_meta_get | GET /portfolio/{accountId}/meta | Account Information |
AccountApi | portfolio_account_id_summary_get | GET /portfolio/{accountId}/summary | Account Summary |
AccountApi | portfolio_accounts_get | GET /portfolio/accounts | Portfolio Accounts |
AccountApi | portfolio_subaccounts_get | GET /portfolio/subaccounts | List of Sub-Accounts |
ContractApi | iserver_contract_conid_info_get | GET /iserver/contract/{conid}/info | Contract Info |
ContractApi | iserver_secdef_info_get | GET /iserver/secdef/info | Get available conids of future/option/warrant/cash/CFD |
ContractApi | iserver_secdef_search_post | POST /iserver/secdef/search | Search by symbol or name |
ContractApi | iserver_secdef_strikes_get | GET /iserver/secdef/strikes | Get strikes for Options/Warrant |
ContractApi | trsrv_futures_get | GET /trsrv/futures | Security Futures by Symbol |
ContractApi | trsrv_secdef_post | POST /trsrv/secdef | Secdef by Conid |
ContractApi | trsrv_stocks_get | GET /trsrv/stocks | Security Stocks by Symbol |
FYIApi | fyi_deliveryoptions_device_id_delete | DELETE /fyi/deliveryoptions/{deviceId} | delete a device |
FYIApi | fyi_deliveryoptions_device_post | POST /fyi/deliveryoptions/device | enable/disable device option |
FYIApi | fyi_deliveryoptions_email_put | PUT /fyi/deliveryoptions/email | enable/disable email option |
FYIApi | fyi_deliveryoptions_get | GET /fyi/deliveryoptions | Get delivery options |
FYIApi | fyi_disclaimer_typecode_get | GET /fyi/disclaimer/{typecode} | get disclaimer for a certain kind of fyi |
FYIApi | fyi_disclaimer_typecode_put | PUT /fyi/disclaimer/{typecode} | mark disclaimer read |
FYIApi | fyi_notifications_get | GET /fyi/notifications | Get a list of notifications |
FYIApi | fyi_notifications_more_get | GET /fyi/notifications/more | Get more notifications based on a certain one |
FYIApi | fyi_notifications_notification_id_put | PUT /fyi/notifications/{notificationId} | Get a list of notifications |
FYIApi | fyi_settings_get | GET /fyi/settings | Get a list of subscriptions |
FYIApi | fyi_settings_typecode_post | POST /fyi/settings/{typecode} | enable/disable certain subscription |
FYIApi | fyi_unreadnumber_get | GET /fyi/unreadnumber | Get unread number of fyis |
IBCustApi | ibcust_entity_info_get | GET /ibcust/entity/info | IBCust Entity Info |
MarketDataApi | iserver_marketdata_conid_unsubscribe_get | GET /iserver/marketdata/{conid}/unsubscribe | Market Data Cancel (Single) |
MarketDataApi | iserver_marketdata_history_get | GET /iserver/marketdata/history | Market Data History |
MarketDataApi | iserver_marketdata_snapshot_get | GET /iserver/marketdata/snapshot | Market Data |
MarketDataApi | iserver_marketdata_unsubscribeall_get | GET /iserver/marketdata/unsubscribeall | Market Data Cancel (All) |
OrderApi | iserver_account_account_id_order_order_id_delete | DELETE /iserver/account/{accountId}/order/{orderId} | Delete Order |
OrderApi | iserver_account_account_id_order_order_id_post | POST /iserver/account/{accountId}/order/{orderId} | Modify Order |
OrderApi | iserver_account_account_id_order_post | POST /iserver/account/{accountId}/order | Place Order |
OrderApi | iserver_account_account_id_order_whatif_post | POST /iserver/account/{accountId}/order/whatif | Preview Order |
OrderApi | iserver_account_account_id_orders_post | POST /iserver/account/{accountId}/orders | Place Orders (Support bracket orders) |
OrderApi | iserver_account_orders_get | GET /iserver/account/orders | Live Orders |
OrderApi | iserver_reply_replyid_post | POST /iserver/reply/{replyid} | Place Order Reply |
PnLApi | iserver_account_pnl_partitioned_get | GET /iserver/account/pnl/partitioned | PnL for the selected account |
PortfolioApi | portfolio_account_id_allocation_get | GET /portfolio/{accountId}/allocation | Account Allocation |
PortfolioApi | portfolio_account_id_ledger_get | GET /portfolio/{accountId}/ledger | Account Ledger |
PortfolioApi | portfolio_account_id_meta_get | GET /portfolio/{accountId}/meta | Account Information |
PortfolioApi | portfolio_account_id_position_conid_get | GET /portfolio/{accountId}/position/{conid} | Position by Conid |
PortfolioApi | portfolio_account_id_positions_invalidate_post | POST /portfolio/{accountId}/positions/invalidate | Invalidates the backend cache of the Portfolio |
PortfolioApi | portfolio_account_id_positions_page_id_get | GET /portfolio/{accountId}/positions/{pageId} | Portfolio Positions |
PortfolioApi | portfolio_account_id_summary_get | GET /portfolio/{accountId}/summary | Account Summary |
PortfolioApi | portfolio_accounts_get | GET /portfolio/accounts | Portfolio Accounts |
PortfolioApi | portfolio_allocation_post | POST /portfolio/allocation | Account Alloction (All Accounts) |
PortfolioApi | portfolio_positions_conid_get | GET /portfolio/positions/{conid} | Positions by Conid |
PortfolioApi | portfolio_subaccounts_get | GET /portfolio/subaccounts | List of Sub-Accounts |
PortfolioAnalystApi | pa_performance_post | POST /pa/performance | Account Performance |
PortfolioAnalystApi | pa_summary_post | POST /pa/summary | Account Balance's Summary |
ScannerApi | iserver_scanner_params_get | GET /iserver/scanner/params | get lists of available scanners |
ScannerApi | iserver_scanner_run_post | POST /iserver/scanner/run | run scanner to get a list of contracts |
SessionApi | iserver_auth_status_post | POST /iserver/auth/status | Authentication Status |
SessionApi | iserver_reauthenticate_post | POST /iserver/reauthenticate | Tries to re-authenticate to Brokerage |
SessionApi | logout_post | POST /logout | Ends the current session |
SessionApi | sso_validate_get | GET /sso/validate | Validate SSO |
SessionApi | tickle_post | POST /tickle | Ping the server to keep the session open |
TradesApi | iserver_account_trades_get | GET /iserver/account/trades | List of Trades for the selected account |
- Account
- AccountMaster
- Accounts
- Allocation
- AllocationInner
- AllocationInnerAssetClass
- AllocationInnerAssetClassLong
- AllocationInnerAssetClassShort
- AllocationInnerGroup
- AllocationInnerGroupLong
- AllocationInnerGroupShort
- AllocationInnerSector
- AllocationInnerSectorLong
- AllocationInnerSectorShort
- AuthStatus
- Body
- Body1
- Body2
- Body3
- Body4
- Body5
- Body6
- Body7
- CalendarRequest
- CalendarRequestDate
- CalendarRequestFilters
- Contract
- ContractRules
- Events
- EventsInner
- Futures
- FuturesInner
- HistoryData
- HistoryResult
- HistorydataData
- HistoryresultBars
- IbcustentityinfoAddress
- IbcustentityinfoEntities
- IbcustentityinfoName
- Inds
- IndsInner
- InlineResponse200
- InlineResponse2001
- InlineResponse20010
- InlineResponse20011
- InlineResponse20012
- InlineResponse20013
- InlineResponse20014
- InlineResponse20015
- InlineResponse20016
- InlineResponse20016Amount
- InlineResponse20016Equity
- InlineResponse20017
- InlineResponse20018
- InlineResponse20019
- InlineResponse2002
- InlineResponse20020
- InlineResponse20021
- InlineResponse20022
- InlineResponse20023
- InlineResponse20023FilterList
- InlineResponse20023InstrumentList
- InlineResponse20023LocationTree
- InlineResponse20023Locations
- InlineResponse20023ScanTypeList
- InlineResponse20024
- InlineResponse20025
- InlineResponse20026
- InlineResponse20027
- InlineResponse2003
- InlineResponse2004
- InlineResponse2004E
- InlineResponse2005
- InlineResponse2006
- InlineResponse2007
- InlineResponse2008
- InlineResponse2009
- InlineResponse400
- InlineResponse4001
- InlineResponse429
- Ledger
- MarketData
- ModifyOrder
- Notifications
- NotificationsInner
- Order
- OrderRequest
- Performance
- PerformanceCps
- PerformanceCpsData
- PerformanceNav
- PerformanceTpps
- Position
- PositionInner
- ScannerParams
- ScannerResult
- ScannerparamsFilter
- ScannerresultContracts
- ScannerresultContractsContract
- Secdef
- SecdefInfo
- SecdefInner
- SetAccount
- StatsData
- Stocks
- StocksInner
- StocksInnerContracts
- Summary
- Symbol
- SystemError
- Trade
- Wagers
- WagersInner
All endpoints do not require authorization.