Docs
View as Markdown

discourse.topic_posts

stable Advanced

Posts (replies) of a Discourse topic.

GET /v1/discourse/topic_posts

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#

NameTypeRequiredDefaultWhat it isConstraints
instancestringno-Known Discourse forum (allowlisted), default meta.discourse.orgmax 253 chars; must match [a-z0-9.-]{3,253}; trimmed, lowercased
idstringyes(required)Topic idmax 10 chars; must match [0-9]{1,10}; trimmed

Request#

curl "https://api.onekey.dev/v1/discourse/topic_posts?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",
        "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",
        "createdAt": "2013-02-01T04:52:28Z",
        "slug": "new-to-discourse-start-here"
      },
      "author": {
        "username": "Discourse",
        "displayName": null
      },
      "ext": {
        "topicId": "1",
        "postNumber": 1
      },
      "engagement": {
        "comments": 0,
        "likes": null
      }
    }
  ],
  "metadata": {
    "platform": "discourse",
    "endpoint": "topic_posts",
    "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 pathOnekey fieldTransform
idcontent.idtoString
usernameauthor.username-
nameauthor.displayName-
cookedcontent.textstripHtml
created_atcontent.createdAttoIsoDate
topic_idext.topicIdtoString
reply_countengagement.commentstoNumber
like_countengagement.likestoNumber
post_numberext.postNumbertoNumber
topic_slugcontent.slug-

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#

StatusCodeWhat to do
401unauthorizedCheck the x-api-key header.
402insufficient_creditsAdd credits; your balance must cover the price.
404not_foundUnknown endpoint path.
422invalid_paramsFix the parameters using the table above. Free.
429rate_limitedWait Retry-After seconds, then retry.
502upstream_errorThe source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).