{
  "status": "illustrative_contract_examples",
  "description": "Illustrative contract responses with example release identifiers and historical values; not captured production responses or current market quotes.",
  "examples": [
    {
      "name": "markets-market_activity",
      "method": "GET",
      "path": "/v1/markets/series",
      "query": {
        "dataset": "market_activity",
        "area": "E08000025",
        "property_type": "flat"
      },
      "http_status": 200,
      "response_file": "markets-market_activity.json"
    },
    {
      "name": "markets-price_bands",
      "method": "GET",
      "path": "/v1/markets/series",
      "query": {
        "dataset": "price_bands",
        "area": "E08000025",
        "price_band": "1"
      },
      "http_status": 200,
      "response_file": "markets-price_bands.json"
    },
    {
      "name": "markets-rental_market",
      "method": "GET",
      "path": "/v1/markets/series",
      "query": {
        "dataset": "rental_market",
        "area": "E08000025",
        "property_type": "flat",
        "bedroom_group": "studio_1"
      },
      "http_status": 200,
      "response_file": "markets-rental_market.json"
    },
    {
      "name": "markets-new_build_price_differential",
      "method": "GET",
      "path": "/v1/markets/series",
      "query": {
        "dataset": "new_build_price_differential",
        "area": "E08000025",
        "property_type": "flat"
      },
      "http_status": 200,
      "response_file": "markets-new_build_price_differential.json"
    },
    {
      "name": "markets-new_build_deliveries",
      "method": "GET",
      "path": "/v1/markets/series",
      "query": {
        "dataset": "new_build_deliveries",
        "area": "E08000025",
        "property_type": "flat"
      },
      "http_status": 200,
      "response_file": "markets-new_build_deliveries.json"
    },
    {
      "name": "markets-new_build_sales_share",
      "method": "GET",
      "path": "/v1/markets/series",
      "query": {
        "dataset": "new_build_sales_share",
        "area": "E08000025",
        "property_type": "flat"
      },
      "http_status": 200,
      "response_file": "markets-new_build_sales_share.json"
    },
    {
      "name": "markets-development_deliveries",
      "method": "GET",
      "path": "/v1/markets/series",
      "query": {
        "dataset": "development_deliveries",
        "area": "E08000025",
        "property_type": "flat",
        "development_size": "small"
      },
      "http_status": 200,
      "response_file": "markets-development_deliveries.json"
    },
    {
      "name": "markets-datasets",
      "method": "GET",
      "path": "/v1/markets/datasets",
      "query": {},
      "http_status": 200,
      "response_file": "markets-datasets.json"
    },
    {
      "name": "markets-releases-current",
      "method": "GET",
      "path": "/v1/markets/releases/current",
      "query": {},
      "http_status": 200,
      "response_file": "markets-releases-current.json"
    },
    {
      "name": "rates-bank_rate",
      "method": "GET",
      "path": "/v1/rates/series",
      "query": {
        "dataset": "bank_rate"
      },
      "http_status": 200,
      "response_file": "rates-bank_rate.json"
    },
    {
      "name": "rates-sonia_overnight",
      "method": "GET",
      "path": "/v1/rates/series",
      "query": {
        "dataset": "sonia_overnight"
      },
      "http_status": 200,
      "response_file": "rates-sonia_overnight.json"
    },
    {
      "name": "rates-sonia_compounded_index",
      "method": "GET",
      "path": "/v1/rates/series",
      "query": {
        "dataset": "sonia_compounded_index"
      },
      "http_status": 200,
      "response_file": "rates-sonia_compounded_index.json"
    },
    {
      "name": "rates-ois_spot_curve",
      "method": "GET",
      "path": "/v1/rates/series",
      "query": {
        "dataset": "ois_spot_curve",
        "tenor_months": "60"
      },
      "http_status": 200,
      "response_file": "rates-ois_spot_curve.json"
    },
    {
      "name": "rates-ois_forward_curve",
      "method": "GET",
      "path": "/v1/rates/series",
      "query": {
        "dataset": "ois_forward_curve",
        "tenor_months": "60"
      },
      "http_status": 200,
      "response_file": "rates-ois_forward_curve.json"
    },
    {
      "name": "rates-indicative_swap_rates",
      "method": "GET",
      "path": "/v1/rates/series",
      "query": {
        "dataset": "indicative_swap_rates",
        "term_years": "5"
      },
      "http_status": 200,
      "response_file": "rates-indicative_swap_rates.json"
    },
    {
      "name": "rates-forward_starting_swap_rates",
      "method": "GET",
      "path": "/v1/rates/series",
      "query": {
        "dataset": "forward_starting_swap_rates",
        "term_years": "5",
        "horizon_from_month": "12",
        "horizon_to_month": "12"
      },
      "http_status": 200,
      "response_file": "rates-forward_starting_swap_rates.json"
    },
    {
      "name": "rates-nominal_gilt_spot_curve",
      "method": "GET",
      "path": "/v1/rates/series",
      "query": {
        "dataset": "nominal_gilt_spot_curve",
        "tenor_months": "60"
      },
      "http_status": 200,
      "response_file": "rates-nominal_gilt_spot_curve.json"
    },
    {
      "name": "rates-nominal_gilt_forward_curve",
      "method": "GET",
      "path": "/v1/rates/series",
      "query": {
        "dataset": "nominal_gilt_forward_curve",
        "tenor_months": "60"
      },
      "http_status": 200,
      "response_file": "rates-nominal_gilt_forward_curve.json"
    },
    {
      "name": "rates-real_gilt_spot_curve",
      "method": "GET",
      "path": "/v1/rates/series",
      "query": {
        "dataset": "real_gilt_spot_curve",
        "tenor_months": "60"
      },
      "http_status": 200,
      "response_file": "rates-real_gilt_spot_curve.json"
    },
    {
      "name": "rates-real_gilt_forward_curve",
      "method": "GET",
      "path": "/v1/rates/series",
      "query": {
        "dataset": "real_gilt_forward_curve",
        "tenor_months": "60"
      },
      "http_status": 200,
      "response_file": "rates-real_gilt_forward_curve.json"
    },
    {
      "name": "rates-market_implied_inflation",
      "method": "GET",
      "path": "/v1/rates/series",
      "query": {
        "dataset": "market_implied_inflation",
        "tenor_months": "60"
      },
      "http_status": 200,
      "response_file": "rates-market_implied_inflation.json"
    },
    {
      "name": "rates-market_implied_inflation_forward",
      "method": "GET",
      "path": "/v1/rates/series",
      "query": {
        "dataset": "market_implied_inflation_forward",
        "tenor_months": "60"
      },
      "http_status": 200,
      "response_file": "rates-market_implied_inflation_forward.json"
    },
    {
      "name": "rates-mortgage_benchmarks",
      "method": "GET",
      "path": "/v1/rates/series",
      "query": {
        "dataset": "mortgage_benchmarks",
        "mortgage_product": "btl_fixed_2y_75ltv"
      },
      "http_status": 200,
      "response_file": "rates-mortgage_benchmarks.json"
    },
    {
      "name": "rates-mortgage_swap_spread",
      "method": "GET",
      "path": "/v1/rates/series",
      "query": {
        "dataset": "mortgage_swap_spread",
        "mortgage_product": "btl_fixed_2y_75ltv"
      },
      "http_status": 200,
      "response_file": "rates-mortgage_swap_spread.json"
    },
    {
      "name": "rates-mortgage_reversion_spread",
      "method": "GET",
      "path": "/v1/rates/series",
      "query": {
        "dataset": "mortgage_reversion_spread"
      },
      "http_status": 200,
      "response_file": "rates-mortgage_reversion_spread.json"
    },
    {
      "name": "rates-mortgage_spread_summary",
      "method": "GET",
      "path": "/v1/rates/series",
      "query": {
        "dataset": "mortgage_spread_summary",
        "mortgage_product": "btl_fixed_2y_75ltv"
      },
      "http_status": 200,
      "response_file": "rates-mortgage_spread_summary.json"
    },
    {
      "name": "rates-sonia_forward_path",
      "method": "GET",
      "path": "/v1/rates/series",
      "query": {
        "dataset": "sonia_forward_path",
        "horizon_from_month": "12",
        "horizon_to_month": "12"
      },
      "http_status": 200,
      "response_file": "rates-sonia_forward_path.json"
    },
    {
      "name": "rates-bank_rate_scenarios",
      "method": "GET",
      "path": "/v1/rates/series",
      "query": {
        "dataset": "bank_rate_scenarios",
        "horizon_from_month": "12",
        "horizon_to_month": "12"
      },
      "http_status": 200,
      "response_file": "rates-bank_rate_scenarios.json"
    },
    {
      "name": "rates-btl_refinancing_scenarios",
      "method": "GET",
      "path": "/v1/rates/series",
      "query": {
        "dataset": "btl_refinancing_scenarios",
        "term_years": "5",
        "horizon_from_month": "12",
        "horizon_to_month": "12"
      },
      "http_status": 200,
      "response_file": "rates-btl_refinancing_scenarios.json"
    },
    {
      "name": "rates-mortgage_reversion_scenarios",
      "method": "GET",
      "path": "/v1/rates/series",
      "query": {
        "dataset": "mortgage_reversion_scenarios",
        "horizon_from_month": "12",
        "horizon_to_month": "12"
      },
      "http_status": 200,
      "response_file": "rates-mortgage_reversion_scenarios.json"
    },
    {
      "name": "rates-financing_stress_scenarios",
      "method": "GET",
      "path": "/v1/rates/series",
      "query": {
        "dataset": "financing_stress_scenarios",
        "scenario": "market_base",
        "horizon_from_month": "12",
        "horizon_to_month": "12"
      },
      "http_status": 200,
      "response_file": "rates-financing_stress_scenarios.json"
    },
    {
      "name": "rates-datasets",
      "method": "GET",
      "path": "/v1/rates/datasets",
      "query": {},
      "http_status": 200,
      "response_file": "rates-datasets.json"
    },
    {
      "name": "rates-releases-current",
      "method": "GET",
      "path": "/v1/rates/releases/current",
      "query": {},
      "http_status": 200,
      "response_file": "rates-releases-current.json"
    },
    {
      "name": "markets-areas",
      "method": "GET",
      "path": "/v1/markets/areas",
      "query": {},
      "http_status": 200,
      "response_file": "markets-areas.json"
    },
    {
      "name": "markets-coverage",
      "method": "GET",
      "path": "/v1/markets/coverage",
      "query": {
        "dataset": "rental_market",
        "area": "E08000025",
        "property_type": "flat",
        "bedroom_group": "studio_1"
      },
      "http_status": 200,
      "response_file": "markets-coverage.json"
    },
    {
      "name": "rates-coverage",
      "method": "GET",
      "path": "/v1/rates/coverage",
      "query": {
        "dataset": "ois_spot_curve",
        "tenor_months": "60"
      },
      "http_status": 200,
      "response_file": "rates-coverage.json"
    },
    {
      "name": "rates-empty-range",
      "method": "GET",
      "path": "/v1/rates/series",
      "query": {
        "dataset": "bank_rate",
        "from": "1900-01-01",
        "to": "1900-01-01"
      },
      "http_status": 200,
      "response_file": "rates-empty-range.json"
    },
    {
      "name": "error-missing-dataset",
      "method": "GET",
      "path": "/v1/markets/series",
      "query": {},
      "http_status": 422,
      "response_file": "error-missing-dataset.json"
    },
    {
      "name": "error-unknown-parameter",
      "method": "GET",
      "path": "/v1/rates/series",
      "query": {
        "dataset": "bank_rate",
        "area": "E08000025"
      },
      "http_status": 400,
      "response_file": "error-unknown-parameter.json"
    },
    {
      "name": "error-invalid-date",
      "method": "GET",
      "path": "/v1/rates/series",
      "query": {
        "dataset": "bank_rate",
        "from": "2026-08"
      },
      "http_status": 422,
      "response_file": "error-invalid-date.json"
    }
  ]
}