serialif color API

What's this?

This is an REST API to get a requested color, its complementary and its grayscale in different formats and the black or white text corresponding to each color according to its brightness.

Color formats

Keyword

HEX

RGB / RGBA

HSL / HSLA

Request

You can use Keyword, HEX(3,4,6 or 8 characters), RGB or RGBA and HSL or HSLA formats to send your color.

Type	Example value	Note	Possible requests
Keyword	aquamarine		https://color.serialif.com/aquamarine
Keyword	aquamarine		https://color.serialif.com/keyword=aquamarine
HEX	#55667788	without #	https://color.serialif.com/55667788
HEX	#55667788	without #	https://color.serialif.com/hex=55667788
RGB	rgb(85, 102, 119)	without rgb, ( ), or spaces	https://color.serialif.com/85,102,119
RGB	rgb(85, 102, 119)	without rgb, ( ), or spaces	https://color.serialif.com/rgb=85,102,119
RGBA	rgba(85, 102, 119, 0.53)	without rgba, ( ), or spaces	https://color.serialif.com/85,102,119,0.53
			https://color.serialif.com/rgb=85,102,119,0.53
			https://color.serialif.com/rgba=85,102,119,0.53
HSL	hsl(85, 102, 119)	without hsl, ( ), or spaces	https://color.serialif.com/hsl=85,102,119
HSLA	hsla(85, 102, 119, 0.53)	without hsla, ( ), or spaces	https://color.serialif.com/hsl=85,102,119,0.53
HSLA	hsla(85, 102, 119, 0.53)	without hsla, ( ), or spaces	https://color.serialif.com/hsla=85,102,119,0.53

Returned colors

Base (requested)

Base (requested) without alpha

Contrasted text

Complementary

Complementary without alpha

Contrasted text

Grayscale

Grayscale without alpha

Contrasted text

Returned colors in JSON

                
                    {
                        "base": {...},
                        "base_without_alpha": {...},
                        "base_without_alpha_contrasted_text": {...},
                        "complementary": {...},
                        "complementary_without_alpha": {...},
                        "complementary_without_alpha_contrasted_text": {...},
                        "grayscale": {...},
                        "grayscale_without_alpha": {...},
                        "grayscale_without_alpha_contrasted_text": {...}
                    }

Data for each color in JSON

                
                    {
                        "keyword": "aquamarine",
                        "hex": {
                            "value": "#7fffd4",
                            "composition": {
                            "red": "7f",
                            "green": "ff",
                            "blue": "d4"
                            }
                        },
                        "rgb": {
                            "value": "rgb(127, 255, 212)",
                            "composition": {
                            "red": 127,
                            "green": 255,
                            "blue": 212
                            }
                        },
                        "hsl": {
                            "value": "hsl(160, 100%, 75%)",
                            "composition": {
                            "hue": 160,
                            "saturation": 100,
                            "lightness": 75
                            }
                        },
                        "hsl_raw": {
                            "value": "hsl(159.84375, 100%, 74.90196%)",
                            "composition": {
                            "hue": 159.84375,
                            "saturation": 100,
                            "lightness": 74.90196
                            }
                        }
                    }

Example error API response

                
                {
                    "status": "error",
                    "error": {
                        "type": "wrong color format",
                        "value": "yellou",
                        "message": "not a valid KEYWORD color"
                    }
                }

Example success API response

                
                {
    "status": "success",
    "base": {
        "keyword": "",
        "hex": {
            "value": "#5f31f5f2",
            "composition": {
                "red": "5f",
                "green": "31",
                "blue": "f5",
                "alpha": "f2"
            }
        },
        "rgba": {
            "value": "rgba(95, 49, 245, 0.95)",
            "composition": {
                "red": 95,
                "green": 49,
                "blue": 245,
                "alpha": 0.94902
            }
        },
        "hsla": {
            "value": "hsla(254, 91%, 58%, 0.95)",
            "composition": {
                "hue": 254,
                "saturation": 91,
                "lightness": 58,
                "alpha": 0.94902
            }
        },
        "hsla_raw": {
            "value": "hsla(254.08163, 90.74074%, 57.64706%, 0.95)",
            "composition": {
                "hue": 254.08163,
                "saturation": 90.74074,
                "lightness": 57.64706,
                "alpha": 0.94902
            }
        }
    },
    "base_without_alpha": {
        "keyword": "",
        "hex": {
            "value": "#5f31f5",
            "composition": {
                "red": "5f",
                "green": "31",
                "blue": "f5"
            }
        },
        "rgb": {
            "value": "rgb(95, 49, 245)",
            "composition": {
                "red": 95,
                "green": 49,
                "blue": 245
            }
        },
        "hsl": {
            "value": "hsl(254, 91%, 58%)",
            "composition": {
                "hue": 254,
                "saturation": 91,
                "lightness": 58
            }
        },
        "hsl_raw": {
            "value": "hsl(254.08163, 90.74074%, 57.64706%)",
            "composition": {
                "hue": 254.08163,
                "saturation": 90.74074,
                "lightness": 57.64706
            }
        }
    },
    "base_without_alpha_contrasted_text": {
        "keyword": "white",
        "hex": {
            "value": "#ffffff",
            "composition": {
                "red": "ff",
                "green": "ff",
                "blue": "ff"
            }
        },
        "rgb": {
            "value": "rgb(255, 255, 255)",
            "composition": {
                "red": 255,
                "green": 255,
                "blue": 255
            }
        },
        "hsl": {
            "value": "hsl(0, 0%, 100%)",
            "composition": {
                "hue": 0,
                "saturation": 0,
                "lightness": 100
            }
        },
        "hsl_raw": {
            "value": "hsl(0, 0%, 100%)",
            "composition": {
                "hue": 0,
                "saturation": 0,
                "lightness": 100
            }
        }
    },
    "complementary": {
        "keyword": "",
        "hex": {
            "value": "#a0ce0af2",
            "composition": {
                "red": "a0",
                "green": "ce",
                "blue": "0a",
                "alpha": "f2"
            }
        },
        "rgba": {
            "value": "rgba(160, 206, 10, 0.95)",
            "composition": {
                "red": 160,
                "green": 206,
                "blue": 10,
                "alpha": 0.94902
            }
        },
        "hsla": {
            "value": "hsla(74, 91%, 42%, 0.95)",
            "composition": {
                "hue": 74,
                "saturation": 91,
                "lightness": 42,
                "alpha": 0.94902
            }
        },
        "hsla_raw": {
            "value": "hsla(74.08163, 90.74074%, 42.35294%, 0.95)",
            "composition": {
                "hue": 74.08163,
                "saturation": 90.74074,
                "lightness": 42.35294,
                "alpha": 0.94902
            }
        }
    },
    "complementary_without_alpha": {
        "keyword": "",
        "hex": {
            "value": "#a0ce0a",
            "composition": {
                "red": "a0",
                "green": "ce",
                "blue": "0a"
            }
        },
        "rgb": {
            "value": "rgb(160, 206, 10)",
            "composition": {
                "red": 160,
                "green": 206,
                "blue": 10
            }
        },
        "hsl": {
            "value": "hsl(74, 91%, 42%)",
            "composition": {
                "hue": 74,
                "saturation": 91,
                "lightness": 42
            }
        },
        "hsl_raw": {
            "value": "hsl(74.08163, 90.74074%, 42.35294%)",
            "composition": {
                "hue": 74.08163,
                "saturation": 90.74074,
                "lightness": 42.35294
            }
        }
    },
    "complementary_without_alpha_contrasted_text": {
        "keyword": "black",
        "hex": {
            "value": "#000000",
            "composition": {
                "red": "00",
                "green": "00",
                "blue": "00"
            }
        },
        "rgb": {
            "value": "rgb(0, 0, 0)",
            "composition": {
                "red": 0,
                "green": 0,
                "blue": 0
            }
        },
        "hsl": {
            "value": "hsl(0, 0%, 0%)",
            "composition": {
                "hue": 0,
                "saturation": 0,
                "lightness": 0
            }
        },
        "hsl_raw": {
            "value": "hsl(0, 0%, 0%)",
            "composition": {
                "hue": 0,
                "saturation": 0,
                "lightness": 0
            }
        }
    },
    "grayscale": {
        "keyword": "",
        "hex": {
            "value": "#939393f2",
            "composition": {
                "red": "93",
                "green": "93",
                "blue": "93",
                "alpha": "f2"
            }
        },
        "rgba": {
            "value": "rgba(147, 147, 147, 0.95)",
            "composition": {
                "red": 147,
                "green": 147,
                "blue": 147,
                "alpha": 0.94902
            }
        },
        "hsla": {
            "value": "hsla(254, 0%, 58%, 0.95)",
            "composition": {
                "hue": 254,
                "saturation": 0,
                "lightness": 58,
                "alpha": 0.94902
            }
        },
        "hsla_raw": {
            "value": "hsla(254.08163, 0%, 57.64706%, 0.95)",
            "composition": {
                "hue": 254.08163,
                "saturation": 0,
                "lightness": 57.64706,
                "alpha": 0.94902
            }
        }
    },
    "grayscale_without_alpha": {
        "keyword": "",
        "hex": {
            "value": "#939393",
            "composition": {
                "red": "93",
                "green": "93",
                "blue": "93"
            }
        },
        "rgb": {
            "value": "rgb(147, 147, 147)",
            "composition": {
                "red": 147,
                "green": 147,
                "blue": 147
            }
        },
        "hsl": {
            "value": "hsl(254, 0%, 58%)",
            "composition": {
                "hue": 254,
                "saturation": 0,
                "lightness": 58
            }
        },
        "hsl_raw": {
            "value": "hsl(254.08163, 0%, 57.64706%)",
            "composition": {
                "hue": 254.08163,
                "saturation": 0,
                "lightness": 57.64706
            }
        }
    },
    "grayscale_without_alpha_contrasted_text": {
        "keyword": "white",
        "hex": {
            "value": "#ffffff",
            "composition": {
                "red": "ff",
                "green": "ff",
                "blue": "ff"
            }
        },
        "rgb": {
            "value": "rgb(255, 255, 255)",
            "composition": {
                "red": 255,
                "green": 255,
                "blue": 255
            }
        },
        "hsl": {
            "value": "hsl(0, 0%, 100%)",
            "composition": {
                "hue": 0,
                "saturation": 0,
                "lightness": 100
            }
        },
        "hsl_raw": {
            "value": "hsl(0, 0%, 100%)",
            "composition": {
                "hue": 0,
                "saturation": 0,
                "lightness": 100
            }
        }
    }
}

Serialif Color API 1.0.0