/xdaforums/boards

POST /api/xdaforums/boards

Price: 5 credits

List XDA Forums boards and categories: name, id, description, section, thread and message counts and sub-boards. Without a category it lists the forum home; with a category id it lists what that category holds, such as a manufacturer's device boards.

How to use it

Start here to find a board id. Entries with board_type 'category' are containers: pass their id as category to drill down. Entries with board_type 'forum' hold threads. Thread and message counts are rounded by the forum itself (for example 37.5K).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• category string nullable — Category id or category URL to list the boards inside it; omit for the forum home (examples: "11976", "https://xdaforums.com/c/google.11976/"; minLength: 1)
• count integer required — Max number of boards to return (min: 1)

Response

• @type string (default: "XdaforumsBoard")
• id string required
• alias string nullable
• name string required
• url string required
• board_type string required
• description string nullable
• section string nullable
• thread_count integer nullable
• message_count integer nullable
• last_post object nullable
  • @type string (default: "XenforoBoardLastPost")
  • thread_id string required
  • thread_alias string nullable
  • thread_title string required
  • prefix string nullable
  • post_id string nullable
  • url string required
  • created_at integer 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: [])
• sub_boards array (default: [])
  • @type string (default: "XenforoBoardRef")
  • id string required
  • alias string nullable
  • name string nullable
  • url string required

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 category with this id 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.