Skip to content
Scrappa Get API key
GitHub API 1 credit/request

GitHub Compare Files

GET https://scrappa.co/api/github/repository/compare/files?owner=laravel&repo=framework&base=12.x&head=13.x

Returns the file-by-file diff between two refs: each changed path with its diff lines and the addition and deletion counts. Served from the quota-free web tier.

GitHub Compare Files 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/github/repository/compare/files?owner=laravel&repo=framework&base=12.x&head=13.x
Auth header
x-api-key
Cost
1 credit/request
owner = laravel repo = framework base = 12.x
Response preview
200 OK
{
    "search_parameters": {
        "engine": "github_compare_files",
        "owner": "laravel",
        "repo": "framework",
        "base": "12.x",
        "head": "13.x"
    },
    "range": "12.x...13.x",
    "files": [
        {
            "path": "src/Application.php",
            "additions": 3,
            "deletions": 1,
...

Parameters

Start with the required fields, then add optional filters only when your use case needs them.

Runnable path

4 required parameters needed before sending a request.

owner string Required

Repository owner login or organization, e.g. laravel.

Example value laravel
repo string Required

Repository name without the owner, e.g. framework.

Example value framework
base string Required

Base ref of the comparison, e.g. main.

Example value 12.x
head string Required

Head ref of the comparison, e.g. a branch or tag.

Example value 13.x

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/github/repository/compare/files?owner=laravel&repo=framework&base=12.x&head=13.x",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "x-api-key: YOUR_API_KEY_HERE"
    ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
    echo "cURL Error #:" . $err;
} else {
    echo $response;
}
PHP
<?php

use Illuminate\Support\Facades\Http;

$response = Http::timeout(30)
    ->withHeaders(['x-api-key' => 'YOUR_API_KEY_HERE'])
    ->get('https://scrappa.co/api/github/repository/compare/files?owner=laravel&repo=framework&base=12.x&head=13.x');

if ($response->successful()) {
    echo $response->body();
} else {
    echo "Error: " . $response->status();
}
JavaScript
const options = {
    method: 'GET',
    headers: {
        'x-api-key': 'YOUR_API_KEY_HERE'
    }
};

fetch('https://scrappa.co/api/github/repository/compare/files?owner=laravel&repo=framework&base=12.x&head=13.x', options)
    .then(response => {
        if (!response.ok) {
            throw new Error(`HTTP error! status: ${response.status}`);
        }
        return response.text();
    })
    .then(data => console.log(data))
    .catch(error => console.error('Error:', error));
JavaScript
const axios = require('axios');

const options = {
    method: 'GET',
    url: 'https://scrappa.co/api/github/repository/compare/files?owner=laravel&repo=framework&base=12.x&head=13.x',
    headers: {
        x-api-key: 'YOUR_API_KEY_HERE',
    }
};

try {
    const response = await axios(options);
    console.log(response.data);
} catch (error) {
    console.error('Error:', error.message);
}
Ruby
require 'net/http'
require 'uri'

uri = URI.parse("https://scrappa.co/api/github/repository/compare/files?owner=laravel&repo=framework&base=12.x&head=13.x")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == 'https'

request = Net::HTTP::Get.new(uri.request_uri)
request['x-api-key'] = 'YOUR_API_KEY_HERE'

begin
    response = http.request(request)
    puts response.body
rescue => e
    puts "Error: #{e.message}"
end
Python
import http.client
import json

conn = http.client.HTTPSConnection("scrappa.co")

headers = {
    'x-api-key': 'YOUR_API_KEY_HERE',
}

try:
    conn.request("GET", "/api/github/repository/compare/files?owner=laravel&repo=framework&base=12.x&head=13.x", headers=headers)
    res = conn.getresponse()
    data = res.read()
    print(data.decode("utf-8"))
except Exception as e:
    print(f"Error: {e}")
finally:
    conn.close()
Python
import requests

headers = {
    'x-api-key': 'YOUR_API_KEY_HERE',
}

try:
    response = requests.get('https://scrappa.co/api/github/repository/compare/files?owner=laravel&repo=framework&base=12.x&head=13.x', headers=headers)
    response.raise_for_status()
    print(response.text)
except requests.exceptions.RequestException as e:
    print(f"Error: {e}")
Java
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import java.io.IOException;

public class ApiExample {
    public static void main(String[] args) {
        OkHttpClient client = new OkHttpClient();

        Request request = new Request.Builder()
            .url("https://scrappa.co/api/github/repository/compare/files?owner=laravel&repo=framework&base=12.x&head=13.x")
        .addHeader("x-api-key", "YOUR_API_KEY_HERE")
            .build();

        try (Response response = client.newCall(request).execute()) {
            if (response.isSuccessful()) {
                System.out.println(response.body().string());
            } else {
                System.out.println("Error: " + response.code());
            }
        } catch (IOException e) {
            System.out.println("Error: " + e.getMessage());
        }
    }
}
Go
package main

import (
    "fmt"
    "net/http"
    "io/ioutil"
)

func main() {
    client := &http.Client{}
    req, err := http.NewRequest("GET", "https://scrappa.co/api/github/repository/compare/files?owner=laravel&repo=framework&base=12.x&head=13.x", nil)
    if err != nil {
        fmt.Println("Error creating request:", err)
        return
    }
    req.Header.Set("x-api-key", "YOUR_API_KEY_HERE")

    resp, err := client.Do(req)
    if err != nil {
        fmt.Println("Error making request:", err)
        return
    }
    defer resp.Body.Close()

    body, err := ioutil.ReadAll(resp.Body)
    if err != nil {
        fmt.Println("Error reading response:", err)
        return
    }

    fmt.Println(string(body))
}
Terminal
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/github/repository/compare/files?owner=laravel&repo=framework&base=12.x&head=13.x"
C#
using System;
using System.Net.Http;
using System.Threading.Tasks;

class Program
{
    static async Task Main()
    {
        using var client = new HttpClient();
        client.DefaultRequestHeaders.Add("x-api-key", "YOUR_API_KEY_HERE");

        try
        {
            var response = await client.SendAsync(new HttpRequestMessage(HttpMethod.Get, "https://scrappa.co/api/github/repository/compare/files?owner=laravel&repo=framework&base=12.x&head=13.x"));
            var content = await response.Content.ReadAsStringAsync();
            Console.WriteLine(content);
        }
        catch (Exception ex)
        {
            Console.WriteLine($"Error: {ex.Message}");
        }
    }
}
TypeScript
import axios from 'axios';

async function run(): Promise<void> {
    try {
        const response = await axios({
            method: 'GET',
            url: 'https://scrappa.co/api/github/repository/compare/files?owner=laravel&repo=framework&base=12.x&head=13.x',
            headers: {
        'x-api-key': 'YOUR_API_KEY_HERE',
            },
        });

        console.log(response.data);
    } catch (error) {
        console.error('Error:', error);
    }
}

void run();
RUST
use reqwest::Client;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();

    let response = client
        .get("https://scrappa.co/api/github/repository/compare/files?owner=laravel&repo=framework&base=12.x&head=13.x")
        .header("x-api-key", "YOUR_API_KEY_HERE")
        .send()
        .await?;

    println!("{}", response.text().await?);

    Ok(())
}

Response Schema

Example response fields are illustrative; inspect the JSON before integrating.

Example response fields

Scan these fields before integrating.

search_parameters range files file_count

Common files fields

path additions deletions lines
JSON Response
200 OK
{
    "search_parameters": {
        "engine": "github_compare_files",
        "owner": "laravel",
        "repo": "framework",
        "base": "12.x",
        "head": "13.x"
    },
    "range": "12.x...13.x",
    "files": [
        {
            "path": "src/Application.php",
            "additions": 3,
            "deletions": 1,
            "lines": [
                "+ new line"
            ]
        }
    ],
    "file_count": 1
}

Errors

Handle these documented responses before retrying or showing customer-facing failures.

422

Validation Error

A parameter failed validation.

404

Not Found

GitHub has no public resource at that address. For a repository this also covers a private or renamed repository, which is indistinguishable anonymously.

{
    "error": "GitHub returned 404 for this resource.",
    "error_code": "github_not_found"
}
503

GitHub Upstream Unavailable

The upstream service is temporarily unavailable. Please retry shortly.

{
    "error": "GitHub upstream is temporarily unavailable.",
    "error_code": "github_upstream_unavailable",
    "retryable": true
}
500

Parser Drift

GitHub returned a response shape this parser does not recognise. The incident has been reported; retrying will return the same result.

{
    "error": "GitHub response shape changed unexpectedly. The incident has been reported.",
    "error_code": "github_parser_drift",
    "retryable": false
}
406

Not Acceptable Upstream

GitHub has no JSON representation for this route, or rejected the request headers. Never charged.

{
    "error": "This GitHub route has no JSON representation.",
    "error_code": "github_html_only_route_json_requested",
    "retryable": false
}

Generate Code with AI

Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.

Try It Live

Test this endpoint in our interactive playground with real data.