Pull request

Try in Playground

Retrieve a pull request’s details, changed files, reviews, inline review comments or commits with section=details, files, reviews, comments or commits. Each list has its own pagination.

GET/v1/github/pull-requestx-api-key

Headers

Get your API key

x-api-keystringrequiredheader

Your ScrapeAtlas customer key. Create one on /account/ and set SCRAPEATLAS_API_KEY.

Query parameters

urlstringrequiredquery

Canonical pull-request URL: https://github.com/owner/repository/pull/number.

max 2048 chars

Examplehttps://github.com/example/repo/pull/1

cursorstringquery

One-based page cursor; activity cursors step backward by month.

pagestringquery

Native one-based API page, alternative to cursor.

limitstringquery

Page size 1–100, alternative to per_page.

per_pagestringquery

Native page size 1–100.

sectionenumquery

Selected section; pagination applies to list sections.

one of: details, files, reviews, comments, commits

Response fields

126

platformstringoptional

Optional.

endpointstringoptional

Optional.

successboolean

Whether retrieval returned usable data.

statusenum

success, partial, failed or challenged.

one of: success, partial

requestIdstring

Request correlation UUID.

sourceUrlstring

Public source URL.

absolute HTTPS URL

fetchedAtstring

UTC fetch time.

Completeness of this bounded response, not complete account enumeration.

coverage.sourceenum

Always included.

one of: public_api, public_html

coverage.completeboolean

Always included.

coverage.warningsstring[]

Always included.

Combined upstream attempts, decoded bytes and elapsed milliseconds.

accounting.upstreamRequestsinteger

Always included.

≥ 0

accounting.responseBytesinteger

Always included.

≥ 0

accounting.durationMsnumber

Always included.

≥ 0

Route-specific compatibility payload. See endpoint description and research coverage notes.

data.idinteger

Always included.

≥ 0

data.node_idstring

Always included.

data.numberinteger

Always included.

≥ 0

data.html_urlstring

Always included.

absolute HTTPS URL

data.titlestring

Always included.

data.bodystringnullable

Always included.

data.stateenum

Always included.

one of: open, closed

data.draftboolean

Always included.

data.mergedboolean

Always included.

data.merged_atstringnullable

Always included.

data.merge_commit_shastringnullable

Always included.

data.mergeablebooleannullable

Always included.

data.mergeable_statestring

Always included.

data.rebaseablebooleannullableoptional

Optional.

Always included.

data.merged_by.idinteger

Always included.

≥ 0

data.merged_by.loginstring

Always included.

data.merged_by.node_idstring

Always included.

data.merged_by.avatar_urlstring

Always included.

absolute HTTPS URL

data.merged_by.html_urlstring

Always included.

absolute HTTPS URL

data.merged_by.typestring

Always included.

data.merged_by.site_adminboolean

Always included.

data.user.idinteger

Always included.

≥ 0

data.user.loginstring

Always included.

data.user.node_idstring

Always included.

data.user.avatar_urlstring

Always included.

absolute HTTPS URL

data.user.html_urlstring

Always included.

absolute HTTPS URL

data.user.typestring

Always included.

data.user.site_adminboolean

Always included.

data.assignees.idinteger

Always included.

≥ 0

data.assignees.loginstring

Always included.

data.assignees.node_idstring

Always included.

data.assignees.avatar_urlstring

Always included.

absolute HTTPS URL

data.assignees.html_urlstring

Always included.

absolute HTTPS URL

data.assignees.typestring

Always included.

data.assignees.site_adminboolean

Always included.

data.requested_reviewers.idinteger

Always included.

≥ 0

data.requested_reviewers.loginstring

Always included.

data.requested_reviewers.node_idstring

Always included.

data.requested_reviewers.avatar_urlstring

Always included.

absolute HTTPS URL

data.requested_reviewers.html_urlstring

Always included.

absolute HTTPS URL

data.requested_reviewers.typestring

Always included.

data.requested_reviewers.site_adminboolean

Always included.

data.requested_teams.idinteger

Always included.

≥ 0

data.requested_teams.namestring

Always included.

data.requested_teams.slugstring

Always included.

data.labels.idintegeroptional

Optional.

≥ 0

data.labels.namestring

Always included.

data.labels.colorstringoptional

Optional.

data.labels.descriptionstringnullableoptional

Optional.

Always included.

data.milestone.numberinteger

Always included.

≥ 0

data.milestone.titlestring

Always included.

data.milestone.statestring

Always included.

data.milestone.due_onstringnullable

Always included.

data.milestone.descriptionstringnullable

Always included.

data.head.labelstring

Always included.

data.head.refstring

Always included.

data.head.shastring

Always included.

data.head.user.idinteger

Always included.

≥ 0

data.head.user.loginstring

Always included.

data.head.user.node_idstring

Always included.

data.head.user.avatar_urlstring

Always included.

absolute HTTPS URL

data.head.user.html_urlstring

Always included.

absolute HTTPS URL

data.head.user.typestring

Always included.

data.head.user.site_adminboolean

Always included.

data.head.repo.idinteger

Always included.

≥ 0

data.head.repo.namestring

Always included.

data.head.repo.full_namestring

Always included.

data.head.repo.html_urlstring

Always included.

absolute HTTPS URL

data.head.repo.privateboolean

Always included.

data.base.labelstring

Always included.

data.base.refstring

Always included.

data.base.shastring

Always included.

data.base.user.idinteger

Always included.

≥ 0

data.base.user.loginstring

Always included.

data.base.user.node_idstring

Always included.

data.base.user.avatar_urlstring

Always included.

absolute HTTPS URL

data.base.user.html_urlstring

Always included.

absolute HTTPS URL

data.base.user.typestring

Always included.

data.base.user.site_adminboolean

Always included.

data.base.repo.idinteger

Always included.

≥ 0

data.base.repo.namestring

Always included.

data.base.repo.full_namestring

Always included.

data.base.repo.html_urlstring

Always included.

absolute HTTPS URL

data.base.repo.privateboolean

Always included.

data.additionsinteger

Always included.

≥ 0

data.deletionsinteger

Always included.

≥ 0

data.changed_filesinteger

Always included.

≥ 0

data.commitsinteger

Always included.

≥ 0

data.commentsinteger

Always included.

≥ 0

data.review_commentsinteger

Always included.

≥ 0

data.lockedboolean

Always included.

data.created_atstring

Always included.

data.updated_atstring

Always included.

data.closed_atstringnullable

Always included.

data.author_associationstring

Always included.

data.diff_urlstring

Always included.

absolute HTTPS URL

data.patch_urlstring

Always included.

absolute HTTPS URL

HTTP 200 returns the success variant. Check status: partial means usable data with warnings, and failed or challenged requests carry a failure object described in Errors & responses.

Error codes

HTTP	failure.code	Meaning
400	`invalid_request`	Invalid, duplicate or unsupported parameters.
401	`unauthorized`	Invalid worker key.
404	`not_found`	Public source record unavailable; SocialFetch aliases return data.lookupStatus=not_found with HTTP 200.
429	`upstream_rate_limited`	GitHub throttled retrieval.
502	`upstream_error` `upstream_challenged` `unsupported_page`	Source retrieval failed or the source contract changed.
502	`unsafe_redirect` `response_too_large` `payload_too_complex` `request_limit`	A fixed safety or resource boundary was reached.
503	`busy`	All worker slots are occupied.
504	`timeout`	Total deadline expired.

Code example

curl "https://api.scrapeatlas.com/v1/github/pull-request?url=https%3A%2F%2Fgithub.com%2Fexample%2Frepo%2Fpull%2F1" \
  -H "x-api-key: YOUR_API_KEY"

const response = await fetch(
  "https://api.scrapeatlas.com/v1/github/pull-request?url=https%3A%2F%2Fgithub.com%2Fexample%2Frepo%2Fpull%2F1",
  {
    headers: {
      "x-api-key": "YOUR_API_KEY"
    }
  }
);

const data = await response.json();
console.log(data.status, data);

type Result = {
  status: "success" | "partial" | "failed" | "challenged";
  requestId: string;
  [field: string]: unknown;
};

const response = await fetch(
  "https://api.scrapeatlas.com/v1/github/pull-request?url=https%3A%2F%2Fgithub.com%2Fexample%2Frepo%2Fpull%2F1",
  {
    headers: {
      "x-api-key": process.env.SCRAPEATLAS_API_KEY!
    }
  }
);

const data = (await response.json()) as Result;
if (data.status === "failed" || data.status === "challenged") {
  throw new Error(`GitHub request failed: ${data.requestId}`);
}
console.log(data);

import requests

response = requests.get(
    "https://api.scrapeatlas.com/v1/github/pull-request",
    headers={"x-api-key": "YOUR_API_KEY"},
    params={
        "url": "https://github.com/example/repo/pull/1"
    },
    timeout=60,
)
data = response.json()
print(data["status"], data)

package main

import (
	"encoding/json"
	"fmt"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.scrapeatlas.com/v1/github/pull-request?url=https%3A%2F%2Fgithub.com%2Fexample%2Frepo%2Fpull%2F1", nil)
	req.Header.Set("x-api-key", "YOUR_API_KEY")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
	fmt.Println(data["status"], data)
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        var client = HttpClient.newHttpClient();
        var request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.scrapeatlas.com/v1/github/pull-request?url=https%3A%2F%2Fgithub.com%2Fexample%2Frepo%2Fpull%2F1"))
            .GET()
            .header("x-api-key", "YOUR_API_KEY")
            .build();
        var response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

Use your sa_live_… customer key at https://api.scrapeatlas.com.

Responses

Successful result. Synthetic example validated against the runtime contract.

{
  "data": {
    "id": 1,
    "node_id": "Synthetic",
    "number": 1,
    "html_url": "https://github.com/example/repo/pull/1",
    "title": "Synthetic",
    "body": "Synthetic",
    "state": "closed",
    "draft": false,
    "merged": false,
    "merged_at": "2025-01-01T00:00:00Z",
    "merge_commit_sha": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "mergeable": null,
    "mergeable_state": "clean",
    "rebaseable": null,
    "merged_by": {
      "id": 1,
      "login": "example",
      "node_id": "Synthetic",
      "avatar_url": "https://avatars.githubusercontent.com/u/1",
      "html_url": "https://github.com/example/repo",
      "type": "User",
      "site_admin": false
    },
    "user": {
      "id": 1,
      "login": "example",
      "node_id": "Synthetic",
      "avatar_url": "https://avatars.githubusercontent.com/u/1",
      "html_url": "https://github.com/example/repo",
      "type": "User",
      "site_admin": false
    },
    "assignees": [],
    "requested_reviewers": [
      {
        "id": 1,
        "login": "example",
        "node_id": "Synthetic",
        "avatar_url": "https://avatars.githubusercontent.com/u/1",
        "html_url": "https://github.com/example/repo",
        "type": "User",
        "site_admin": false
      }
    ],
    "requested_teams": [],
    "labels": [],
    "milestone": null,
    "head": {
      "label": "Synthetic",
      "ref": "Synthetic",
      "sha": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "user": {
        "id": 1,
        "login": "example",
        "node_id": "Synthetic",
        "avatar_url": "https://avatars.githubusercontent.com/u/1",
        "html_url": "https://github.com/example/repo",
        "type": "User",
        "site_admin": false
      },
      "repo": {
        "id": 1,
        "name": "synthetic.txt",
        "full_name": "example/repo",
        "html_url": "https://github.com/example/repo",
        "private": false
      }
    },
    "base": {
      "label": "Synthetic",
      "ref": "Synthetic",
      "sha": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "user": {
        "id": 1,
        "login": "example",
        "node_id": "Synthetic",
        "avatar_url": "https://avatars.githubusercontent.com/u/1",
        "html_url": "https://github.com/example/repo",
        "type": "User",
        "site_admin": false
      },
      "repo": {
        "id": 1,
        "name": "synthetic.txt",
        "full_name": "example/repo",
        "html_url": "https://github.com/example/repo",
        "private": false
      }
    },
    "additions": 1,
    "deletions": 1,
    "changed_files": 1,
    "commits": 1,
    "comments": 1,
    "review_comments": 1,
    "locked": false,
    "created_at": "2025-01-01T00:00:00Z",
    "updated_at": "2025-01-01T00:00:00Z",
    "closed_at": "2025-01-01T00:00:00Z",
    "author_association": "CONTRIBUTOR",
    "diff_url": "https://github.com/example/repo",
    "patch_url": "https://github.com/example/repo"
  },
  "platform": "github",
  "endpoint": "/v1/github/pull-request",
  "success": true,
  "status": "success",
  "requestId": "00000000-0000-4000-8000-000000000001",
  "sourceUrl": "https://github.com/example/repo/pull/1",
  "fetchedAt": "2026-09-17T00:00:00.000Z",
  "coverage": {
    "source": "public_api",
    "complete": true,
    "warnings": []
  },
  "accounting": {
    "upstreamRequests": 1,
    "responseBytes": 13837,
    "durationMs": 1
  }
}

Invalid, duplicate or unsupported parameters.

{
  "platform": "github",
  "endpoint": "string",
  "success": true,
  "status": "success",
  "requestId": "9d2f1c0a-6b1e-4c7d-9a8e-2f3b4c5d6e7f",
  "sourceUrl": "https://example.com/",
  "fetchedAt": "2026-01-01T00:00:00.000Z",
  "coverage": {
    "source": "public_api",
    "complete": true,
    "warnings": [
      "string"
    ]
  },
  "accounting": {
    "upstreamRequests": 0,
    "responseBytes": 0,
    "durationMs": 0
  },
  "data": {
    "items": [
      {
        "sha": "string",
        "filename": "string",
        "status": "string",
        "additions": 0,
        "deletions": 0,
        "changes": 0,
        "blob_url": "https://example.com/",
        "raw_url": "https://example.com/",
        "contents_url": "https://example.com/",
        "patch": "string",
        "previous_filename": "string"
      }
    ],
    "next_cursor": "string",
    "dropped": 0,
    "total": 0
  },
  "pagination": {
    "next_cursor": "string",
    "has_more": true,
    "page_size": 0
  }
}