datagovsg.housing

Client for interacting with the Housing APIs.

Example usage:

# get the list of available car park spaces
from datagovsg import Housing
from datagovsg.housing.types import CarparkAvailabilityItemDict
housing = Housing()
carpark_availability: list[CarparkAvailabilityItemDict] = housing.carpark_availability()

Methods

class datagovsg.housing.client.Client(api_key: str | None = None, cache_backend: str | BaseCache = 'sqlite')

Bases: DataGovSg

Interact with the housing-related endpoints.

Reference: https://data.gov.sg/datasets?formats=API&topics=housing

Parameters:

  • api_key (str | None)

  • cache_backend (str | BaseCache)

carpark_availability(**kwargs: Unpack[HousingArgsDict]) → list[CarparkAvailabilityItemDict]

Get the latest carpark availability in Singapore.

Retrieved every minute.

Parameters:

kwargs (HousingArgsDict) – Key-value arguments to be passed as parameters to the endpoint URL.

Raises:

ValueError – date_time argument is before 1 January 2018 12:00am (inclusive).

Returns:

Available carpark spaces. (Cached for 1 minute.)

Return type:

CarparkAvailabilityDict

Types