# GitHub User Info

## Overview

| Property | Value |
|----------|-------|
| **Status** | degraded |
| **Method** | `GET` |
| **Endpoint** | `/v2/github/user/info` |
| **Base URL** | `https://api.piloterr.com` |
| **Credit Cost** | 1 credit per call |
| **Documentation** | https://www.piloterr.com/library/github-user-info |

## Description

Retrieve public GitHub user profile data including bio, company, location, follower count, repositories, and associated email addresses.

## Authentication

- **Key Name:** `x-api-key`
- **Location:** HTTP Header
- **Get an API key:** https://app.piloterr.com/register

## Example Request

```bash
curl --location --request GET 'https://api.piloterr.com/v2/github/user/info' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_API_KEY'
```

## Example Response

### Lookup Linus Torvalds GitHub profile

```json
{
  "id": 1024025,
  "name": "Linus Torvalds",
  "email": [
    "torvalds@linux-foundation.org"
  ],
  "login": "torvalds",
  "company": "Linux Foundation",
  "location": "Portland, OR",
  "ssh_keys": "https://github.com/torvalds.keys",
  "followers": 199164,
  "following": 0,
  "avatar_url": "https://avatars.githubusercontent.com/u/1024025?v=4",
  "created_at": "2011-09-03T15:26:22Z",
  "updated_at": "2023-11-12T20:08:30Z",
  "public_gists": "https://gist.github.com/torvalds",
  "public_repos": 7
}
```

## Documentation

## Overview
The GitHub User Info endpoint retrieves the full public profile of any GitHub user, including follower count, repositories, company, location, and email addresses.

## Quickstart
```
GET https://api.piloterr.com/v2/github/user/info?query=torvalds
```

## Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| `query` | string | yes | GitHub profile URL, username, or email |

## Response fields
| Field | Type | Description |
|---|---|---|
| `login` | string | GitHub username |
| `name` | string | Display name |
| `company` | string | Company affiliation |
| `followers` | number | GitHub followers |
| `public_repos` | number | Public repository count |
| `email` | array | Associated email addresses |

## Notes
- Only public profile data is returned.
- Email may be empty if not made public.

## Main use cases
- Enrich developer records with GitHub profile data for technical outreach
- Verify developer credentials via follower count and repositories
- Build developer analytics dashboards with open-source metrics
- Identify open-source project maintainers by username or email