Log in

API usage

Add &scraper=github-repository to a Crawling API request. URL-encode the target URL in the url parameter.

curl 'https://api.crawlbase.com/?token=YOUR_TOKEN' \
  --data-urlencode 'url=https://github.com/rails/rails' \
  --data-urlencode 'scraper=github-repository' -G
from crawlbase import CrawlingAPI

api = CrawlingAPI({'token': 'YOUR_TOKEN'})
res = api.get(
    'https://github.com/rails/rails',
    {'scraper': 'github-repository'}
)

import json
data = json.loads(res['body'])
const { CrawlingAPI } = require('crawlbase');
const api = new CrawlingAPI({ token: 'YOUR_TOKEN' });

const res = await api.get(
  'https://github.com/rails/rails',
  { scraper: 'github-repository' }
);
const data = JSON.parse(res.body);
require 'crawlbase'
api = Crawlbase::API.new(token: 'YOUR_TOKEN')

res = api.get('https://github.com/rails/rails', scraper: 'github-repository')
data = JSON.parse(res.body)

Example input URL

The URL passed in the url parameter (URL-decoded for readability):

https://github.com/rails/rails

Response shape

JSON response body. Field types may be null when the source page omits the value.

name
string | null
Repository name.
owner
string | null
Owner (user or organization) login.
fullName
string
Full owner/name identifier.
url
string
Canonical repository URL.
description
string | null
Repository description (the tagline under the header).
primaryLanguage
string | null
Primary programming language (first entry of languages).
languages
array
Languages listed in the repository language bar.
stars
integer | null
Star count.
forks
integer | null
Fork count.
watchers
integer | null
Watcher count.
hasIssues
boolean
True if the Issues tab is enabled.
openIssuesCount
integer | null
Open issue count.
openPrsCount
integer | null
Open pull request count.
topics
array
Repository topic tags.
license
string | null
License name shown in the sidebar.
defaultBranch
string | null
Default branch name.
latestRelease
string | null
Latest release tag, when the repository has releases.
readmePresent
boolean
True if a rendered README is present.
archived
boolean
True if the repository is archived (read-only).

Sample response

{
  "name": "rails",
  "owner": "rails",
  "fullName": "rails/rails",
  "url": "https://github.com/rails/rails",
  "description": "Ruby on Rails",
  "primaryLanguage": "Ruby",
  "languages": ["Ruby", "JavaScript", "HTML", "SCSS", "CSS", "Dockerfile"],
  "stars": 58789,
  "forks": 22414,
  "watchers": 2400,
  "hasIssues": true,
  "openIssuesCount": 478,
  "openPrsCount": 1081,
  "topics": ["ruby", "rails", "html", "activerecord", "framework", "mvc", "activejob"],
  "license": "MIT license",
  "defaultBranch": "main",
  "latestRelease": "v8.1.3",
  "readmePresent": true,
  "archived": false
}