Skip to main content

Board index

GET /<board>
Displays the first page of threads for a board in index view.
board
string
required
Board shortname (e.g., g, tech, lambda)

Response

Returns an HTML page with:
  • Thread previews showing OP and recent replies
  • Thread statistics (reply count, image count)
  • Pagination controls
  • Report form (if authenticated)
The index view shows the most recent threads with a configurable number of preview posts per thread.

Board index page

GET /<board>/page/<page_num>
Displays a specific page of threads for a board in index view.
board
string
required
Board shortname
page_num
integer
required
Page number (0-indexed)

Response

Returns an HTML page with the same structure as the board index, showing threads for the requested page.
Pagination starts at page 0. Each page displays a configured number of threads.

Catalog

GET /<board>/catalog
Displays the first page of the board catalog with thread cards showing thumbnails and metadata.
board
string
required
Board shortname

Response

Returns an HTML page with:
  • Grid layout of thread cards
  • Thread thumbnails (if available)
  • Reply and image counts
  • Pagination for large boards
  • Admin controls (if authenticated as admin)
Catalog view provides a visual overview of threads. Each page shows up to 150 threads divided into batches of 15.

Catalog page

GET /<board>/catalog/<page_num>
Displays a specific page of the board catalog.
board
string
required
Board shortname
page_num
integer
required
Page number (0-indexed)

Response

Returns an HTML page with catalog cards for the requested page.

Build docs developers (and LLMs) love