---
title: "Retrieve a GitHub user profile"
method: GET
path: "/github/user/{username}"
tags: ["GitHub"]
---

# Retrieve a GitHub user profile

`GET /github/user/{username}`

## Request

- Base URL: `https://api.crawlora.net/api/v1`
- URL: `https://api.crawlora.net/api/v1/github/user/{username}`
- Auth: API key in header `x-api-key`

Returns a public GitHub user's profile plus user-published social links. Email is included only when the user has made it public on their profile.

## Path parameters

- `username` string, required

## Headers

- `x-api-key` string, required

## Response `200`

Wrapped user profile

- AppResponse: The Response struct is used for wrapping the API response with a code, message, and data.
  - `code` integer: Code is the HTTP status code or a custom code used to indicate the result of the request @example 200
  - `data` unknown
  - `msg` unknown

## Other responses

- `400`: Missing or invalid parameters
- `404`: User not found
- `503`: Upstream error or rate limit

---

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