# Lucide — Wrapped API

> **You are on:** `https://api.beta.paywithlocus.com/api` | [llms.txt](https://beta.paywithlocus.com/llms.txt) | [docs](https://docs.paywithlocus.com)
>
> Locus runs on multiple environments -- make sure every URL you call matches your expected environment.
> | Environment | Landing | API | Docs |
> |---|---|---|---|
> | Production | paywithlocus.com | api.paywithlocus.com | docs.paywithlocus.com |
> | Beta | beta.paywithlocus.com | api.beta.paywithlocus.com | docs.paywithlocus.com |
> | Stage | stage.paywithlocus.com | api.stage.paywithlocus.com | docs.paywithlocus.com |
>
> If the API URL above doesn't match your expected environment, re-fetch this file from the correct domain.

> Browse and download thousands of Lucide icons with instant search and category filtering to find exactly what you need. Get SVG files and metadata for each icon to integrate them seamlessly into your projects.

**Category:** Developer Tools | **Website:** [lucide.dev/](https://lucide.dev/) | **Docs:** [parse.bot/marketplace/a8278f1a-2244-494e-807e-f23326b24baa/lucide-dev-api](https://parse.bot/marketplace/a8278f1a-2244-494e-807e-f23326b24baa/lucide-dev-api)

Pay-per-use API proxy for Locus Pro. Each call burns credits from your workspace balance.

## Access

**Base URL:** `https://api.beta.paywithlocus.com/api/wrapped/credits/lucide/`
**Auth:** `Authorization: Bearer <LOCUS_CREDITS_SECRET_KEY>` (an `lcr_` secret key or a scoped `lcac_` agent credential)
**Required header:** `Idempotency-Key: <fresh UUID per call>`. A retry with the same key replays the stored result without a new charge.
**Response:** the provider response after any endpoint-specific normalization. `X-Locus-Credits-Charged` carries the charge and `X-Locus-Credits-Balance` the remaining balance. Insufficient credits return `402` before the provider is called.
**Pricing:** estimated costs below are USD. Locus debits the credit equivalent at your workspace rate.

Full call contract: https://docs.paywithlocus.com/api-reference/introduction

> Using a Pay With Locus wallet key (`claw_` prefix)? Wallet routes are documented separately: https://docs.paywithlocus.com/wrapped-apis/for-agents

## Endpoints

### Get all icon names

Retrieves the complete sorted list of all Lucide icon names in kebab-case. The list is derived from the project's icon registry and includes every published icon. No pagination — returns the full set in one response.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/lucide/get-all-icon-names \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### Get all icons with svgs

Batch-retrieves icon names paired with their raw SVG content. Use limit to cap the number of icons returned; omitting limit returns the entire icon set (1500+ icons, slow). Icons are returned sorted by name.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `limit` | integer | No | Maximum number of icons to retrieve. Omitting returns all icons. |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/lucide/get-all-icons-with-svgs \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"limit":"<integer>"}'
```

### Get icon metadata

Retrieves structured metadata for a single Lucide icon: tags (semantic keywords), categories the icon belongs to, and contributor GitHub usernames. Returns input_not_found when the icon name does not exist.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `icon_name` | string | Yes | Kebab-case name of the icon (e.g. 'activity', 'heart'). Use get_all_icon_names to discover valid names. |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/lucide/get-icon-metadata \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"icon_name":"<string>"}'
```

### Get icon svg

Fetches the raw SVG markup for a single Lucide icon identified by its kebab-case name. The SVG is the canonical source file from the Lucide repository — a 24×24 stroke-based vector. Returns input_not_found when the icon name does not exist.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `icon_name` | string | Yes | Kebab-case name of the icon (e.g. 'activity', 'arrow-down', 'heart'). Use get_all_icon_names to discover valid names. |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/lucide/get-icon-svg \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"icon_name":"<string>"}'
```

### Get icons by category

Returns a sorted list of icon names belonging to the specified category. The category_slug must match a slug from list_categories. Returns input_not_found when the slug does not match any known category.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `category_slug` | string | Yes | Slug identifier of the category (e.g. 'arrows', 'animals', 'medical'). Obtain from list_categories endpoint. |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/lucide/get-icons-by-category \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"category_slug":"<string>"}'
```

### List categories

Lists every Lucide icon category with its human-readable display name, URL-safe slug, and the count of icons it contains. Categories are stable identifiers used by get_icons_by_category.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/lucide/list-categories \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### Search icons

Full-text search over icon names and their semantic tags. Returns a sorted list of matching icon names. Matching is case-insensitive substring against both the icon name and its tag list.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `query` | string | Yes | Search keyword to match against icon names and tags (e.g. 'heart', 'arrow', 'file'). |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/lucide/search-icons \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"query":"<string>"}'
```

## Next steps

- [All wrapped API providers](https://beta.paywithlocus.com/wapi/index.md): pick another provider.
- [Find and call tools](https://beta.paywithlocus.com/agent/tools.md): price ceilings, async results, and errors.
- [Credits and billing](https://beta.paywithlocus.com/agent/billing.md): what a call costs and how to add credits.
- [Agent docs index](https://beta.paywithlocus.com/agent/index.md): every Locus agent page.