List Datasets By Topic

get

List Datasets By Topic

Retrieve the full list of datasets available on Data Marketplace by providing the topic, such as accommodation or visitors.

Resource URL

https://tih-api.stb.gov.sg /analytics/common/open/v1/datasets

Header Parameters

Name Values Description
Content-Type

Format of the request body sent. Accepts only application/json.

Accept

Format of the response body returned. Returns only application/json.

Query Parameters

Name Values Description
topicName
(required)

Topic which the search will be executed on. Accepts one topic name.

Possible values include accommodation, attractions, bars_clubs, cruises, events, food_beverages, shops, precincts, tours, venues, visitors, walking_trails, other_travel_services and others. Response will return datasets that match the searched topic name. If no matching topic is found, response will return empty result.

organisationId

Attribute used to uniquely identify the organisation contributing the datasets, which the search will be executed on. Accepts one Organisation Id.

Response will return datasets contributed by the Organisation Id entered. If unspecified, datasets contributed by all organisations will be returned.

Validation: valid organisationId

sort

Datasets information may be sorted by [datasetName or metadataUpdatedDate].

If unspecified, response will be sorted by datasetName in ascending order, followed by metadataUpdatedDate in ascending order.

Validation: acceptable sort value

sort_order

Sort in [asc | desc] order.

Validation: acceptable sort order value

limit

Maximum number of datasets to return in a response.

Default set to 20, with maximum of 50. Response will return 50 data records if value entered exceeds the maximum.

Validation: integer

offset

The first position to return from the results, by offsetting the starting point.

Default set to 0, which starts the page at the first record. Response will be empty if value for offset exceeds the total number of records.

Validation: integer

Try it out

HTTP Basic

OAuth 2.0

API Key

RESET

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Response Error Details

HTTP Code Description
400 Bad Request — Request was not accepted and could be due to malformed parameter (e.g. spelling error) or missing a required parameter.
401 Unauthorised — API key is invalid or was not provided.
403 Forbidden — API key does not have the permission to perform the request.
404 Resource Not Found — Requested resource (i.e. the resource URL) does not exist.
405 Method Not Allowed — The HTTP request method is not supported by the resource.
406 Not Acceptable — Requester's acceptable content type for the response does not match the content type returned by the resource.
414 Request URL Too Long — Request URL exceeded the maximum acceptable URL length.
415 Unsupported Media Type — Request's format is not supported by the resource.
422 Unprocessable Entity — Request was not accepted, often due to semantic errors, such as data format.
500 Server Errors — Something is not working on TIH's end, happened very rarely.

Resource Summary

Security Category

General

Working...