Color Brightness CalculatorColor Brightness Calculator API

OnlineCredit Usage:1 per callRefreshed 1 month ago
avg: 142ms|p50: 137ms|p75: 145ms|p90: 156ms|p99: 176ms

Color Brightness Calculator is a tool for calculating color brightness and luminance. It determines if a color is light or dark using WCAG 2.0 standards and provides contrast ratios for accessibility compliance.

The Color Brightness Calculator API provides reliable and fast access to color brightness calculator data through a simple REST interface. Built for developers who need consistent, high-quality results with minimal setup time.

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

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

Code Examples

Here are examples of how to call the Color Brightness Calculator API in different programming languages:

cURL Request
curl -X GET \
  "https://api.apiverve.com/v1/colorbrightness?hex=FF5733" \
  -H "X-API-Key: your_api_key_here"
JavaScript (Fetch API)
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);
Python (Requests)
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)
Node.js (Native HTTPS)
const https = require('https');
const url = require('url');

const options = {
  method: 'GET',
  headers: {
    'X-API-Key': 'your_api_key_here',
    'Content-Type': 'application/json'
  }
};

const req = https.request('https://api.apiverve.com/v1/colorbrightness?hex=FF5733', options, (res) => {
  let data = '';
  res.on('data', (chunk) => data += chunk);
  res.on('end', () => console.log(JSON.parse(data)));
});

req.end();
PHP (cURL)
<?php

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, 'https://api.apiverve.com/v1/colorbrightness?hex=FF5733');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'X-API-Key: your_api_key_here',
    'Content-Type: application/json'
]);

$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);
print_r($data);

?>
Go (net/http)
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))
}
Ruby (Net::HTTP)
require 'net/http'
require 'json'

uri = URI('https://api.apiverve.com/v1/colorbrightness?hex=FF5733')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)
request['X-API-Key'] = 'your_api_key_here'
request['Content-Type'] = 'application/json'

response = http.request(request)
puts JSON.pretty_generate(JSON.parse(response.body))
C# (HttpClient)
using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        using var client = new HttpClient();
        client.DefaultRequestHeaders.Add("X-API-Key", "your_api_key_here");

        var response = await client.GetAsync("https://api.apiverve.com/v1/colorbrightness?hex=FF5733");
        response.EnsureSuccessStatusCode();

        var responseBody = await response.Content.ReadAsStringAsync();
        Console.WriteLine(responseBody);
    }
}

Authentication

The Color Brightness 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 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

ParameterTypeRequiredDescriptionDefaultExample
hexstringrequired
Hex color value (with or without # prefix)
Format: hexColor (e.g., FF5733)
-FF5733

Response

The Color Brightness Calculator API returns responses in JSON, XML, YAML, and CSV formats:

Example Responses

JSON Response
200 OK
{
  "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
  }
}
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>
    <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>
YAML Response
200 OK
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
CSV Response
200 OK
keyvalue
hex#FF5733
rgb{r:255,g:87,b:51}
luminance0.2832
perceived_brightness131
yiq133.13
is_lightfalse
is_darktrue
brightness_categorydark
recommended_text_color#FFFFFF
contrast_ratio_with_white3.15
contrast_ratio_with_black6.66
wcag_aa_compliant_with_whitefalse
wcag_aa_compliant_with_blacktrue
wcag_aaa_compliant_with_whitefalse
wcag_aaa_compliant_with_blackfalse

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:

Response fields marked with Premium are available exclusively on paid plans.View pricing
FieldTypeSample ValueDescription
hexstring"#FF5733"Hexadecimal color value provided in the request
rgbobject{...}RGB color components: red, green, blue values
â”” rnumber255Red component value between 0 and 255
â”” gnumber87Green component value between 0 and 255
â”” bnumber51Blue component value between 0 and 255
luminancePremiumnumber0.2832Relative luminance calculated using WCAG 2.0 formula
perceived_brightnessPremiumnumber131Perceived brightness score from 0 to 255
yiqPremiumnumber133.13YIQ color space brightness value for brightness analysis
is_lightbooleanfalseBoolean indicating if color is considered light
is_darkbooleantrueBoolean indicating if color is considered dark
brightness_categorystring"dark"Brightness classification: light, medium, or dark category
recommended_text_colorPremiumstring"#FFFFFF"Recommended text color for optimal contrast and readability
contrast_ratio_with_whitePremiumnumber3.15WCAG contrast ratio calculation between color and white
contrast_ratio_with_blackPremiumnumber6.66WCAG contrast ratio calculation between color and black
wcag_aa_compliant_with_whitePremiumbooleanfalseWhether color meets WCAG AA contrast requirements with white
wcag_aa_compliant_with_blackPremiumbooleantrueWhether color meets WCAG AA contrast requirements with black
wcag_aaa_compliant_with_whitePremiumbooleanfalseWhether color meets WCAG AAA contrast requirements with white
wcag_aaa_compliant_with_blackPremiumbooleanfalseWhether color meets WCAG AAA contrast requirements with black

Headers

Required and optional headers for Color Brightness Calculator API requests:

Header NameRequiredExample ValueDescription
X-API-Keyrequiredyour_api_key_hereYour APIVerve API key. Found in your dashboard under API Keys.
Acceptoptionalapplication/jsonSpecify response format: application/json (default), application/xml, or application/yaml
User-AgentoptionalMyApp/1.0Identifies your application for analytics and debugging purposes
X-Request-IDoptionalreq_123456789Custom request identifier for tracking and debugging requests
Cache-Controloptionalno-cacheControl caching behavior for the request and response

Learn more about 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.

Test Color Brightness 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 {
  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 supports Cross-Origin Resource Sharing (CORS) with wildcard configuration, allowing you to call Color Brightness Calculator directly from browser-based applications without proxy servers.

CORS HeaderValueDescription
Access-Control-Allow-Origin*Accepts requests from any origin
Access-Control-Allow-Methods*Accepts any HTTP method
Access-Control-Allow-Headers*Accepts any request headers

Browser Usage: You can call Color Brightness Calculator directly from JavaScript running in the browser without encountering CORS errors. No proxy server or additional configuration needed.

Learn more about CORS support →

Rate Limiting

Color Brightness Calculator API requests are subject to rate limiting based on your subscription plan. These limits ensure fair usage and maintain service quality for all Color Brightness Calculator users.

PlanRate LimitDescription
Free5 requests/minHard rate limit enforced - exceeding will return 429 errors
StarterNo LimitProduction ready - standard traffic priority
ProNo LimitProduction ready - preferred traffic priority
MegaNo LimitProduction ready - highest traffic priority

Learn more about rate limiting →

Rate Limit Headers

When rate limits apply, each Color Brightness Calculator response includes headers to help you track your usage:

HeaderDescription
X-RateLimit-LimitMaximum number of requests allowed per time window
X-RateLimit-RemainingNumber of requests remaining in the current window
X-RateLimit-ResetUnix timestamp when the rate limit window resets

Handling Rate Limits

Free Plan: When you exceed your rate limit, Color Brightness Calculator returns a 429 Too Many Requests status code. Your application should implement appropriate backoff logic to handle this gracefully.

Paid Plans: No rate limiting or throttling applied. All paid plans (Starter, Pro, Mega) are production-ready.

Best Practices for Color Brightness Calculator:

  • Monitor the rate limit headers to track your Color Brightness Calculator usage (Free plan only)
  • Cache color brightness calculator responses where appropriate to reduce API calls
  • Upgrade to Pro or Mega for guaranteed no-throttle Color Brightness Calculator performance

Note: Color Brightness Calculator rate limits are separate from credit consumption. You may have credits remaining but still hit rate limits when using Color Brightness Calculator on Free tier.

Error Codes

The Color Brightness Calculator API uses standard HTTP status codes to indicate success or failure:

CodeMessageDescriptionSolution
200OKRequest successful, data returnedNo action needed - request was successful
400Bad RequestInvalid request parameters or malformed requestCheck required parameters and ensure values match expected formats
401UnauthorizedMissing or invalid API keyInclude x-api-key header with valid API key from dashboard
403ForbiddenAPI key lacks permission or insufficient creditsCheck credit balance in dashboard or upgrade plan
429Too Many RequestsRate limit exceeded (Free: 5 req/min)Implement request throttling or upgrade to paid plan
500Internal Server ErrorServer error occurredRetry request after a few seconds, contact support if persists
503Service UnavailableAPI temporarily unavailableWait and retry, check status page for maintenance updates

Learn more about error handling →

Need help? Contact support with your X-Request-ID for assistance.

Integrate Color Brightness Calculator with SDKs

Get started quickly with official Color Brightness Calculator SDKs for your preferred language. Each library handles authentication, request formatting, and error handling automatically.

Available for Node.js, Python, C#/.NET, and Android/Java. All SDKs are open source and regularly updated.

Integrate Color Brightness Calculator with No-Code API Tools

Connect the Color Brightness Calculator API to your favorite automation platform without writing code. Build workflows that leverage color brightness calculator data across thousands of apps.

All platforms use your same API key to access Color Brightness Calculator. Visit our integrations hub for step-by-step setup guides.

Frequently Asked Questions

How do I get an API key for Color Brightness 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 Brightness Calculator and all other APIVerve APIs. The free plan includes 1,000 credits plus a 500 credit bonus.
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?
Yes! The Color Brightness 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 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.

What's Next?

Continue your journey with these recommended resources

Was this page helpful?