# Classaction — 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 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. Each call is automatically billed to your wallet in USDC.

## Access

**Base URL:** `https://api.paywithlocus.com/api/wrapped/parse-classaction-org-api-624a46b3/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## 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.paywithlocus.com/api/wrapped/parse-classaction-org-api-624a46b3/get_news_article \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -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.paywithlocus.com/api/wrapped/parse-classaction-org-api-624a46b3/get_settlement_card_details \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -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.paywithlocus.com/api/wrapped/parse-classaction-org-api-624a46b3/list_data_breaches \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -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.paywithlocus.com/api/wrapped/parse-classaction-org-api-624a46b3/list_lawsuits \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -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.paywithlocus.com/api/wrapped/parse-classaction-org-api-624a46b3/list_settlements \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -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.paywithlocus.com/api/wrapped/parse-classaction-org-api-624a46b3/search_settlements \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -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.paywithlocus.com/api/wrapped/parse-classaction-org-api-624a46b3/search_site \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"limit":"<integer>","page":"<integer>","query":"<string>"}'
```