Start with 100 free credits. No card needed. Get an API key

GitHub user API

GitHub user: GET /v1/github/user. 1 credit per request.

GET /v1/github/user

GET /v1/github/user

GitHub user.

  • Cost: 1 credit
  • Cache: Results are kept up to 30 days; send max_age_days to reuse them for free.
  • Timeout: A request still running after about 25 seconds answers 202 with a job to poll (Batch and jobs).

Parameters

NameTypeRequiredDescription
handlestringone ofA username (with or without @) or a profile or repository URL (github.com/<name>). Also accepted as username, login.
urlURLone ofProfile URL (github.com/<user>). Accepted hosts: github.com.

Send at least one of handle, url. If you send several, the first listed is used and the rest are ignored.

Every request also accepts:

  • trim: true for a smaller response without null fields and extra.
  • raw: true to also get the platform's original object as raw.
  • max_age_days: accept a cached result up to this many days old, for 0 credits (Caching).

Example request

Set your key in the environment first (see Authentication).

curl -G "https://api.socialscrape.dev/v1/github/user" \
  -H "x-api-key: $SOCIALSCRAPE_API_KEY" \
  --data-urlencode "handle=torvalds"

Example response

This is a sample from a recorded response. Status 200.

200 OKSample values
{
  "ok": true,
  "credits_charged": 1,
  "credits_remaining": 4999,
  "cached": false,
  "cached_at": null,
  "request_id": "req_61963aec2e8934ef860d4a93",
  "data": {
    "object": "profile",
    "platform": "github",
    "id": "1024025",
    "handle": "torvalds",
    "name": "Linus Torvalds",
    "headline": null,
    "url": "https://github.com/torvalds",
    "kind": "person",
    "bio": null,
    "avatar_url": "https://avatars.githubusercontent.com/u/1024025?v=4",
    "banner_url": null,
    "verified": null,
    "is_private": null,
    "status": null,
    "restriction": null,
    "external_url": null,
    "links": [],
    "location": "Portland, OR",
    "category": null,
    "created_at": "2011-09-03T15:26:22Z",
    "is_live": null,
    "stats": {
      "followers": 329772,
      "following": 0,
      "posts": null,
      "likes": null,
      "views": null
    },
    "approximate": null,
    "extra": {
      "company": "Linux Foundation",
      "node_id": "MDQ6VXNlcjEwMjQwMjU=",
      "public_gists": 1,
      "public_repos": 12,
      "site_admin": false,
      "type": "User",
      "updated_at": "2026-10-16T15:33:53Z"
    }
  },
  "cursor": null,
  "has_more": null
}

Response

A Profile object in data.

See Data models for every field. The envelope around data is described in Responses.

Errors

Failures are free: credits_charged is 0. Branch on error.code, never on the message.

CodeHTTPRetryMeaning
invalid_params400noA parameter is missing, unknown or has the wrong type.
unsupported_url400noThe URL is not one this endpoint accepts (wrong platform or form).
not_found404noThe platform says this profile, post or item does not exist.

Every request can also fail with the account and platform errors listed on the Errors page.

Example error:

JSON
{
  "ok": false,
  "error": {
    "code": "not_found",
    "message": "The platform says this profile, post or item does not exist.",
    "retryable": false
  },
  "credits_charged": 0,
  "request_id": "req_1594b2225172a7799fef75ee"
}