stackexchange.comments

stable Advanced

Latest comments on a site.

GET /v1/stackexchange/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#

Name	Type	Required	Default	What it is	Constraints
`site`	string	no	-	Stack Exchange site, default stackoverflow	max 41 chars; must match `[a-z][a-z.]{1,40}`; trimmed, lowercased

Request#

curl "https://api.onekey.dev/v1/stackexchange/comments" \
  -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": "141183235",
        "text": "The path after the domain is not necessary present, so the positive lookahead should be modified to handle this alternative. And what happens if the path contains …/some.dir/file.txt ? It will match :-(",
        "createdAt": "2026-09-28T19:55:44Z"
      },
      "ext": {
        "postId": "80005902"
      },
      "engagement": {
        "likes": 0
      },
      "author": {
        "id": "653182",
        "username": "Patrick Janser",
        "url": "https://stackoverflow.com/users/653182/patrick-janser",
        "avatarUrl": "https://i.sstatic.net/s5wL8.jpg?s=256",
        "reputation": 4729
      }
    },
    {
      "content": {
        "id": "141183234",
        "text": "Please the code relevant to your question.",
        "createdAt": "2026-09-28T19:55:21Z"
      },
      "ext": {
        "postId": "80006535"
      },
      "engagement": {
        "likes": 0
      },
      "author": {
        "id": "535275",
        "username": "Scott Hunter",
        "url": "https://stackoverflow.com/users/535275/scott-hunter",
        "avatarUrl": "https://i.sstatic.net/Ft2Mw.jpg?s=256",
        "reputation": 50047
      }
    }
  ],
  "metadata": {
    "platform": "stackexchange",
    "endpoint": "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 path	Onekey field	Transform
`comment_id`	`content.id`	`toString`
`post_id`	`ext.postId`	`toString`
`body`	`content.text`	`stripHtml`
`creation_date`	`content.createdAt`	`toIsoDate`
`score`	`engagement.likes`	`toNumber`
`owner.user_id`	`author.id`	`toString`
`owner.display_name`	`author.username`	`htmlUnescape`
`owner.link`	`author.url`	`safeUrl`
`owner.profile_image`	`author.avatarUrl`	`safeUrl`
`owner.reputation`	`author.reputation`	`toNumber`

Caching and freshness#

Fresh for about 30 seconds. Repeat calls in that window are served from cache and are free.
Between 30 seconds and 5 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).