Issue

Try in Playground

Retrieve issue or pull-request details from an /issues/N or /pull/N URL, with source fields and a type marker. Use section=comments for one page of discussion comments in creation order with text, author, reactions and timestamps.

GET/v1/github/issuex-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 HTTPS github.com URL of the user, repository or issue required by this route.

max 2048 chars

Examplehttps://github.com/example/repo/issues/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.

sincestringquery

Inclusive date/timestamp filter, or trending daily/weekly/monthly range.

sectionenumquery

details (default) or comments. Paging and since apply to comments.

one of: details, comments

Response fields

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.idstring

Always included.

data.urlstringnullable

Always included.

absolute HTTPS URL

Always included.

data.content.textstringnullable

Always included.

data.content.media_urlsstring[]nullable

Always included.

data.content.thumbnail_urlstringnullable

Always included.

data.content.duration_secondsnumbernullable

Always included.

data.author.usernamestringnullable

Always included.

data.author.display_namestringnullable

Always included.

data.author.avatar_urlstringnullable

Always included.

absolute HTTPS URL

data.author.verifiedbooleannullable

Always included.

data.engagement.viewsintegernullable

Always included.

≥ 0

data.engagement.likesintegernullable

Always included.

≥ 0

data.engagement.commentsintegernullable

Always included.

≥ 0

data.engagement.sharesintegernullable

Always included.

≥ 0

data.engagement.savesintegernullable

Always included.

≥ 0

Always included.

data.flags.nsfwbooleannullable

Always included.

data.flags.spoilerbooleannullable

Always included.

data.flags.pinnedbooleannullable

Always included.

data.flags.deletedboolean

Always included.

data.published_atstringnullable

Always included.

data.extobjectoptional

Optional.

data.numberinteger

Always included.

≥ 0

data.titlestring

Always included.

data.bodystringnullable

Always included.

data.html_urlstring

Always included.

absolute HTTPS URL

data.stateenum

Always included.

one of: open, closed

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.labels.namestring

Always included.

data.commentsinteger

Always included.

≥ 0

data.created_atstring

Always included.

data.updated_atstring

Always included.

data.closed_atstringnullable

Always included.

data.reactions.total_countinteger

Always included.

≥ 0

Always included.

data.post.idstring

Always included.

data.post.urlstringnullable

Always included.

absolute HTTPS URL

Always included.

data.post.content.textstringnullable

Always included.

data.post.content.media_urlsstring[]nullable

Always included.

data.post.content.thumbnail_urlstringnullable

Always included.

data.post.content.duration_secondsnumbernullable

Always included.

data.post.author.usernamestringnullable

Always included.

data.post.author.display_namestringnullable

Always included.

data.post.author.avatar_urlstringnullable

Always included.

absolute HTTPS URL

data.post.author.verifiedbooleannullable

Always included.

data.post.engagement.viewsintegernullable

Always included.

≥ 0

data.post.engagement.likesintegernullable

Always included.

≥ 0

data.post.engagement.commentsintegernullable

Always included.

≥ 0

data.post.engagement.sharesintegernullable

Always included.

≥ 0

data.post.engagement.savesintegernullable

Always included.

≥ 0

Always included.

data.post.flags.nsfwbooleannullable

Always included.

data.post.flags.spoilerbooleannullable

Always included.

data.post.flags.pinnedbooleannullable

Always included.

data.post.flags.deletedboolean

Always included.

data.post.published_atstringnullable

Always included.

data.post.extobjectoptional

Optional.

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 and the waiting queue are occupied.
504	`timeout`	Total deadline expired.

Code example

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

const response = await fetch(
  "https://api.scrapeatlas.com/v1/github/issue?url=https%3A%2F%2Fgithub.com%2Fexample%2Frepo%2Fissues%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/issue?url=https%3A%2F%2Fgithub.com%2Fexample%2Frepo%2Fissues%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/issue",
    headers={"x-api-key": "YOUR_API_KEY"},
    params={
        "url": "https://github.com/example/repo/issues/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/issue?url=https%3A%2F%2Fgithub.com%2Fexample%2Frepo%2Fissues%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/issue?url=https%3A%2F%2Fgithub.com%2Fexample%2Frepo%2Fissues%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": {
    "node_id": "I_81",
    "number": 1,
    "title": "Synthetic issue",
    "body": "Example issue text",
    "html_url": "https://github.com/example/repo/issues/1",
    "state": "open",
    "user": {
      "id": 42,
      "node_id": "U_42",
      "login": "example",
      "avatar_url": "https://avatars.githubusercontent.com/u/42",
      "html_url": "https://github.com/example",
      "type": "User",
      "site_admin": false
    },
    "labels": [
      {
        "name": "enhancement"
      }
    ],
    "comments": 2,
    "created_at": "2026-01-01T00:00:00Z",
    "updated_at": "2026-01-01T00:00:00Z",
    "closed_at": null,
    "reactions": {
      "total_count": 3
    },
    "id": "81",
    "url": "https://github.com/example/repo/issues/1",
    "content": {
      "text": "Example issue text",
      "media_urls": null,
      "thumbnail_url": null,
      "duration_seconds": null
    },
    "author": {
      "username": "example",
      "display_name": null,
      "avatar_url": "https://avatars.githubusercontent.com/u/42",
      "verified": null
    },
    "engagement": {
      "views": null,
      "likes": 3,
      "comments": 2,
      "shares": null,
      "saves": null
    },
    "flags": {
      "nsfw": null,
      "spoiler": null,
      "pinned": null,
      "deleted": false
    },
    "published_at": "2026-01-01T00:00:00Z",
    "ext": {
      "node_id": "I_81",
      "number": 1,
      "title": "Synthetic issue",
      "body": "Example issue text",
      "html_url": "https://github.com/example/repo/issues/1",
      "state": "open",
      "user": {
        "id": 42,
        "node_id": "U_42",
        "login": "example",
        "avatar_url": "https://avatars.githubusercontent.com/u/42",
        "html_url": "https://github.com/example",
        "type": "User",
        "site_admin": false
      },
      "labels": [
        {
          "name": "enhancement"
        }
      ],
      "comments": 2,
      "created_at": "2026-01-01T00:00:00Z",
      "updated_at": "2026-01-01T00:00:00Z",
      "closed_at": null,
      "reactions": {
        "total_count": 3
      },
      "type": "issue"
    },
    "post": {
      "id": "81",
      "url": "https://github.com/example/repo/issues/1",
      "content": {
        "text": "Example issue text",
        "media_urls": null,
        "thumbnail_url": null,
        "duration_seconds": null
      },
      "author": {
        "username": "example",
        "display_name": null,
        "avatar_url": "https://avatars.githubusercontent.com/u/42",
        "verified": null
      },
      "engagement": {
        "views": null,
        "likes": 3,
        "comments": 2,
        "shares": null,
        "saves": null
      },
      "flags": {
        "nsfw": null,
        "spoiler": null,
        "pinned": null,
        "deleted": false
      },
      "published_at": "2026-01-01T00:00:00Z",
      "ext": {
        "node_id": "I_81",
        "number": 1,
        "title": "Synthetic issue",
        "body": "Example issue text",
        "html_url": "https://github.com/example/repo/issues/1",
        "state": "open",
        "user": {
          "id": 42,
          "node_id": "U_42",
          "login": "example",
          "avatar_url": "https://avatars.githubusercontent.com/u/42",
          "html_url": "https://github.com/example",
          "type": "User",
          "site_admin": false
        },
        "labels": [
          {
            "name": "enhancement"
          }
        ],
        "comments": 2,
        "created_at": "2026-01-01T00:00:00Z",
        "updated_at": "2026-01-01T00:00:00Z",
        "closed_at": null,
        "reactions": {
          "total_count": 3
        },
        "type": "issue"
      }
    }
  },
  "platform": "github",
  "endpoint": "/v1/github/issue",
  "success": true,
  "status": "success",
  "requestId": "00000000-0000-4000-8000-000000000001",
  "sourceUrl": "https://github.com/example/repo/issues/1",
  "fetchedAt": "2026-09-17T00:00:00.000Z",
  "coverage": {
    "source": "public_api",
    "complete": true,
    "warnings": []
  },
  "accounting": {
    "upstreamRequests": 1,
    "responseBytes": 509,
    "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": [
      {
        "id": 0,
        "body": "string",
        "html_url": "https://example.com/",
        "created_at": "string",
        "updated_at": "string",
        "user": {
          "id": 0,
          "login": "string",
          "node_id": "string",
          "avatar_url": "https://example.com/",
          "html_url": "https://example.com/",
          "type": "string",
          "site_admin": true
        },
        "reactions": {
          "total_count": 0
        },
        "comment": {
          "id": "string",
          "url": "https://example.com/",
          "parent_id": "string",
          "post_id": "string",
          "text": "string",
          "author": {
            "username": null,
            "display_name": null,
            "avatar_url": null,
            "verified": null
          },
          "engagement": {
            "likes": null,
            "replies": null
          },
          "flags": {
            "deleted": null,
            "pinned": null
          },
          "published_at": "string",
          "replies": [
            null
          ],
          "ext": {}
        }
      }
    ],
    "next_cursor": "string",
    "dropped": 0,
    "total": 0
  },
  "pagination": {
    "next_cursor": "string",
    "has_more": true,
    "page_size": 0
  }
}