GitHub repository API
GitHub repository: GET /v1/github/repository. 1 credit per request.
GET /v1/github/repository
GET /v1/github/repository
GitHub repository.
- 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 |
|---|---|---|---|
url | URL | one of | Repository URL (github.com/<owner>/<repo>). Accepted hosts: github.com. |
repo | string | one of | "owner/name" or a repository URL (github.com/<owner>/<name>, any page of it). Also accepted as full_name. |
Send at least one of url, repo. 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).
curl -G "https://api.socialscrape.dev/v1/github/repository" \ -H "x-api-key: $SOCIALSCRAPE_API_KEY" \ --data-urlencode "repo=torvalds/linux"
import os
import requests
params = {
"repo": "torvalds/linux",
}
res = requests.get(
"https://api.socialscrape.dev/v1/github/repository",
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"])
const url = new URL("https://api.socialscrape.dev/v1/github/repository"); url.search = new URLSearchParams({ "repo": "torvalds/linux" }).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); }
{
"nodes": [
{
"name": "SocialScrape GitHub repository",
"type": "n8n-nodes-base.httpRequest",
"typeVersion": 4.2,
"position": [
0,
0
],
"parameters": {
"method": "GET",
"url": "https://api.socialscrape.dev/v1/github/repository",
"sendQuery": true,
"queryParameters": {
"parameters": [
{
"name": "repo",
"value": "torvalds/linux"
}
]
},
"sendHeaders": true,
"headerParameters": {
"parameters": [
{
"name": "x-api-key",
"value": "={{ $env.SOCIALSCRAPE_API_KEY }}"
}
]
}
}
}
],
"connections": {}
}
Example response
This is a sample from a recorded response. Status 200.
{
"ok": true,
"credits_charged": 1,
"credits_remaining": 4999,
"cached": false,
"cached_at": null,
"request_id": "req_d892f16395227006cdbe6251",
"data": {
"object": "repo",
"platform": "github",
"id": "2325298",
"full_name": "torvalds/linux",
"name": "linux",
"url": "https://github.com/torvalds/linux",
"owner": {
"id": "1024025",
"handle": "torvalds",
"name": null,
"url": "https://github.com/torvalds",
"avatar_url": "https://avatars.githubusercontent.com/u/1024025?v=4",
"verified": null
},
"description": "Linux kernel source tree",
"language": "C",
"topics": [],
"license": "Other",
"stars": 253786,
"forks": 67471,
"watchers": 8482,
"open_issues": 3,
"is_fork": false,
"is_archived": false,
"default_branch": "master",
"created_at": "2011-09-04T22:48:12Z",
"updated_at": "2026-10-30T01:16:26Z",
"pushed_at": "2026-10-30T00:07:06Z",
"extra": {
"allow_forking": true,
"disabled": false,
"has_discussions": false,
"has_issues": false,
"has_pages": false,
"has_wiki": false,
"is_template": false,
"network_count": 67471,
"node_id": "MDEwOlJlcG9zaXRvcnkyMzI1Mjk4",
"private": false,
"size": 6391699,
"visibility": "public",
"web_commit_signoff_required": false
}
},
"cursor": null,
"has_more": null
}
Response
A Repo 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:
{
"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_326379e357c83e3a6beb865b"
}
Related endpoints
- GitHub user (
GET /v1/github/user) - GitHub user repositories (
GET /v1/github/user/repositories) - 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)