| search_instrumentA | Fetch instruments, optionally filtered by ticker or name.
Args:
search_term: Search term to filter instruments by ticker or name
(case-insensitive)
Returns:
List of matching TradeableInstrument objects, or all instruments if no
search term is provided
|
| search_exchangeA | Fetch exchanges, optionally filtered by name or ID.
Args:
search_term: Optional search term to filter exchanges by name or ID
(case-insensitive)
Returns:
List of matching Exchange objects, or all exchanges if no search term
is provided
|
| fetch_piesA | |
| create_pieB | Create a new pie with the specified parameters.
Args:
name: Name of the pie
instrument_shares: Dictionary mapping instrument tickers to their
weights in the pie
(e.g., {'AAPL_US_EQ': 0.5, 'MSFT_US_EQ': 0.5})
dividend_cash_action: How dividends are handled. Defaults to REINVEST.
Possible values: REINVEST, TO_ACCOUNT_CASH
end_date: Optional end date for the pie in ISO 8601 format
(e.g., '2024-12-31T23:59:59Z')
goal: Total desired value of the pie in account currency
icon: Optional icon identifier for the pie
Returns:
AccountBucketInstrumentsDetailedResponse: Details of the created pie
|
| delete_pieC | |
| fetch_a_pieB | Fetch a specific pie by ID. |
| update_pieA | Update an existing pie with new parameters. The pie must be renamed when
updating it.
Args:
pie_id: ID of the pie to update
name: New name for the pie. Required when updating a pie.
instrument_shares: Dictionary mapping instrument tickers to their new
weights in the pie
(e.g., {'AAPL_US_EQ': 0.5, 'MSFT_US_EQ': 0.5})
dividend_cash_action: How dividends should be handled.
Possible values: REINVEST, TO_ACCOUNT_CASH
end_date: New end date for the pie in ISO 8601 format
(e.g., '2024-12-31T23:59:59Z')
goal: New total desired value of the pie in account currency
icon: New icon identifier for the pie
Returns:
AccountBucketInstrumentsDetailedResponse: Updated details of the pie
|
| duplicate_pieA | Create a duplicate of an existing pie.
Args:
pie_id: ID of the pie to duplicate
name: Optional new name for the duplicated pie
icon: Optional new icon for the duplicated pie
Returns:
AccountBucketInstrumentsDetailedResponse: Details of the duplicated pie
|
| fetch_all_ordersB | |
| place_limit_orderA | Place a limit order to buy or sell an instrument at a specified price or better.
Args:
ticker: Ticker symbol of the instrument to trade (e.g., 'AAPL_US_EQ')
quantity: Number of shares/units to trade
limit_price: Limit price for the order
time_validity: Time validity of the order. Defaults to DAY.
Possible values: DAY, GOOD_TILL_CANCEL
Returns:
Order: Details of the placed order
|
| place_market_orderB | Place a market order to buy or sell an instrument at the current market price.
Args:
ticker: Ticker symbol of the instrument to trade (e.g., 'AAPL_US_EQ')
quantity: Number of shares/units to trade
extended_hours: Whether the order can execute outside regular trading
hours when the instrument supports it
Returns:
Order: Details of the placed order
|
| place_stop_orderA | Place a stop order to buy or sell an instrument when the market price
reaches a specified stop price.
Args:
ticker: Ticker symbol of the instrument to trade (e.g., 'AAPL_US_EQ')
quantity: Number of shares/units to trade
stop_price: Stop price that triggers the order
time_validity: Time validity of the order. Defaults to DAY.
Possible values: DAY, GOOD_TILL_CANCEL
Returns:
Order: Details of the placed order
|
| place_stop_limit_orderA | Place a stop-limit order to buy or sell an instrument when the market
price reaches a specified stop price, then execute at a specified limit
price or better.
Args:
ticker: Ticker symbol of the instrument to trade (e.g., 'AAPL_US_EQ')
quantity: Number of shares/units to trade
stop_price: Stop price that triggers the limit order
limit_price: Limit price for the order
time_validity: Time validity of the order. Defaults to DAY.
Possible values: DAY, GOOD_TILL_CANCEL
Returns:
Order: Details of the placed order
|
| cancel_orderC | Cancel an existing order. |
| fetch_orderC | Fetch a specific order by ID. |
| fetch_account_infoC | Fetch the account summary. |
| fetch_account_summaryB | Fetch the account summary. |
| fetch_account_cashA | Fetch account cash balance. |
| fetch_positionsA | Fetch open positions, optionally filtered by ticker. |
| fetch_position_by_tickerC | Fetch a single open position by ticker. |
| fetch_all_open_positionsA | Deprecated alias for fetch_positions(). |
| fetch_open_position_by_tickerB | Deprecated alias for fetch_position_by_ticker(). |
| search_specific_position_by_tickerB | Deprecated alias for fetch_position_by_ticker(). |
| fetch_historical_order_dataC | Fetch historical order data with pagination. |
| fetch_paid_out_dividendsC | Fetch historical dividend data with pagination. |
| fetch_exports_listA | Lists detailed information about all csv account exports. |
| request_csv_exportA | Request a CSV export of the account's orders, dividends and transactions
history.
Once the export is complete it can be accessed from the download link in the
exports list.
Args:
include_dividends: Whether to include dividend information in the export.
Defaults to True
include_interest: Whether to include interest information in the export.
Defaults to True
include_orders: Whether to include order history in the export.
Defaults to True
include_transactions: Whether to include transaction history in the export.
Defaults to True
time_from: Start time for the report in ISO 8601 format
(e.g., '2023-01-01T00:00:00Z')
time_to: End time for the report in ISO 8601 format
(e.g., '2023-12-31T23:59:59Z')
Returns:
EnqueuedReportResponse: Response containing the report ID and status
|
| fetch_transaction_listC | Fetch superficial information about movements to and from your
account. |
