# GitHub User (`github.user`)

Public profile of a GitHub user or organization: name, bio, company, location, followers and repository counts.

Docs: https://primaryapi.com/docs/api-reference/github/user

- Endpoint: `POST https://api.primaryapi.com/v1/run/github.user`
- Category: Knowledge & Data · Platform: `github` · Kind: lookup · Status: live
- Price: 1 credit per call; up to 3 credits if a call is retried elsewhere. A quote’s `maxCredits` is the most a given call can cost.
- Billing unit: per successful call
- Reliability: routed to a healthy upstream and retried automatically when an attempt fails; live 30-day status: `GET https://api.primaryapi.com/v1/status/apis?sku=github.user`
- Execution: synchronous (answers 202 only if it outlives the wait window)

## Input

| Field | Type | Required | Default | Constraints | Description |
|---|---|---|---|---|---|
| `handle` | string | yes |  | max 200 chars | GitHub username (login), with or without @; a github.com profile URL also works. |

Unknown fields are rejected with `400 invalid_input`. The routing controls `preferLatencyUnderMs` and `maxCredits` may be sent in the same JSON body.

## Output

When `output.found` is `true`, `output.data` has this shape:

| Field | Type | Description |
|---|---|---|
| `id` | string \| null | GitHub numeric account id (as a string) |
| `login` | string |  |
| `name` | string \| null |  |
| `bio` | string \| null |  |
| `company` | string \| null |  |
| `blog` | string \| null | Website from the profile |
| `location` | string \| null |  |
| `avatarUrl` | string \| null |  |
| `profileUrl` | string |  |
| `twitterUsername` | string \| null |  |
| `publicRepos` | integer \| null |  |
| `publicGists` | integer \| null |  |
| `followers` | integer \| null |  |
| `following` | integer \| null |  |
| `type` | string \| null | User \| Organization |
| `createdUtc` | integer \| null | Account creation, UTC epoch seconds |

When the thing you asked about does not exist (or a search matches nothing) the call still succeeds: `output.found` is `false`, `output.data` is `null` and `output.reason` says why (`not_found`, `private`, `no_results`, …). Misses are free unless the notes below say misses are billed.

## Example request

```bash
curl -sS -X POST "https://api.primaryapi.com/v1/run/github.user" \
  -H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"handle":"octocat"}'
```

## Example response

_Values are placeholders that follow the output schema; `credits` is what this call would cost at the usual price._

```json
{
  "output": {
    "found": true,
    "data": {
      "id": "583231",
      "login": "octocat",
      "name": "The Octocat",
      "bio": null,
      "company": "@github",
      "blog": "https://github.blog",
      "location": "San Francisco",
      "avatarUrl": "https://avatars.githubusercontent.com/u/583231?v=4",
      "profileUrl": "https://github.com/octocat",
      "twitterUsername": null,
      "publicRepos": 8,
      "publicGists": 8,
      "followers": 24844,
      "following": 9,
      "type": "User",
      "createdUtc": 1295981076
    }
  },
  "provider": "PrimaryAPI",
  "credits": 1,
  "items": 1,
  "requestId": "req_01JBXK6Y2N9V8T4R3Q2P1M0A7Z"
}
```

## Pricing and reliability

- Usual price: 1 credit per call
- Price ceiling: up to 3 credits if a call is retried elsewhere. A quote’s `maxCredits` is the most a given call can cost; the `maxCredits` routing control caps it per call
- Live 30-day status, success rate, uptime and latency: `GET https://api.primaryapi.com/v1/status/apis?sku=github.user`

## Errors to handle

`invalid_input`, `unauthorized`, `insufficient_balance`, `key_limit_reached`, `trial_cap_reached`, `forbidden`, `not_found`, `idempotency_conflict`, `rate_limited`, `all_sources_failed`, `service_unavailable`, `timeout`. See https://primaryapi.com/docs/errors.

## Notes

Email addresses are never returned (GitHub AUP forbids selling personal information).

