/producthunt/leaderboards

POST /api/producthunt/leaderboards

Price: 5 credits

Get a Product Hunt leaderboard snapshot for a given period and date.

How to use it

Get a Product Hunt leaderboard for a specific period and date. date format follows the period: daily 'YYYY/M/D' (e.g. '2024/1/15'), weekly 'YYYY/W' (ISO week, e.g. '2024/3'), monthly 'YYYY/M' (e.g. '2024/1'), yearly 'YYYY' (e.g. '2024'). Set featured to false to also include launches that were not featured. Returns the top-ranked launches with rank, name, tagline, launch_alias, product_alias, upvote_count, comment_count, image, topics, and dates.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• period string required — Leaderboard period. (one of: "daily", "weekly", "monthly", "yearly"; examples: "daily")
• date string required — Leaderboard date matching the period: daily 'YYYY/M/D', weekly 'YYYY/W' (ISO week), monthly 'YYYY/M', yearly 'YYYY'. (examples: "2024/1/15", "2024/3", "2024/1", "2024"; minLength: 4)
• featured boolean — When true, only featured launches are returned (matches the site's default). (default: true)
• count integer required — Max number of leaderboard items to return (min: 1)

Response

• @type string (default: "ProductHuntLeaderboardItem")
• rank integer required
• id string required
• name string required
• tagline string nullable
• launch_alias string required
• product_id string nullable
• product_alias string nullable
• url string required
• image string nullable
• upvote_count integer nullable
• comment_count integer nullable
• daily_rank integer nullable
• weekly_rank integer nullable
• monthly_rank integer nullable
• featured_at string nullable
• created_at string nullable
• topics array (default: [])
  • @type string (default: "ProductHuntLeaderboardTopic")
  • id string nullable
  • name string required
  • alias string 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 — Leaderboard for the given period/date is 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.