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

> Composite endpoint — fetches repo metadata, README excerpt, latest 3 releases, top feature request, and top complaint in parallel and returns a structured dossier `{ info, readme, releases, top_issues }`. Useful for AI-grounding workflows where a single call should return everything you'd need to summarise a project. 5 credits per call.

TL;DR: `GET /v1/github/repo/dossier` costs 5 credits 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}`. |

## Code example

```bash
curl "https://www.socialcrawl.dev/v1/github/repo/dossier?url=https%3A%2F%2Fgithub.com%2Ffacebook%2Freact" \
  -H "x-api-key: sc_YOUR_API_KEY"
```

## FAQ

### What does the GitHub Repo Dossier API do?

It pulls a repository's stats, recent activity, and issues, then uses AI to synthesize them into one project dossier — a competitive-intelligence brief on the project. You get the whole picture in a single call instead of stitching endpoints yourself.

### How do I call the dossier endpoint?

Send a GET request to /v1/github/repo/dossier with the repository URL in the url parameter. SocialCrawl gathers the repo, activity, and issue data upstream, runs the AI synthesis, and returns the assembled dossier in one response.

### What goes into the dossier?

Repository stats (stars, forks, language, license), a read on recent commit and release activity, and a synthesis of what the open issues say about the project's health and direction — combined into one structured brief.

### Why not just call the repo and issues endpoints myself?

You can, but you would then have to fetch several endpoints, join them, and write the analysis. The dossier endpoint does all of that in one call and adds the AI synthesis — something GitHub's own REST API does not provide.

### How much does the GitHub Repo Dossier API cost?

This is an advanced endpoint at 5 credits per call, because it fans out to several upstream calls and runs an AI synthesis pass. New accounts get 100 free credits with no credit card required — enough to build 20 dossiers before you pay.

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 get a full AI project dossier for a GitHub repo
- What is the SocialCrawl GitHub Repo Dossier API?