Comments

Try in Playground

One page of issue discussion comments, ordered by source creation time, with text, author, reaction count and timestamps.

GET/v1/github/issue/commentsx-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.

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.

Always included.

up to 100 items

data.items.idinteger

Always included.

≥ 0

data.items.bodystring

Always included.

data.items.html_urlstring

Always included.

absolute HTTPS URL

data.items.created_atstring

Always included.

data.items.updated_atstring

Always included.

data.items.user.idinteger

Always included.

≥ 0

data.items.user.loginstring

Always included.

data.items.user.node_idstring

Always included.

data.items.user.avatar_urlstring

Always included.

absolute HTTPS URL

data.items.user.html_urlstring

Always included.

absolute HTTPS URL

data.items.user.typestring

Always included.

data.items.user.site_adminboolean

Always included.

data.items.reactions.total_countinteger

Always included.

≥ 0

Always included.

data.items.comment.idstring

Always included.

data.items.comment.urlstring

Always included.

absolute HTTPS URL

data.items.comment.parent_idstringnullable

Always included.

data.items.comment.post_idstring

Always included.

data.items.comment.textstring

Always included.

data.items.comment.author.usernamestringnullable

Always included.

data.items.comment.author.display_namestringnullable

Always included.

data.items.comment.author.avatar_urlstringnullable

Always included.

data.items.comment.author.verifiedbooleannullable

Always included.

data.items.comment.engagement.likesinteger

Always included.

≥ 0

data.items.comment.engagement.repliesintegernullable

Always included.

data.items.comment.flags.deletedboolean

Always included.

data.items.comment.flags.pinnedbooleannullable

Always included.

data.items.comment.published_atstring

Always included.

data.items.comment.repliesJSON[]nullable

Always included.

data.items.comment.extobject

Always included.

data.next_cursorstringnullable

Always included.

data.droppedintegeroptional

Optional.

≥ 0

data.totalintegernullableoptional

Optional.

Always included.

pagination.next_cursorstringnullable

Always included.

pagination.has_moreboolean

Always included.

pagination.page_sizeintegeroptional

Optional.

≥ 0

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/issue/comments?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/comments?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/comments?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/comments",
    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/comments?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/comments?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": {
    "items": [
      {
        "id": 1,
        "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
        },
        "body": "Synthetic comment",
        "reactions": {
          "total_count": 1
        },
        "created_at": "2025-01-01T00:00:00Z",
        "updated_at": "2025-01-01T00:00:00Z",
        "html_url": "https://github.com/example/repo/issues/1#issuecomment-1",
        "comment": {
          "id": "1",
          "url": "https://github.com/example/repo/issues/1#issuecomment-1",
          "parent_id": null,
          "post_id": "example/repo/issues/1",
          "text": "Synthetic comment",
          "author": {
            "username": "example",
            "display_name": null,
            "avatar_url": "https://avatars.githubusercontent.com/u/42",
            "verified": null
          },
          "engagement": {
            "likes": 1,
            "replies": null
          },
          "flags": {
            "deleted": false,
            "pinned": null
          },
          "published_at": "2025-01-01T00:00:00Z",
          "replies": null,
          "ext": {
            "updated_at": "2025-01-01T00:00:00Z",
            "reactions": {
              "total_count": 1
            }
          }
        }
      }
    ],
    "total": null,
    "next_cursor": null,
    "dropped": 0
  },
  "pagination": {
    "next_cursor": null,
    "has_more": false,
    "page_size": 1
  },
  "platform": "github",
  "endpoint": "/v1/github/issue/comments",
  "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": 391,
    "durationMs": 1
  }
}

Invalid, duplicate or unsupported parameters.

{
  "success": false,
  "status": "failed",
  "requestId": "9d2f1c0a-6b1e-4c7d-9a8e-2f3b4c5d6e7f",
  "failure": {
    "code": "invalid_request",
    "message": "Invalid request: missing, duplicate, unsupported or malformed parameters."
  },
  "accounting": {
    "upstreamRequests": 0,
    "responseBytes": 0,
    "durationMs": 0
  }
}