Skip to content
Color API

/v1/compare (GET)

GET
/v1/compare
 
curl --request GET \
  --url 'https://color.koval.tools/v1/compare?color1=example&color2=example'

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “ Query Parameters ”
color1
required
string
>= 1 characters
color2
required
string
>= 1 characters

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Color comparison

Media type application/json
object
input
required
object
color1
required
string
color2
required
string
normalized
required
object
color1
required
object
hex
required
string
hex8
required
string
rgb
required
object
r
required
number
g
required
number
b
required
number
hsl
required
object
h
required
number
s
required
number
l
required
number
oklch
required
object
l
required
number
c
required
number
h
required
number
color2
required
object
hex
required
string
hex8
required
string
rgb
required
object
r
required
number
g
required
number
b
required
number
hsl
required
object
h
required
number
s
required
number
l
required
number
oklch
required
object
l
required
number
c
required
number
h
required
number
distance
required
object
oklab
required
number
label
required
string
contrast
required
object
wcag
required
object
contrast_ratio
required
number
aa_normal_text
required
boolean

Example generated

{
  "input": {
    "color1": "example",
    "color2": "example"
  },
  "normalized": {
    "color1": {
      "hex": "example",
      "hex8": "example",
      "rgb": {
        "r": 1,
        "g": 1,
        "b": 1
      },
      "hsl": {
        "h": 1,
        "s": 1,
        "l": 1
      },
      "oklch": {
        "l": 1,
        "c": 1,
        "h": 1
      }
    },
    "color2": {
      "hex": "example",
      "hex8": "example",
      "rgb": {
        "r": 1,
        "g": 1,
        "b": 1
      },
      "hsl": {
        "h": 1,
        "s": 1,
        "l": 1
      },
      "oklch": {
        "l": 1,
        "c": 1,
        "h": 1
      }
    }
  },
  "distance": {
    "oklab": 1,
    "label": "example"
  },
  "contrast": {
    "wcag": {
      "contrast_ratio": 1,
      "aa_normal_text": true
    }
  }
}

400

Section titled “ 400 ”

Validation error