datagovsg.economy

Client for interacting with the Economy APIs.

Example usage:

# get the patents lodged on 1 August 2018
from datetime import date
from datagovsg import Economy
from datagovsg.economy.types import EconomyDict
economy = Economy()
patents: EconomyDict = economy.patents(lodgement_date=date(2018, 8, 1))

Methods

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

Bases: DataGovSg

Interact with the economy-related endpoints.

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

Parameters:

  • api_key (str | None)

  • cache_backend (str | BaseCache)

designs(**kwargs: Unpack[EconomyArgsDict]) → EconomyDict

Get design applications lodged with IPOS in Singapore.

Updated daily from IPOS.

Parameters:

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

Raises:

ValueError – lodgement_date argument is not between 1 August 2018 and 31 October 2020 (start and end dates inclusive).

Returns:

Design application information. (Cached for 12 hours.)

Return type:

EconomyDict

patents(**kwargs: Unpack[EconomyArgsDict]) → EconomyDict

Get patent applications lodged with IPOS in Singapore.

Updated daily from IPOS.

Parameters:

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

Raises:

ValueError – lodgement_date argument is not between 1 August 2018 and 31 October 2020 (start and end dates inclusive).

Returns:

Patent application information. (Cached for 12 hours.)

Return type:

EconomyDict

trademarks(**kwargs: Unpack[EconomyArgsDict]) → EconomyDict

Get trademark applications lodged with IPOS in Singapore.

Updated daily from IPOS.

Parameters:

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

Raises:

ValueError – lodgement_date argument is not between 1 August 2018 and 31 October 2020 (start and end dates inclusive).

Returns:

Trademark application information. (Cached for 12 hours.)

Return type:

EconomyDict

Types