Housing Data

This package provides access to data used by mygov housing forms:

• CPI data from ONS

Usage

This package provides an endpoint that provides access to the most recently available CPI data from the ONS. All versions of the CPI data are cached in couch.

It also provides a REST interface to allow manipulate rent pressure zone information.

Configuration

• cpi.graceperiod

  • grace period to use when determining of the CPi data has expired.
  • Type ISO 8601 Duration
  • Default: PT12H

• cpi.source.url

  • the url used to fetch CPI data from ONS.
  • Type: URL
  • Default: https://www.ons.gov.uk/generator?format=csv&uri=/economy/inflationandpriceindices/timeseries/d7bt/mm23

• cpi.update.crontab

  • The crontab used to schedule regular updates of the cpi data in couchdb and elastcisearch
  • Type: string
  • Default: 0 * * * *

• cpi.update.retryinterval

  • The retry interval in millis to use when retrying CPI updates
  • Type: int
  • Default: 10000

• s3.enabled

  • Flag indicating whether to copy CPI data to S3
  • Type: boolean
  • Default: false

• s3.region

  • The AWS region to use when accessing s3.
  • Type: string
  • Default: (none)

• s3.target

  • The S3 URL to which CPI data should be copied if enabled. (e.g. s3://mybucket/cpi.json)
  • Type: string
  • Default: (none)