User Profile

GET/v1/github/user1 credit

Returns the public profile of a GitHub user or organization: name, bio, company, location, website, follower and repository counts and creation date.

01Query parameters

Name	Type	Description
handleoptional	string	GitHub username, e.g. `torvalds` (a leading `@` is ignored). One of `handle`, `username` or `url` is required.
usernameoptional	string	Same as `handle`, accepted under this name too. One of `handle`, `username` or `url` is required.
urloptional	string	GitHub profile URL, e.g. `https://github.com/torvalds`. One of `handle`, `username` or `url` is required.

02Request

curl "https://api.scrapesocial.ai/v1/github/user?handle=torvalds" \
  -H "x-api-key: $SCRAPESOCIAL_KEY"

03Responses

Real answers from the API. Lists are shortened to 2 items.

GET /v1/github/user?handle=torvalds

{
  "success": true,
  "credits_remaining": 4980,
  "credits_charged": 1,
  "id": 1024025,
  "node_id": "MDQ6VXNlcjEwMjQwMjU=",
  "login": "torvalds",
  "name": "Linus Torvalds",
  "company": "Linux Foundation",
  "blog": "",
  "location": "Portland, OR",
  "email": null,
  "bio": null,
  "twitter_username": null,
  "avatar_url": "https://avatars.githubusercontent.com/u/1024025?v=4",
  "url": "https://github.com/torvalds",
  "type": "User",
  "site_admin": false,
  "public_repos": 12,
  "public_gists": 1,
  "followers": 329390,
  "following": 0,
  "created_at": "2011-09-03T15:26:22Z",
  "updated_at": "2026-10-16T15:33:53Z"
}

Common to every endpoint

Any route can answer these: a missing or wrong key, no credits left, the platform not answering, or a failure on our side. None of them costs credits.

GET /v1/cosmos/profile?handle=design

{
  "success": false,
  "message": "Invalid API key"
}

04Notes

Works for organizations too (their `type` is `Organization`). `url` in the answer is the github.com profile page. An unknown user is a free 404; a value that is not a GitHub username or profile URL is a free 400.

05Errors & credits

Every error has success: false, a real HTTP status and costs no credits.

400missing_parameter
A required parameter is missing or invalid.
403private_account
The account is private or age-restricted.
404not_found
No such account.
503upstream_error
The platform did not answer; retry shortly.