github.pull

stable Standard

One GitHub pull request with change stats.

GET /v1/github/pull

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.

Also works with: URL lookup (github.com/{owner}/{repo}/pull/{number}). Any batch can include it.

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

Request#

curl "https://api.onekey.dev/v1/github/pull?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": "1",
      "title": "Run each test in its own <iframe>",
      "text": "This is not blocking the initial launch, so feel free to put it on the back-burner for now.\n\nThe Jasmine test harness still runs in the parent window and reports to PhantomJS via `window.callPhantom`, but each test `<iframe>` has its own copy of `react-test.js` and each individual test module is required in the global context of a separate `<iframe>`.\n\nThis gives us a significant approximation of the benefits of mocking, at least in terms of isolating tests from one another.\n\ncr @jeffmo @zpao\n",
      "url": "https://github.com/react/react/pull/1",
      "createdAt": "2013-05-29T20:20:53Z",
      "updatedAt": "2026-01-27T19:55:21Z",
      "state": "closed"
    },
    "author": {
      "username": "benjamn"
    },
    "engagement": {
      "comments": 7,
      "likes": null
    },
    "ext": {
      "mergedAt": "2013-06-03T17:58:02Z",
      "sourceBranch": "run-tests-in-iframes",
      "additions": 241,
      "deletions": 79,
      "changedFiles": 24,
      "commits": 9,
      "merged": true
    }
  },
  "metadata": {
    "platform": "github",
    "endpoint": "pull",
    "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
`number`	`content.id`	`toString`
`title`	`content.title`	-
`body`	`content.text`	-
`html_url`	`content.url`	`safeUrl`
`created_at`	`content.createdAt`	`toIsoDate`
`updated_at`	`content.updatedAt`	`toIsoDate`
`state`	`content.state`	-
`user.login`	`author.username`	-
`comments`	`engagement.comments`	`toNumber`
`reactions.total_count`	`engagement.likes`	`toNumber`
`merged_at`	`ext.mergedAt`	`toIsoDate`
`head.ref`	`ext.sourceBranch`	-
`additions`	`ext.additions`	`toNumber`
`deletions`	`ext.deletions`	`toNumber`
`changed_files`	`ext.changedFiles`	`toNumber`
`commits`	`ext.commits`	`toNumber`
`merged`	`ext.merged`	`toBoolean`

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