# Cyberport Id Source API Documentation

`GET /api/cyberport/ids?ids=...` takes product ids from a search or category result unchanged and returns the ids the site publishes for that lookup. Use any id with the product and reviews endpoints.

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

## 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 |
| --- | --- | --- | --- |
| `ids` | string | Yes | One or more product ids, separated by commas or semicolons. |

## Example request

```bash
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/cyberport/ids?ids=1C17-2F0%3B1H62-09X"
```

## Example response

```json
{
    "success": true,
    "site": "de",
    "ids": [
        "1C17-2F0",
        "1H62-09X"
    ],
    "found_ids": [
        "1C17-2F0",
        "1H62-09X"
    ],
    "product_path_prefix": "/p/",
    "meta": {
        "endpoint_family": "cyberport-ids",
        "billable": true,
        "credits_charged": 1
    }
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 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)
