Color Brightness Calculator API
Overview
To use Color Brightness Calculator, you need an API key. You can get one by creating a free account and visiting your dashboard.
GET Endpoint
https://api.apiverve.com/v1/colorbrightnessExample
How to call the Color Brightness Calculator API in different programming languages.
curl -X GET \
"https://api.apiverve.com/v1/colorbrightness?hex=FF5733" \
-H "X-API-Key: your_api_key_here"const response = await fetch('https://api.apiverve.com/v1/colorbrightness?hex=FF5733', {
method: 'GET',
headers: {
'X-API-Key': 'your_api_key_here',
'Content-Type': 'application/json'
}
});
const data = await response.json();
console.log(data);import requests
headers = {
'X-API-Key': 'your_api_key_here',
'Content-Type': 'application/json'
}
response = requests.get('https://api.apiverve.com/v1/colorbrightness?hex=FF5733', headers=headers)
data = response.json()
print(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")
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))
}{
"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
}
}Authentication
The Color Brightness Calculator API requires authentication via API key. Include your API key in the request header:
X-API-Key: your_api_key_hereInteractive API Playground
Test the Color Brightness Calculator API directly in your browser with live requests and responses.
Parameters
The following parameters are available for the Color Brightness Calculator API:
Calculate Color Brightness
| Parameter | Type | Required | Description | Default | Example |
|---|---|---|---|---|---|
hex | string | required | Hex color value (with or without # prefix) Format: hexColor (e.g., FF5733) | - |
Response
The Color Brightness 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 version="1.0" encoding="UTF-8"?>
<response>
<status>ok</status>
<error xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<data>
<hex>#FF5733</hex>
<rgb>
<r>255</r>
<g>87</g>
<b>51</b>
</rgb>
<luminance>0.2832</luminance>
<perceived_brightness>131</perceived_brightness>
<yiq>133.13</yiq>
<is_light>false</is_light>
<is_dark>true</is_dark>
<brightness_category>dark</brightness_category>
<recommended_text_color>#FFFFFF</recommended_text_color>
<contrast_ratio_with_white>3.15</contrast_ratio_with_white>
<contrast_ratio_with_black>6.66</contrast_ratio_with_black>
<wcag_aa_compliant_with_white>false</wcag_aa_compliant_with_white>
<wcag_aa_compliant_with_black>true</wcag_aa_compliant_with_black>
<wcag_aaa_compliant_with_white>false</wcag_aaa_compliant_with_white>
<wcag_aaa_compliant_with_black>false</wcag_aaa_compliant_with_black>
</data>
</response>
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
| key | value |
|---|---|
| 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 Structure
All API responses follow a consistent structure with the following fields:
| Field | Type | Description | Example |
|---|---|---|---|
status | string | Indicates whether the request was successful ("ok") or failed ("error") | ok |
error | string | null | Contains error message if status is "error", otherwise null | null |
data | object | null | Contains 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:
| Field | Type | Sample Value | Description |
|---|---|---|---|
hex | string | Hexadecimal color value provided in the request | |
rgb | object | RGB color components: red, green, blue values | |
└ r | number | Red component value between 0 and 255 | |
└ g | number | Green component value between 0 and 255 | |
└ b | number | Blue component value between 0 and 255 | |
luminancePremium | number | Relative luminance calculated using WCAG 2.0 formula | |
perceived_brightnessPremium | number | Perceived brightness score from 0 to 255 | |
yiqPremium | number | YIQ color space brightness value for brightness analysis | |
is_light | boolean | Boolean indicating if color is considered light | |
is_dark | boolean | Boolean indicating if color is considered dark | |
brightness_category | string | Brightness classification: light, medium, or dark category | |
recommended_text_colorPremium | string | Recommended text color for optimal contrast and readability | |
contrast_ratio_with_whitePremium | number | WCAG contrast ratio calculation between color and white | |
contrast_ratio_with_blackPremium | number | WCAG contrast ratio calculation between color and black | |
wcag_aa_compliant_with_whitePremium | boolean | Whether color meets WCAG AA contrast requirements with white | |
wcag_aa_compliant_with_blackPremium | boolean | Whether color meets WCAG AA contrast requirements with black | |
wcag_aaa_compliant_with_whitePremium | boolean | Whether color meets WCAG AAA contrast requirements with white | |
wcag_aaa_compliant_with_blackPremium | boolean | Whether color meets WCAG AAA contrast requirements with black |
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 Brightness Calculator through GraphQL to combine it with other API calls in a single request. Query only the color brightness calculator data you need with precise field selection, and orchestrate complex data fetching workflows.
Credit Cost: Each API called in your GraphQL query consumes its standard credit cost.
POST https://api.apiverve.com/v1/graphqlquery {
colorbrightness(
input: {
hex: "FF5733"
}
) {
hex
rgb {
r
g
b
}
luminance
perceived_brightness
yiq
is_light
is_dark
brightness_category
recommended_text_color
contrast_ratio_with_white
contrast_ratio_with_black
wcag_aa_compliant_with_white
wcag_aa_compliant_with_black
wcag_aaa_compliant_with_white
wcag_aaa_compliant_with_black
}
}Note: Authentication is handled via the x-api-key header in your GraphQL request, not as a query parameter.
CORS Support
The Color Brightness 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 Brightness 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 Brightness 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 Brightness Calculator
Official Color Brightness Calculator packages on npm, PyPI, NuGet, and JitPack — plus a Postman collection and an OpenAPI spec. See the SDK guide →
No-Code Integrations
Color Brightness 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 Brightness Calculator?
How many credits does Color Brightness Calculator cost?
Each successful Color Brightness 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 brightness calculator lookups.
Can I use Color Brightness Calculator in production?
The free plan is for testing and development only. For production use of Color Brightness 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 Brightness Calculator from a browser?
What happens if I exceed my Color Brightness Calculator credit limit?
When you reach your monthly credit limit, Color Brightness 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.








