Crossbrowsertesting.com Screenshot Comparisons API

crossbrowsertesting · Developer Tools

Developer Tools No Auth Free & Open developer_tools

What's in this version: 1. Compare two screenshots for layout differences 2. Compare a full screenshot test of browsers to a single baseline browser for layout differences. 3. Compare a screenshot test version to another test version - good for regression tests. 4. Get links to the Comparison UI for visual representation of layout differences

Authentication

No authentication requiredFree to use with no key needed.

Sample Requests

GET Compare Full Screenshot Test

Get comparison results for all browsers in target screenshot test against a base screenshot result. The base result can be from the same test or from another test run at an earlier time. This is a one-to-many comparison.

https://api.apis.guru/v2/specs/crossbrowsertesting.com/3.0.0/screenshots/{target_screenshot_test_id}/{target_version_id}/comparison/{base_result_id}?format=json&callback=example&tolerance=30

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/crossbrowsertesting.com/3.0.0/screenshots/{target_screenshot_test_id}/{target_version_id}/comparison/{base_result_id}?format=json&callback=example&tolerance=30"

import requests
params = {
    "format": "json",
    "callback": "example",
    "tolerance": "30"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/crossbrowsertesting.com/3.0.0/screenshots/{target_screenshot_test_id}/{target_version_id}/comparison/{base_result_id}",
    params=params,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/crossbrowsertesting.com/3.0.0/screenshots/{target_screenshot_test_id}/{target_version_id}/comparison/{base_result_id}');
url.searchParams.set('format', 'json');
url.searchParams.set('callback', 'example');
url.searchParams.set('tolerance', '30');

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

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

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/crossbrowsertesting.com/3.0.0/screenshots/{target_screenshot_test_id}/{target_version_id}/comparison/{base_result_id}")
	q := baseURL.Query()
	q.Set("format", "json")
	q.Set("callback", "example")
	q.Set("tolerance", "30")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/crossbrowsertesting.com/3.0.0/screenshots/{target_screenshot_test_id}/{target_version_id}/comparison/{base_result_id}")
uri.query = URI.encode_www_form({
  "format" => "json",
  "callback" => "example",
  "tolerance" => "30"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/crossbrowsertesting.com/3.0.0/screenshots/{target_screenshot_test_id}/{target_version_id}/comparison/{base_result_id}?" . http_build_query([
    "format" => "json",
    "callback" => "example",
    "tolerance" => "30"
]);
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET Compare Screenshot Test Versions

Get comparison results for all browsers in target screenshot test against the same browser in the base screenshot test. This is a good method for regression testing. For example, you've run a screenshot test against a set of browsers that is "good". Then, after some changes, you run a new screenshot

https://api.apis.guru/v2/specs/crossbrowsertesting.com/3.0.0/screenshots/{target_screenshot_test_id}/{target_version_id}/comparison/parallel/{base_version_id}?format=json&callback=example&tolerance=30

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/crossbrowsertesting.com/3.0.0/screenshots/{target_screenshot_test_id}/{target_version_id}/comparison/parallel/{base_version_id}?format=json&callback=example&tolerance=30"

import requests
params = {
    "format": "json",
    "callback": "example",
    "tolerance": "30"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/crossbrowsertesting.com/3.0.0/screenshots/{target_screenshot_test_id}/{target_version_id}/comparison/parallel/{base_version_id}",
    params=params,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/crossbrowsertesting.com/3.0.0/screenshots/{target_screenshot_test_id}/{target_version_id}/comparison/parallel/{base_version_id}');
url.searchParams.set('format', 'json');
url.searchParams.set('callback', 'example');
url.searchParams.set('tolerance', '30');

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

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

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/crossbrowsertesting.com/3.0.0/screenshots/{target_screenshot_test_id}/{target_version_id}/comparison/parallel/{base_version_id}")
	q := baseURL.Query()
	q.Set("format", "json")
	q.Set("callback", "example")
	q.Set("tolerance", "30")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/crossbrowsertesting.com/3.0.0/screenshots/{target_screenshot_test_id}/{target_version_id}/comparison/parallel/{base_version_id}")
uri.query = URI.encode_www_form({
  "format" => "json",
  "callback" => "example",
  "tolerance" => "30"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/crossbrowsertesting.com/3.0.0/screenshots/{target_screenshot_test_id}/{target_version_id}/comparison/parallel/{base_version_id}?" . http_build_query([
    "format" => "json",
    "callback" => "example",
    "tolerance" => "30"
]);
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET Compare Single Screenshot

Get comparison results for a single target screenshot result against a base screenshot result. This is a one-to-one comparison.

https://api.apis.guru/v2/specs/crossbrowsertesting.com/3.0.0/screenshots/{target_screenshot_test_id}/{target_version_id}/{target_result_id}/comparison/{base_result_id}?format=json&callback=example&tolerance=30

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/crossbrowsertesting.com/3.0.0/screenshots/{target_screenshot_test_id}/{target_version_id}/{target_result_id}/comparison/{base_result_id}?format=json&callback=example&tolerance=30"

import requests
params = {
    "format": "json",
    "callback": "example",
    "tolerance": "30"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/crossbrowsertesting.com/3.0.0/screenshots/{target_screenshot_test_id}/{target_version_id}/{target_result_id}/comparison/{base_result_id}",
    params=params,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/crossbrowsertesting.com/3.0.0/screenshots/{target_screenshot_test_id}/{target_version_id}/{target_result_id}/comparison/{base_result_id}');
url.searchParams.set('format', 'json');
url.searchParams.set('callback', 'example');
url.searchParams.set('tolerance', '30');

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

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

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/crossbrowsertesting.com/3.0.0/screenshots/{target_screenshot_test_id}/{target_version_id}/{target_result_id}/comparison/{base_result_id}")
	q := baseURL.Query()
	q.Set("format", "json")
	q.Set("callback", "example")
	q.Set("tolerance", "30")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/crossbrowsertesting.com/3.0.0/screenshots/{target_screenshot_test_id}/{target_version_id}/{target_result_id}/comparison/{base_result_id}")
uri.query = URI.encode_www_form({
  "format" => "json",
  "callback" => "example",
  "tolerance" => "30"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/crossbrowsertesting.com/3.0.0/screenshots/{target_screenshot_test_id}/{target_version_id}/{target_result_id}/comparison/{base_result_id}?" . http_build_query([
    "format" => "json",
    "callback" => "example",
    "tolerance" => "30"
]);
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

Postman Setup Guide

Get Postman ↗

See official documentation for authentication and setup.

What can you build with Crossbrowsertesting.com Screenshot Comparisons API?

Crossbrowsertesting.com Screenshot Comparisons API is a Developer Tools API. Developers commonly use developer tools APIs for:

automating code review and quality checks
integrating CI/CD pipelines and build systems
managing feature flags and A/B tests
monitoring errors and application performance
generating and validating test data

No authentication required. This API is open — no signup or key needed. Ideal for quick prototypes and public-facing features. Crossbrowsertesting.com Screenshot Comparisons API is free to use, making it a low-risk choice to experiment with.

New to APIs? Read our beginner's guide · Learn about API keys · What is REST?

Open documentation ↗