# Shadcnregistry — Wrapped API

> **You are on:** `https://api.paywithlocus.com/api` | [llms.txt](https://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.

> Search and discover shadcn/ui components across multiple registries. View detailed component information including source code and installation commands, browse component types and creators, bulk retrieve entire component collections, or inspect external registries by URL.

**Category:** Developer Tools | **Website:** [shadcnregistry.com/](https://shadcnregistry.com/) | **Docs:** [parse.bot/marketplace/316999b1-80fd-4333-b501-cf6f8a734600/shadcnregistry-com-api](https://parse.bot/marketplace/316999b1-80fd-4333-b501-cf6f8a734600/shadcnregistry-com-api)

Pay-per-use API proxy. Each call is automatically billed to your wallet in USDC.

## Access

**Base URL:** `https://api.paywithlocus.com/api/wrapped/parse-shadcnregistry-com-api-316999b1/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### get_all_component_types

Retrieve the complete list of component types used across all registries. These types can be passed as the type filter in search_components.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-shadcnregistry-com-api-316999b1/get_all_component_types \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_all_components_bulk

Bulk collect full data for all components across registries. This endpoint iterates through all registries and fetches every component's detail. Use with caution.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `limit` | integer | No | Max number of registries to process |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-shadcnregistry-com-api-316999b1/get_all_components_bulk \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"limit":"<integer>"}'
```

### get_all_registries

Retrieve all listed shadcn/ui registries from the homepage. Each registry includes name, slug, description, item count, and thumbnail URL. No pagination — the full catalog is returned in a single response.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-shadcnregistry-com-api-316999b1/get_all_registries \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_component_detail

Retrieve full component details including description, install command, source files with content, npm dependencies, and registry dependencies. The component_id is in @namespace/name format (obtainable from get_registry_detail or search_components).

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `component_id` | string | Yes | Component ID in @namespace/name format (e.g. '@8bitcn/accordion', '@kokonutui/button') |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-shadcnregistry-com-api-316999b1/get_component_detail \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"component_id":"<string>"}'
```

### get_creators

List all creators producing shadcn/ui related content. Returns creator names and their social links (GitHub, YouTube, X/Twitter).

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-shadcnregistry-com-api-316999b1/get_creators \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_registry_detail

Retrieve registry metadata and the full list of its components by slug. Each component summary includes id, name, and namespace. The component id is in @namespace/name format suitable for use with get_component_detail.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `slug` | string | Yes | Registry slug identifying the registry (e.g. '8bitcn', 'animate-ui', 'aceternity', 'kokonutui', 'magicui') |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-shadcnregistry-com-api-316999b1/get_registry_detail \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"slug":"<string>"}'
```

### inspect_external_registry

Fetch and parse an external shadcn/ui registry JSON file by URL. Returns structured metadata including component name, type, description, dependencies, and file contents with source code. The URL should point to a valid shadcn/ui registry JSON endpoint.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `url` | string | Yes | Full URL to a shadcn/ui registry JSON file (e.g. 'https://8bitcn.com/r/accordion.json', 'https://kokonutui.com/r/switch-button.json') |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-shadcnregistry-com-api-316999b1/inspect_external_registry \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"<string>"}'
```

### search_components

Full-text search for components by keyword across all registries. Optionally filter by component type. Returns matching components with metadata including id, name, description, type, namespace, and source URL.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `query` | string | Yes | Search keyword to match against component names and descriptions |
| `type` | string | No | Component type filter. Accepted values: 'lib', 'block', 'component', 'ui', 'hook', 'page', 'file', 'theme', 'style' |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-shadcnregistry-com-api-316999b1/search_components \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"<string>","type":"<string>"}'
```