/fivech/boards/search

POST /api/fivech/boards/search

Price: 5 credits

Browse the 5ch (5ちゃんねる) board catalogue: every board with its directory name, display name, category, server host and URL. Filter by keyword and category, and opt in to the adult BBSPINK boards.

How to use it

List and filter 5ch (5ちゃんねる) boards. This is the discovery entry point: it maps human board names to the 'board' directory name every other 5ch endpoint expects. 'keyword' matches display name or directory name, 'category' restricts to one of the 49 site categories, and 'include_adult' adds the BBSPINK boards (excluded by default). Each result has id (directory name), name, url, host, category, category_id and is_adult.

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 results to return (min: 1)
• keyword string — Filter boards whose display name or directory name contains this text (default: ""; examples: "ニュース", "game")
• category string nullable — Restrict results to a single board category (one of: "地震", "おすすめ", "特別企画", "be", "ニュース", "世界情勢", "案内", "運営", "馴れ合い", "AA", "社会", "会社・職業", "裏社会", "地域", "文化", "学問・理系", "学問・文系", "家電製品", "政治経済", "食文化", "生活", "ネタ雑談", "カテゴリ雑談", "実況ch", "受験・学校", "趣味", "乗り物", "スポーツ一般", "球技", "格闘技", "旅行・外出", "テレビ等", "芸能", "アイドル", "ギャンブル", "ゲーム", "携帯型ゲーム", "ネットゲーム", "漫画・小説等", "音楽", "心と身体", "ＰＣ等", "ネット関係", "雑談系２", "大使館", "荒野", "隔離", "BBSPINK")
• include_adult boolean — Include the adult BBSPINK boards in the catalogue (default: false)

Response

• @type string (default: "FivechBoardSummary")
• id string required
• name string required
• url string required
• host string required
• category string required
• category_id integer nullable
• is_adult 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 — 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.