Add Portfolio Lot
AddPortfolioLotRecord a user-confirmed purchase or sale in the caller's portfolio. Never infer or guess the instrument, quantity, price or date. For stock, pass ticker; a listing on another exchange is its MIC:TICKER symbol (e.g. XPAR:AIR, as ScreenStocks returns it). For an option, pass both its underlying ticker and verified OCC symbol; unknown or expired contracts are rejected. quantity is signed: positive for long shares/contracts, negative for short stock or written options. costPerUnit is always the positive per-share price or option premium, never the per-contract total, in the currency the listing trades in and in major units (London prices in pounds, not pence). Identical retries within the duplicate window return the existing lot instead of adding another.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| note | No | Optional. A short note from the user about this lot, up to 256 characters. | |
| fxRate | No | Optional. The broker's exchange rate on the trade, as units of the portfolio's currency per 1 unit of the stock's trading currency (e.g. 0.92 for EUR per USD). Only when the user states it; omit to convert at the official rate on the trade date. | |
| ticker | Yes | Stock ticker, or MIC:TICKER for a listing on another exchange, e.g. XPAR:AIR. For an option, the UNDERLYING U.S. ticker, e.g. AAPL. | |
| quantity | Yes | Signed size: shares for a stock, contracts for an option. Negative for a short sale or a written option. | |
| portfolio | Yes | The portfolio to add to, by name. | |
| costPerUnit | Yes | Price per share, always positive: paid for a long, received for a short. For an option, the premium per share (a $3.20 contract is 3.20, not 320). In the currency the stock trades in, in major units: London prices in pounds, not pence. | |
| acquiredDate | Yes | The trade date, as yyyy-MM-dd. Cannot be in the future. | |
| optionContract | No | Optional. The OCC option symbol, e.g. O:AAPL260724C00110000. Provide it to record an option contract; omit it for shares. |