datagovsg.housing

Client for interacting with the Housing APIs.

Example usage:

# get the list of available car park spaces
from datagovsg import Housing
housing = Housing()
carpark_availability = housing.carpark_availability()

Methods

class datagovsg.housing.client.Client

Bases: DataGovSg

Interact with the housing-related endpoints.

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

carpark_availability(**kwargs: Unpack[HousingArgsDict]) → CarparkAvailabilityDict

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.

Returns:

Available carpark spaces. (Cached for 1 minute.)

Return type:

CarparkAvailabilityDict

Types