Search / README.md
chmielvu's picture
Fix: Use default SearXNG port 8080 configuration
daebe8d verified
---
title: SearXNG Search API
emoji: ๐Ÿ”
colorFrom: blue
colorTo: purple
sdk: docker
pinned: false
license: mit
app_port: 8080
tags:
- search
- api
- searxng
- metasearch
---
# SearXNG Search API
A privacy-focused metasearch engine with JSON API support.
## API Usage
### Search Endpoint
```
GET /search?q=your+query&format=json
```
**Parameters:**
| Param | Description | Example |
|-------|-------------|---------|
| `q` | Search query (required) | `python async` |
| `format` | Output format | `json`, `html`, `rss` |
| `categories` | Category filter | `general`, `images`, `news`, `it`, `science` |
| `engines` | Specific engines | `google,duckduckgo,github` |
| `pageno` | Page number | `1`, `2`, `3` |
| `language` | Language code | `en`, `de`, `pl` |
| `time_range` | Time filter | `day`, `week`, `month`, `year` |
### Example Requests
```bash
# Basic search (JSON)
curl "https://chmielvu-search.hf.space/search?q=machine%20learning&format=json"
# Search specific engines
curl "https://chmielvu-search.hf.space/search?q=fastapi&engines=github,stackoverflow&format=json"
# News search
curl "https://chmielvu-search.hf.space/search?q=AI&categories=news&format=json"
# IT/programming search
curl "https://chmielvu-search.hf.space/search?q=docker&categories=it&format=json"
```
### Response Format (JSON)
```json
{
"query": "machine learning",
"number_of_results": 42,
"results": [
{
"title": "Result Title",
"url": "https://example.com",
"content": "Snippet of content...",
"engine": "google",
"parsed_url": ["https", "example.com", "/path", "", ""]
}
]
}
```
## Available Engines
- **General:** Google, DuckDuckGo, Bing
- **Development:** GitHub, StackOverflow
- **Science:** arXiv
- **Social:** Reddit
- **Media:** Pixiv
## MCP Integration
This instance can be used with the [SearXNG MCP Server](https://github.com/nik-sharky/searxng-mcp) for AI agent integration.