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

Boots Product Search API Documentation

GET https://scrappa.co/api/boots/search?query=moisturiser

GET /api/boots/search GET /api/boots/search returns public Boots products as structured JSON. Use query or category. brand removes rows of another brand. page is zero-based and comes from the source, so page one is never labelled as another page. sort accepts only mostRelevant, priceLowToHigh, topRated and newest. Prices are numbers with currency GBP; regular, current, saving and perUnit are separate. Advantage points and deal flags stay in their own fields and are never merged into the ordinary price. Ratings and review counts are numbers. image_url is a full-size image URL. in_stock is online stock only. Store stock, suggest and a price filter are not published yet.

Credits

A successful request costs 3 credits. Errors and challenges cost nothing. The response shows the charge in meta.credits_charged. Clients are never rate limited.

Boots Product Search API Documentation 1 credit / request

Endpoint

Request preview
GET
https://scrappa.co/api/boots/search?query=moisturiser
Auth header
x-api-key
Cost
1 credit / request
query = moisturiser category = example
Response preview
200 OK
{
    "success": true,
    "currency": "GBP",
    "items": [
        {
            "object_id": "10389493",
            "title": "Example moisturiser",
            "brand": "No7",
            "pricing": {
                "current": {
                    "value": 12.95,
                    "currency": "GBP"
                }
            },
...

Parameters

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

Runnable path

2 required parameters needed before sending a request.

4 optional filters available.

query string Required

Search words (use this or category).

Example value moisturiser
category string Required

Category filter (use this or query).

Example value example
brand string Optional

Exact brand.

Example value example
page integer Optional

Zero-based page index.

Example value 1
size integer Optional

Page size, 1 to 200.

Example value 10
sort string Optional

mostRelevant, priceLowToHigh, topRated or newest.

Example value relevance

Request Examples

PHP
<?php

$curl = curl_init();

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

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/boots/search?query=moisturiser', 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/boots/search?query=moisturiser',
    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/boots/search?query=moisturiser")
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/boots/search?query=moisturiser", 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/boots/search?query=moisturiser', 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/boots/search?query=moisturiser")
        .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/boots/search?query=moisturiser", 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/boots/search?query=moisturiser"
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/boots/search?query=moisturiser"));
            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/boots/search?query=moisturiser',
            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/boots/search?query=moisturiser")
        .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 currency items page total meta

Common items fields

object_id title brand pricing
JSON Response
200 OK
{
    "success": true,
    "currency": "GBP",
    "items": [
        {
            "object_id": "10389493",
            "title": "Example moisturiser",
            "brand": "No7",
            "pricing": {
                "current": {
                    "value": 12.95,
                    "currency": "GBP"
                }
            },
            "reviews": {
                "average": 4.5,
                "count": 120
            },
            "in_stock": true
        }
    ],
    "page": 0,
    "total": 2717,
    "meta": {
        "endpoint_family": "E01",
        "billable": true,
        "attempts": 1,
        "credits_charged": 3
    }
}

Errors

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

404

Not Found

No product is available for that id (`not_found`). Non-billable.

{
    "meta": {
        "attempts": 1,
        "billable": false,
        "endpoint_family": "boots-search"
    },
    "error": {
        "code": "not_found",
        "message": "No product is available for this id."
    },
    "success": false
}
422

Validation Error

A parameter is missing, unknown or invalid. Unknown parameters, including an unpublished price filter, are rejected. Non-billable.

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

Upstream Unavailable

The source could not be reached, answered with a challenge, or changed its shape (`upstream_blocked`, `upstream_unavailable`, `parser_drift`). Never billed. Clients are never rate limited.

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