/github/commits

POST /api/github/commits

Price: 5 credits

Get a GitHub commit by sha, branch, or tag within a repository

How to use it

Get full details of a single GitHub commit identified by a commit URL, 'owner/repo@sha' form, or 'owner/repo/sha'. The sha may be a full/short commit hash, a branch name, or a tag. Returns the commit message, author and committer (git identity plus GitHub user when known), authored/committed timestamps, parent commit hashes, addition/deletion/total line counts, GPG verification status, comment count, and the list of changed files with per-file line counts.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• commit string required — Commit as a GitHub commit URL, 'owner/repo@sha' form, or 'owner/repo/sha'. The sha may be a full or short commit hash, a branch name, or a tag. (examples: "https://github.com/torvalds/linux/commit/1da177e4c3f41524e886b7f1b8a0c1fc7321cac2", "octocat/Hello-World@7fd1a60"; minLength: 1)

Response

• @type string (default: "GithubCommit")
• sha string required
• text string (default: "")
• author object nullable
  • @type string (default: "GithubCommitUser")
  • name string nullable
  • email string nullable
  • login string nullable
  • id integer nullable
  • image string nullable
• committer object nullable
  • @type string (default: "GithubCommitUser")
  • name string nullable
  • email string nullable
  • login string nullable
  • id integer nullable
  • image string nullable
• authored_at string (default: "")
• committed_at string (default: "")
• parents array (default: [])
• addition_count integer (default: 0)
• deletion_count integer (default: 0)
• total_count integer (default: 0)
• is_verified boolean (default: false)
• verification_reason string nullable
• comment_count integer (default: 0)
• files array (default: [])
  • @type string (default: "GithubCommitFile")
  • filename string required
  • status string (default: "")
  • addition_count integer (default: 0)
  • deletion_count integer (default: 0)
  • change_count integer (default: 0)
• web_url string (default: "")

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Commit not found Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.