1 stable release

1.0.0	Feb 22, 2021

#22 in #openapi-generator

Apache-2.0

365KB
6K SLoC

Rust API client for openapi

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

Overview

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.

API version: 1.0.0
Package version: 1.0.0
Build package: org.openapitools.codegen.languages.RustClientCodegen

Documentation for API Endpoints

All URIs are relative to https://localhost:5000/v1/api

Class	Method	HTTP request	Description
AccountApi	iserver_account_pnl_partitioned_get	get /iserver/account/pnl/partitioned	PnL for the selected account
AccountApi	iserver_account_post	post /iserver/account	Switch Account
AccountApi	iserver_accounts_get	get /iserver/accounts	Brokerage Accounts
AccountApi	portfolio_account_id_ledger_get	get /portfolio/{accountId}/ledger	Account Ledger
AccountApi	portfolio_account_id_meta_get	get /portfolio/{accountId}/meta	Account Information
AccountApi	portfolio_account_id_summary_get	get /portfolio/{accountId}/summary	Account Summary
AccountApi	portfolio_accounts_get	get /portfolio/accounts	Portfolio Accounts
AccountApi	portfolio_subaccounts_get	get /portfolio/subaccounts	List of Sub-Accounts
AlertApi	iserver_account_account_id_alert_activate_post	post /iserver/account/{accountId}/alert/activate	Activate or deactivate an alert
AlertApi	iserver_account_account_id_alert_alert_id_delete	delete /iserver/account/{accountId}/alert/{alertId}	Delete an alert
AlertApi	iserver_account_account_id_alert_post	post /iserver/account/{accountId}/alert	Create or modify alert
AlertApi	iserver_account_account_id_alerts_get	get /iserver/account/{accountId}/alerts	Get a list of available alerts
AlertApi	iserver_account_alert_id_get	get /iserver/account/alert/:id	Get details of an alert
AlertApi	iserver_account_mta_get	get /iserver/account/mta	Get MTA alert
ContractApi	iserver_contract_conid_info_and_rules_get	get /iserver/contract/{conid}/info-and-rules	Info and Rules
ContractApi	iserver_contract_conid_info_get	get /iserver/contract/{conid}/info	Contract Details
ContractApi	iserver_secdef_info_get	get /iserver/secdef/info	Secdef Info
ContractApi	iserver_secdef_search_post	post /iserver/secdef/search	Search by Symbol or Name
ContractApi	iserver_secdef_strikes_get	get /iserver/secdef/strikes	Search Strikes
ContractApi	trsrv_futures_get	get /trsrv/futures	Security Futures by Symbol
ContractApi	trsrv_secdef_post	post /trsrv/secdef	Secdef by Conid
ContractApi	trsrv_secdef_schedule_get	get /trsrv/secdef/schedule	Get trading schedule for symbol
ContractApi	trsrv_stocks_get	get /trsrv/stocks	Security Stocks by Symbol
FYIApi	fyi_deliveryoptions_device_id_delete	delete /fyi/deliveryoptions/{deviceId}	Delete a device
FYIApi	fyi_deliveryoptions_device_post	post /fyi/deliveryoptions/device	Enable/Disable device option
FYIApi	fyi_deliveryoptions_email_put	put /fyi/deliveryoptions/email	Enable/Disable email option
FYIApi	fyi_deliveryoptions_get	get /fyi/deliveryoptions	Get delivery options
FYIApi	fyi_disclaimer_typecode_get	get /fyi/disclaimer/{typecode}	Get disclaimer for a certain kind of fyi
FYIApi	fyi_disclaimer_typecode_put	put /fyi/disclaimer/{typecode}	Mark disclaimer read
FYIApi	fyi_notifications_get	get /fyi/notifications	Get a list of notifications
FYIApi	fyi_notifications_more_get	get /fyi/notifications/more	Get more notifications based on a certain one
FYIApi	fyi_notifications_notification_id_put	put /fyi/notifications/{notificationId}	Get a list of notifications
FYIApi	fyi_settings_get	get /fyi/settings	Get a list of subscriptions
FYIApi	fyi_settings_typecode_post	post /fyi/settings/{typecode}	Enable/Disable certain subscription
FYIApi	fyi_unreadnumber_get	get /fyi/unreadnumber	Get unread number of fyis. The HTTP method POST is also supported.
IBCustApi	ibcust_entity_info_get	get /ibcust/entity/info	IBCust Entity Info
MarketDataApi	iserver_marketdata_conid_unsubscribe_get	get /iserver/marketdata/{conid}/unsubscribe	Market Data Cancel (Single)
MarketDataApi	iserver_marketdata_history_get	get /iserver/marketdata/history	Market Data History
MarketDataApi	iserver_marketdata_snapshot_get	get /iserver/marketdata/snapshot	Market Data
MarketDataApi	iserver_marketdata_unsubscribeall_get	get /iserver/marketdata/unsubscribeall	Market Data Cancel (All)
OrderApi	iserver_account_account_id_order_order_id_delete	delete /iserver/account/{accountId}/order/{orderId}	Cancel Order
OrderApi	iserver_account_account_id_order_order_id_post	post /iserver/account/{accountId}/order/{orderId}	Modify Order
OrderApi	iserver_account_account_id_order_post	post /iserver/account/{accountId}/order	Place Order
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_fa_group_post	post /iserver/account/orders/{faGroup}	Place Orders for Financial Advisor Groups
OrderApi	iserver_account_orders_get	get /iserver/account/orders	Live Orders
OrderApi	iserver_reply_replyid_post	post /iserver/reply/{replyid}	Place Order Reply
PnLApi	iserver_account_pnl_partitioned_get	get /iserver/account/pnl/partitioned	PnL for the selected account
PortfolioApi	portfolio_account_id_allocation_get	get /portfolio/{accountId}/allocation	Account Allocation
PortfolioApi	portfolio_account_id_ledger_get	get /portfolio/{accountId}/ledger	Account Ledger
PortfolioApi	portfolio_account_id_meta_get	get /portfolio/{accountId}/meta	Account Information
PortfolioApi	portfolio_account_id_position_conid_get	get /portfolio/{accountId}/position/{conid}	Position by Conid
PortfolioApi	portfolio_account_id_positions_invalidate_post	post /portfolio/{accountId}/positions/invalidate	Invalidates the backend cache of the Portfolio
PortfolioApi	portfolio_account_id_positions_page_id_get	get /portfolio/{accountId}/positions/{pageId}	Portfolio Positions
PortfolioApi	portfolio_account_id_summary_get	get /portfolio/{accountId}/summary	Account Summary
PortfolioApi	portfolio_accounts_get	get /portfolio/accounts	Portfolio Accounts
PortfolioApi	portfolio_allocation_post	post /portfolio/allocation	Account Alloction (All Accounts)
PortfolioApi	portfolio_positions_conid_get	get /portfolio/positions/{conid}	Positions by Conid
PortfolioApi	portfolio_subaccounts_get	get /portfolio/subaccounts	List of Sub-Accounts
PortfolioAnalystApi	pa_performance_post	post /pa/performance	Account Performance
PortfolioAnalystApi	pa_summary_post	post /pa/summary	Account Balance's Summary
PortfolioAnalystApi	pa_transactions_post	post /pa/transactions	Position's Transaction History
ScannerApi	iserver_scanner_params_get	get /iserver/scanner/params	Scanner Parameters
ScannerApi	iserver_scanner_run_post	post /iserver/scanner/run	run scanner to get a list of contracts
SessionApi	iserver_auth_status_post	post /iserver/auth/status	Authentication Status
SessionApi	iserver_reauthenticate_post	post /iserver/reauthenticate	Tries to re-authenticate to Brokerage
SessionApi	logout_post	post /logout	Ends the current session
SessionApi	sso_validate_get	get /sso/validate	Validate SSO
SessionApi	tickle_post	post /tickle	Ping the server to keep the session open
StreamingApi	ws_post	post /ws	Websocket Endpoint
TradesApi	iserver_account_trades_get	get /iserver/account/trades	List of Trades for the selected account

Documentation For Models

To get access to the crate's generated documentation, use:

cargo doc --open

Author

Dependencies

~5–9.5MB
~199K SLoC