github.issue_comments

stable Standard

Comments of a GitHub issue or pull request.

GET /v1/github/issue_comments

What you get#

A list of GitHub 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.

Pagination: 10 results per page. The response carries a pagination block; send its next_cursor back as the cursor parameter to get the next page. Every page is one call at the price below. See Pagination.

Also known as: /github/issue/comments on APIs that nest their paths. See Alternatives and equivalents.

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
`owner`	string	yes	(required)	GitHub user or organisation login	max 39 chars; must match `[a-z0-9](?:[a-z0-9-]{0,38})`; trimmed, leading @ removed, lowercased
`repo`	string	yes	(required)	Repository name	max 100 chars; must match `[a-z0-9_-][a-z0-9._-]{0,99}`; trimmed, lowercased
`number`	string	yes	(required)	Issue / pull request number	max 9 chars; must match `\d{1,9}`; trimmed
`cursor`	string	no	-	Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.	-

Request#

curl "https://api.onekey.dev/v1/github/issue_comments?owner=facebook&repo=react&number=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 GitHub response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json

{
  "success": true,
  "data": [
    {
      "content": {
        "id": "18857724",
        "text": "A++, merge away when you're ready\n",
        "url": "https://github.com/react/react/pull/1#issuecomment-18857724",
        "createdAt": "2013-06-03T17:39:44Z"
      },
      "author": {
        "username": "zpao"
      },
      "engagement": {
        "likes": 0
      }
    },
    {
      "content": {
        "id": "18857922",
        "text": "I like this much better than our current test system.\n\nBut isn't it masking the fact that dumpCache() doesn't work consistently between our phantom and jstest test runners? I think that's why we had the original issue where the reactRoot count was not reset when running in phantom. Doesn't that mean that some tests will pass in phantom (because they're better isolated) and fail in jstest?\n",
        "url": "https://github.com/react/react/pull/1#issuecomment-18857922",
        "createdAt": "2013-06-03T17:43:01Z"
      },
      "author": {
        "username": "petehunt"
      },
      "engagement": {
        "likes": 0
      }
    }
  ],
  "metadata": {
    "platform": "github",
    "endpoint": "issue_comments",
    "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`
`body`	`content.text`	-
`html_url`	`content.url`	`safeUrl`
`created_at`	`content.createdAt`	`toIsoDate`
`user.login`	`author.username`	-
`reactions.total_count`	`engagement.likes`	`toNumber`

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