---
title: "Search"
method: GET
path: "/v1/github/search"
tags: ["GitHub"]
---

# Search

`GET /v1/github/search`

## Request

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

Search issues and pull requests, repositories or users with type=issues, repositories or users. Use source qualifiers, type-specific sorting and caller-selected pagination. Each successful request costs 1 account credit, including partial results. Failed requests cost 0 credits.

## Query parameters

- `cursor` string
- `page` string
- `limit` string
- `per_page` string
- `query` string, required
- `sort` 'reactions' | 'comments' | 'created' | 'updated' | 'stars' | 'forks' | 'help-wanted-issues' | 'followers' | 'repositories' | 'joined'
- `order` 'asc' | 'desc'
- `type` 'issues' | 'repositories' | 'users'

## 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
      - `items` 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
              - …
        - `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
      - `total` integer, nullable
      - `total_count` integer, required
      - `incomplete_results` boolean, required
      - `next_cursor` string, nullable, required
      - `dropped` integer, required
    - `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
  - 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
        - `node_id` string, required
        - `name` string, required
        - `full_name` string, required
        - `owner` object, required
          - `id` integer, required
          - `login` string, required
          - `avatar_url` string, uri, required
          - `url` string, uri, required
          - `type` string, required
        - `private` false, required
        - `description` string, nullable, required
        - `fork` boolean, required
        - `homepage` string, nullable, required
        - `language` string, nullable, required
        - `forks_count` integer, required
        - `watchers_count` integer, required
        - `size` integer, required
        - `default_branch` string, required
        - `open_issues_count` integer, required
        - `topics` string[], required
        - `license` object, nullable, required
          - `key` string, required
          - `name` string, required
          - `spdx_id` string, nullable, required
        - `archived` boolean, required
        - `disabled` boolean, required
        - `visibility` string, required
        - `pushed_at` string, nullable, required
        - `created_at` string, required
        - `updated_at` string, required
        - `url` string, uri, required
        - `stars_count` integer, required
        - `subscriberCount` integer, nullable
        - `networkCount` integer, nullable
        - `hasIssues` boolean, nullable
        - `hasDiscussions` boolean, nullable
        - `hasWiki` boolean, nullable
        - `hasPages` boolean, nullable
        - `isTemplate` boolean, nullable
        - `parentRepository` object, nullable
          - `fullName` string, required
          - `url` string, uri, required
        - `sourceRepository` object, nullable
          - `fullName` string, required
          - `url` string, uri, required
      - `total` integer, nullable
      - `total_count` integer, required
      - `incomplete_results` boolean, required
      - `next_cursor` string, nullable, required
    - `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
  - 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
        - `login` string, required
        - `node_id` string, required
        - `avatar_url` string, uri, required
        - `html_url` string, uri, required
        - `type` string, required
        - `site_admin` boolean, required
      - `total` integer, nullable
      - `total_count` integer, required
      - `incomplete_results` boolean, required
      - `next_cursor` string, nullable, required
    - `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)