# Color API Scraper - HEX RGB HSL Color Data (`lulzasaur/colorapi-scraper`) Actor

Scrape color data including HEX, RGB, HSL, CMYK values and closest named colors. Generate color schemes or look up random colors.

- **URL**: https://apify.com/lulzasaur/colorapi-scraper.md
- **Developed by:** [lulz bot](https://apify.com/lulzasaur) (community)
- **Categories:** E-commerce
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $10.00 / 1,000 results

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.

Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event

## What's an Apify Actor?

Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.

- **AI agents and MCP clients** — the [Apify MCP server](https://docs.apify.com/integrations/mcp.md) at `https://mcp.apify.com` (remote, streamable HTTP, OAuth on first use).
- **Agentic workflows and local Actor development** — [Agent Skills](https://apify.com/.well-known/agent-skills/index.json) with the [Apify CLI](https://docs.apify.com/cli/docs.md): `npm install -g apify-cli`, then `apify login`.
- **JavaScript/TypeScript projects** — the official [JS/TS client](https://docs.apify.com/api/client/js/docs.md): `npm install apify-client`.
- **Python projects** — the official [Python client](https://docs.apify.com/api/client/python/docs.md): `pip install apify-client`.
- **Any other language** — the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).

# README

## Color API Scraper

Look up color data in multiple formats (HEX, RGB, HSL, HSV, CMYK, XYZ), find closest named colors, and generate color schemes using The Color API.

### Features

- **Color lookup** — get full color data for any hex value
- **Color schemes** — generate monochrome, analogic, complement, triad, quad schemes
- **Random colors** — generate N random colors with full metadata
- **Multiple formats** — HEX, RGB, HSL, HSV, CMYK, XYZ values
- **Named colors** — find the closest CSS named color for any value
- **Preview images** — get 100x100 color swatch image URLs

### Input

| Field | Type | Description |
|-------|------|-------------|
| `mode` | string | "lookup", "scheme", or "random" (default: "lookup") |
| `color` | string | Hex color without # (e.g., "FF0000") for lookup/scheme modes |
| `schemeMode` | string | Scheme type: monochrome, analogic, complement, triad, quad, etc. |
| `count` | number | Colors in scheme or number of random colors (default: 5) |

### Output

Each color record includes:

```json
{
    "hex": "#FF0000",
    "rgb": "rgb(255, 0, 0)",
    "hsl": "hsl(0, 100%, 50%)",
    "cmyk": "cmyk(0%, 100%, 100%, 0%)",
    "name": "Red",
    "exactMatch": true,
    "imageUrl": "https://www.thecolorapi.com/id?format=svg&named=true&hex=FF0000",
    "contrastColor": "#FFFFFF",
    "scrapedAt": "2026-04-26T12:00:00Z"
}
```

### Use Cases

- **Design tools** — convert between color formats for web/print design
- **Palette generation** — create harmonious color schemes for branding
- **Data visualization** — generate color palettes for charts and graphs
- **Accessibility** — check contrast colors for WCAG compliance
- **Education** — learn color theory with named color matching

### Pricing

This actor uses pay-per-event pricing at **$0.005 per result scraped**.

# Actor input Schema

## `mode` (type: `string`):

Lookup a specific color, generate a color scheme, or get random colors.

## `color` (type: `string`):

Hex color code without # (e.g., 'FF0000' for red, '00FF00' for green). Used in 'lookup' and 'scheme' modes.

## `schemeMode` (type: `string`):

Color scheme type (only used in 'scheme' mode).

## `count` (type: `integer`):

Number of colors: for 'scheme' mode (colors in scheme), for 'random' mode (random colors to generate).

## `proxyConfiguration` (type: `object`):

Optional proxy to use.

## Actor input object example

```json
{
  "mode": "lookup",
  "color": "FF0000",
  "schemeMode": "analogic",
  "count": 5
}
```

# Actor output Schema

## `results` (type: `string`):

No description

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {};

// Run the Actor and wait for it to finish
const run = await client.actor("lulzasaur/colorapi-scraper").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {}

# Run the Actor and wait for it to finish
run = client.actor("lulzasaur/colorapi-scraper").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"])
for item in client.dataset(run["defaultDatasetId"]).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{}' |
apify call lulzasaur/colorapi-scraper --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=lulzasaur/colorapi-scraper",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/6FgDakkLLadziAfdT/builds/upniULfAWMtsHg3gl/openapi.json