# ConsumerAffairs Search API Documentation

<p><strong>ConsumerAffairs Search API Documentation</strong> Search public ConsumerAffairs company aliases from the site sitemap by keyword. Each result carries the sitemap slug, a readable name, category and url. The slug is used unchanged by the company and reviews endpoints. Sitemap metadata carries no rating or review count, so those fields are not returned and are a named follow-up. An empty search is not billed. Cost: 1 credit per successful request. Failed requests are not billed. Not affiliated with ConsumerAffairs.</p>

- **Documentation:** [https://scrappa.co/docs/consumeraffairs-api/consumeraffairs_search](https://scrappa.co/docs/consumeraffairs-api/consumeraffairs_search)
- **API group:** ConsumerAffairs API
- **Endpoint:** `GET https://scrappa.co/api/consumeraffairs/search`

## Authentication

Send your Scrappa API key in the `X-API-KEY` request header. Paid endpoints also support accountless x402 payments when called without an API key.

## Parameters

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `query` | string | Yes | Keyword, up to 100 characters. |
| `page` | integer | No | Page number, 1 or higher. |

## Example response

```json
{
    "data": {
        "items": [
            {
                "url": "https://www.consumeraffairs.com/finance/toyota-financial-services.html",
                "name": "Toyota Financial Services",
                "slug": "finance/toyota-financial-services.html",
                "category": "finance"
            }
        ],
        "filters": {
            "page": 1,
            "query": "toyota"
        },
        "pagination": {
            "has_more": true,
            "per_page": 10,
            "total_items": 42,
            "current_page": 1
        }
    },
    "meta": {
        "credits": 1,
        "billable": true,
        "endpoint_family": "search"
    },
    "success": true
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 422 | Validation Error | A query parameter is missing or invalid. This response is not billed. |

## More Scrappa resources

- [API documentation](https://scrappa.co/docs)
- [Full LLM-readable API reference](https://scrappa.co/llms-full.txt)
- [OpenAPI specification](https://scrappa.co/docs/api.json)
- [Pricing](https://scrappa.co/pricing)
