---
title: "Releases and tags"
method: GET
path: "/v1/github/repo/releases"
tags: ["GitHub"]
---

# Releases and tags

`GET /v1/github/repo/releases`

## Request

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

One source page of releases with tags, names, Markdown notes, publication dates, prerelease flags, author and asset metadata; asset files are not downloaded. Use type=tags or type=branches for repository tags or branches with commit references. 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
- `type` 'releases' | 'tags' | 'branches'

## 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
        - `post` object
          - `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
        - `id` integer, required
        - `tag_name` string, required
        - `name` string, nullable, required
        - `body` string, nullable
        - `published_at` string, nullable, required
        - `prerelease` boolean, required
        - `assets` object[], required
          - `id` integer
          - `name` string
          - `size` integer
          - `download_count` integer
          - `browser_download_url` string, uri
      - `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
  - 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
        - `name` string, required
        - `zipball_url` string, uri, required
        - `tarball_url` string, uri, required
        - `commit` object, required
          - `sha` string, required
          - `url` string, uri, required
        - `node_id` string, 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
  - 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
        - `name` string, required
        - `commit` object, required
          - `sha` string, required
          - `url` string, uri, required
        - `protected` boolean, 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)