Search eBay.com listings with keyword, category, price, condition, buying-format and free-shipping filters plus the upstream sort orders. Returns the result cards (title, link, product id, condition, price with currency, quantity sold, sponsored flag, shipping, location, thumbnail), related searches, category facets and the approximate total_results. Valid empty results (a filter combination with no matches, a page beyond the last) are billable success.
Run this endpoint
Endpoint
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.
string
Required
Free text search, e.g. coffee maker.
coffee maker
integer
Optional
eBay category id. 0 = all categories.
10
integer
Optional
Result page, 1-based. Default: 1.
1
integer
Optional
Results per page. Allowed: 60, 120, 240. Default: 60.
60
integer
Optional
Upstream sort order: 1, 7, 10, 12, 15 or 16.
relevance
boolean
Optional
Only Buy It Now listings.
true
boolean
Optional
Only auction listings.
true
array
Optional
Repeatable condition id, e.g. 1000 = New.
["example"]
number
Optional
Minimum price.
10
number
Optional
Maximum price.
10
boolean
Optional
Only listings with free shipping.
true
integer
Optional
Preferred item location filter.
10
string
Optional
Postal code for the location filter, e.g. 10001.
example
Request Examples
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://scrappa.co/api/ebay/search?q=coffee+maker&page=1&per_page=60",
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/ebay/search?q=coffee+maker&page=1&per_page=60');
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/ebay/search?q=coffee+maker&page=1&per_page=60', 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/ebay/search?q=coffee+maker&page=1&per_page=60',
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/ebay/search?q=coffee+maker&page=1&per_page=60")
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/ebay/search?q=coffee+maker&page=1&per_page=60", 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/ebay/search?q=coffee+maker&page=1&per_page=60', 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/ebay/search?q=coffee+maker&page=1&per_page=60")
.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/ebay/search?q=coffee+maker&page=1&per_page=60", 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/ebay/search?q=coffee+maker&page=1&per_page=60"
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/ebay/search?q=coffee+maker&page=1&per_page=60"));
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/ebay/search?q=coffee+maker&page=1&per_page=60',
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/ebay/search?q=coffee+maker&page=1&per_page=60")
.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
data
meta
{
"success": true,
"data": {
"query": "coffee maker",
"page": 1,
"per_page": 60,
"total_results": 100000,
"has_more": true,
"results": [
{
"title": "Automatic 4-Cup Coffee Maker with Glass Carafe, Reusable Filter, and Keep Warm",
"link": "https://www.ebay.com/itm/287059807763",
"product_id": "287059807763",
"price": {
"raw": "$22.47",
"extracted": 22.47,
"currency": "USD"
},
"quantity_sold": 27,
"sponsored": false
}
],
"related_searches": [
{
"query": "coffee maker 12 cup",
"link": "https://www.ebay.com/sch/i.html?_nkw=coffee+maker+12+cup&_sop=12"
}
],
"categories": [
{
"id": 20625,
"name": "Kitchen, Dining & Bar"
}
]
},
"meta": {
"endpoint_family": "search"
}
}
Errors
Handle these documented responses before retrying or showing customer-facing failures.
HTTP 422
A public parameter is invalid. This response is not billable.
HTTP 503
eBay did not return usable data for this request. This response is not billable.
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.