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

> Search and retrieve information about class action settlements, lawsuit investigations, and data breaches all in one place. Find relevant cases, get detailed settlement information, and stay updated with the latest news articles related to consumer lawsuits and legal actions.

**Category:** Government & Public Data | **Website:** [classaction.org/](https://classaction.org/) | **Docs:** [parse.bot/marketplace/624a46b3-8cdf-453d-bd77-b84610148502/classaction-org-api](https://parse.bot/marketplace/624a46b3-8cdf-453d-bd77-b84610148502/classaction-org-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/classaction/`
**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 news article

Get the full content of a news article or newswire filing by its URL path. Searches the Algolia index for the matching article and returns its title, full text content, description, and publication dates.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `path` | string | Yes | URL path of the article (e.g. '/news/michael-kors-settlement'). Obtainable from search_site results. |

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

### Get settlement card details

Get full details for a specific settlement by its Algolia object ID. Includes potential administrator info and hearing dates extracted from related newswire filings. The object_id is obtainable from list_settlements or search_settlements results.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `object_id` | string | Yes | Algolia objectID of the settlement (from list_settlements or search_settlements results). |

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

### List data breaches

List reported data breaches with pagination. Each breach includes the affected company, impacted data types, report date, and path to the detail page.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `limit` | integer | No | Max results per page. |
| `page` | integer | No | Zero-based page number for pagination. |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/classaction/list-data-breaches \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"limit":"<integer>","page":"<integer>"}'
```

### List lawsuits

Retrieve lawsuit investigations with pagination. Each lawsuit includes name, description, summary, featured status, path, and object ID.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `limit` | integer | No | Max results per page. |
| `page` | integer | No | Zero-based page number for pagination. |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/classaction/list-lawsuits \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"limit":"<integer>","page":"<integer>"}'
```

### List settlements

Retrieve open class action settlements with pagination. Each settlement includes payout amounts, claim deadlines, proof requirements, and whether it is featured or new. Results are ordered by recency within the Algolia index.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `limit` | integer | No | Max results per page. |
| `page` | integer | No | Zero-based page number for pagination. |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/classaction/list-settlements \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"limit":"<integer>","page":"<integer>"}'
```

### Search settlements

Search for settlements by keyword. Returns matching settlement summaries filtered to the Settlements content type. Results include payout amounts, deadlines, and proof requirements.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `limit` | integer | No | Max results to return. |
| `query` | string | Yes | Search keyword (e.g. 'Toyota', 'Data Breach'). |

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

### Search site

Search the entire site across all content types (settlements, lawsuits, news, data breaches). Returns Algolia hit objects with full metadata including name, path, description, content, page type, and attributes.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `limit` | integer | No | Max results per page. |
| `page` | integer | No | Zero-based page number for pagination. |
| `query` | string | Yes | Search keyword. |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/classaction/search-site \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"limit":"<integer>","page":"<integer>","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.