---
title: "Issue"
method: GET
path: "/v1/github/issue"
tags: ["GitHub"]
---

# Issue

`GET /v1/github/issue`

## Request

- Base URL: `https://api.scrapeatlas.com`
- URL: `https://api.scrapeatlas.com/v1/github/issue`
- Auth: API key in header `x-api-key`

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. Each successful request costs 1 account credit, including partial results. Failed requests cost 0 credits.

## Query parameters

- `url` string, required
- `cursor` string
- `page` string
- `limit` string
- `per_page` string
- `since` string, date-time
- `section` 'details' | 'comments'

## Response `200`

Inspect the response status and failure or coverage fields.

- union
  - object
    - `platform` 'github'
    - `endpoint` string
    - `success` true, required
    - `status` 'success' | 'partial', required
    - `requestId` string, uuid, required
    - `sourceUrl` string, uri, required
    - `fetchedAt` string, date-time, required
    - `coverage` object, required
      - `source` 'public_api' | 'public_html', required
      - `complete` boolean, required
      - `warnings` string[], required
    - `accounting` object, required
      - `upstreamRequests` integer, required
      - `responseBytes` integer, required
      - `durationMs` number, required
    - `data` object, required
      - `id` string, required
      - `url` string, uri, nullable, required
      - `content` object, required
        - `text` string, nullable, required
        - `media_urls` string[], nullable, required
        - `thumbnail_url` string, nullable, required
        - `duration_seconds` number, nullable, required
      - `author` object, required
        - `username` string, nullable, required
        - `display_name` string, nullable, required
        - `avatar_url` string, uri, nullable, required
        - `verified` boolean, nullable, required
      - `engagement` object, required
        - `views` integer, nullable, required
        - `likes` integer, nullable, required
        - `comments` integer, nullable, required
        - `shares` integer, nullable, required
        - `saves` integer, nullable, required
      - `flags` object, required
        - `nsfw` boolean, nullable, required
        - `spoiler` boolean, nullable, required
        - `pinned` boolean, nullable, required
        - `deleted` boolean, required
      - `published_at` string, nullable, required
      - `ext` object
      - `number` integer, required
      - `title` string, required
      - `body` string, nullable, required
      - `html_url` string, uri, required
      - `state` 'open' | 'closed', required
      - `user` object, nullable, required
        - `id` integer, required
        - `login` string, required
        - `node_id` string, required
        - `avatar_url` string, uri, required
        - `html_url` string, uri, required
        - `type` string, required
        - `site_admin` boolean, required
      - `labels` union[], required
        - union
          - string
          - object
            - `name` string, required
      - `comments` integer, required
      - `created_at` string, required
      - `updated_at` string, required
      - `closed_at` string, nullable, required
      - `reactions` object, required
        - `total_count` integer, required
      - `post` object, required
        - `id` string, required
        - `url` string, uri, nullable, required
        - `content` object, required
          - `text` string, nullable, required
          - `media_urls` string[], nullable, required
          - `thumbnail_url` string, nullable, required
          - `duration_seconds` number, nullable, required
        - `author` object, required
          - `username` string, nullable, required
          - `display_name` string, nullable, required
          - `avatar_url` string, uri, nullable, required
          - `verified` boolean, nullable, required
        - `engagement` object, required
          - `views` integer, nullable, required
          - `likes` integer, nullable, required
          - `comments` integer, nullable, required
          - `shares` integer, nullable, required
          - `saves` integer, nullable, required
        - `flags` object, required
          - `nsfw` boolean, nullable, required
          - `spoiler` boolean, nullable, required
          - `pinned` boolean, nullable, required
          - `deleted` boolean, required
        - `published_at` string, nullable, required
        - `ext` object
  - object
    - `success` false, required
    - `status` 'failed' | 'challenged', required
    - `requestId` string, uuid, required
    - `failure` object, required
      - `code` 'invalid_request' | 'unauthorized' | 'not_found' | 'upstream_challenged' | 'upstream_rate_limited' | 'upstream_error' | 'unsupported_page' | 'response_too_large' | 'unsafe_redirect' | 'request_limit' | 'timeout' | 'busy' | 'payload_too_complex' | 'upstream_pending', required
      - `message` string, required
    - `accounting` object, required
      - `upstreamRequests` integer, required
      - `responseBytes` integer, required
      - `durationMs` number, required
  - object
    - `platform` 'github'
    - `endpoint` string
    - `success` true, required
    - `status` 'success' | 'partial', required
    - `requestId` string, uuid, required
    - `sourceUrl` string, uri, required
    - `fetchedAt` string, date-time, required
    - `coverage` object, required
      - `source` 'public_api' | 'public_html', required
      - `complete` boolean, required
      - `warnings` string[], required
    - `accounting` object, required
      - `upstreamRequests` integer, required
      - `responseBytes` integer, required
      - `durationMs` number, required
    - `data` object, required
      - `items` object[], required
        - `id` integer, required
        - `body` string, required
        - `html_url` string, uri, required
        - `created_at` string, required
        - `updated_at` string, required
        - `user` object, nullable, required
          - `id` integer, required
          - `login` string, required
          - `node_id` string, required
          - `avatar_url` string, uri, required
          - `html_url` string, uri, required
          - `type` string, required
          - `site_admin` boolean, required
        - `reactions` object, required
          - `total_count` integer, required
        - `comment` object, required
          - `id` string, required
          - `url` string, uri, required
          - `parent_id` string, nullable, required
          - `post_id` string, required
          - `text` string, required
          - `author` object, required
            - `username` string, nullable, required
            - `display_name` string, nullable, required
            - `avatar_url` string, uri, nullable, required
            - `verified` boolean, nullable, required
          - `engagement` object, required
            - `likes` integer, required
            - `replies` integer, nullable, required
          - `flags` object, required
            - `deleted` boolean, required
            - `pinned` boolean, nullable, required
          - `published_at` string, required
          - `replies` unknown[], nullable, required
            - unknown
          - `ext` object, required
      - `next_cursor` string, nullable, required
      - `dropped` integer
      - `total` integer, nullable
    - `pagination` object, required
      - `next_cursor` string, nullable, required
      - `has_more` boolean, required
      - `page_size` integer
  - object
    - `success` false, required
    - `status` 'failed' | 'challenged', required
    - `requestId` string, uuid, required
    - `failure` object, required
      - `code` 'invalid_request' | 'unauthorized' | 'not_found' | 'upstream_challenged' | 'upstream_rate_limited' | 'upstream_error' | 'unsupported_page' | 'response_too_large' | 'unsafe_redirect' | 'request_limit' | 'timeout' | 'busy' | 'payload_too_complex' | 'upstream_pending', required
      - `message` string, required
    - `accounting` object, required
      - `upstreamRequests` integer, required
      - `responseBytes` integer, required
      - `durationMs` number, required

## Other responses

- `400`: Request could not complete; inspect error or failure.code.
- `401`: Request could not complete; inspect error or failure.code.
- `402`: Request could not complete; inspect error or failure.code.
- `403`: Request could not complete; inspect error or failure.code.
- `404`: Request could not complete; inspect error or failure.code.
- `408`: Request could not complete; inspect error or failure.code.
- `413`: Request could not complete; inspect error or failure.code.
- `429`: Request could not complete; inspect error or failure.code.
- `500`: Request could not complete; inspect error or failure.code.
- `502`: Request could not complete; inspect error or failure.code.
- `503`: Request could not complete; inspect error or failure.code.
- `504`: Request could not complete; inspect error or failure.code.

---

[API](https://skmtc.dev/scrapeatlas/apis/scrapeatlas-api.md) · [All operations](https://skmtc.dev/scrapeatlas/apis/scrapeatlas-api/llms.txt) · [OpenAPI document](https://skmtc.dev/scrapeatlas/apis/scrapeatlas-api/revisions/9ba049316894?raw)