# Cyberport Product Search API Documentation

`GET /api/cyberport/search` returns Cyberport Deutschland products as structured JSON.

## What you get

Each hit has `id`, `gtin`, `manufacturerid`, `title`, `brand`, numeric `price`, `currency`, numeric `rating`, `review_count`, `is_sale` and `position`. Use `id` unchanged with the product and reviews endpoints.

## Parameters and gates

`query` or `category` is required. The category value is a path from the categories route. Only page 1 is published: the storefront ignores `page`, `productsPerPage`, `sort` and price inputs, so `page_size` is 20, `total_results` shows the upstream hit count and `paging` explains the limit. Later pages, sorting, price bounds and brand filters return 422 before any lookup.

## Credits

A successful request costs **1 credit**. Errors and missing products cost nothing. The response shows the charge in `meta.credits_charged`.

- **Documentation:** [https://scrappa.co/docs/cyberport-api/cyberport_search](https://scrappa.co/docs/cyberport-api/cyberport_search)
- **API group:** Cyberport API
- **Endpoint:** `GET https://scrappa.co/api/cyberport/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 | No | Search words. Use this or category. |
| `category` | string | No | Category path from the categories route. |
| `page` | integer | No | Only page 1 is published. |

## Example request

```bash
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/cyberport/search?query=notebook"
```

## Example response

```json
{
    "success": true,
    "site": "de",
    "query": "notebook",
    "items": [
        {
            "position": 1,
            "id": "1C17-2F0",
            "price": 849,
            "currency": "EUR",
            "is_sale": false
        }
    ],
    "page": 1,
    "meta": {
        "endpoint_family": "cyberport-search",
        "billable": true,
        "credits_charged": 1
    }
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 422 | Page Not Available | Only the first public page is available (`unsupported_page`). Non-billable. |
| 422 | Validation Error | A parameter is missing, unknown or not published yet. Unknown parameters are rejected, never ignored. Non-billable. |
| 503 | Upstream Unavailable | The upstream could not be reached, answered with a challenge, or changed its embedded page shape. One upstream GET per lookup. A challenge keeps the session, queues one refresh and allows one retry, then fails without a charge. A rate limit keeps the session. Retryable and never billed. Clients are never rate limited. |

## 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)
