# Cyberport Reviews API Documentation

`GET /api/cyberport/reviews?id=...` returns the public rating, review count, rating distribution and the reviews embedded on the product page. Each review has numeric `rating` and an ISO 8601 `created_at` date.

Only page 1 is public. Page 2 returns 422 and page 1 is never labelled as page 2.

## 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_reviews](https://scrappa.co/docs/cyberport-api/cyberport_reviews)
- **API group:** Cyberport API
- **Endpoint:** `GET https://scrappa.co/api/cyberport/reviews`

## 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 |
| --- | --- | --- | --- |
| `id` | string | Yes | Product id from a search, category or id result. |
| `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/reviews?id=1H62-09X"
```

## Example response

```json
{
    "success": true,
    "site": "de",
    "product_id": "1H62-09X",
    "review_count": 4,
    "rating_distribution": [],
    "reviews": [
        {
            "external_id": "1",
            "author": "Buyer",
            "rating": 5,
            "title": "Good",
            "text": "Works well.",
            "created_at": "2024-10-01T00:00:00Z"
        }
    ],
    "page": 1,
    "meta": {
        "endpoint_family": "cyberport-reviews",
        "billable": true,
        "credits_charged": 1
    }
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 422 | Page Not Available | Only the first public page is available (`unsupported_page`). Non-billable. |
| 404 | Not Found | The upstream has no product with that id (`not_found`). 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)
