Skip to main content
Version: v5

payoff

Draw what one position returns across a range of underlying prices.

Raises​

HTTPException If the expiration lists no strategy, or does not list the position.

Parameters​

symbol: str
Default: BTC
The underlying root, as it appears in the instrument name.

target_price: float
The price the underlying is expected to reach.

target_date: str
When it is expected to reach it.

budget: float
Default: 5000.0
The capital to put at risk, in the quote currency. Each position is sized so its worst loss across a threefold move either way is this much.

legs: str
The contracts to draw, as 'Buy SYMBOL / Sell 2 SYMBOL'. Click the Legs cell of a strategy in the optimizer to set it, or pick one here. Left empty, the best strategy for the view is drawn.

raw: bool
Default: False
theme: str
Default: dark


Returns​