Skip to content
Scrappa Get API key
Cyberport API 1 credit / request

Cyberport Product Search API Documentation

GET https://scrappa.co/api/cyberport/search?query=notebook

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.

Cyberport Product Search API Documentation 1 credit / request

Endpoint

Request preview
GET
https://scrappa.co/api/cyberport/search?query=notebook
Auth header
x-api-key
Cost
1 credit / request
Response preview
200 OK
{
    "success": true,
    "site": "de",
    "query": "notebook",
    "items": [
        {
            "position": 1,
            "id": "1C17-2F0",
            "price": 849,
            "currency": "EUR",
            "is_sale": false
        }
    ],
    "page": 1,
...

Parameters

Start with the required fields, then add optional filters only when your use case needs them.

Runnable path

This endpoint has no required query parameters.

3 optional filters available.

query string Optional

Search words. Use this or category.

Example value notebook
category string Optional

Category path from the categories route.

Example value example
page integer Optional

Only page 1 is published.

Example value 1

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/cyberport/search?query=notebook",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "x-api-key: YOUR_API_KEY_HERE"
    ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
    echo "cURL Error #:" . $err;
} else {
    echo $response;
}
PHP
<?php

use Illuminate\Support\Facades\Http;

$response = Http::timeout(30)
    ->withHeaders(['x-api-key' => 'YOUR_API_KEY_HERE'])
    ->get('https://scrappa.co/api/cyberport/search?query=notebook');

if ($response->successful()) {
    echo $response->body();
} else {
    echo "Error: " . $response->status();
}
JavaScript
const options = {
    method: 'GET',
    headers: {
        'x-api-key': 'YOUR_API_KEY_HERE'
    }
};

fetch('https://scrappa.co/api/cyberport/search?query=notebook', options)
    .then(response => {
        if (!response.ok) {
            throw new Error(`HTTP error! status: ${response.status}`);
        }
        return response.text();
    })
    .then(data => console.log(data))
    .catch(error => console.error('Error:', error));
JavaScript
const axios = require('axios');

const options = {
    method: 'GET',
    url: 'https://scrappa.co/api/cyberport/search?query=notebook',
    headers: {
        x-api-key: 'YOUR_API_KEY_HERE',
    }
};

try {
    const response = await axios(options);
    console.log(response.data);
} catch (error) {
    console.error('Error:', error.message);
}
Ruby
require 'net/http'
require 'uri'

uri = URI.parse("https://scrappa.co/api/cyberport/search?query=notebook")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == 'https'

request = Net::HTTP::Get.new(uri.request_uri)
request['x-api-key'] = 'YOUR_API_KEY_HERE'

begin
    response = http.request(request)
    puts response.body
rescue => e
    puts "Error: #{e.message}"
end
Python
import http.client
import json

conn = http.client.HTTPSConnection("scrappa.co")

headers = {
    'x-api-key': 'YOUR_API_KEY_HERE',
}

try:
    conn.request("GET", "/api/cyberport/search?query=notebook", headers=headers)
    res = conn.getresponse()
    data = res.read()
    print(data.decode("utf-8"))
except Exception as e:
    print(f"Error: {e}")
finally:
    conn.close()
Python
import requests

headers = {
    'x-api-key': 'YOUR_API_KEY_HERE',
}

try:
    response = requests.get('https://scrappa.co/api/cyberport/search?query=notebook', headers=headers)
    response.raise_for_status()
    print(response.text)
except requests.exceptions.RequestException as e:
    print(f"Error: {e}")
Java
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import java.io.IOException;

public class ApiExample {
    public static void main(String[] args) {
        OkHttpClient client = new OkHttpClient();

        Request request = new Request.Builder()
            .url("https://scrappa.co/api/cyberport/search?query=notebook")
        .addHeader("x-api-key", "YOUR_API_KEY_HERE")
            .build();

        try (Response response = client.newCall(request).execute()) {
            if (response.isSuccessful()) {
                System.out.println(response.body().string());
            } else {
                System.out.println("Error: " + response.code());
            }
        } catch (IOException e) {
            System.out.println("Error: " + e.getMessage());
        }
    }
}
Go
package main

import (
    "fmt"
    "net/http"
    "io/ioutil"
)

func main() {
    client := &http.Client{}
    req, err := http.NewRequest("GET", "https://scrappa.co/api/cyberport/search?query=notebook", nil)
    if err != nil {
        fmt.Println("Error creating request:", err)
        return
    }
    req.Header.Set("x-api-key", "YOUR_API_KEY_HERE")

    resp, err := client.Do(req)
    if err != nil {
        fmt.Println("Error making request:", err)
        return
    }
    defer resp.Body.Close()

    body, err := ioutil.ReadAll(resp.Body)
    if err != nil {
        fmt.Println("Error reading response:", err)
        return
    }

    fmt.Println(string(body))
}
Terminal
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/cyberport/search?query=notebook"
C#
using System;
using System.Net.Http;
using System.Threading.Tasks;

class Program
{
    static async Task Main()
    {
        using var client = new HttpClient();
        client.DefaultRequestHeaders.Add("x-api-key", "YOUR_API_KEY_HERE");

        try
        {
            var response = await client.SendAsync(new HttpRequestMessage(HttpMethod.Get, "https://scrappa.co/api/cyberport/search?query=notebook"));
            var content = await response.Content.ReadAsStringAsync();
            Console.WriteLine(content);
        }
        catch (Exception ex)
        {
            Console.WriteLine($"Error: {ex.Message}");
        }
    }
}
TypeScript
import axios from 'axios';

async function run(): Promise<void> {
    try {
        const response = await axios({
            method: 'GET',
            url: 'https://scrappa.co/api/cyberport/search?query=notebook',
            headers: {
        'x-api-key': 'YOUR_API_KEY_HERE',
            },
        });

        console.log(response.data);
    } catch (error) {
        console.error('Error:', error);
    }
}

void run();
RUST
use reqwest::Client;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();

    let response = client
        .get("https://scrappa.co/api/cyberport/search?query=notebook")
        .header("x-api-key", "YOUR_API_KEY_HERE")
        .send()
        .await?;

    println!("{}", response.text().await?);

    Ok(())
}

Response Schema

Example response fields are illustrative; inspect the JSON before integrating.

Example response fields

Scan these fields before integrating.

success site query items page meta

Common items fields

position id price currency
JSON Response
200 OK
{
    "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

Handle these documented responses before retrying or showing customer-facing failures.

422

Page Not Available

Only the first public page is available (`unsupported_page`). Non-billable.

{
    "meta": {
        "attempts": 1,
        "billable": false,
        "retryable": false,
        "endpoint_family": "cyberport-search"
    },
    "error": {
        "code": "unsupported_page",
        "message": "Further pages are not published yet."
    },
    "success": false
}
422

Validation Error

A parameter is missing, unknown or not published yet. Unknown parameters are rejected, never ignored. Non-billable.

{
    "errors": {
        "query": [
            "The query field is required when category is not present."
        ]
    },
    "message": "The request validation failed"
}
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.

{
    "meta": {
        "attempts": 1,
        "billable": false,
        "retryable": true,
        "endpoint_family": "cyberport-search"
    },
    "error": {
        "code": "upstream_unavailable",
        "message": "The upstream is temporarily unavailable. Please retry."
    },
    "success": false
}

Generate Code with AI

Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.

Try It Live

Test this endpoint in our interactive playground with real data.