/xdaforums/threads

POST /api/xdaforums/threads

Price: 10 credits

Get an XDA Forums thread by id or URL: title, prefix label, board and its category, thread starter, start and last-modified time, reply count, page count and the opening post.

How to use it

Use this to identify a thread and read its opening post before paging through replies. A bare numeric id works as well as the full thread URL. page_count tells how many 20-post pages the thread has.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• thread string required — XDA Forums thread id or thread URL (examples: "4482089", "https://xdaforums.com/t/psa-android-13-bootloader-anti-rollback.4482089/"; minLength: 1)

Response

• @type string (default: "XdaforumsThread")
• id string required
• alias string nullable
• url string required
• thread_title string required
• prefix string nullable
• board object nullable
  • @type string (default: "XenforoBoardRef")
  • id string required
  • alias string nullable
  • name string nullable
  • url string required
• category string nullable
• author object nullable
  • @type string (default: "XenforoMember")
  • id string nullable
  • alias string nullable
  • name string required
  • url string nullable
  • image string nullable
  • user_title string nullable
  • joined_at integer nullable
  • messages_count integer nullable
  • solutions_count integer nullable
  • reaction_score integer nullable
  • location string nullable
  • devices array (default: [])
• created_at integer nullable
• updated_at integer nullable
• reply_count integer nullable
• view_count integer nullable
• page_count integer (default: 1)
• first_post object nullable
  • @type string (default: "XenforoPost")
  • id string required
  • number integer nullable
  • thread_id string required
  • url string required
  • author object nullable
    • @type string (default: "XenforoMember")
    • id string nullable
    • alias string nullable
    • name string required
    • url string nullable
    • image string nullable
    • user_title string nullable
    • joined_at integer nullable
    • messages_count integer nullable
    • solutions_count integer nullable
    • reaction_score integer nullable
    • location string nullable
    • devices array (default: [])
  • created_at integer nullable
  • updated_at integer nullable
  • text string nullable
  • images array (default: [])
  • links array (default: [])
  • attachments array (default: [])
    • @type string (default: "XenforoAttachment")
    • id string nullable
    • name string nullable
    • url string required
    • image string nullable
    • size_bytes integer nullable
    • view_count integer nullable
  • quoted_post_ids array (default: [])
  • reactions array (default: [])
  • reaction_count integer nullable
  • is_thread_starter boolean (default: false)

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 — No thread with this id, or the thread is not visible to a logged-out visitor 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.