SearchXNG API Documentation

Base URL: https://searchxng.cleaners.co.il

GUI interface: SearchXNG Search UI

OpenAPI JSON: /api/openapi.json

1. Core Search Endpoint

GET /search - classic SearXNG endpoint. For integrations use format=json.

Parameter	Type	Description
q	string	Search query (required)
format	string	html, json, csv, rss
categories	string	Examples: general, news, science
language	string	Example: en, he
safesearch	0|1|2	0=off, 1=moderate, 2=strict
pageno	integer	Page number, starting at 1
time_range	day|month|year	Optional freshness filter
engines	string	Comma-separated engines list

2. SERP Text Endpoint (New)

GET /api/serp-text or POST /api/serp-text returns:

• A single concatenated block in serp_text_block (good for AI context ingestion).
• Structured per-result blocks in results[] with URL/title/snippet/engines/cached and a per-result serp_text.

2.1 Request Params

Parameter	Type	Description
q	string	Search query (required)
categories	string or array	Single or multiple categories, e.g. general, news, science or ["general","news"]
language	string	Language hint, e.g. he, en, auto
safesearch	0|1|2	Safe search mode
pageno	integer	Page number (default 1)
time_range	day|month|year	Freshness filter
engines	string or array	Filter by engines
limit	integer	Max result blocks to return (min 1)
include_engines	boolean	Include engines list in each block (default true)
include_cached	boolean	Include cached indicator/link (default true)
include_auxiliary	boolean	Include answers/suggestions/infoboxes/etc. (default true)

2.2 Response Shape

{
  "query": "מה מזג האוויר היום?",
  "categories": ["general"],
  "pageno": 1,
  "number_of_results": 0,
  "results_count": 8,
  "serp_text_block": "...all result blocks in one text...",
  "results": [
    {
      "rank": 1,
      "url": "https://weather.walla.co.il/",
      "display_url": "https://weather.walla.co.il",
      "display_path": "",
      "title": "וואלה מזג האוויר: תחזית מזג האוויר יומית ושבועית בישראל - וואלה מזג אויר",
      "snippet": "...",
      "engines": ["google", "karmasearch", "startpage"],
      "cached": {
        "label": "cached",
        "url": "https://webcache.googleusercontent.com/search?q=cache:https://weather.walla.co.il/"
      },
      "published_date": null,
      "category": "general",
      "serp_text": "https://weather.walla.co.il\n..."
    }
  ]
}

3. Examples

# A) Standard JSON search
curl -s "https://searchxng.cleaners.co.il/search?q=latest+ai+news&format=json"

# B) New SERP text endpoint (GET) - GENERAL
curl -s "https://searchxng.cleaners.co.il/api/serp-text?q=%D7%9E%D7%94+%D7%9E%D7%96%D7%92+%D7%94%D7%90%D7%95%D7%95%D7%99%D7%A8+%D7%94%D7%99%D7%95%D7%9D%3F&categories=general&language=he&limit=8"

# C) New SERP text endpoint (GET) - NEWS
curl -s "https://searchxng.cleaners.co.il/api/serp-text?q=%D7%9E%D7%94+%D7%9E%D7%96%D7%92+%D7%94%D7%90%D7%95%D7%95%D7%99%D7%A8+%D7%94%D7%99%D7%95%D7%9D%3F&categories=news&language=he&limit=8"

# D) New SERP text endpoint (GET) - SCIENCE
curl -s "https://searchxng.cleaners.co.il/api/serp-text?q=weather+forecast+models&categories=science&language=en&limit=8"

# E) New SERP text endpoint (POST JSON) - GENERAL + NEWS + SCIENCE
curl -s "https://searchxng.cleaners.co.il/api/serp-text" \
  -H "Content-Type: application/json" \
  -d '{
    "q": "מה מזג האוויר היום?",
    "categories": ["general", "news", "science"],
    "language": "he",
    "limit": 10,
    "include_engines": true,
    "include_cached": true,
    "include_auxiliary": true
  }'

4. SERP Text Block Usage

The field serp_text_block is intentionally formatted as plain text chunks, each chunk similar to what you see in SERP cards. Example shape:

https://weather.walla.co.il
וואלה מזג האוויר: תחזית מזג האוויר יומית ושבועית בישראל - וואלה מזג אויר
ערוץ מזג האוויר של וואלה המתקדם ביותר בישראל...
startpage
google
cached

https://www.accuweather.com
› he › il › tel-aviv › 215854 › weather-forecast › 215854
תחזית מזג אוויר לשלושה ימים בתל אביב-יפו, מָחוֹז תֵּל אָבִיב, ישראל‏ | AccuWeather
...
yahoo
karmasearch
cached

Use this field when you want a single textual context block for LLM prompts. Use results[] when you need deterministic structured parsing.

5. n8n Integration Pattern

Recommended setup:

• Method: POST
• URL: https://searchxng.cleaners.co.il/api/serp-text
• JSON Body: {"q":"{{$json.query}}","categories":["general"],"language":"he","limit":8}

Then map serp_text_block to AI context or iterate over results[].