price_yoy_inflation_cap_floor
Prices year-on-year inflation caps, floors, and collars using supplied fixings, curves, and volatility to return valuations for hedging and risk analysis.
Instructions
Price a year-on-year inflation cap / floor / collar (POST /price-year-on-year-inflation-cap-floor).
fixings REQUIRED as in price_yoy_inflation_swap. vol:
{constant: 0.01, type: Black|Bachelier|UnitDisplacedBlack, id?} (a
YoYOptionletVolSpec the tool adds with the preset's conventions) or a surface
id. cap_rate for Cap/Collar, floor_rate for Floor/Collar.
Args:
market_data_source: where the market numbers in this call come from. user_pasted
(the user pasted or typed the numbers in this conversation), user_file (the
user attached a file/screenshot the numbers were read from), engine_example
(an engine example's pricing block, only when the user explicitly asked to run
an example), session (a market previously stored in this session, which
itself came from one of the above). There is no value for estimated, recalled or
placeholder data. If you would have to invent numbers, do not call this tool:
ask the user for the data.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| vol | Yes | ||
| as_of | No | ||
| tenor | No | ||
| market | Yes | ||
| preset | No | EUR_HICP | |
| spread | No | ||
| fixings | Yes | ||
| gearing | No | ||
| cap_rate | No | ||
| notional | Yes | ||
| frequency | No | ||
| floor_rate | No | ||
| request_id | No | ||
| cap_floor_type | Yes | ||
| effective_date | No | as_of | |
| inflation_curve | Yes | ||
| termination_date | No | ||
| additional_trades | No | ||
| discounting_curve | Yes | ||
| calendar_overrides | No | ||
| inflation_index_id | Yes | ||
| market_data_source | Yes | ||
| schedule_overrides | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||