# GitHub User Profile

Returns the public profile of a GitHub account: login, name, bio, avatar, company, location, blog, social links, hireable flag, follower and following counts, public repository and gist counts, and account creation and update dates. Requires no GitHub credential of any kind.

- **Documentation:** [https://scrappa.co/docs/github-api/github_user](https://scrappa.co/docs/github-api/github_user)
- **API group:** GitHub API
- **Endpoint:** `GET https://scrappa.co/api/github/user`

## Authentication

Send your Scrappa API key in the `X-API-KEY` request header. Paid endpoints also support accountless x402 payments when called without an API key.

## Parameters

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `username` | string | Yes | GitHub account login, e.g. torvalds. |

## Example request

```bash
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/github/user?username=torvalds"
```

## Example response

```json
{
    "search_parameters": {
        "engine": "github_user",
        "username": "torvalds"
    },
    "login": "torvalds",
    "id": 1,
    "name": "Linus Torvalds",
    "bio": null,
    "company": "Linux Foundation",
    "blog": "",
    "location": "Portland, OR",
    "followers": 2400000,
    "following": 0,
    "public_repos": 8,
    "public_gists": 0,
    "created_at": "2011-09-03T15:26:22Z",
    "updated_at": "2026-09-12T09:41:07Z"
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 422 | Validation Error | A parameter failed validation. |
| 404 | Not Found | GitHub has no public resource at that address. For a repository this also covers a private or renamed repository, which is indistinguishable anonymously. |
| 503 | GitHub Upstream Unavailable | The upstream service is temporarily unavailable. Please retry shortly. |
| 500 | Parser Drift | GitHub returned a response shape this parser does not recognise. The incident has been reported; retrying will return the same result. |
| 406 | Not Acceptable Upstream | GitHub has no JSON representation for this route, or rejected the request headers. Never charged. |

## More Scrappa resources

- [API documentation](https://scrappa.co/docs)
- [Full LLM-readable API reference](https://scrappa.co/llms-full.txt)
- [OpenAPI specification](https://scrappa.co/docs/api.json)
- [Pricing](https://scrappa.co/pricing)