# GitHub User Profile Velocity API (https://www.socialcrawl.dev/platforms/github/user-profile-velocity)

> Composite endpoint — combines a `/search/issues` PR-velocity query (total + merged), the user's own repo list, and parallel per-repo enrichment (stars + releases for external repos; README + releases + top-issues for own repos) into a structured contribution dossier `{ velocity, contributed_repos[], own_repos[] }`. The `depth` param controls fan-out width: `quick` enriches up to 5 external + 3 own repos, `default` 10 + 5, `deep` 15 + 5. 10 credits per call.

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

## Parameters

| Parameter | Required | Description |
| --- | --- | --- |
| `handle` | yes | GitHub username. |
| `depth` | no | `quick`, `default`, or `deep`. Defaults to `default`. Trades off upstream calls vs. dossier richness. (quick \| default \| deep) |

## Code example

```bash
curl "https://www.socialcrawl.dev/v1/github/user/profile-velocity?handle=octocat" \
  -H "x-api-key: sc_YOUR_API_KEY"
```

## FAQ

### What does the GitHub Velocity API do?

It builds a contribution-velocity dossier for a GitHub user — an AI read on how active they are, how consistently they ship, and which projects they contribute to. It turns a scattered activity history into one structured summary.

### How do I call the profile-velocity endpoint?

Send a GET request to /v1/github/user/profile-velocity with the username in the handle parameter. SocialCrawl gathers the user's activity upstream, runs the AI analysis, and returns the velocity dossier in one response.

### What is the depth parameter for?

Depth is optional and controls how far back and how thoroughly the analysis reaches. A shallower depth returns a faster, lighter read; a deeper depth pulls more history for a fuller picture. Omit it to use the default depth.

### What can I use a contributor velocity dossier for?

Technical recruiting, developer-relations targeting, and open-source community analysis. It tells you whether a developer is consistently active and where they focus, far faster than reading their profile and repos by hand.

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

This is a premium endpoint at 10 credits per call, since it gathers a user's activity and runs a deep AI analysis pass. New accounts get 100 free credits with no credit card required — enough to profile 10 developers 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 measure a GitHub user's contribution velocity with AI
- What is the SocialCrawl GitHub Velocity API?