---
title: "User"
method: GET
path: "/v1/github/user"
tags: ["GitHub"]
---

# User

`GET /v1/github/user`

## Request

- Base URL: `https://api.scrapeatlas.com`
- URL: `https://api.scrapeatlas.com/v1/github/user`
- Auth: API key in header `x-api-key`

Retrieve a user or organization profile with biography, public email, location, account timestamps and counts; choose native, normalized or camelCase fields with format. Use view=social-links for linked social accounts or view=organizations for public organization memberships. Each successful request costs 1 account credit, including partial results. Failed requests cost 0 credits.

## Query parameters

- `handle` string
- `url` string
- `cursor` string
- `page` string
- `limit` string
- `per_page` string
- `format` 'native' | 'normalized' | 'camelCase'
- `view` 'profile' | 'social-links' | 'organizations'

## Response `200`

Inspect the response status and failure or coverage fields.

- union
  - object
    - `platform` 'github'
    - `endpoint` string
    - `success` true, required
    - `status` 'success' | 'partial', required
    - `requestId` string, uuid, required
    - `sourceUrl` string, uri, required
    - `fetchedAt` string, date-time, required
    - `coverage` object, required
      - `source` 'public_api' | 'public_html', required
      - `complete` boolean, required
      - `warnings` string[], required
    - `accounting` object, required
      - `upstreamRequests` integer, required
      - `responseBytes` integer, required
      - `durationMs` number, required
    - `id` integer, required
    - `node_id` string, required
    - `login` string, required
    - `name` string, nullable, required
    - `company` string, nullable, required
    - `blog` string, nullable, required
    - `location` string, nullable, required
    - `email` string, nullable, required
    - `bio` string, nullable, required
    - `twitter_username` string, nullable, required
    - `avatar_url` string, uri, required
    - `type` 'User' | 'Organization', required
    - `site_admin` boolean, required
    - `public_repos` integer, required
    - `public_gists` integer, required
    - `followers` integer, required
    - `following` integer, required
    - `created_at` string, required
    - `updated_at` string, required
    - `url` string, uri, required
  - object
    - `success` false, required
    - `status` 'failed' | 'challenged', required
    - `requestId` string, uuid, required
    - `failure` object, required
      - `code` 'invalid_request' | 'unauthorized' | 'not_found' | 'upstream_challenged' | 'upstream_rate_limited' | 'upstream_error' | 'unsupported_page' | 'response_too_large' | 'unsafe_redirect' | 'request_limit' | 'timeout' | 'busy' | 'payload_too_complex' | 'upstream_pending', required
      - `message` string, required
    - `accounting` object, required
      - `upstreamRequests` integer, required
      - `responseBytes` integer, required
      - `durationMs` number, required
  - object
    - `platform` 'github', required
    - `endpoint` '/v1/github/profile', required
    - `success` true, required
    - `status` 'success' | 'partial', required
    - `requestId` string, uuid, required
    - `sourceUrl` string, uri, required
    - `fetchedAt` string, date-time, required
    - `coverage` object, required
      - `source` 'public_api' | 'public_html', required
      - `complete` boolean, required
      - `warnings` string[], required
    - `accounting` object, required
      - `upstreamRequests` integer, required
      - `responseBytes` integer, required
      - `durationMs` number, required
    - `data` object, required
      - `id` string, required
      - `username` string, required
      - `display_name` string, nullable, required
      - `avatar_url` string, uri, required
      - `bio` string, nullable, required
      - `verified` boolean, nullable, required
      - `followers` integer, required
      - `following` integer, required
      - `posts_count` integer, required
      - `likes_count` integer, nullable, required
      - `url` string, uri, required
      - `location` string, nullable, required
      - `external_url` string, nullable, required
      - `private` boolean, nullable, required
      - `joined_at` string, required
      - `ext` object, required
      - `author` object, required
        - `id` string, required
        - `username` string, required
        - `display_name` string, nullable, required
        - `avatar_url` string, uri, required
        - `bio` string, nullable, required
        - `verified` boolean, nullable, required
        - `followers` integer, required
        - `following` integer, required
        - `posts_count` integer, required
        - `likes_count` integer, nullable, required
        - `url` string, uri, required
        - `location` string, nullable, required
        - `external_url` string, nullable, required
        - `private` boolean, nullable, required
        - `joined_at` string, required
        - `ext` object, required
  - object
    - `success` false, required
    - `status` 'failed' | 'challenged', required
    - `requestId` string, uuid, required
    - `failure` object, required
      - `code` 'invalid_request' | 'unauthorized' | 'not_found' | 'upstream_challenged' | 'upstream_rate_limited' | 'upstream_error' | 'unsupported_page' | 'response_too_large' | 'unsafe_redirect' | 'request_limit' | 'timeout' | 'busy' | 'payload_too_complex' | 'upstream_pending', required
      - `message` string, required
    - `accounting` object, required
      - `upstreamRequests` integer, required
      - `responseBytes` integer, required
      - `durationMs` number, required
  - object
    - `platform` 'github'
    - `endpoint` string
    - `success` true, required
    - `status` 'success' | 'partial', required
    - `requestId` string, uuid, required
    - `sourceUrl` string, uri, required
    - `fetchedAt` string, date-time, required
    - `coverage` object, required
      - `source` 'public_api' | 'public_html', required
      - `complete` boolean, required
      - `warnings` string[], required
    - `accounting` object, required
      - `upstreamRequests` integer, required
      - `responseBytes` integer, required
      - `durationMs` number, required
    - `data` object, required
      - `lookupStatus` 'found' | 'not_found', required
      - `profile` object, nullable, required
        - `platformUserId` string, required
        - `handle` string, required
        - `avatarUrl` string, uri, required
        - `profileUrl` string, uri, required
        - `accountType` string, required
        - `siteAdmin` boolean
        - `nodeId` string
        - `displayName` string, nullable
        - `company` string, nullable
        - `blog` string, nullable
        - `location` string, nullable
        - `email` string, nullable
        - `bio` string, nullable
        - `twitterUsername` string, nullable
        - `accountCreatedAt` string
        - `accountUpdatedAt` string
        - `platform` 'github'
      - `metrics` object, nullable, required
        - `publicRepos` integer, required
        - `publicGists` integer, required
        - `followers` integer, required
        - `following` integer, required
  - object
    - `success` false, required
    - `status` 'failed' | 'challenged', required
    - `requestId` string, uuid, required
    - `failure` object, required
      - `code` 'invalid_request' | 'unauthorized' | 'not_found' | 'upstream_challenged' | 'upstream_rate_limited' | 'upstream_error' | 'unsupported_page' | 'response_too_large' | 'unsafe_redirect' | 'request_limit' | 'timeout' | 'busy' | 'payload_too_complex' | 'upstream_pending', required
      - `message` string, required
    - `accounting` object, required
      - `upstreamRequests` integer, required
      - `responseBytes` integer, required
      - `durationMs` number, required
  - object
    - `platform` 'github'
    - `endpoint` string
    - `success` true, required
    - `status` 'success' | 'partial', required
    - `requestId` string, uuid, required
    - `sourceUrl` string, uri, required
    - `fetchedAt` string, date-time, required
    - `coverage` object, required
      - `source` 'public_api' | 'public_html', required
      - `complete` boolean, required
      - `warnings` string[], required
    - `accounting` object, required
      - `upstreamRequests` integer, required
      - `responseBytes` integer, required
      - `durationMs` number, required
    - `data` object, required
      - `items` object[], required
        - `provider` string, required
        - `url` string, uri, required
      - `next_cursor` string, nullable, required
      - `dropped` integer
      - `total` integer, nullable
    - `pagination` object, required
      - `next_cursor` string, nullable, required
      - `has_more` boolean, required
      - `page_size` integer
  - object
    - `success` false, required
    - `status` 'failed' | 'challenged', required
    - `requestId` string, uuid, required
    - `failure` object, required
      - `code` 'invalid_request' | 'unauthorized' | 'not_found' | 'upstream_challenged' | 'upstream_rate_limited' | 'upstream_error' | 'unsupported_page' | 'response_too_large' | 'unsafe_redirect' | 'request_limit' | 'timeout' | 'busy' | 'payload_too_complex' | 'upstream_pending', required
      - `message` string, required
    - `accounting` object, required
      - `upstreamRequests` integer, required
      - `responseBytes` integer, required
      - `durationMs` number, required
  - object
    - `platform` 'github'
    - `endpoint` string
    - `success` true, required
    - `status` 'success' | 'partial', required
    - `requestId` string, uuid, required
    - `sourceUrl` string, uri, required
    - `fetchedAt` string, date-time, required
    - `coverage` object, required
      - `source` 'public_api' | 'public_html', required
      - `complete` boolean, required
      - `warnings` string[], required
    - `accounting` object, required
      - `upstreamRequests` integer, required
      - `responseBytes` integer, required
      - `durationMs` number, required
    - `data` object, required
      - `items` object[], required
        - `login` string, required
        - `id` integer, required
        - `node_id` string, required
        - `avatar_url` string, uri, required
        - `description` string, nullable, required
      - `next_cursor` string, nullable, required
      - `dropped` integer
      - `total` integer, nullable
    - `pagination` object, required
      - `next_cursor` string, nullable, required
      - `has_more` boolean, required
      - `page_size` integer

## Other responses

- `400`: Request could not complete; inspect error or failure.code.
- `401`: Request could not complete; inspect error or failure.code.
- `402`: Request could not complete; inspect error or failure.code.
- `403`: Request could not complete; inspect error or failure.code.
- `404`: Request could not complete; inspect error or failure.code.
- `408`: Request could not complete; inspect error or failure.code.
- `413`: Request could not complete; inspect error or failure.code.
- `429`: Request could not complete; inspect error or failure.code.
- `500`: Request could not complete; inspect error or failure.code.
- `502`: Request could not complete; inspect error or failure.code.
- `503`: Request could not complete; inspect error or failure.code.
- `504`: Request could not complete; inspect error or failure.code.

---

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