Search Multiple Datasets By Keyword

get

Search Multiple Datasets By Keyword

Provide the ability to search through multiple content datasets by keyword.

Resource URL

https://api.stb.gov.sg/content /common/v2/search

Header Parameters

Name Values Description
Content-Type

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

X-Content-Language

Supported language [en | zh-cn | zh-tw | ja | ko].
Validation: acceptable language code

Query Parameters

Name Values Description
dataset
(required)

Dataset which the search will be executed on. Possible value(s): [accommodation, attractions, bars_clubs, cruises, events, food_beverages, mice_events, precincts, shops, tours, venues, walking_trails].
Note that events value is for Leisure Events category, and mice_events value is for Business/MICE Events category.
Provide one value or a comma-delimited string of values.
Validation: acceptable category

typeId

Filter the content based on specific or multiple types (subcategories) of a dataset (category), by using a comma-delimited string of typeId value(s).
Refer to List Content Types API for the typeId values.
Validation: acceptable typeId values of a specific dataset

keyword

Keyword to look for within name, description, body and tags when performing the search function.
Max: 255 characters

filtersource

Filter the content based on specific source or multiple sources by using a comma-delimited string of values.
Max: 255 characters
Validation: valid content source & case sensitive
E.g. stb, other content source(s)

sort

Field name to sort (name, rating, source, lastupdateddate ).
Validation: Acceptable value

sortOrder

Sort order [asc | desc].
Validation: acceptable sort order value

distinct

Filters content to remove duplicated Places of Interest.
Distinct value [Yes | No].
Validation: acceptable distinct value

startDate

Event start date.
Validation: date format in YYYY-MM-DD

endDate

Event end date.
Validation: date format in YYYY-MM-DD

group

Retrieve Points of Interest related to wellness (Wellness) or Singapore Tourism Awards (STA) by using the group value(s) (Wellness, STA). Provide one value or a comma-delimited string of values.
E.g. Wellness,STA

offset

The position to return from the results.
By specifying offset, you retrieve a subset of records starting with the offset value. Offset works with limit, which determines how many records to retrieve starting from the offset.
If offset value exceeds the total number of records, the response will be empty.
Default value: 0 (starts from first record).
Validation: integer

limit

Maximum number of data records to return in a response.
Default set to 20, with maximum of 50. If the limit value exceeds the maximum, the response will return 50 data 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...