BotList ⌁
Public REST API

BotList API

All public endpoints live under /api/.... JSON is returned everywhere except this documentation page at https://botlist.click/api/docs.

Base URL https://botlist.click/api
Format REST + JSON
Auth Public GET endpoints
Docs https://botlist.click/api/docs
API Section

Overview

Entry points and general information about the public REST API.

GET /api

Returns API overview data, base URLs and a flat list of routes.

https://botlist.click/api
GET /api/docs

Human-readable HTML documentation for the API.

https://botlist.click/api/docs
GET /api/stats

Aggregated public counters such as bot totals, votes, reviews and server counts.

https://botlist.click/api/stats
API Section

Pages

Endpoints that mirror the data shown on public pages of the site.

GET /api/pages/index

Homepage/index data with paginated public bot cards.

Query Params
  • page: Page number. Default: 1.
  • per_page: Items per page. Default: 24. Max: 100.
https://botlist.click/api/pages/index?page=1&per_page=24
GET /api/pages/search

Search page data with paginated matches and recommendation cards.

Query Params
  • q: Required search query.
  • page: Page number. Default: 1.
  • per_page: Items per page. Default: 24. Max: 100.
https://botlist.click/api/pages/search?q=music&page=1
GET /api/pages/bot/{id_or_slug}

Bot detail page data including metadata and a comments preview.

https://botlist.click/api/pages/bot/1457336602618757192
API Section

Bots

Public bot resources for lists, detail pages, comments and search.

GET /api/bots

Paginated bot collection. Supports ranking, newest sorting and simple filters.

Query Params
  • page: Page number. Default: 1.
  • per_page: Items per page. Default: 20. Max: 100.
  • q: Optional search query. When set, results are ordered by relevance.
  • tag: Filter by an exact tag value.
  • verified: Boolean filter: 1/0, true/false, yes/no.
  • tracked: Boolean filter: 1/0, true/false, yes/no.
  • sort: rank or newest. Default: rank.
https://botlist.click/api/bots?sort=rank&page=1&per_page=20
GET /api/bots/{id_or_slug}

Full public bot resource with install, support, policy and uptime data.

https://botlist.click/api/bots/form-bot
GET /api/bots/{id_or_slug}/comments

Paginated public reviews/comments for a bot.

Query Params
  • page: Page number. Default: 1.
  • per_page: Items per page. Default: 20. Max: 100.
https://botlist.click/api/bots/form-bot/comments?page=1
GET /api/search

Search endpoint that returns ranked bot matches with scores.

Query Params
  • q: Required search query.
  • page: Page number. Default: 1.
  • per_page: Items per page. Default: 20. Max: 100.
https://botlist.click/api/search?q=moderation&page=1
API Section

Monitoring

Public monitoring read endpoints that remain available under /api.

GET /api/uptime/{id_or_slug}

Reads stored uptime data for a bot.

https://botlist.click/api/uptime/form-bot