price_ois_swap
Price a fixed-versus-compounded overnight index swap (OIS) using supplied market data, preset conventions, and discount/forward curves.
Instructions
Price an OIS (fixed vs compounded overnight) swap (POST /price-ois-swap).
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.
market: as in price_vanilla_swap.
preset: a preset with an ois_swap block (USD_SOFR_OIS: payment lag 2;
EUR_ESTR_OIS: payment lag 0).
swap_type, notional, fixed_rate, effective_date, termination_date | tenor,
spread, index_id, discounting_curve, forwarding_curve: as in
price_vanilla_swap (the overnight index id defaults to the preset's).
payment_lag, averaging_method, lookback_days, lockout_days,
apply_observation_shift, telescopic_value_dates: overnight-leg
parameters; each defaults to the preset's value (noted).
fixed_leg_overrides, overnight_leg_overrides, additional_trades, as_of,
include_flows: as in price_vanilla_swap.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| as_of | No | ||
| tenor | No | ||
| market | Yes | ||
| preset | Yes | ||
| spread | No | ||
| index_id | No | ||
| notional | Yes | ||
| swap_type | Yes | ||
| fixed_rate | Yes | ||
| request_id | No | ||
| payment_lag | No | ||
| lockout_days | No | ||
| include_flows | No | ||
| lookback_days | No | ||
| effective_date | Yes | ||
| averaging_method | No | ||
| forwarding_curve | Yes | ||
| termination_date | No | ||
| additional_trades | No | ||
| discounting_curve | Yes | ||
| calendar_overrides | No | ||
| market_data_source | Yes | ||
| fixed_leg_overrides | No | ||
| telescopic_value_dates | No | ||
| apply_observation_shift | No | ||
| overnight_leg_overrides | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||