# /hk01/coupons/search

`POST /api/hk01/coupons/search`

Price: 10 credits

Search the live HK01 (香港01) voucher wallet — Hong Kong retail and dining offers redeemable through the HK01 app. Returns voucher title, subtitle, description, terms, issuer, merchant, redemption display type, redemption rules, artwork and the validity window. Expired and unpublished vouchers are excluded.

## How to use it

Live Hong Kong vouchers offered by HK01. Empty keyword lists everything currently redeemable; the keyword matches voucher title and issuer. Each item has id, coupon_title, subtitle, description, terms, issuer, merchant, display_type (TEXT / QR / BAR_CODE_CODE128 / BAR_CODE_EAN13), use_type (REUSE or TAP_TO_USE), redeem_quota, is_free_redeem/is_popular/is_featured and published_at/expires_at in unix seconds. The voucher's own lifetime is separate from that publication window: redeem_expiry_type is BEFORE with a fixed redeem_expires_at (unix seconds), or SPAN with redeem_valid_for_days counted from activation.

## Parameters

- `access-token` (string, required)

## Request body

- `timeout` (integer) — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
- `keyword` (string) — Free-text query over voucher title and issuer. Leave empty to list every live voucher (default: ""; examples: "優惠", "折扣")
- `count` (integer, required) — Max number of vouchers to return (min: 1; max: 1000)

## Response

### 200 — Successful Response

- `@type` (string) (default: "Hk01Coupon")
- `id` (integer, required)
- `coupon_title` (string, required)
- `subtitle` (string, nullable)
- `description` (string, nullable)
- `terms` (string, nullable)
- `web_url` (string, nullable)
- `redirect_url` (string, nullable)
- `image` (string, nullable)
- `issuer` (string, nullable)
- `merchant` (string, nullable)
- `display_type` (string, nullable)
- `use_type` (string, nullable)
- `redeem_quota` (integer, nullable)
- `redeem_expiry_type` (string, nullable)
- `redeem_expires_at` (integer, nullable)
- `redeem_valid_for_days` (integer, nullable)
- `is_free_redeem` (boolean) (default: false)
- `is_popular` (boolean) (default: false)
- `is_featured` (boolean) (default: false)
- `published_at` (integer, nullable)
- `expires_at` (integer, nullable)
- `created_at` (integer, nullable)
- `updated_at` (integer, nullable)

## Errors

### 422 — Validation Error

The request body did not validate

What to do: Check the fields against this schema. A URN with the wrong prefix is the most common cause.

- `detail` (array)
  - `loc` (array, required)
  - `msg` (string, required)
  - `type` (string, required)
  - `input` (any)
  - `ctx` (object)

### 408

The request ran past its time limit

What to do: Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.

### 412

The entity was not found, or a precondition failed

What to do: Retrying will not help: either the entity does not exist, or the input points at a different one.

### 429

Too many requests: a rate limit or a usage window is exhausted

What to do: When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.

### 500

Something broke on our side

What to do: Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.

### 529

Rate limit reached, or the endpoint is overloaded

What to do: Wait at least 30 seconds, then retry.

## Response envelope

Success: Array of objects (may be empty if no results)

Error: Error may coexist with partial results if it occurs mid-execution. Check X-Error header and status code.

Every response carries these headers:

- `X-Error` — Error message text (present only on error)
- `X-Request-ID` — Unique request identifier
- `X-Execution-Time` — Execution time in seconds
- `X-Result-Count` — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
- `X-Total-Available-Results` — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
- `X-Warning` — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
- `X-Retry-After` — Seconds to wait before retrying. Present only on 429.