discourse.search_topics

stable Advanced

Search topics on a Discourse forum.

GET /v1/discourse/search_topics

What you get#

A list of Discourse results in Onekey's unified shape, in data (an array). An empty array is a normal, successful answer and is charged like any other; a source that reports "nothing found" as an error returns a free 404 not_found instead.

What it costs#

Advanced · 5 credits for a fresh fetch, charged only when it succeeds.
Free when served from cache (0.2 credit for a cached response over 100 KB).
Free if the request is invalid (never charged) or the source fails or reports not found (refunded).

Parameters#

Name	Type	Required	Default	What it is	Constraints
`instance`	string	no	-	Known Discourse forum (allowlisted), default meta.discourse.org	max 253 chars; must match `[a-z0-9.-]{3,253}`; trimmed, lowercased
`q`	string	yes	(required)	Search query	max 200 chars; trimmed, repeated spaces collapsed

Request#

curl "https://api.onekey.dev/v1/discourse/search_topics?q=plugin" \
  -H "x-api-key: YOUR_API_KEY"

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

Recorded response#

A real Discourse response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json

{
  "success": true,
  "data": [
    {
      "content": {
        "id": "54462",
        "title": "The Plugin::Instance.find_all method incorrectly treats every file with the «plugin.rb» name as a Discourse plugin",
        "slug": "the-plugin-instance-find-all-method-incorrectly-treats-every-file-with-the-plugin-rb-name-as-a-discourse-plugin",
        "createdAt": "2016-12-19T00:21:09Z",
        "updatedAt": "2017-05-16T21:29:12Z"
      },
      "engagement": {
        "likes": null,
        "comments": 1,
        "views": null
      },
      "ext": {
        "posts": 6,
        "categoryId": "1"
      },
      "entity": {
        "name": null
      }
    },
    {
      "content": {
        "id": "266794",
        "title": "ActivityPub Plugin",
        "slug": "activitypub-plugin",
        "createdAt": "2023-05-31T17:21:52Z",
        "updatedAt": "2026-09-19T04:50:04Z"
      },
      "engagement": {
        "likes": null,
        "comments": 346,
        "views": null
      },
      "ext": {
        "posts": 480,
        "categoryId": "22"
      },
      "entity": {
        "name": {
          "id": 803,
          "name": "activitypub",
          "slug": "activitypub"
        }
      }
    }
  ],
  "metadata": {
    "platform": "discourse",
    "endpoint": "search_topics",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 5,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}

Field mapping#

How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.

Source path	Onekey field	Transform
`id`	`content.id`	`toString`
`title`	`content.title`	-
`slug`	`content.slug`	-
`created_at`	`content.createdAt`	`toIsoDate`
`last_posted_at`	`content.updatedAt`	`toIsoDate`
`like_count`	`engagement.likes`	`toNumber`
`reply_count`	`engagement.comments`	`toNumber`
`views`	`engagement.views`	`toNumber`
`posts_count`	`ext.posts`	`toNumber`
`category_id`	`ext.categoryId`	`toString`
`tags.0`	`entity.name`	-

Caching and freshness#

Fresh for about 2 minutes. Repeat calls in that window are served from cache and are free.
Between 2 minutes and 15 minutes the cached copy is still served instantly and marked stale: true while Onekey refreshes it in the background.
If the source is down when a refresh is needed, the last copy can be served for up to 1 hour more (marked stale).
A "not found" is remembered for 1 minute and is free.
The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

Status	Code	What to do
401	`unauthorized`	Check the `x-api-key` header.
402	`insufficient_credits`	Add credits; your balance must cover the price.
404	`not_found`	Unknown endpoint path.
422	`invalid_params`	Fix the parameters using the table above. Free.
429	`rate_limited`	Wait `Retry-After` seconds, then retry.
502	`upstream_error`	The source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).