# 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
- **Features:** Limited permissions
- **Stats:** 3 total users, 2 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/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
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.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## 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.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# 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(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).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": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,lulzasaur/colorapi-scraper"
        }
    }
}
```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

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