Skip to content
Scrappa Get API key

Search (Light)

Lightweight web search endpoint. Returns structured JSON search results. Max 200 results per query (10 pages × 20 results). Supports query modifiers like filetype:pdf, site:reddit.com, or "exact phrase".

Run this endpoint

Search (Light) 1 credit/request

Endpoint

GET https://scrappa.co/api/search-light?query=artificial+intelligence&num=10
Request preview GET
https://scrappa.co/api/search-light?query=artificial+intelligence&num=10
Auth header x-api-key
Cost 1 credit/request
query = artificial intelligence
Response preview 200 OK
{
    "organic_results": [
        {
            "position": 1,
            "title": "Example Search Result",
            "link": "https://example.com/article",
            "displayed_link": "example.com/article",
            "snippet": "This is an example search result snippet that describes the content...",
            "snippet_highlighted_words": [
                "example",
                "search"
            ],
            "thumbnail": "https://example.com/thumbnail.jpg",
            "rich_snippet": {
...

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.

12 optional filters available.

query string Required

Search query with optional modifiers

Example value artificial intelligence
num integer Optional

Number of results per page (1-20, default: 10)

Example value 10
page integer Optional

Page number for pagination (1-10, default: 1). Mutually exclusive with "start". Internally converted to a start offset after validation.

Example value 1
start integer Optional

Starting index for offset-based pagination (0-170). Mutually exclusive with "page".

Example value 0
hl string Optional

Interface language code (default: en)

Example value en
safe string Optional

Safe search: off or active (default: off)

Example value off
lr string Optional

Restrict results to language (e.g., lang_en)

Example value lang_en
gl string Optional

Country code for results (e.g., us, de)

Example value us
cr string Optional

Restrict to country (e.g., countryUS)

Example value countryUS
dateRestrict string Optional

Date filter (e.g., d7 for last 7 days)

Example value d7
sort string Optional

Sort order (e.g., date)

Example value relevance
filter integer Optional

Enable/disable duplicate filtering (0 or 1)

Example value 1
rights string Optional

Filter by usage rights (cc_publicdomain, cc_attribute, cc_sharealike, cc_noncommercial, cc_nonderived)

Example value cc_publicdomain

Request Examples

<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/search-light?query=artificial+intelligence&num=10",
    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

use Illuminate\Support\Facades\Http;

$response = Http::timeout(30)
    ->withHeaders(['x-api-key' => 'YOUR_API_KEY_HERE'])
    ->get('https://scrappa.co/api/search-light?query=artificial+intelligence&num=10');

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

fetch('https://scrappa.co/api/search-light?query=artificial+intelligence&num=10', 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));
const axios = require('axios');

const options = {
    method: 'GET',
    url: 'https://scrappa.co/api/search-light?query=artificial+intelligence&num=10',
    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);
}
require 'net/http'
require 'uri'

uri = URI.parse("https://scrappa.co/api/search-light?query=artificial+intelligence&num=10")
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
import http.client
import json

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

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

try:
    conn.request("GET", "/api/search-light?query=artificial+intelligence&num=10", headers=headers)
    res = conn.getresponse()
    data = res.read()
    print(data.decode("utf-8"))
except Exception as e:
    print(f"Error: {e}")
finally:
    conn.close()
import requests

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

try:
    response = requests.get('https://scrappa.co/api/search-light?query=artificial+intelligence&num=10', headers=headers)
    response.raise_for_status()
    print(response.text)
except requests.exceptions.RequestException as e:
    print(f"Error: {e}")
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/search-light?query=artificial+intelligence&num=10")
        .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());
        }
    }
}
package main

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

func main() {
    client := &http.Client{}
    req, err := http.NewRequest("GET", "https://scrappa.co/api/search-light?query=artificial+intelligence&num=10", 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))
}
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/search-light?query=artificial+intelligence&num=10"
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/search-light?query=artificial+intelligence&num=10"));
            var content = await response.Content.ReadAsStringAsync();
            Console.WriteLine(content);
        }
        catch (Exception ex)
        {
            Console.WriteLine($"Error: {ex.Message}");
        }
    }
}
import axios from 'axios';

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

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

void run();
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/search-light?query=artificial+intelligence&num=10")
        .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.

organic_results people_also_search_for search_information pagination total_results

Common organic_results fields

position title link displayed_link
JSON Response
200 OK
{
    "organic_results": [
        {
            "position": 1,
            "title": "Example Search Result",
            "link": "https://example.com/article",
            "displayed_link": "example.com/article",
            "snippet": "This is an example search result snippet that describes the content...",
            "snippet_highlighted_words": [
                "example",
                "search"
            ],
            "thumbnail": "https://example.com/thumbnail.jpg",
            "rich_snippet": {
                "image": "https://example.com/image.jpg",
                "thumbnail": "https://example.com/thumb.jpg"
            }
        }
    ],
    "people_also_search_for": [
        "related query 1",
        "related query 2",
        "related query 3"
    ],
    "search_information": {
        "query_displayed": "example search query",
        "total_results": 1500000,
        "time_taken": 0.42
    },
    "pagination": {
        "current_page": 1,
        "pages": [
            {
                "page": 1,
                "start": 0
            },
            {
                "page": 2,
                "start": 10
            },
            {
                "page": 3,
                "start": 20
            }
        ]
    },
    "total_results": 1500000
}

Errors

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

422

Validation Error

The query, pagination, localization, safe search, date, sort, duplicate filter, or rights parameters failed validation.

{
    "errors": {
        "page": [
            "Cannot use both \"page\" and \"start\" parameters together. Use \"page\" for page-based pagination (1, 2, 3...) or \"start\" for offset-based pagination (0, 10, 20...)."
        ],
        "query": [
            "A search query is required."
        ]
    },
    "message": "The request validation failed"
}
401

Authentication Required

The request is missing a valid Scrappa API key in the X-API-KEY header.

{
    "code": "UNAUTHORIZED",
    "error": "Authentication required",
    "status": 401
}
403

Credits Or Account Access Blocked

The API key is valid, but the account cannot use Search Light because email verification, free request, subscription, or credit-pack access is blocked.

{
    "code": "FORBIDDEN",
    "error": "You've ran out of credits to use please purchase a subscription or a package.",
    "status": 403
}
500

Search Upstream Unavailable

Search Light could not fetch Google CSE search results through the configured worker and proxy-backed fallback path.

{
    "error": "Internal server error",
    "service": "google_search_light"
}
500

CSE Config Unavailable

Search Light could not load the Google CSE token and library version required to build the search request.

{
    "error": "Internal server error",
    "service": "google_search_light"
}
500

Search Parse Failed

Search Light fetched a response but could not parse it into the documented JSON result structure.

{
    "error": "Internal server error",
    "service": "google_search_light"
}

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.

Related reading

Try It Live

Test this endpoint in our interactive playground with real data.