Request and Response Examples

These illustrative responses show the documented contract using example release identifiers and historical values. They are not captured production responses, current market quotes or promises of coverage and recency. The examples use accepted to demonstrate a normally served release; null publication timestamps mean no timestamp is recorded.

All requests require authentication. Use /releases/current and /coverage to discover the release and periods available to your account.

The example index pairs every request with its full JSON response. Each curve/path example selects a small number of nodes for readability; omitting those filters returns the retained nodes, subject to pagination.

Complete Example Library

Example	HTTP Status	Response
`markets-market_activity`	200	JSON
`markets-price_bands`	200	JSON
`markets-rental_market`	200	JSON
`markets-new_build_price_differential`	200	JSON
`markets-new_build_deliveries`	200	JSON
`markets-new_build_sales_share`	200	JSON
`markets-development_deliveries`	200	JSON
`markets-datasets`	200	JSON
`markets-releases-current`	200	JSON
`rates-bank_rate`	200	JSON
`rates-sonia_overnight`	200	JSON
`rates-sonia_compounded_index`	200	JSON
`rates-ois_spot_curve`	200	JSON
`rates-ois_forward_curve`	200	JSON
`rates-indicative_swap_rates`	200	JSON
`rates-forward_starting_swap_rates`	200	JSON
`rates-nominal_gilt_spot_curve`	200	JSON
`rates-nominal_gilt_forward_curve`	200	JSON
`rates-real_gilt_spot_curve`	200	JSON
`rates-real_gilt_forward_curve`	200	JSON
`rates-market_implied_inflation`	200	JSON
`rates-market_implied_inflation_forward`	200	JSON
`rates-mortgage_benchmarks`	200	JSON
`rates-mortgage_swap_spread`	200	JSON
`rates-mortgage_reversion_spread`	200	JSON
`rates-mortgage_spread_summary`	200	JSON
`rates-sonia_forward_path`	200	JSON
`rates-bank_rate_scenarios`	200	JSON
`rates-btl_refinancing_scenarios`	200	JSON
`rates-mortgage_reversion_scenarios`	200	JSON
`rates-financing_stress_scenarios`	200	JSON
`rates-datasets`	200	JSON
`rates-releases-current`	200	JSON
`markets-areas`	200	JSON
`markets-coverage`	200	JSON
`rates-coverage`	200	JSON
`rates-empty-range`	200	JSON
`error-missing-dataset`	422	JSON
`error-unknown-parameter`	400	JSON
`error-invalid-date`	422	JSON

Market Activity

http

GET /v1/markets/series?dataset=market_activity&area=E08000025&property_type=flat

HTTP 200

json

{
  "request_id": "data_14f4882ca0e64e3dbdd292c66281184f",
  "dataset": "market_activity",
  "release_id": "example-markets-release",
  "published_at": null,
  "release_status": "accepted",
  "selection": {
    "area": "E08000025",
    "property_type": "flat",
    "mode": "latest"
  },
  "revision_policy": "Values may be revised in subsequent releases.",
  "series": [
    {
      "basis": "estimated",
      "frequency": "monthly",
      "metric": "price_per_sqm_gbp",
      "unit": "GBP/m2",
      "window_months": 12,
      "series_id": "series_19a55eef49db719eb49efbd02cba8a2f",
      "dimensions": {},
      "availability": {
        "status": "available",
        "from": "2026-05",
        "to": "2026-06"
      },
      "observations": [
        {
          "period": "2026-06",
          "period_end": "2026-06-30",
          "period_start": "2025-07-01",
          "status": "estimated",
          "value": 2491.0485952010913
        }
      ]
    },
    {
      "basis": "recorded_revisable",
      "frequency": "monthly",
      "metric": "sales_count",
      "unit": "sales",
      "window_months": 12,
      "series_id": "series_09e2e1e81072067ce3277c2d2a5eed12",
      "dimensions": {},
      "availability": {
        "status": "available",
        "from": "2026-05",
        "to": "2026-06"
      },
      "observations": [
        {
          "period": "2026-06",
          "period_end": "2026-06-30",
          "period_start": "2025-07-01",
          "status": "recorded_revisable",
          "value": 1806
        }
      ]
    },
    {
      "basis": "recorded_revisable",
      "frequency": "monthly",
      "metric": "sales_share_pct",
      "unit": "percent",
      "window_months": 12,
      "series_id": "series_ede7302e37ba265cd45e6064ad264e81",
      "dimensions": {},
      "availability": {
        "status": "available",
        "from": "2026-05",
        "to": "2026-06"
      },
      "observations": [
        {
          "period": "2026-06",
          "period_end": "2026-06-30",
          "period_start": "2025-07-01",
          "status": "recorded_revisable",
          "value": 17.906008328375968
        }
      ]
    },
    {
      "basis": "recorded_revisable",
      "frequency": "monthly",
      "metric": "sales_value_gbp",
      "unit": "GBP",
      "window_months": 12,
      "series_id": "series_c8b25b6c2f87aaf460ec42fc1d2a3164",
      "dimensions": {},
      "availability": {
        "status": "available",
        "from": "2026-05",
        "to": "2026-06"
      },
      "observations": [
        {
          "period": "2026-06",
          "period_end": "2026-06-30",
          "period_start": "2025-07-01",
          "status": "recorded_revisable",
          "value": 305550444.0
        }
      ]
    },
    {
      "basis": "recorded_revisable",
      "frequency": "monthly",
      "metric": "sales_value_per_km2_gbp",
      "unit": "GBP/km2",
      "window_months": 12,
      "series_id": "series_097ff94c60d5b527e8d6f36d89e40527",
      "dimensions": {},
      "availability": {
        "status": "available",
        "from": "2026-05",
        "to": "2026-06"
      },
      "observations": [
        {
          "period": "2026-06",
          "period_end": "2026-06-30",
          "period_start": "2025-07-01",
          "status": "recorded_revisable",
          "value": 1141053.2628922402
        }
      ]
    }
  ],
  "next_cursor": null
}

Mixed-Date Rental Market

http

GET /v1/markets/series?dataset=rental_market&area=E08000025&property_type=flat&bedroom_group=studio_1

HTTP 200

json

{
  "request_id": "data_97be9dc918884f7d915fd2b03a365387",
  "dataset": "rental_market",
  "release_id": "example-markets-release",
  "published_at": null,
  "release_status": "accepted",
  "selection": {
    "area": "E08000025",
    "property_type": "flat",
    "bedroom_group": "studio_1",
    "mode": "latest"
  },
  "revision_policy": "Values may be revised in subsequent releases.",
  "series": [
    {
      "basis": "estimated",
      "capital_window_months": 24,
      "frequency": "monthly",
      "metric": "gross_yield_pct",
      "rental_window_months": 12,
      "unit": "percent",
      "window_months": null,
      "series_id": "series_44af273977c40e3aee9b080b52e8c922",
      "dimensions": {},
      "availability": {
        "status": "available",
        "from": "2026-05",
        "to": "2026-07"
      },
      "observations": [
        {
          "capital_observation_month": "2026-06",
          "capital_period_end": "2026-06-30",
          "capital_period_start": "2024-07-01",
          "input_month_gap": 1,
          "mixed_vintage": true,
          "period": "2026-07",
          "rental_observation_month": "2026-07",
          "rental_period_end": "2026-07-31",
          "rental_period_start": "2025-08-01",
          "status": "estimated",
          "structure_observation_month": "2026-06",
          "value": 6.81073794944787
        }
      ]
    },
    {
      "basis": "estimated",
      "frequency": "monthly",
      "metric": "monthly_rent_gbp",
      "unit": "GBP/month",
      "window_months": 12,
      "series_id": "series_07adbeed6429e4962c3372dc3920ed47",
      "dimensions": {},
      "availability": {
        "status": "available",
        "from": "2026-05",
        "to": "2026-07"
      },
      "observations": [
        {
          "period": "2026-07",
          "period_end": "2026-07-31",
          "period_start": "2025-08-01",
          "rental_observation_month": "2026-07",
          "status": "estimated",
          "structure_observation_month": "2026-06",
          "value": 733.8212502009297
        }
      ]
    },
    {
      "basis": "estimated",
      "frequency": "monthly",
      "metric": "property_value_gbp",
      "unit": "GBP",
      "window_months": 24,
      "series_id": "series_94522c19826ba731b1d3f04a4882b827",
      "dimensions": {},
      "availability": {
        "status": "available",
        "from": "2026-05",
        "to": "2026-06"
      },
      "observations": [
        {
          "capital_observation_month": "2026-06",
          "period": "2026-06",
          "period_end": "2026-06-30",
          "period_start": "2024-07-01",
          "status": "estimated",
          "value": 129293.69868246106
        }
      ]
    }
  ],
  "next_cursor": null
}

A Curve Node

http

GET /v1/rates/series?dataset=ois_spot_curve&tenor_months=60

HTTP 200

json

{
  "request_id": "data_506227e2ea3e4af187e547dcd00cc909",
  "dataset": "ois_spot_curve",
  "release_id": "example-rates-release",
  "published_at": null,
  "release_status": "accepted",
  "selection": {
    "tenor_months": "60",
    "mode": "latest"
  },
  "revision_policy": "Values may be revised in subsequent releases.",
  "series": [
    {
      "basis": "indicative",
      "frequency": "daily",
      "history_capability": "retained_observations",
      "metric": "rate_pct",
      "unit": "percent",
      "series_id": "series_97429054685ccdd56d6faf515f367f8d",
      "dimensions": {
        "tenor_months": 60
      },
      "availability": {
        "status": "available",
        "from": "2026-08-03",
        "to": "2026-09-14"
      },
      "observations": [
        {
          "compounding": "continuous_annual",
          "day_count": "ACT/365",
          "interval_end_date": "2031-09-14",
          "interval_end_month": 60,
          "interval_kind": "spot_from_as_of_to_maturity",
          "interval_start_date": "2026-09-14",
          "interval_start_month": 0,
          "period": "2026-09-14",
          "snapshot_date": "2026-09-14",
          "status": "indicative",
          "value": 4.679327772688851
        }
      ]
    }
  ],
  "next_cursor": null
}

A Financing Scenario

http

GET /v1/rates/series?dataset=btl_refinancing_scenarios&term_years=5&horizon_from_month=12&horizon_to_month=12

HTTP 200

json

{
  "request_id": "data_2b4d6f32172349aeb4e63356ff73d7b0",
  "dataset": "btl_refinancing_scenarios",
  "release_id": "example-rates-release",
  "published_at": null,
  "release_status": "accepted",
  "selection": {
    "scenario": "market_base",
    "term_years": "5",
    "horizon_from_month": "12",
    "horizon_to_month": "12",
    "mode": "latest"
  },
  "revision_policy": "Values may be revised in subsequent releases.",
  "series": [
    {
      "basis": "scenario",
      "frequency": "daily",
      "history_capability": "saved_snapshot_only",
      "metric": "rate_pct",
      "unit": "percent",
      "series_id": "series_e23d1b3d7a77e71a3cb13f59c8bffb27",
      "dimensions": {
        "horizon_month": 12,
        "ltv_pct": 75,
        "term_years": 5
      },
      "availability": {
        "status": "available",
        "from": "2026-09-14",
        "to": "2026-09-14"
      },
      "observations": [
        {
          "mortgage_latest_observation_date": "2026-08-31",
          "period": "2026-09-14",
          "projection_end_date": "2027-10-14",
          "projection_end_month": 13,
          "projection_start_date": "2027-09-14",
          "projection_start_month": 12,
          "snapshot_date": "2026-09-14",
          "sonia_compounding": "continuous_annual",
          "status": "scenario",
          "svr_latest_observation_date": "2026-08-31",
          "swap_10y_end_date": "2037-09-14",
          "swap_2y_end_date": "2029-09-14",
          "swap_5y_end_date": "2032-09-14",
          "value": 5.170580059218242
        }
      ]
    }
  ],
  "next_cursor": null
}

Validation Error

http

GET /v1/rates/series?dataset=bank_rate&from=2026-08

HTTP 422

json

{
  "request_id": "data_398dfa5f4ec945a98838d36af97909a8",
  "error": {
    "code": "invalid_parameter",
    "message": "Use YYYY-MM-DD.",
    "field": "from"
  }
}