github.pull_files

stable Advanced

Files changed by a GitHub pull request.

GET /v1/github/pull_files

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.

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
`number`	string	yes	(required)	Issue / pull request number	max 9 chars; must match `\d{1,9}`; trimmed
`cursor`	string	no	-	Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.	-

Request#

curl "https://api.onekey.dev/v1/github/pull_files?owner=facebook&repo=react&number=10000" \
  -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": {
        "title": "fixtures/fiber-debugger/package.json",
        "state": "modified",
        "url": "https://github.com/react/react/blob/15b555cc883d537b6286eb15482153e42cb8b2b2/fixtures%2Ffiber-debugger%2Fpackage.json"
      },
      "ext": {
        "additions": 2,
        "deletions": 2,
        "changes": 4
      }
    },
    {
      "content": {
        "title": "fixtures/fiber-debugger/yarn.lock",
        "state": "modified",
        "url": "https://github.com/react/react/blob/15b555cc883d537b6286eb15482153e42cb8b2b2/fixtures%2Ffiber-debugger%2Fyarn.lock"
      },
      "ext": {
        "additions": 68,
        "deletions": 10,
        "changes": 78
      }
    }
  ],
  "metadata": {
    "platform": "github",
    "endpoint": "pull_files",
    "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. Fields the source lacks come back as null.

Source path	Onekey field	Transform
`filename`	`content.title`	-
`status`	`content.state`	-
`additions`	`ext.additions`	`toNumber`
`deletions`	`ext.deletions`	`toNumber`
`changes`	`ext.changes`	`toNumber`
`blob_url`	`content.url`	`safeUrl`

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; 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 for the full list and retry guidance.

Status: stable (verified against the live source).