searchDealsByKeyword

get

searchDealsByKeyword

Retrieve the full list of deals. This API allows developers to retrieve a list of deals that matches the search criteria. The keyword will match with name, description and tags, returning the most relevant deal(s).

Resource URL

https://api.stb.gov.sg/content /v1.1/deals

Header Parameters

Name Values Description
Content-Language

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

Query Parameters

Name Values Description
category

Filter deals by deal category [accommodation | attractions | bars_clubs | food_beverages | shops | tour].
Validation: acceptable category

keyword

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

discount

Discount value to filter by. Default sets to 0. Response returns deals with discount value equals to and larger than discount value queried. Only applicable if id for deal type is 3.
Validation: integer

deal_type

Filter deals by deal type. Provide one id or a comma-delimited string of ids. Refer to Deal Type.
Validation: acceptable deal type id

limit

Maximum number of records to return in response. Default sets to 20, which is the maximum.
Validation: integer

offset

Number of records to discard. Default sets to 0.
Validation: integer

sort

Field name to sort by [updated_date | category | deal_type | discount | valid_end_date | promotion_end_date].
Validation: acceptable sort type

sort_order

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

Try it out

HTTP Basic

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 Error Code Description
400 400 Bad request
401 401 Unauthorized
404 404 Not Found
500 500 Internal server error

Resource Summary

Security Category

Deals User API

Working...