github.commit
stable Standard
One GitHub commit with change stats (sha or ref).
GET /v1/github/commit
What you get#
One GitHub record in Onekey's unified shape, in data. If the record does not exist you get a 404 not_found and are not charged.
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 |
ref | string | yes | (required) | Commit sha or ref (branch/tag) | max 100 chars; must match [A-Za-z0-9_][A-Za-z0-9_./-]{0,99}; trimmed |
Request#
curl "https://api.onekey.dev/v1/github/commit?owner=facebook&repo=react&ref=main" \
-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.
{
"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
},
"ext": {
"additions": 399,
"deletions": 0,
"changes": 399
}
},
"metadata": {
"platform": "github",
"endpoint": "commit",
"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 |
|---|---|---|
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 |
stats.additions | ext.additions | toNumber |
stats.deletions | ext.deletions | toNumber |
stats.total | ext.changes | toNumber |
Caching and freshness#
- Fresh for about 1 hour. Repeat calls in that window are served from cache and are free.
- Between 1 hour and 1 day the cached copy is still served instantly and marked
stale: truewhile 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 3 days more (marked stale).
- A "not found" is remembered for 5 minutes 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 | That record does not exist. Free; do not retry. |
| 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).