Overview
Color Converter works by analyzing the color provided and converting it to the specified format. It uses advanced algorithms to convert the color to the specified format and returns the color in the new format.
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/colorconverter?hex=FF0000" \
-H "x-api-key: your_api_key_here"const res = await fetch('https://api.apiverve.com/v1/colorconverter?hex=FF0000', {
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/colorconverter?hex=FF0000",
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/colorconverter?hex=FF0000", 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 | The color in hexadecimal format (e.g., FF0000). Make sure you ommit the # |
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": "#FF0000",
"rgb": "255, 0, 0",
"hsl": "0, 100, 50",
"cmyk": "0, 100, 100, 0",
"ansi16": 91,
"name": "red",
"channels": {
"rgbChannels": 3,
"cmykChannels": 4,
"ansiChannels": 1,
"hexChannels": 1,
"hslChannels": 3
}
}
}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 |
|---|---|---|---|
hexPremium | string | "#FF0000" | Color in hexadecimal format with hash prefix included |
rgb | string | "255, 0, 0" | Color in red green blue comma-separated format |
hslPremium | string | "0, 100, 50" | Color in hue saturation lightness comma-separated format |
cmykPremium | string | "0, 100, 100, 0" | Color in cyan magenta yellow key comma-separated format |
ansi16Premium | number | 91 | ANSI 16-color code representation of the color |
namePremium | string | "red" | Common English name of the color if available |
channels | object | {...} | |
rgbChannels | number | 3 | Number of RGB color channels always three |
cmykChannels | number | 4 | Number of CMYK color channels always four |
ansiChannels | number | 1 | Number of ANSI color channels always one |
hexChannels | number | 1 | Number of hexadecimal color channels always one |
hslChannels | number | 3 | Number of HSL color channels always three |
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. |
Other ways to use Color Converter
Set up Color Converter 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 Data Conversion: