Neuji

Shopping search

Shopping (product) search results as JSON.

TEXT
GET /v1/shopping

Requires a valid API key, an active membership, and available API credit.

Query parameters

Name Type Required Default Description
q string yes The search query (a product or category).
safe string no moderate Safe-search level: off, moderate, or strict.
gl string no (auto) Two-letter region/country code (e.g. us, gb) — affects pricing/merchants.
hl string no (auto) Two-letter language code (e.g. en, es).
time string no any Recency filter: any, hour, day, week, month, year.
num integer no (provider default) Desired result count. Clamped to 5–100 (out-of-range → 20).

Response

JSON
{
  "query": "wireless headphones",
  "kind": "shopping",
  "results": [
    {
      "title": "Acme Wireless Headphones",
      "url": "https://shop.example.com/p/acme-wh",
      "description": "Over-ear, 40-hour battery…",
      "thumbnail": "https://shop.example.com/p/acme-wh/thumb.jpg",
      "price": "$129.99",
      "meta": "Example Store",
      "extra": null
    }
  ]
}
Field Type Description
query string The query that was executed.
kind string Always shopping for this endpoint.
results[].title string Product title.
results[].url string Product page URL.
results[].description string | null Product description, when available.
results[].thumbnail string | null Product image URL.
results[].price string | null Formatted price, when available.
results[].meta string | null Merchant / source.
results[].extra string | null Not typically used for shopping.

Examples

cURL
curl -G "https://api.neuji.com/v1/shopping" \
  -H "Authorization: Bearer $NEUJI_API_KEY" \
  --data-urlencode "q=wireless headphones" \
  --data-urlencode "gl=us"
C#
using var http = new HttpClient();
http.DefaultRequestHeaders.Authorization =
    new("Bearer", Environment.GetEnvironmentVariable("NEUJI_API_KEY"));
var url = "https://api.neuji.com/v1/shopping?q=" + Uri.EscapeDataString("wireless headphones") + "&gl=us";
Console.WriteLine(await http.GetStringAsync(url));
JavaScript
const params = new URLSearchParams({ q: "wireless headphones", gl: "us" });
const res = await fetch(`https://api.neuji.com/v1/shopping?${params}`, {
  headers: { Authorization: `Bearer ${process.env.NEUJI_API_KEY}` },
});
const data = await res.json();
for (const r of data.results) console.log(`${r.title}: ${r.price} (${r.meta})`);
Was this page helpful?