Download dataset

Guide to downloading datasets

To download an entire dataset via API, you will need to first call the initiate download API, followed by the poll download API.

You may add column and rows filters to get a subset of the dataset, although this is optional.

For datasets that do not have the CSV extension (ie GeoJSON, KML, PDF etc.), you may skip this endpoint and proceed to the Poll Download API below.

To find the dataset_id, refer to the URL of dataset. For this dataset: https://data.gov.sg/collections/522/datasets/d_11e68bba3b3c76733475a72d09759eeb/view or https://data.gov.sg/datasets/d_11e68bba3b3c76733475a72d09759eeb/view

The datasetId is: d_11e68bba3b3c76733475a72d09759eeb

For staging, note that the dataset_id might differ between staging and production:

• Domain: https://api-open-staging.data.gov.sg/

• Example: https://api-open-staging.data.gov.sg/v1/public/api/datasets/d_8b84c4ee58e3cfc0ece0d773c8ca6abc/initiate-download

Initiate download for a dataset

get

Path parameters

datasetIdstringRequired

ID of the dataset

Example: d_3f960c10fed6145404ca7b821f263b87

Body

application/json

columnNamesstring[]Optional

List of selected columns in filtered dataset.

Example: ["uen","uen_status_desc","entity_type_desc","entity_name"]

filtersarrayOptional

Filters defines how users want to filter their dataset.

Filters is an array of objects which have columnName, type and value attributes.

• columnName refers to the column where the filter is to be applied.
• type can be EQ, LIKE, or ILIKE:
  • EQ: Direct comparison for filter and is case sensitive.
  • LIKE: Similar to EQ but includes partial matching. Any words containing the string in the value attribute will be matched.
  • ILIKE: Case-insensitive version of LIKE.

Example: [{"columnName":"uen_status_desc","type":"EQ","value":"Registered"},{"columnName":"entity_type_desc","type":"LIKE","value":"Local"},{"columnName":"entity_name","type":"ILIKE","value":"data"}]

Responses

201

Successful response

application/json

400

Request Failure

application/json

429

Rate limit exceeded

application/json

get

/v1/public/api/datasets/{datasetId}/initiate-download

HTTPcURLJavaScriptPython

GET /v1/public/api/datasets/{datasetId}/initiate-download HTTP/1.1
Host: api-open.data.gov.sg
Content-Type: application/json
Accept: */*
Content-Length: 275

{
  "columnNames": [
    "uen",
    "uen_status_desc",
    "entity_type_desc",
    "entity_name"
  ],
  "filters": [
    {
      "columnName": "uen_status_desc",
      "type": "EQ",
      "value": "Registered"
    },
    {
      "columnName": "entity_type_desc",
      "type": "LIKE",
      "value": "Local"
    },
    {
      "columnName": "entity_name",
      "type": "ILIKE",
      "value": "data"
    }
  ]
}

{
  "code": 1,
  "data": {
    "message": "text"
  },
  "errorMsg": "text"
}

After initiating the download of a dataset, this endpoint below returns a link to access the dataset

Poll download for a dataset after download has been initiated

get

Path parameters

datasetIdstringRequired

ID of the dataset

Example: d_3f960c10fed6145404ca7b821f263b87

Body

application/json

columnNamesstring[]Optional

List of selected columns in filtered dataset.

Example: ["uen","uen_status_desc","entity_type_desc","entity_name"]

filtersarrayOptional

Filters defines how users want to filter their dataset.

Filters is an array of objects which have columnName, type and value attributes.

• columnName refers to the column where the filter is to be applied.
• type can be EQ, LIKE, or ILIKE:
  • EQ: Direct comparison for filter and is case sensitive.
  • LIKE: Similar to EQ but includes partial matching. Any words containing the string in the value attribute will be matched.
  • ILIKE: Case-insensitive version of LIKE.

Example: [{"columnName":"uen_status_desc","type":"EQ","value":"Registered"},{"columnName":"entity_type_desc","type":"LIKE","value":"Local"},{"columnName":"entity_name","type":"ILIKE","value":"data"}]

Responses

201

Successful response

application/json

400

Request Failure

application/json

429

Rate limit exceeded

application/json

get

/v1/public/api/datasets/{datasetId}/poll-download

HTTPcURLJavaScriptPython

GET /v1/public/api/datasets/{datasetId}/poll-download HTTP/1.1
Host: api-open.data.gov.sg
Content-Type: application/json
Accept: */*
Content-Length: 275

{
  "columnNames": [
    "uen",
    "uen_status_desc",
    "entity_type_desc",
    "entity_name"
  ],
  "filters": [
    {
      "columnName": "uen_status_desc",
      "type": "EQ",
      "value": "Registered"
    },
    {
      "columnName": "entity_type_desc",
      "type": "LIKE",
      "value": "Local"
    },
    {
      "columnName": "entity_name",
      "type": "ILIKE",
      "value": "data"
    }
  ]
}

{
  "code": 1,
  "data": {
    "status": "text",
    "url": "text"
  },
  "errorMsg": "text"
}

As data.gov.sg is a public shared service, we will apply quotas to ensure that they are fairly used by all users. If you exceed the quota of 5 requests per minute, you’ll likely receive a 429 Error. For higher rate limits - create an API key