/fivech/boards

POST /api/fivech/boards

Price: 10 credits

Get a 5ch (5ちゃんねる) board by its directory name: display name, category, server host, default anonymous name, board logo, number of live threads, posting limits and board flags.

How to use it

Fetch one 5ch (5ちゃんねる) board by its directory name (the latin slug in the URL, e.g. 'newsplus', 'poverty', 'iPhone'). Returns name, category, host, url, is_adult (BBSPINK boards), default_name (the board's anonymous handle), image, thread_count (live threads right now), posting limits (subject/name/mail/message max length, thread_creation_interval), flags (has_forced_id, has_slip, shows_ip, has_be_id) and the raw settings map.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• board string required — Board directory name (examples: "newsplus", "poverty", "iPhone"; minLength: 1)

Response

• @type string (default: "FivechBoard")
• id string required
• name string required
• url string required
• host string required
• category string required
• category_id integer nullable
• is_adult boolean (default: false)
• default_name string nullable
• image string nullable
• thread_count integer nullable
• subject_max_length integer nullable
• name_max_length integer nullable
• mail_max_length integer nullable
• message_max_length integer nullable
• thread_creation_interval integer nullable
• has_forced_id boolean (default: false)
• has_slip boolean (default: false)
• shows_ip boolean (default: false)
• has_be_id boolean (default: false)
• settings object (default: {})
  • * string

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 — Board not found (well-formed directory name but no such board on 5ch) 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.