Overview
Color Brightness Calculator works by applying WCAG 2.0 relative luminance formulas to RGB color values, calculating contrast ratios with black and white, and determining optimal text colors for accessibility.
Endpoint
One host, one path per API. The block below shows this call in four languages; every one of them is the same HTTP request. Making requests covers the timeouts, retries and parameter rules that apply to all of them. The SDKs wrap the same call in a typed client.
curl "https://api.apiverve.com/v1/colorbrightness?hex=FF5733" \
-H "x-api-key: your_api_key_here"const res = await fetch('https://api.apiverve.com/v1/colorbrightness?hex=FF5733', {
headers: { 'x-api-key': 'your_api_key_here' },
});
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
const { data } = await res.json();
console.log(data);import requests
res = requests.get(
"https://api.apiverve.com/v1/colorbrightness?hex=FF5733",
headers={"x-api-key": "your_api_key_here"},
timeout=15,
)
res.raise_for_status()
print(res.json()["data"])package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "https://api.apiverve.com/v1/colorbrightness?hex=FF5733", nil)
req.Header.Set("x-api-key", "your_api_key_here")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}Replace your_api_key_here with the key from your dashboard. When the inputs arrive as a list rather than one at a time, batch requests run up to 200 of them through this same API in a single call.
Authentication
Send your key in the x-api-key header. That is the only auth step — there is no token exchange and no per-endpoint scope to configure. Authentication covers creating, rotating and revoking keys.
A 401 means the key is missing, invalid or expired. A 403 means the key is valid but not permitted here — blocked by a key restriction or an IP allow-list. Running out of credits is a 429.
Parameters
Sent in the query string. Premium parameters are accepted on every plan but only take effect on plans that include them.
| Parameter | Type | Description |
|---|---|---|
hexRequired | string | Hex color value (with or without # prefix) hexColor |
Response
Every API returns the same three top-level keys, so one response handler covers your whole integration: status, error and data. Only data changes shape. Response format covers the envelope, the other output formats and how premium fields are withheld.
{
"status": "ok",
"error": null,
"data": {
"hex": "#FF5733",
"rgb": {
"r": 255,
"g": 87,
"b": 51
},
"luminance": 0.2832,
"perceived_brightness": 131,
"yiq": 133.13,
"is_light": false,
"is_dark": true,
"brightness_category": "dark",
"recommended_text_color": "#FFFFFF",
"contrast_ratio_with_white": 3.15,
"contrast_ratio_with_black": 6.66,
"wcag_aa_compliant_with_white": false,
"wcag_aa_compliant_with_black": true,
"wcag_aaa_compliant_with_white": false,
"wcag_aaa_compliant_with_black": false
}
}Response fields
Paths are relative to data. Premium fields are absent rather than zeroed on plans that do not include them, so check for presence instead of comparing to 0.
| Field | Type | Example | Description |
|---|---|---|---|
hex | string | "#FF5733" | Hexadecimal color value provided in the request |
rgb | object | {...} | RGB color components: red, green, blue values |
r | number | 255 | Red component value between 0 and 255 |
g | number | 87 | Green component value between 0 and 255 |
b | number | 51 | Blue component value between 0 and 255 |
luminancePremium | number | 0.2832 | Relative luminance calculated using WCAG 2.0 formula |
perceived_brightnessPremium | number | 131 | Perceived brightness score from 0 to 255 |
yiqPremium | number | 133.13 | YIQ color space brightness value for brightness analysis |
is_light | boolean | false | Boolean indicating if color is considered light |
is_dark | boolean | true | Boolean indicating if color is considered dark |
brightness_category | string | "dark" | Brightness classification: light, medium, or dark category |
recommended_text_colorPremium | string | "#FFFFFF" | Recommended text color for optimal contrast and readability |
contrast_ratio_with_whitePremium | number | 3.15 | WCAG contrast ratio calculation between color and white |
contrast_ratio_with_blackPremium | number | 6.66 | WCAG contrast ratio calculation between color and black |
wcag_aa_compliant_with_whitePremium | boolean | false | Whether color meets WCAG AA contrast requirements with white |
wcag_aa_compliant_with_blackPremium | boolean | true | Whether color meets WCAG AA contrast requirements with black |
wcag_aaa_compliant_with_whitePremium | boolean | false | Whether color meets WCAG AAA contrast requirements with white |
wcag_aaa_compliant_with_blackPremium | boolean | false | Whether color meets WCAG AAA contrast requirements with black |
Errors
Read the HTTP status first, then error for the specific reason. The body names the parameter that has to change. Error handling covers the full status list and which of them are worth retrying.
| Status | Meaning | What to do |
|---|---|---|
400 | Input was rejected | Read error; it names the parameter. |
401 | Key missing or invalid | Check the header name and the key value. |
403 | Key valid, but not permitted | A key restriction or IP allow-list; see key scoping. |
429 | Rate limited, or out of credits | Read error to tell them apart; see rate limits. |
Use cases
- Web Accessibility
- Ensure WCAG compliance by calculating contrast ratios for text and background colors
- UI Design
- Determine appropriate text colors for backgrounds based on brightness calculations
- Theme Development
- Automatically select light or dark text based on background color brightness
- Color Analysis
- Analyze color brightness and categorize colors for design systems and palettes
Other ways to use Color Brightness Calculator
Set up Color Brightness Calculator on APIVerve, or reach the same source a different way. Your APIVerve account and credits work on all of them — one key, one balance.
Related
More in Reference Data: