# Allcarindex — 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 search detailed information on over 14,000 automotive brands and 6,000 concept cars, organized by region, country, and model specifications. Discover vehicle data across the world's largest automotive encyclopedia with instant access to brand details, model information, and comprehensive search capabilities.

**Category:** Automotive | **Website:** [allcarindex.com/](https://allcarindex.com/) | **Docs:** [parse.bot/marketplace/2e26de9b-3d8a-4ad2-9e3a-38bd63f17d00/allcarindex-com-api](https://parse.bot/marketplace/2e26de9b-3d8a-4ad2-9e3a-38bd63f17d00/allcarindex-com-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/allcarindex/`
**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 regions

Retrieve a list of all geographic regions available for browsing brands. Returns a static list of 6 regions with name and slug.

**Estimated cost:** Metered

_No parameters required._

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

### Get brand detail

Retrieve detailed information about a specific car brand including company history, production years, places, and company names across different eras. Requires a country slug and brand slug, both obtainable from get_brands_list results.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `brand_slug` | string | Yes | URL slug of the brand (e.g. bmw, aaa, peugeot). Obtained from get_brands_list results. |
| `country` | string | Yes | Country slug of the brand (e.g. france, germany, united-kingdom). Obtained from get_brands_list results. |

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

### Get brands by country

Retrieve the count of car brands and models from a specific country. Uses the search interface to find brand and model totals for the given country.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `country` | string | Yes | Country name slug (e.g. france, germany, japan, united-kingdom). |

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

### Get brands list

Retrieve a paginated list of car brands filtered by geographic region and starting letter. Returns 12 brands per page. Each brand includes name, country, production years, image URL, and a slug usable for detail lookup. Pagination metadata includes current page, total pages, and whether more pages exist.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `letter` | string | No | Starting letter of the brand name (a-z, 0-9). |
| `max_year` | integer | No | Maximum production year filter. |
| `min_year` | integer | No | Minimum production year filter. |
| `page` | integer | No | Page number for pagination. |
| `region` | string | No | Geographic region to browse. |
| `sort` | string | No | Sort order for results. Leave empty for default (alphabetical A-Z). |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/allcarindex/get-brands-list \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"letter":"<string>","max_year":"<integer>","min_year":"<integer>","page":"<integer>","region":"<string>","sort":"<string>"}'
```

### Search

Search the AllCarIndex database by keyword. Returns the count of matching brands, models, and blog posts. Individual result items are not publicly accessible; only aggregate counts are returned.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `query` | string | Yes | Search keyword (e.g. BMW, Toyota, Peugeot). |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/allcarindex/search \
  -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.