price_cap_floor
Price interest-rate caps, floors, or collars using user-supplied market data, curves, volatility, and model to get NPV, ATM rate, and implied volatility.
Instructions
Price an interest-rate cap, floor or collar (POST /price-cap-floor).
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.
preset: a preset with a cap_floor block (EUR_EURIBOR_3M quarterly,
EUR_EURIBOR_6M semiannual).
cap_floor_type: Cap | Floor | Collar. strike: decimal.
effective_date, termination_date | tenor: as in price_vanilla_swap.
vol: {constant: 0.2, type: Lognormal|Normal|ShiftedLognormal, displacement?, id?} (an OptionletVolSpec the tool adds to the market, base conventions
from the preset) or the id of a surface already in the market.
model: Black | Bachelier | ShiftedBlack | HullWhiteLattice (a
CapFloorModelSpec the tool adds, id <type>_model) or a model id.
include_details: per-caplet breakdown.
frequency, day_counter, business_day_convention, schedule_overrides:
default from the preset (noted).
summary.cap_floors: npv, atm_rate, implied_volatility.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| vol | Yes | ||
| as_of | No | ||
| model | Yes | ||
| tenor | No | ||
| market | Yes | ||
| preset | Yes | ||
| strike | Yes | ||
| index_id | No | ||
| notional | Yes | ||
| frequency | No | ||
| request_id | No | ||
| day_counter | No | ||
| cap_floor_type | Yes | ||
| effective_date | Yes | ||
| include_details | No | ||
| forwarding_curve | Yes | ||
| termination_date | No | ||
| additional_trades | No | ||
| discounting_curve | Yes | ||
| calendar_overrides | No | ||
| market_data_source | Yes | ||
| schedule_overrides | No | ||
| business_day_convention | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||