Skip to content
/ singstat Public

Unofficial Python package for interacting with APIs available at SingStat.gov.sg

License

Notifications You must be signed in to change notification settings

yuhui/singstat

Repository files navigation

singstat

Python 3 PyPi PyPi status CodeCov coverage downloads GNU General Public License v3.0 Documentation Status

This is an unofficial Python package for interacting with APIs available at SingStat.gov.sg.

Installing the package

Install the package using pip:

pip install singstat

Using the package

The main steps are:

  1. Import the Client class.
  2. Instantiate an object from the Client class.
  3. Call a function on that object.

For more information, refer to the documentation.

Usage overview

Interacting with SingStat.gov.sg's API is done through a client.

This client contains several public functions, one function per endpoint. A function's name is the same as its corresponding endpoint's ending path.

Most functions accept named arguments, where an argument corresponds with a parameter that the endpoint accepts.

Reference

SingStat.gov.sg's Developer Guide

Other Packages Built by Me

If you like this package, you may be interested in these packages that I have built to work with other Government of Singapore APIs:

  • datagovsg: for interacting with APIs available at Data.gov.sg.
  • landtransportsg: for interacting with APIs available at LTA DataMall.