Docs
View as Markdown

stackexchange.post_comments

stable Advanced

Comments on a post (question or answer).

GET /v1/stackexchange/post_comments

What you get#

A list of Stack Exchange 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
idstringyes(required)Question idmax 10 chars; must match [0-9]{1,10}; trimmed
sitestringno-Stack Exchange site, default stackoverflowmax 41 chars; must match [a-z][a-z.]{1,40}; trimmed, lowercased

Request#

curl "https://api.onekey.dev/v1/stackexchange/post_comments?id=11227809" \
  -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 Stack Exchange response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json
{
  "success": true,
  "data": [
    {
      "content": {
        "id": "141067132",
        "text": "@SuhitKalubarme: This question isn't asking whether it's worth sorting first if you need to run this algorithm on data that isn't sorted. Any comparison-based sort will also involve compare-and-branch, and will be slower than one pass of this if() add . (Unless your sort compiles to branchless code using cmov e.g. for merge-sort, or you use SIMD sorting networks, but if either of those are available they'd speed up the conditional-sum to be much faster than a whole sort, and to not be data-dependent. So it's never worth sorting first except possibly if you'll be summing many times.)",
        "createdAt": "2026-05-24T13:59:16Z"
      },
      "ext": {
        "postId": "11227809"
      },
      "engagement": {
        "likes": 0
      },
      "author": {
        "id": "224132",
        "username": "Peter Cordes",
        "url": "https://stackoverflow.com/users/224132/peter-cordes",
        "avatarUrl": "https://i.sstatic.net/N4ivW.png?s=256",
        "reputation": 382877
      }
    },
    {
      "content": {
        "id": "137941445",
        "text": "@ŠimonHrabec: Too bad we can't edit comments. Mods can, I think; perhaps they'd be willing to do it manually for you since this is a bit of a special case: the first (non-deleted) comment on SO's highest-voted question. It would be a shame to delete the comment over that one inaccuracy because that wasn't its main point.",
        "createdAt": "2024-03-29T11:43:03Z"
      },
      "ext": {
        "postId": "11227809"
      },
      "engagement": {
        "likes": 2
      },
      "author": {
        "id": "224132",
        "username": "Peter Cordes",
        "url": "https://stackoverflow.com/users/224132/peter-cordes",
        "avatarUrl": "https://i.sstatic.net/N4ivW.png?s=256",
        "reputation": 382877
      }
    }
  ],
  "metadata": {
    "platform": "stackexchange",
    "endpoint": "post_comments",
    "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
comment_idcontent.idtoString
post_idext.postIdtoString
bodycontent.textstripHtml
creation_datecontent.createdAttoIsoDate
scoreengagement.likestoNumber
owner.user_idauthor.idtoString
owner.display_nameauthor.usernamehtmlUnescape
owner.linkauthor.urlsafeUrl
owner.profile_imageauthor.avatarUrlsafeUrl
owner.reputationauthor.reputationtoNumber

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).