# Icon Search — Font Awesome Free Metadata API (`qualifyops/icon-search`) Actor Fast SVG icon search API for developers and AI agents. Search 1,880+ open-source Font Awesome Free icons by keyword, synonym or category; returns name, unicode, styles, categories and canonical SVG CDN URLs. Pay-per-result. Icons CC BY 4.0, code MIT. - **URL**: https://apify.com/qualifyops/icon-search.md - **Developed by:** [QualifyOps](https://apify.com/qualifyops) (community) - **Categories:** Lead generation, Business - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing $10.00 / 1,000 icon returneds 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 a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. 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. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use 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 ## Icon Search — Font Awesome Free metadata API Search the open-source **Font Awesome Free** icon set by keyword, synonym, alias or category and get back clean, structured records a developer or agent can drop straight into a UI or a design pipeline. Give it a `query` (e.g. `arrow`, `user`, `payment`) and it returns **one dataset item per matching icon** with: - `name`, `label`, `unicode`, `html_entity` (e.g. ``) - `styles` and the free/pro split: `free_styles`, `pro_only_styles`, `is_free`, `is_pro_only` - `categories` (from Font Awesome's own category metadata) - `search_terms` (the icon's synonyms) - `css_classes` per style (e.g. `fa-solid fa-arrow-left`) - `svg_urls` — canonical public SVG URLs on jsDelivr for every free style - `canonical_url` — the icon's page on fontawesome.com Optional `style` filter (`solid` / `regular` / `brands`) and `limit` (1–200). ### Example Input: ```json { "query": "payment", "style": "any", "limit": 5 } ```` Returns `credit-card`, `cash-register`, `cart-shopping`, `money-bill`, … each as a full record. Example item: ```json { "name": "credit-card", "label": "Credit Card", "unicode": "f09d", "html_entity": "", "styles": ["solid", "regular"], "free_styles": ["solid", "regular"], "pro_only_styles": [], "is_free": true, "is_pro_only": false, "categories": ["money", "shopping"], "css_classes": { "solid": "fa-solid fa-credit-card", "regular": "fa-regular fa-credit-card" }, "svg_urls": { "solid": "https://cdn.jsdelivr.net/gh/FortAwesome/Font-Awesome@6.5.2/svgs/solid/credit-card.svg", "regular": "https://cdn.jsdelivr.net/gh/FortAwesome/Font-Awesome@6.5.2/svgs/regular/credit-card.svg" }, "canonical_url": "https://fontawesome.com/icons/credit-card", "font_awesome_version": "6.5.2", "license": "Icons CC BY 4.0; code/metadata MIT — Font Awesome Free" } ``` ### Pricing Pay-per-event: **one returned icon = one `icon-returned` event ≈ USD 0.01** (see `.actor/pay_per_event.json`). No subscription, no minimum. ### Data source & license (important) This actor reads only the **public, openly licensed** Font Awesome Free metadata at runtime from the official open-source repository, served over public CDNs: - `https://cdn.jsdelivr.net/gh/FortAwesome/Font-Awesome@/metadata/icons.json` - `https://cdn.jsdelivr.net/gh/FortAwesome/Font-Awesome@/metadata/categories.yml` - SVG URLs point at the same public repo path. Font Awesome Free license (https://fontawesome.com/license/free): - **Icons: CC BY 4.0** — attribution required. - **Code & metadata (including `icons.json`): MIT.** - **Fonts: SIL OFL 1.1.** We surface metadata and link to canonical public assets; we do **not** re-host, relicense, or expose any Pro-only asset. Pro-only styles are reported as flags with no SVG URL. "Font Awesome" is a trademark of Fonticons, Inc.; this is an **unofficial, independent** utility and is not affiliated with or endorsed by Fonticons, Inc. No proxies, no login-walled data, no scraping of a hostile surface — only owner-published, openly licensed public metadata. ### Run / verify locally (no Apify, no APIFY\_TOKEN, no Docker) The search logic is isolated from the Apify runtime so it runs offline: ```bash python3 scripts/smoke.py # sample queries: arrow, user, payment python3 scripts/smoke.py payment # ad-hoc query python3 -m unittest discover -s tests -v # offline unit tests (network-free fixture) ``` `scripts/smoke.py` fetches the live public metadata when the network is available and falls back to a small bundled authentic snapshot (`fixtures/sample_icons.json`) otherwise, so it always demonstrates real matches. The `apify` dependency is only used inside the Apify runtime (`src/main.py`). ### Commercial ancestry Reverse-engineers the proven mechanism `one_time_digital_asset_freemium_icons` (ancestry: Font Awesome) via a **license-clean** route: instead of re-selling assets, it sells fast, structured **search over openly licensed metadata** — useful to developers and coding agents building UIs. See `foundry/money_artery/plays.jsonl` (`play-font-awesome`). ### Status Minimum executable form is **built, smoke-tested and unit-tested locally**. Publication to the Apify Store is owner/environment-gated — see `EXECUTION_STATUS.md`. # Actor input Schema ## `query` (type: `string`): Keyword, synonym or category to search, e.g. 'arrow', 'user', 'payment'. Matches icon names, labels, search terms and aliases. ## `style` (type: `string`): Only return icons that ship in this style. Leave as 'any' for all styles. ## `limit` (type: `integer`): Maximum number of matching icons to return (1-200). ## `font_awesome_version` (type: `string`): Git tag of the open-source Font Awesome Free release to search. Advanced; the default is recommended. ## Actor input object example ```json { "query": "payment", "style": "any", "limit": 25, "font_awesome_version": "6.5.2" } ``` # 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 '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "query": "arrow" }; // Run the Actor and wait for it to finish const run = await client.actor("qualifyops/icon-search").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 '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "query": "arrow" } # Run the Actor and wait for it to finish run = client.actor("qualifyops/icon-search").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 '{ "query": "arrow" }' | apify call qualifyops/icon-search --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=qualifyops/icon-search", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Icon Search — Font Awesome Free Metadata API", "description": "Fast SVG icon search API for developers and AI agents. Search 1,880+ open-source Font Awesome Free icons by keyword, synonym or category; returns name, unicode, styles, categories and canonical SVG CDN URLs. Pay-per-result. Icons CC BY 4.0, code MIT.", "version": "0.1", "x-build-id": "pRqqYR8fsYQT6YUBu" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/qualifyops~icon-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-qualifyops-icon-search", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/qualifyops~icon-search/runs": { "post": { "operationId": "runs-sync-qualifyops-icon-search", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/qualifyops~icon-search/run-sync": { "post": { "operationId": "run-sync-qualifyops-icon-search", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "query" ], "properties": { "query": { "title": "Search query", "type": "string", "description": "Keyword, synonym or category to search, e.g. 'arrow', 'user', 'payment'. Matches icon names, labels, search terms and aliases." }, "style": { "title": "Style filter", "enum": [ "any", "solid", "regular", "brands" ], "type": "string", "description": "Only return icons that ship in this style. Leave as 'any' for all styles.", "default": "any" }, "limit": { "title": "Max results", "minimum": 1, "maximum": 200, "type": "integer", "description": "Maximum number of matching icons to return (1-200).", "default": 25 }, "font_awesome_version": { "title": "Font Awesome version", "type": "string", "description": "Git tag of the open-source Font Awesome Free release to search. Advanced; the default is recommended.", "default": "6.5.2" } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } } ```