---
title: "Run a deep profile analysis for a single GitHub username"
method: POST
path: "/v1/profile/analyze"
---

# Run a deep profile analysis for a single GitHub username

`POST /v1/profile/analyze`

## Request

- Base URL: `https://api.githunt.ai`
- URL: `https://api.githunt.ai/v1/profile/analyze`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-Api-Key`

## Request body

- object
  - `username` string, required: GitHub username to analyze

## Response `200`

Profile analysis

- ProfileAnalyzeResponse
  - `success` true
  - `data` object: Deep analysis payload. Top-level keys: profile (basic profile facts), emails ({emails: [{address, sources, commitCount, isPrimary}]}), commitQuality, repositories, activity, roleMatch (ranked array of role fits with score breakdowns), proficiency ({level, score, experienceYears}), scores (best-role score with detailed breakdown), badges, summary. Sub-shapes may gain fields over time (additive only).
    - `proficiency` object
      - `level` string
      - `score` number
      - `experienceYears` number
    - `emails` object
      - `emails` object[]
        - `address` string
        - `sources` string[]
        - `isPrimary` boolean
    - `roleMatch` object[]
      - `role` string
      - `displayName` string
      - `score` number

## Other responses

- `400`: Invalid request
- `401`: Missing, invalid, or revoked API key
- `404`: No matching developer
- `429`: Monthly or daily quota exceeded
- `500`: Unexpected server error

---

[API](https://skmtc.dev/githunt/apis/githunt-api.md) · [All operations](https://skmtc.dev/githunt/apis/githunt-api/llms.txt) · [OpenAPI document](https://skmtc.dev/githunt/apis/githunt-api/revisions/6fc325607da0?raw)