/ctgoodjobs/jobs/similar

POST /api/ctgoodjobs/jobs/similar

Price: 1 credit

Get the listings CTgoodjobs (Hong Kong job board) considers similar to a given job. Returns each similar job with its id, url, title, employer name, logo, similarity score, total view count, publication timestamps and listing flags, ordered by descending similarity. A live listing typically has a dozen matches; an expired listing has none and returns an empty list. An unknown job id returns 412.

How to use it

Find jobs similar to a given CTgoodjobs (Hong Kong) listing, addressed by job id or job URL. Each result carries id, url, job_title, company_name, image, similarity (0-1 relevance score computed by the board), view_count (how many times the listing was opened), published_at, published_display and posted_at, and the is_boosted, is_recommended and is_crawled flags. Useful for mapping competing postings for the same role and for reading demand signals from view counts. Results come back sorted by descending similarity and are capped at count. Expired listings have no similar jobs and return an empty list. Feed a returned id back into ctgoodjobs/jobs for the full listing.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• job string required — CTgoodjobs job id, or a job URL containing it (examples: "10199618", "https://jobs.ctgoodjobs.hk/job/10199618/relationship-manager-business-banking"; minLength: 1)
• count integer required — Max result count (examples: 10; min: 1)

Response

• @type string (default: "CtgoodjobsSimilarJob")
• id string required
• url string required
• job_title string required
• company_name string nullable
• image string nullable
• similarity number nullable
• view_count integer nullable
• published_at integer nullable
• published_display string nullable
• posted_at integer nullable
• is_boosted boolean nullable
• is_recommended boolean nullable
• is_crawled boolean nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit 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 — Job not found 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 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 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 Wait at least 30 seconds, then retry.

Response 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.