Repository

Try in Playground

Retrieve repository identity, owner, stars, forks, subscribers, topics, license and feature flags. Choose native, normalized or camelCase fields with format.

GET/v1/github/repositoryx-api-key

Headers

Get your API key

x-api-keystringrequiredheader

Your ScrapeAtlas customer key. Create one on /account/ and set SCRAPEATLAS_API_KEY.

Query parameters

urlstringrequiredquery

Canonical HTTPS github.com URL of the user, repository or issue required by this route.

max 2048 chars

Examplehttps://github.com/example/repo

formatenumquery

Response projection: native (default), normalized or camelCase where listed.

one of: native, normalized, camelCase

Response fields

platformstringoptional

Optional.

endpointstringoptional

Optional.

successboolean

Whether retrieval returned usable data.

statusenum

success, partial, failed or challenged.

one of: success, partial

requestIdstring

Request correlation UUID.

sourceUrlstring

Public source URL.

absolute HTTPS URL

fetchedAtstring

UTC fetch time.

Completeness of this bounded response, not complete account enumeration.

coverage.sourceenum

Always included.

one of: public_api, public_html

coverage.completeboolean

Always included.

coverage.warningsstring[]

Always included.

Combined upstream attempts, decoded bytes and elapsed milliseconds.

accounting.upstreamRequestsinteger

Always included.

≥ 0

accounting.responseBytesinteger

Always included.

≥ 0

accounting.durationMsnumber

Always included.

≥ 0

Always included.

repository.idinteger

Always included.

≥ 0

repository.node_idstring

Always included.

repository.namestring

Always included.

repository.full_namestring

Always included.

repository.owner.idinteger

Always included.

≥ 0

repository.owner.loginstring

Always included.

repository.owner.avatar_urlstring

Always included.

absolute HTTPS URL

repository.owner.urlstring

Always included.

absolute HTTPS URL

repository.owner.typestring

Always included.

repository.privateboolean

Always included.

repository.descriptionstringnullable

Always included.

repository.forkboolean

Always included.

repository.homepagestringnullable

Always included.

repository.languagestringnullable

Always included.

repository.forks_countinteger

Always included.

≥ 0

repository.watchers_countinteger

Always included.

≥ 0

repository.sizeinteger

Always included.

≥ 0

repository.default_branchstring

Always included.

repository.open_issues_countinteger

Always included.

≥ 0

repository.topicsstring[]

Always included.

repository.license.keystring

Always included.

repository.license.namestring

Always included.

repository.license.spdx_idstringnullable

Always included.

repository.archivedboolean

Always included.

repository.disabledboolean

Always included.

repository.visibilitystring

Always included.

repository.pushed_atstringnullable

Always included.

repository.created_atstring

Always included.

repository.updated_atstring

Always included.

repository.urlstring

Always included.

absolute HTTPS URL

repository.stars_countinteger

Always included.

≥ 0

repository.subscriberCountintegernullableoptional

Optional.

repository.networkCountintegernullableoptional

Optional.

repository.hasIssuesbooleannullableoptional

Optional.

repository.hasDiscussionsbooleannullableoptional

Optional.

repository.hasWikibooleannullableoptional

Optional.

repository.hasPagesbooleannullableoptional

Optional.

repository.isTemplatebooleannullableoptional

Optional.

repository.parentRepository.fullNamestring

Always included.

repository.parentRepository.urlstring

Always included.

absolute HTTPS URL

Optional.

repository.sourceRepository.fullNamestring

Always included.

repository.sourceRepository.urlstring

Always included.

absolute HTTPS URL

HTTP 200 returns the success variant. Check status: partial means usable data with warnings, and failed or challenged requests carry a failure object described in Errors & responses.

Error codes

HTTP	failure.code	Meaning
400	`invalid_request`	Invalid, duplicate or unsupported parameters.
401	`unauthorized`	Invalid worker key.
404	`not_found`	Public source record unavailable; SocialFetch aliases return data.lookupStatus=not_found with HTTP 200.
429	`upstream_rate_limited`	GitHub throttled retrieval.
502	`upstream_error` `upstream_challenged` `unsupported_page`	Source retrieval failed or the source contract changed.
502	`unsafe_redirect` `response_too_large` `payload_too_complex` `request_limit`	A fixed safety or resource boundary was reached.
503	`busy`	All worker slots are occupied.
504	`timeout`	Total deadline expired.

Code example

curl "https://api.scrapeatlas.com/v1/github/repository?url=https%3A%2F%2Fgithub.com%2Fexample%2Frepo" \
  -H "x-api-key: YOUR_API_KEY"

const response = await fetch(
  "https://api.scrapeatlas.com/v1/github/repository?url=https%3A%2F%2Fgithub.com%2Fexample%2Frepo",
  {
    headers: {
      "x-api-key": "YOUR_API_KEY"
    }
  }
);

const data = await response.json();
console.log(data.status, data);

type Result = {
  status: "success" | "partial" | "failed" | "challenged";
  requestId: string;
  [field: string]: unknown;
};

const response = await fetch(
  "https://api.scrapeatlas.com/v1/github/repository?url=https%3A%2F%2Fgithub.com%2Fexample%2Frepo",
  {
    headers: {
      "x-api-key": process.env.SCRAPEATLAS_API_KEY!
    }
  }
);

const data = (await response.json()) as Result;
if (data.status === "failed" || data.status === "challenged") {
  throw new Error(`GitHub request failed: ${data.requestId}`);
}
console.log(data);

import requests

response = requests.get(
    "https://api.scrapeatlas.com/v1/github/repository",
    headers={"x-api-key": "YOUR_API_KEY"},
    params={
        "url": "https://github.com/example/repo"
    },
    timeout=60,
)
data = response.json()
print(data["status"], data)

package main

import (
	"encoding/json"
	"fmt"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.scrapeatlas.com/v1/github/repository?url=https%3A%2F%2Fgithub.com%2Fexample%2Frepo", nil)
	req.Header.Set("x-api-key", "YOUR_API_KEY")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
	fmt.Println(data["status"], data)
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        var client = HttpClient.newHttpClient();
        var request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.scrapeatlas.com/v1/github/repository?url=https%3A%2F%2Fgithub.com%2Fexample%2Frepo"))
            .GET()
            .header("x-api-key", "YOUR_API_KEY")
            .build();
        var response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

Use your sa_live_… customer key at https://api.scrapeatlas.com.

Responses

Successful result. Synthetic example validated against the runtime contract.

{
  "repository": {
    "id": 9,
    "node_id": "R_9",
    "name": "repo",
    "full_name": "example/repo",
    "private": false,
    "description": "Synthetic repository",
    "fork": false,
    "homepage": "",
    "language": "TypeScript",
    "forks_count": 2,
    "watchers_count": 7,
    "size": 50,
    "default_branch": "main",
    "open_issues_count": 1,
    "topics": [
      "synthetic"
    ],
    "license": null,
    "archived": false,
    "disabled": false,
    "visibility": "public",
    "pushed_at": "2026-01-01T00:00:00Z",
    "created_at": "2020-01-01T00:00:00Z",
    "updated_at": "2026-01-01T00:00:00Z",
    "owner": {
      "id": 42,
      "login": "example",
      "avatar_url": "https://avatars.githubusercontent.com/u/42",
      "url": "https://github.com/example",
      "type": "User"
    },
    "url": "https://github.com/example/repo",
    "stars_count": 7,
    "subscriberCount": null,
    "networkCount": null,
    "hasIssues": null,
    "hasDiscussions": null,
    "hasWiki": null,
    "hasPages": null,
    "isTemplate": null,
    "parentRepository": null,
    "sourceRepository": null
  },
  "platform": "github",
  "endpoint": "/v1/github/repository",
  "success": true,
  "status": "success",
  "requestId": "00000000-0000-4000-8000-000000000001",
  "sourceUrl": "https://github.com/example/repo",
  "fetchedAt": "2026-09-17T00:00:00.000Z",
  "coverage": {
    "source": "public_api",
    "complete": true,
    "warnings": []
  },
  "accounting": {
    "upstreamRequests": 1,
    "responseBytes": 711,
    "durationMs": 1
  }
}

Invalid, duplicate or unsupported parameters.

{
  "platform": "github",
  "endpoint": "string",
  "success": true,
  "status": "success",
  "requestId": "9d2f1c0a-6b1e-4c7d-9a8e-2f3b4c5d6e7f",
  "sourceUrl": "https://example.com/",
  "fetchedAt": "2026-01-01T00:00:00.000Z",
  "coverage": {
    "source": "public_api",
    "complete": true,
    "warnings": [
      "string"
    ]
  },
  "accounting": {
    "upstreamRequests": 0,
    "responseBytes": 0,
    "durationMs": 0
  },
  "data": {
    "id": "string",
    "username": "string",
    "display_name": "string",
    "avatar_url": "https://example.com/",
    "bio": "string",
    "verified": true,
    "followers": 0,
    "following": 0,
    "posts_count": 0,
    "likes_count": 0,
    "url": "https://example.com/",
    "location": "string",
    "external_url": "string",
    "private": true,
    "joined_at": "string",
    "ext": {},
    "author": {
      "id": "string",
      "username": "string",
      "display_name": "string",
      "avatar_url": "https://example.com/",
      "bio": "string",
      "verified": true,
      "followers": 0,
      "following": 0,
      "posts_count": 0,
      "likes_count": 0,
      "url": "https://example.com/",
      "location": "string",
      "external_url": "string",
      "private": true,
      "joined_at": "string",
      "ext": {}
    }
  }
}