Docs
View as Markdown

github.releases

stable Standard

Releases of a GitHub repository.

GET /v1/github/releases

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/repo/releases 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
cursorstringno-Opaque cursor from a previous response's pagination.next_cursor. Omit for the first page.-

Request#

curl "https://api.onekey.dev/v1/github/releases?owner=facebook&repo=react" \
  -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": "385715000",
        "title": "v19.3.0",
        "text": "Below is a list of all new features, APIs, and bug fixes.\r\n\r\nRead the [React 19.3 release post](https://react.dev/blog/2026/09/09/react-19-3) for more information.\r\n\r\n## New React Features\r\n\r\n- `<ViewTransition />`: Adds `<ViewTransition />` and `addTransitionType` APIs to power View Transition animations in React (@sebmarkbage, @jackpope, @gaearon: [#31975](https://github.com/facebook/react/pull/31975), [#31987](https://github.com/facebook/react/pull/31987), [#31996](https://github.com/facebook/react/pull/31996), [#31999](https://github.com/facebook/react/pull/31999), [#32001](https://github.com/facebook/react/pull/32001), [#32002](https://github.com/facebook/react/pull/32002), [#32028](https://github.com/facebook/react/pull/32028), [#32029](https://github.com/facebook/react/pull/32029), [#32031](https://github.com/facebook/react/pull/32031), [#32034](https://github.com/facebook/react/pull/32034), [#32038](https://github.com/facebook/react/pull/32038), [#32041](https://github.com/facebook/react/pull/32041), [#32050](https://github.com/facebook/react/pull/32050), [#32090](https://github.com/facebook/react/pull/32090), [#32105](https://github.com/facebook/react/pull/32105), [#32254](https://github.com/facebook/react/pull/32254), [#32379](https://github.com/facebook/react/pull/32379), [#32422](https://github.com/facebook/react/pull/32422), [#32462](https://github.com/facebook/react/pull/32462), [#32540](https://github.com/facebook/react/pull/32540), [#32545](https://github.com/",
        "url": "https://github.com/react/react/releases/tag/v19.3.0",
        "createdAt": "2026-09-09T18:01:33Z"
      },
      "ext": {
        "contentName": "19.3.0 (September 9, 2026)",
        "prerelease": false
      },
      "author": {
        "username": "eps1lon"
      }
    },
    {
      "content": {
        "id": "356654919",
        "title": "v19.2.8",
        "text": "## React Server Components\r\n\r\n- Performance improvements when decoding\r\n ([#37087](https://github.com/facebook/react/pull/37087) by @eps1lon)",
        "url": "https://github.com/react/react/releases/tag/v19.2.8",
        "createdAt": "2026-07-21T15:49:09Z"
      },
      "ext": {
        "contentName": "19.2.8 (July 21st, 2026)",
        "prerelease": false
      },
      "author": {
        "username": "eps1lon"
      }
    }
  ],
  "metadata": {
    "platform": "github",
    "endpoint": "releases",
    "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
idcontent.idtoString
tag_namecontent.title-
nameext.contentName-
bodycontent.text-
html_urlcontent.urlsafeUrl
published_atcontent.createdAttoIsoDate
prereleaseext.prereleasetoBoolean
author.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).