/threads/posts/search

POST /api/threads/posts/search

Price: 20 credits

Threads — search public posts by keyword (top or recent)

How to use it

Search Threads posts by keyword. Sort by top results (default) or most recent.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• query string required — Search keyword (examples: "openai"; minLength: 1)
• count integer required — Max number of posts to return (min: 1)
• sort string — Result ordering: top results or most recent (default: "default"; one of: "default", "recent")

Response

• @type string (default: "ThreadsPost")
• id string required
• code string required
• url string required
• text string nullable
• created_at integer nullable
• like_count integer (default: 0)
• reply_count integer (default: 0)
• repost_count integer (default: 0)
• quote_count integer (default: 0)
• reshare_count integer (default: 0)
• is_reply boolean (default: false)
• is_pinned boolean (default: false)
• is_paid_partnership boolean (default: false)
• is_edited boolean (default: false)
• has_audio boolean (default: false)
• image string nullable
• user object nullable
  • @type string (default: "ThreadsPostUser")
  • id string required
  • alias string required
  • name string required
  • url string required
  • image string nullable
  • is_verified boolean (default: false)
• media array (default: [])
  • @type string (default: "ThreadsPostMedia")
  • type string required
  • url string required
  • width integer (default: 0)
  • height integer (default: 0)
• link_preview object nullable
  • @type string (default: "ThreadsPostLink")
  • url string required
  • display_url string nullable
  • image string nullable
• quoted_post object nullable (see schema ThreadsPost)
• reposted_post object nullable (see schema ThreadsPost)

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 — The entity was not found, or a precondition failed 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.