# GitHub Repo Releases API (https://www.socialcrawl.dev/platforms/github/repo-releases)

> Returns the most recent releases for the repository under `data.items[]`: each entry includes `tag_name`, `name`, `body` (markdown release notes), `published_at`, `prerelease`, and `assets[]`. Sorted newest-first by upstream default.

TL;DR: `GET /v1/github/repo/releases` costs 1 credit per call and returns SocialCrawl's unified JSON schema. Single x-api-key auth, 100 free credits on signup.

## Parameters

| Parameter | Required | Description |
| --- | --- | --- |
| `url` | yes | GitHub repo URL: `https://github.com/{owner}/{repo}`. |
| `per_page` | no | Releases per page (1-100). Defaults to 30. |
| `page` | no | 1-indexed page number. |
| `since` | no | Only rows published on or after this date: YYYY-MM-DD (midnight UTC) or an ISO 8601 timestamp. Rows older than it are left off each page. This list is not in date order, so the walk does not stop at the date: keep following `next_cursor`, and each page costs what a page costs even when every row on it is filtered out. A row with no date is kept. `published_after`, `start_date`, `from_date`, `publish_time` (`yesterday`, `this-week`, `this-month`, `last-3-months`, `last-6-months`) and `max_age_days` are accepted and applied as `since`. |
| `until` | no | Only rows published on or before this date: YYYY-MM-DD (that whole UTC day is included) or an ISO 8601 timestamp. Newer rows are left off each page and the walk does not stop, so older pages follow. A row with no date is kept. `published_before`, `end_date` and `to_date` are accepted and applied as `until`. |
| `max_pages` | no | 1 to 50 (default 1, or 50 when `max_items` or `max_credits` is sent). Walk up to this many pages in one call and return the rows from all of them. Each page walked is billed exactly as one call to this endpoint (a cached page is free) and counts against your rate limit; its charge and any refund are recorded under the page's own request id, listed in `data.walk.request_ids`. The walk stops early at the last page, or when the request's time budget runs low; `data.walk.stopped` says why (`end`, `max_pages`, `max_items`, `max_credits`, `time_budget`, `page_error`) and `pagination.next_cursor` continues from where it stopped. |
| `max_items` | no | 1 to 5000. Get more in one call: keep walking pages until the response holds at least this many rows, then stop with `data.walk.stopped: "max_items"`. The last page is returned whole (it was billed), so `data.items` can hold up to one page more than this, and `pagination.next_cursor` resumes right after it without skipping a row. Walks up to 50 pages unless `max_pages` says fewer; each page is billed as one call (a cached page is free). Add `max_credits` to cap the spend. A long walk can stop on the time budget first (`"time_budget"`): send the returned cursor with the same params to continue. |
| `max_credits` | no | 1 to 100000. The most this call may spend, across every page it walks. A page starts only while the credits already spent plus that page's price (or, when higher, the most any page of this walk has cost) still fit, so the call never goes past it; the walk then stops with `data.walk.stopped: "max_credits"` and the cursor to resume. Sent alone, it walks as far as the budget goes (up to 50 pages). A value below the price of one page is a free 400 whose `error.details.page_credits` names that price. Credits a row join (`include=`) adds are known only once a page has run, so page 1 is checked against its own price. |

## Code example

```bash
curl -G "https://www.socialcrawl.dev/v1/github/repo/releases" \
  --data-urlencode "url=https://github.com/facebook/react" \
  -H "x-api-key: sc_YOUR_API_KEY"
```

## FAQ

### How do I list a repo's releases with an API?

Send a GET request to /v1/github/repo/releases with the repository URL in the url parameter. SocialCrawl returns an array of releases, each with tag name, release notes, published date, author, prerelease flag, and downloadable asset list.

### What fields does each release include?

Tag name, release name, body (the release notes as markdown), published and created timestamps, author, draft and prerelease flags, and an assets array with file name, size, and download URL for each attached binary.

### Can I track a project's release cadence with this?

Yes. List releases on a schedule and compare published timestamps to measure how often a project ships. Pair it with the repo endpoint for stars and the dossier endpoint for a synthesized activity view of the same project.

### Are release assets and binaries included?

Yes. Each release carries an assets array listing every uploaded file with its name, content type, byte size, download count, and direct download URL, useful for tracking which build artifacts a project distributes.

### How much does the GitHub Releases API cost?

Each request costs 1 credit on the standard tier, regardless of how many releases come back. New accounts get 100 free credits with no credit card required, enough to pull release history for around 100 repositories.

See the full GitHub API: https://www.socialcrawl.dev/platforms/github

## Pricing

- Standard endpoints: 1 credit per call
- Advanced endpoints: 5 credits per call
- Premium endpoints: 10 credits per call
- 100 free credits on signup, no credit card required. Cached responses cost 0 credits. Credit packs never expire.
- Full pricing: https://www.socialcrawl.dev/pricing

## Explore with AI

Questions this API answers, phrased for an AI assistant:

- How to list GitHub releases for a repo with an API
- What does the SocialCrawl GitHub Releases API return?