SocialScrape
Get early access
Docs menu

Get started

Guides

API reference

Resources

GitHub followers

Beta GET /v1/github/user/followers

GET /v1/github/user/followers

GitHub followers.

  • Cost: 1 credit
  • Status: Beta. Built and tested against recorded responses; the shape may still gain fields.
  • 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 ofGitHub username. 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:

  • 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).

curl
curl -G "https://api.socialscrape.io/v1/github/user/followers" \
  -H "x-api-key: $SOCIALSCRAPE_API_KEY" \
  --data-urlencode "handle=torvalds"
Python
import os
import requests

params = {
    "handle": "torvalds",
}
res = requests.get(
    "https://api.socialscrape.io/v1/github/user/followers",
    headers={"x-api-key": os.environ["SOCIALSCRAPE_API_KEY"]},
    params=params,
)
body = res.json()

if body["ok"]:
    print(body["data"])
else:
    print(body["error"]["code"], body["error"]["message"])
TypeScript
const url = new URL("https://api.socialscrape.io/v1/github/user/followers");
url.search = new URLSearchParams({
  "handle": "torvalds"
}).toString();
const res = await fetch(url, {
  headers: { "x-api-key": process.env.SOCIALSCRAPE_API_KEY! },
});
const body = await res.json();

if (body.ok) {
  console.log(body.data);
} else {
  console.error(body.error.code, body.error.message);
}
n8n
{
  "nodes": [
    {
      "name": "SocialScrape GitHub followers",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        0,
        0
      ],
      "parameters": {
        "method": "GET",
        "url": "https://api.socialscrape.io/v1/github/user/followers",
        "sendQuery": true,
        "queryParameters": {
          "parameters": [
            {
              "name": "handle",
              "value": "torvalds"
            }
          ]
        },
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "x-api-key",
              "value": "={{ $env.SOCIALSCRAPE_API_KEY }}"
            }
          ]
        }
      }
    }
  ],
  "connections": {}
}

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.

{
  "ok": true,
  "credits_charged": 1,
  "credits_remaining": 4999,
  "cached": false,
  "cached_at": null,
  "request_id": "req_06db94fea6b08ec89b1e3416",
  "data": {
    "object": "list",
    "items": [
      {
        "object": "profile",
        "platform": "github",
        "id": "1000000001",
        "handle": "sample_user",
        "name": "Sample User",
        "headline": null,
        "url": null,
        "kind": "person",
        "bio": null,
        "avatar_url": null,
        "banner_url": null,
        "verified": null,
        "is_private": null,
        "external_url": null,
        "links": null,
        "location": null,
        "category": null,
        "created_at": null,
        "stats": {
          "followers": null,
          "following": null,
          "posts": null,
          "likes": null,
          "views": null
        },
        "extra": {
          "node_id": "MDQ6VXNlcjIwNg==",
          "site_admin": false,
          "type": "User"
        }
      },
      {
        "object": "profile",
        "platform": "github",
        "id": "1000000001",
        "handle": "sample_user",
        "name": "Sample User",
        "headline": null,
        "url": null,
        "kind": "person",
        "bio": null,
        "avatar_url": null,
        "banner_url": null,
        "verified": null,
        "is_private": null,
        "external_url": null,
        "links": null,
        "location": null,
        "category": null,
        "created_at": null,
        "stats": {
          "followers": null,
          "following": null,
          "posts": null,
          "likes": null,
          "views": null
        },
        "extra": {
          "node_id": "MDQ6VXNlcjM2NQ==",
          "site_admin": false,
          "type": "User"
        }
      }
    ],
    "cursor": "eyJwIjoyfQ",
    "has_more": true,
    "parent": null
  },
  "cursor": "eyJwIjoyfQ",
  "has_more": true
}

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.

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.