/lobsters/stories/search

POST /api/lobsters/stories/search

Price: 20 credits

List Lobsters stories from one of its listings — newest, front page, recently active, a tag combination or a linked domain — each with title, submitted link, submitter, score, tags and comment count

How to use it

Exactly one of `source`, `tags` and `domain` selects the listing; passing none or two is a 422. Lobsters has no keyword search of any kind here, so a topic is reached through `tags` — take the vocabulary from lobsters/tags/search, since an unknown tag is a 412 rather than an empty list, and several tags are a union, not an intersection. `source=hottest` is the front page and stops at 25 stories however large `count` is. Stories come without their comments — pass an `id` to lobsters/stories for those.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• count integer required — Max number of stories to return (min: 1; max: 2000)
• source string nullable — Which site-wide listing to read: newest submissions, the front page, or the stories with the most recent comment activity (one of: "newest", "hottest", "active")
• tags array nullable — Read the listing of stories carrying any of these Lobsters tags instead of a site-wide listing (examples: ["programming"], ["programming","rust"]; minItems: 1)
• domain string nullable — Read the listing of stories linking to this domain instead of a site-wide listing (examples: "github.com", "arstechnica.com"; minLength: 1)

Response

• @type string (default: "LobstersStory")
• id string required
• url string nullable
• comments_url string nullable
• link_url string nullable
• created_at integer nullable
• score integer nullable
• flag_count integer nullable
• comment_count integer nullable
• description string nullable
• description_html string nullable
• author string nullable
• author_url string nullable
• is_author_submission boolean nullable
• tags array (default: [])
• comments array (default: [])
  • @type string (default: "LobstersComment")
  • id string required
  • url string nullable
  • story_url string nullable
  • story_id string nullable
  • parent_comment_id string nullable
  • created_at integer nullable
  • updated_at integer nullable
  • depth integer nullable
  • score integer nullable
  • flag_count integer nullable
  • is_deleted boolean nullable
  • is_moderated boolean nullable
  • text string nullable
  • text_html string nullable
  • author string nullable
  • author_url string nullable

Errors

• 422 — Not exactly one of source, tags and domain, or a malformed tag or domain 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 — No such tag or domain listing 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.