Color Similarity CalculatorColor Similarity Calculator API

OnlineCredit Usage:1 per callRefreshed 1 month ago
avg: 258ms|p50: 244ms|p75: 267ms|p90: 295ms|p99: 351ms

Overview

To use Color Similarity Calculator, you need an API key. You can get one by creating a free account and visiting your dashboard.

GET Endpoint

URL
https://api.apiverve.com/v1/colorsimilarity

Example

How to call the Color Similarity Calculator API in different programming languages.

cURL Request
curl -X GET \
  "https://api.apiverve.com/v1/colorsimilarity?color1=FF5733&color2=FF6B47" \
  -H "X-API-Key: your_api_key_here"
JavaScript (Fetch API)
const response = await fetch('https://api.apiverve.com/v1/colorsimilarity?color1=FF5733&color2=FF6B47', {
  method: 'GET',
  headers: {
    'X-API-Key': 'your_api_key_here',
    'Content-Type': 'application/json'
  }
});

const data = await response.json();
console.log(data);
Python (Requests)
import requests

headers = {
    'X-API-Key': 'your_api_key_here',
    'Content-Type': 'application/json'
}

response = requests.get('https://api.apiverve.com/v1/colorsimilarity?color1=FF5733&color2=FF6B47', headers=headers)

data = response.json()
print(data)
Go (net/http)
package main

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

)

func main() {
    req, _ := http.NewRequest("GET", "https://api.apiverve.com/v1/colorsimilarity?color1=FF5733&color2=FF6B47", nil)

    req.Header.Set("X-API-Key", "your_api_key_here")
    req.Header.Set("Content-Type", "application/json")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    body, _ := io.ReadAll(resp.Body)
    fmt.Println(string(body))
}
Example Response
{
  "status": "ok",
  "error": null,
  "data": {
    "color1": {
      "hex": "#FF5733",
      "rgb": {
        "r": 255,
        "g": 87,
        "b": 51
      },
      "hsl": {
        "h": 10.6,
        "s": 100,
        "l": 60
      }
    },
    "color2": {
      "hex": "#FF6B47",
      "rgb": {
        "r": 255,
        "g": 107,
        "b": 71
      },
      "hsl": {
        "h": 11.7,
        "s": 100,
        "l": 63.9
      }
    },
    "rgb_distance": 28.28,
    "rgb_similarity": 93.6,
    "hsl_similarity": 97.71,
    "overall_similarity": 95.65,
    "delta_e": 28.28,
    "hue_difference": 1.15,
    "saturation_difference": 0,
    "lightness_difference": 3.92,
    "similarity_category": "nearly identical",
    "are_identical": false
  }
}

Authentication

The Color Similarity Calculator API requires authentication via API key. Include your API key in the request header:

Required Header
X-API-Key: your_api_key_here

Learn more about authentication →

Interactive API Playground

Test the Color Similarity Calculator API directly in your browser with live requests and responses.

Parameters

The following parameters are available for the Color Similarity Calculator API:

Calculate Color Similarity

ParameterTypeRequiredDescriptionDefaultExample
color1stringrequired
First hex color value (with or without # prefix)
Format: hexColor (e.g., FF5733)
-FF5733
color2stringrequired
Second hex color value (with or without # prefix)
Format: hexColor (e.g., FF6B47)
-FF6B47

Response

The Color Similarity Calculator API returns responses in JSON, XML, YAML, and CSV formats. The JSON response is shown in the Example section above; alternative formats below.

Other Response Formats

XML Response
200 OK
<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>ok</status>
  <error xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
  <data>
    <color1>
      <hex>#FF5733</hex>
      <rgb>
        <r>255</r>
        <g>87</g>
        <b>51</b>
      </rgb>
      <hsl>
        <h>10.6</h>
        <s>100</s>
        <l>60</l>
      </hsl>
    </color1>
    <color2>
      <hex>#FF6B47</hex>
      <rgb>
        <r>255</r>
        <g>107</g>
        <b>71</b>
      </rgb>
      <hsl>
        <h>11.7</h>
        <s>100</s>
        <l>63.9</l>
      </hsl>
    </color2>
    <rgb_distance>28.28</rgb_distance>
    <rgb_similarity>93.6</rgb_similarity>
    <hsl_similarity>97.71</hsl_similarity>
    <overall_similarity>95.65</overall_similarity>
    <delta_e>28.28</delta_e>
    <hue_difference>1.15</hue_difference>
    <saturation_difference>0</saturation_difference>
    <lightness_difference>3.92</lightness_difference>
    <similarity_category>nearly identical</similarity_category>
    <are_identical>false</are_identical>
  </data>
</response>
YAML Response
200 OK
status: ok
error: null
data:
  color1:
    hex: '#FF5733'
    rgb:
      r: 255
      g: 87
      b: 51
    hsl:
      h: 10.6
      s: 100
      l: 60
  color2:
    hex: '#FF6B47'
    rgb:
      r: 255
      g: 107
      b: 71
    hsl:
      h: 11.7
      s: 100
      l: 63.9
  rgb_distance: 28.28
  rgb_similarity: 93.6
  hsl_similarity: 97.71
  overall_similarity: 95.65
  delta_e: 28.28
  hue_difference: 1.15
  saturation_difference: 0
  lightness_difference: 3.92
  similarity_category: nearly identical
  are_identical: false
CSV Response
200 OK
keyvalue
color1{hex:#FF5733,rgb:{r:255,g:87,b:51},hsl:{h:10.6,s:100,l:60}}
color2{hex:#FF6B47,rgb:{r:255,g:107,b:71},hsl:{h:11.7,s:100,l:63.9}}
rgb_distance28.28
rgb_similarity93.6
hsl_similarity97.71
overall_similarity95.65
delta_e28.28
hue_difference1.15
saturation_difference0
lightness_difference3.92
similarity_categorynearly identical
are_identicalfalse

Response Structure

All API responses follow a consistent structure with the following fields:

FieldTypeDescriptionExample
statusstringIndicates whether the request was successful ("ok") or failed ("error")ok
errorstring | nullContains error message if status is "error", otherwise nullnull
dataobject | nullContains the API response data if successful, otherwise null{...}

Learn more about response formats →

Response Data Fields

When the request is successful, the data object contains the following fields:

FieldTypeSample ValueDescription
color1object{...}
-
â”” hexstring"#FF5733"
First color in hexadecimal format representation
â”” rgbobject{...}
-
â”” rnumber255
Red channel value for first color
â”” gnumber87
Green channel value for first color
â”” bnumber51
Blue channel value for first color
â”” hslobject{...}
-
â”” hnumber10.6
Hue value for first color in degrees
â”” snumber100
Saturation percentage for first color
â”” lnumber60
Lightness percentage for first color
color2object{...}
-
â”” hexstring"#FF6B47"
Second color in hexadecimal format representation
â”” rgbobject{...}
-
â”” rnumber255
Red channel value for second color
â”” gnumber107
Green channel value for second color
â”” bnumber71
Blue channel value for second color
â”” hslobject{...}
-
â”” hnumber11.7
Hue value for second color in degrees
â”” snumber100
Saturation percentage for second color
â”” lnumber63.9
Lightness percentage for second color

Headers

Only X-API-Key is required. Optional headers include Accept for response format negotiation (JSON, XML, or YAML), User-Agent, and X-Request-ID for request tracing. See all request headers →

GraphQL AccessALPHA

Access Color Similarity Calculator through GraphQL to combine it with other API calls in a single request. Query only the color similarity calculator data you need with precise field selection, and orchestrate complex data fetching workflows.

Test Color Similarity Calculator in the GraphQL Explorer to confirm availability and experiment with queries.

Credit Cost: Each API called in your GraphQL query consumes its standard credit cost.

GraphQL Endpoint
POST https://api.apiverve.com/v1/graphql
GraphQL Query Example
query {
  colorsimilarity(
    input: {
      color1: "FF5733"
      color2: "FF6B47"
    }
  ) {
    color1 {
      hex
      rgb {
        r
        g
        b
      }
      hsl {
        h
        s
        l
      }
    }
    color2 {
      hex
      rgb {
        r
        g
        b
      }
      hsl {
        h
        s
        l
      }
    }
    rgb_distance
    rgb_similarity
    hsl_similarity
    overall_similarity
    delta_e
    hue_difference
    saturation_difference
    lightness_difference
    similarity_category
    are_identical
  }
}

Note: Authentication is handled via the x-api-key header in your GraphQL request, not as a query parameter.

CORS Support

The Color Similarity Calculator API accepts cross-origin requests from any origin, so it can be called directly from browser-based applications without a proxy. See CORS support →

Rate Limiting

Color Similarity Calculator requests are throttled per minute on the Free plan and unthrottled on paid plans. Exceeding the limit returns 429 Too Many Requests; rate-limit usage is reported in the X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset response headers. See per-plan limits and best practices →

Error Codes

The Color Similarity Calculator API uses standard HTTP status codes — 200 on success, 400 for invalid parameters, 401 for missing or invalid keys, 403 for insufficient credits, 429 for rate-limit exhaustion, and 500/503 for server-side issues. Each error response includes an X-Request-ID header you can quote when contacting support. See full error handling guide →

SDKs for Color Similarity Calculator

Official Color Similarity Calculator packages on npm, PyPI, NuGet, and JitPack — plus a Postman collection and an OpenAPI spec. See the SDK guide →

No-Code Integrations

Color Similarity Calculator works with Zapier, Make, Pipedream, n8n, and Power Automate using the same API key. See setup guides →

Frequently Asked Questions

How do I get an API key for Color Similarity Calculator?
Sign up for a free account at dashboard.apiverve.com. Your API key will be automatically generated and available in your dashboard. The same key works for Color Similarity Calculator and all other APIVerve APIs. The free plan includes 1,000 credits plus a 500 credit bonus.
How many credits does Color Similarity Calculator cost?

Each successful Color Similarity Calculator API call consumes credits based on plan tier. Check the pricing section above for the exact credit cost. Failed requests and errors don't consume credits, so you only pay for successful color similarity calculator lookups.

Can I use Color Similarity Calculator in production?

The free plan is for testing and development only. For production use of Color Similarity Calculator, upgrade to a paid plan (Starter, Pro, or Mega) which includes commercial use rights, no attribution requirements, and guaranteed uptime SLAs. All paid plans are production-ready.

Can I use Color Similarity Calculator from a browser?
Yes! The Color Similarity Calculator API supports CORS with wildcard configuration, so you can call it directly from browser-based JavaScript without needing a proxy server. See the CORS section above for details.
What happens if I exceed my Color Similarity Calculator credit limit?

When you reach your monthly credit limit, Color Similarity Calculator API requests will return an error until you upgrade your plan or wait for the next billing cycle. You'll receive notifications at 80% and 95% usage to give you time to upgrade if needed.

What's Next?

Continue your journey with these recommended resources

Was this page helpful?