discourse.topic

stable Standard

A Discourse topic.

GET /v1/discourse/topic

What you get#

One Discourse record in Onekey's unified shape, in data. If the record does not exist you get a 404 not_found and are not charged.

What it costs#

Standard · 1 credit 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
`id`	string	yes	(required)	Topic id	max 10 chars; must match `[0-9]{1,10}`; trimmed

Request#

curl "https://api.onekey.dev/v1/discourse/topic?id=1" \
  -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": "1",
      "title": "New to Discourse? Start here!",
      "slug": "new-to-discourse-start-here",
      "createdAt": "2013-02-01T04:52:28Z",
      "text": "We’re so glad you’re here! This is our official community, where you can connect, ask questions, and share ideas about Discourse , a powerful platform for support, teamwork, and everything community. You’ll find topics here on features, bugs, hosting, development, and general support. Want to run your own Discourse site? There are a couple of great ways to get started: Official hosting & migration services Fully managed by the team that builds Discourse – ideal for those who want peace of mind and expert support. Use the free, open source code A fast and streamlined option if you prefer to self-host. Get up and running with our easy 30-minute official install instructions. Want to try Discourse before setting up a s"
    },
    "engagement": {
      "likes": 443,
      "comments": 5,
      "views": 119502
    },
    "ext": {
      "posts": 1,
      "categoryId": "67"
    },
    "author": {
      "username": "Discourse"
    }
  },
  "metadata": {
    "platform": "discourse",
    "endpoint": "topic",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 1,
    "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`
`like_count`	`engagement.likes`	`toNumber`
`reply_count`	`engagement.comments`	`toNumber`
`views`	`engagement.views`	`toNumber`
`posts_count`	`ext.posts`	`toNumber`
`post_stream.posts.0.username`	`author.username`	-
`post_stream.posts.0.cooked`	`content.text`	`stripHtml`
`category_id`	`ext.categoryId`	`toString`

Caching and freshness#

Fresh for about 30 minutes. Repeat calls in that window are served from cache and are free.
Between 30 minutes and 6 hours 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 day more (marked stale).
A "not found" is remembered for 5 minutes 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`	That record does not exist. Free; do not retry.
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).