Docs
View as Markdown

github.top_issues

stable Standard

Most-reacted open issues of a repository (feature requests and complaints ranked by reactions).

GET /v1/github/top_issues

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.

Also known as: /github/repo/top-issues 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#

NameTypeRequiredDefaultWhat it isConstraints
ownerstringyes(required)GitHub user or organisation loginmax 39 chars; must match [a-z0-9](?:[a-z0-9-]{0,38}); trimmed, leading @ removed, lowercased
repostringyes(required)Repository namemax 100 chars; must match [a-z0-9_-][a-z0-9._-]{0,99}; trimmed, lowercased

Request#

curl "https://api.onekey.dev/v1/github/top_issues?owner=psf&repo=requests" \
  -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": 3829,
        "title": "Session.verify=False ignored when REQUESTS_CA_BUNDLE environment variable is set",
        "text": "One would expect that when the caller explicitly asks to make unverified requests, then the `REQUESTS_CA_BUNDLE` environment variable doesn't affect it. The reality is different, however.\r\n\r\n```python\r\nimport os\r\nimport requests\r\n\r\nos.environ['REQUESTS_CA_BUNDLE'] = 'asd.pem'  # Must be an existing ",
        "url": "https://github.com/psf/requests/issues/3829",
        "createdAt": "2017-01-24T13:40:18Z",
        "updatedAt": "2024-02-12T14:04:41Z",
        "state": "open"
      },
      "engagement": {
        "votes": 25,
        "comments": 14
      },
      "author": {
        "username": "intgr"
      }
    },
    {
      "content": {
        "id": 4871,
        "title": "respect no_proxy environment variable and proxies['no'] parameter",
        "text": "make `requests` respect `no_proxy` settings\n\nbugfix attached\n\n## Expected Result\n\nhttp requests to whitelisted urls should bypass all proxies\n\nwhitelisted urls, as defined in the `no_proxy` env var\n\n## Actual Result\n\nproxies are not bypassed\n\nthe sample script will raise\n\n`requests.exceptions.Connec",
        "url": "https://github.com/psf/requests/issues/4871",
        "createdAt": "2018-11-13T14:33:10Z",
        "updatedAt": "2026-05-12T14:03:01Z",
        "state": "open"
      },
      "engagement": {
        "votes": 16,
        "comments": 15
      },
      "author": {
        "username": "milahu"
      }
    }
  ],
  "metadata": {
    "platform": "github",
    "endpoint": "top_issues",
    "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 pathOnekey fieldTransform
numbercontent.idtoNumber
titlecontent.title-
bodycontent.text-
html_urlcontent.urlsafeUrl
created_atcontent.createdAttoIsoDate
updated_atcontent.updatedAttoIsoDate
statecontent.state-
reactions.total_countengagement.votestoNumber
commentsengagement.commentstoNumber
user.loginauthor.username-

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