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_daysto reuse them for free. - Timeout: A request still running after about 25 seconds answers
202with a job to poll (Batch and jobs).
Parameters#
| Name | Type | Required | Description |
|---|---|---|---|
handle | string | one of | GitHub username. Also accepted as username, login. |
url | URL | one of | Profile 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:truefor a smaller response withoutnullfields andextra.raw:trueto also get the platform's original object asraw.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).
1curl -G "https://api.socialscrape.dev/v1/github/user" \2 -H "x-api-key: $SOCIALSCRAPE_API_KEY" \3 --data-urlencode "handle=torvalds"1import os2import requests34params = {5 "handle": "torvalds",6}7res = requests.get(8 "https://api.socialscrape.dev/v1/github/user",9 headers={"x-api-key": os.environ["SOCIALSCRAPE_API_KEY"]},10 params=params,11)12body = res.json()1314if body["ok"]:15 print(body["data"])16else:17 print(body["error"]["code"], body["error"]["message"])1const url = new URL("https://api.socialscrape.dev/v1/github/user");2url.search = new URLSearchParams({3 "handle": "torvalds"4}).toString();5const res = await fetch(url, {6 headers: { "x-api-key": process.env.SOCIALSCRAPE_API_KEY! },7});8const body = await res.json();910if (body.ok) {11 console.log(body.data);12} else {13 console.error(body.error.code, body.error.message);14}1{2 "nodes": [3 {4 "name": "SocialScrape GitHub user",5 "type": "n8n-nodes-base.httpRequest",6 "typeVersion": 4.2,7 "position": [8 0,9 010 ],11 "parameters": {12 "method": "GET",13 "url": "https://api.socialscrape.dev/v1/github/user",14 "sendQuery": true,15 "queryParameters": {16 "parameters": [17 {18 "name": "handle",19 "value": "torvalds"20 }21 ]22 },23 "sendHeaders": true,24 "headerParameters": {25 "parameters": [26 {27 "name": "x-api-key",28 "value": "={{ $env.SOCIALSCRAPE_API_KEY }}"29 }30 ]31 }32 }33 }34 ],35 "connections": {}36}Example response#
This is a sample from a recorded response. Status 200.
200 OKSample response
1{2 "ok": true,3 "credits_charged": 1,4 "credits_remaining": 4999,5 "cached": false,6 "cached_at": null,7 "request_id": "req_61963aec2e8934ef860d4a93",8 "data": {9 "object": "profile",10 "platform": "github",11 "id": "1024025",12 "handle": "torvalds",13 "name": "Linus Torvalds",14 "headline": null,15 "url": "https://github.com/torvalds",16 "kind": "person",17 "bio": null,18 "avatar_url": "https://avatars.githubusercontent.com/u/1024025?v=4",19 "banner_url": null,20 "verified": null,21 "is_private": null,22 "external_url": null,23 "links": [],24 "location": "Portland, OR",25 "category": null,26 "created_at": "2011-09-03T15:26:22Z",27 "stats": {28 "followers": 329772,29 "following": 0,30 "posts": null,31 "likes": null,32 "views": null33 },34 "extra": {35 "company": "Linux Foundation",36 "node_id": "MDQ6VXNlcjEwMjQwMjU=",37 "public_gists": 1,38 "public_repos": 12,39 "site_admin": false,40 "type": "User",41 "updated_at": "2026-10-16T15:33:53Z"42 }43 },44 "cursor": null,45 "has_more": null46}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.
| Code | HTTP | Retry | Meaning |
|---|---|---|---|
invalid_params | 400 | no | A parameter is missing, unknown or has the wrong type. |
unsupported_url | 400 | no | The URL is not one this endpoint accepts (wrong platform or form). |
not_found | 404 | no | The 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:
1{2 "ok": false,3 "error": {4 "code": "not_found",5 "message": "The platform says this profile, post or item does not exist.",6 "retryable": false7 },8 "credits_charged": 0,9 "request_id": "req_1594b2225172a7799fef75ee"10}Related endpoints#
- GitHub user repositories (
GET /v1/github/user/repositories) - GitHub repository (
GET /v1/github/repository) - GitHub followers (
GET /v1/github/user/followers) - GitHub following (
GET /v1/github/user/following) - GitHub contribution calendar (
GET /v1/github/user/contributions) - GitHub public activity (
GET /v1/github/user/activity) - GitHub pull requests by a user (
GET /v1/github/user/pull-requests) - GitHub trending repositories (
GET /v1/github/trending/repositories)