Color Brightness CalculatorColor Brightness Calculator API

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

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

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

Example

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)
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))
}
Example 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
  }
}

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. 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>
    <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
rnumber255
Red component value between 0 and 255
gnumber87
Green component value between 0 and 255
bnumber51
Blue component value between 0 and 255
luminancePremiumnumber0.2832
Relative luminance calculated using WCAG 2.0 formula
perceived_brightnessPremiumnumber131
Perceived brightness score from 0 to 255
yiqPremiumnumber133.13
YIQ color space brightness value for brightness analysis
is_lightbooleanfalse
Boolean indicating if color is considered light
is_darkbooleantrue
Boolean 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.15
WCAG contrast ratio calculation between color and white
contrast_ratio_with_blackPremiumnumber6.66
WCAG contrast ratio calculation between color and black
wcag_aa_compliant_with_whitePremiumbooleanfalse
Whether color meets WCAG AA contrast requirements with white
wcag_aa_compliant_with_blackPremiumbooleantrue
Whether color meets WCAG AA contrast requirements with black
wcag_aaa_compliant_with_whitePremiumbooleanfalse
Whether color meets WCAG AAA contrast requirements with white
wcag_aaa_compliant_with_blackPremiumbooleanfalse
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.

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 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?
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?