GitHub followers API reference

GET /v1/github/user/followers

GitHub followers.

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#

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:

cursor: the cursor from the previous page (Pagination).
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).

1curl -G "https://api.socialscrape.dev/v1/github/user/followers" \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/followers",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/followers");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 followers",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/followers",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, lists and long text are shortened, other people's names and handles are replaced. 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_06db94fea6b08ec89b1e3416",8  "data": {9    "object": "list",10    "items": [11      {12        "object": "profile",13        "platform": "github",14        "id": "1000000001",15        "handle": "sample_user",16        "name": "Sample User",17        "headline": null,18        "url": null,19        "kind": "person",20        "bio": null,21        "avatar_url": null,22        "banner_url": null,23        "verified": null,24        "is_private": null,25        "external_url": null,26        "links": null,27        "location": null,28        "category": null,29        "created_at": null,30        "stats": {31          "followers": null,32          "following": null,33          "posts": null,34          "likes": null,35          "views": null36        },37        "extra": {38          "node_id": "MDQ6VXNlcjIwNg==",39          "site_admin": false,40          "type": "User"41        }42      },43      {44        "object": "profile",45        "platform": "github",46        "id": "1000000001",47        "handle": "sample_user",48        "name": "Sample User",49        "headline": null,50        "url": null,51        "kind": "person",52        "bio": null,53        "avatar_url": null,54        "banner_url": null,55        "verified": null,56        "is_private": null,57        "external_url": null,58        "links": null,59        "location": null,60        "category": null,61        "created_at": null,62        "stats": {63          "followers": null,64          "following": null,65          "posts": null,66          "likes": null,67          "views": null68        },69        "extra": {70          "node_id": "MDQ6VXNlcjM2NQ==",71          "site_admin": false,72          "type": "User"73        }74      }75    ],76    "cursor": "eyJwIjoyfQ",77    "has_more": true,78    "parent": null79  },80  "cursor": "eyJwIjoyfQ",81  "has_more": true82}

Response#

A list of Profile objects in data.items, with data.cursor and data.has_more.

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.

GitHub user (GET /v1/github/user)
GitHub user repositories (GET /v1/github/user/repositories)
GitHub repository (GET /v1/github/repository)
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)

Parameters#

Example request#

Example response#

Response#

Errors#

Related endpoints#