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

Worten Product Search API Documentation

GET https://scrappa.co/api/worten/search?query=iphone&page_size=24

GET /api/worten/search returns Worten Portugal products as structured JSON. One page holds 24 or 48 products.

What you get

Each item has id, sku, ean, title, brand, price, original_price, discount_percent, currency, rating, review_count, in_stock, seller_id, shipping and a full-size image. Use id unchanged with the product, specifications and variants endpoints. facets[] lists the public filter slugs and their option values.

Parameters and filters

page is 1-based. page_size accepts only 24 and 48; any other value returns 422. sort is relevance, rating_bazaar, purchases, relative_striked_price or price, with order ASC or DESC.

category takes a public _cc1 facet value such as CMS-01G2YYDYYVP212M9N4DGER68ZK. min_price and max_price are EUR bounds; both are required and together build one price filter. A single bound returns 422. A named parameter replaces a raw filter for the same slug. filters is a JSON array of {"key":<facet-slug>,"value":[...]} objects for every other facet. Only slugs published by the storefront are accepted. Bad JSON, an unknown slug or an empty value array returns 422 before any lookup. If the upstream cannot apply a filter, the route returns 422 and bills nothing. A page is never mislabelled.

Credits

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

Worten Product Search API Documentation 1 credit / request

Endpoint

Request preview
GET
https://scrappa.co/api/worten/search?query=iphone&page_size=24
Auth header
x-api-key
Cost
1 credit / request
query = iphone
Response preview
200 OK
{
    "success": true,
    "site": "pt",
    "query": "iphone",
    "items": [
        {
            "position": 1,
            "id": "ffffffff-0000-4000-a000-000077b0f986",
            "sku": "8600340",
            "ean": [
                "5601234567890"
            ],
            "title": "Example iPhone",
            "brand": "APPLE",
...

Parameters

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

Runnable path

1 required parameter needed before sending a request.

8 optional filters available.

query string Required

Search words.

Example value iphone
category string Optional

Public _cc1 facet value such as CMS-01G2YYDYYVP212M9N4DGER68ZK.

Example value example
min_price number Optional

Lowest EUR price. Use with max_price.

Example value 10
max_price number Optional

Highest EUR price. Use with min_price.

Example value 10
page integer Optional

Result page, 1-based.

Example value 1
page_size integer Optional

Hits per page. Only 24 and 48 are accepted.

Example value 24
sort string Optional

relevance, rating_bazaar, purchases, relative_striked_price or price.

Example value relevance
order string Optional

ASC or DESC.

Example value example
filters string Optional

JSON array of facet filters, for example [{"key":"brand_name","value":["APPLE"]}].

Example value example

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/worten/search?query=iphone&page_size=24",
    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/worten/search?query=iphone&page_size=24');

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/worten/search?query=iphone&page_size=24', 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/worten/search?query=iphone&page_size=24',
    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/worten/search?query=iphone&page_size=24")
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/worten/search?query=iphone&page_size=24", 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/worten/search?query=iphone&page_size=24', 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/worten/search?query=iphone&page_size=24")
        .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/worten/search?query=iphone&page_size=24", 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/worten/search?query=iphone&page_size=24"
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/worten/search?query=iphone&page_size=24"));
            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/worten/search?query=iphone&page_size=24',
            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/worten/search?query=iphone&page_size=24")
        .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 page_size total_hits next_page +7 more

Common items fields

position id sku ean
JSON Response
200 OK
{
    "success": true,
    "site": "pt",
    "query": "iphone",
    "items": [
        {
            "position": 1,
            "id": "ffffffff-0000-4000-a000-000077b0f986",
            "sku": "8600340",
            "ean": [
                "5601234567890"
            ],
            "title": "Example iPhone",
            "brand": "APPLE",
            "price": 899,
            "original_price": 999,
            "discount_percent": 10,
            "currency": "EUR",
            "rating": 4.5,
            "review_count": 120,
            "in_stock": true,
            "seller_id": "worten",
            "shipping": {
                "price": 0
            },
            "image": "https://www.worten.pt/i/example.jpg"
        }
    ],
    "page": 1,
    "page_size": 24,
    "total_hits": 15311,
    "next_page": 2,
    "has_more": true,
    "sort": "relevance",
    "order": "ASC",
    "applied_filters": [],
    "facets": [],
    "filter_errors": [],
    "meta": {
        "endpoint_family": "worten-search",
        "billable": true,
        "attempts": 1,
        "credits_charged": 1
    }
}

Errors

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

404

Not Found

The storefront has no product with that id (`not_found`). Non-billable.

{
    "meta": {
        "attempts": 1,
        "billable": false,
        "retryable": true,
        "endpoint_family": "worten-search"
    },
    "error": {
        "code": "not_found",
        "message": "The storefront has no record for that product."
    },
    "success": false
}
422

Validation Error

A parameter is missing or unsupported. Only page sizes 24 and 48 are accepted, and filters use facet slugs from the search result. Non-billable.

{
    "errors": {
        "page_size": [
            "The selected page_size is invalid."
        ]
    },
    "message": "The selected page_size is invalid."
}
503

Upstream Unavailable

The storefront could not be reached, answered with a challenge, or changed its response shape. Retryable and never billed. Clients are never rate limited.

{
    "meta": {
        "attempts": 1,
        "billable": false,
        "retryable": true,
        "endpoint_family": "worten-search"
    },
    "error": {
        "code": "upstream_unavailable",
        "message": "The storefront 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.