# github.commits

**stable** **Advanced**

Recent commits of a GitHub repository.

`GET /v1/github/commits`

## 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](https://onekey.dev/docs/pagination.md).

## 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 |
| --- | --- | --- | --- | --- | --- |
| `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 |
| `cursor` | string | no | - | Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page. | - |

## Request

```bash
curl "https://api.onekey.dev/v1/github/commits?owner=facebook&repo=react" \
  -H "x-api-key: YOUR_API_KEY"
```

```python
import requests

res = requests.get(
    "https://api.onekey.dev/v1/github/commits",
    params={"owner": "facebook", "repo": "react"},
    headers={"x-api-key": "YOUR_API_KEY"},
)
body = res.json()

if body["success"]:
    print(body["data"])
else:
    print(body["error"]["code"], body["error"]["message"])
```

```javascript
const params = new URLSearchParams({ owner: "facebook", repo: "react" });
const res = await fetch(`https://api.onekey.dev/v1/github/commits?${params}`, {
  headers: { "x-api-key": "YOUR_API_KEY" },
});
const body = await res.json();

if (body.success) console.log(body.data);
else console.error(body.error.code, body.error.message);
```

## 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": "d083ec1da1e5252abd3ddfdde6dfbc09701a2c51",
        "text": "[compiler] Allow setState after await in effect functions (#36734)\n\n`react-hooks/set-state-in-effect` flagged setState calls that happen\nafter an `await` inside an async function invoked from an effect.\nPost-await code resumes in a microtask after the effect body has\nreturned, so the \"synchronous setState cascades a render\" rationale does\nnot apply; the lint was a false positive on a common data-loading shape\n(15 reactions on the issue).\n\nThe fix exempts a setState only when it is *provably* post-await: a\nforward must-dataflow over the HIR CFG computes the blocks that begin\nafter an await has executed on every path from the function entry\n(optimistic initialization so loop back-edges do not pessimize the meet,\nfixpoint to the greatest solution), plus an intra-block flag for\ninstructions after an Await in the same block. A setState reachable on\nany await-free path still flags, so the conditional-await case remains\nan error by design, with a fixture documenting that choice. Suppression\nis sound under try/catch because HIRBuilder terminates blocks after each\ninstruction in a try region, and an awaited rejection also resumes in a\nmicrotask.\n\nFixtures: post-await setState (event gone), setState before the first\nawait (still flags), setState after a conditional await (still flags).\nFirst commit documents the false positive via the lint-mode logger\noutput, second removes it.\n\nBuilds on the approach in #36417 by @raashish1601, hardened from a\nseen-await flag to the path-sensitive ana",
        "url": "https://github.com/react/react/commit/d083ec1da1e5252abd3ddfdde6dfbc09701a2c51",
        "createdAt": "2026-09-22T17:26:59Z"
      },
      "author": {
        "displayName": "lauren",
        "username": "poteto"
      },
      "engagement": {
        "comments": 0
      }
    },
    {
      "content": {
        "id": "8b0da1c6e4c225ea674e96b7790c4b538542e71a",
        "text": "[rust-compiler] Fix detection of shorthand and computed properties (#37674)\n\nBefore this would incorrectly mark certain computed properties as\nshorthand. The babel code didn't care about this because of how it was\nwritten, but the swc short circuited on shorthand. Causing incorrect\ncode generation",
        "url": "https://github.com/react/react/commit/8b0da1c6e4c225ea674e96b7790c4b538542e71a",
        "createdAt": "2026-09-22T16:13:10Z"
      },
      "author": {
        "displayName": "Jimmy Miller",
        "username": "jimmyhmiller"
      },
      "engagement": {
        "comments": 0
      }
    }
  ],
  "metadata": {
    "platform": "github",
    "endpoint": "commits",
    "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](https://onekey.dev/docs/schema.md). Fields the source lacks come back as `null`.

| Source path | Onekey field | Transform |
| --- | --- | --- |
| `sha` | `content.id` | - |
| `commit.message` | `content.text` | - |
| `html_url` | `content.url` | `safeUrl` |
| `commit.author.date` | `content.createdAt` | `toIsoDate` |
| `commit.author.name` | `author.displayName` | - |
| `author.login` | `author.username` | - |
| `commit.comment_count` | `engagement.comments` | `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](https://onekey.dev/pricing); 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](https://onekey.dev/docs/errors.md) for the full list and retry guidance.

Status: stable (verified against the live source).