From 07e5879868266519fca75de9f7b5c9de7295c0fc Mon Sep 17 00:00:00 2001
From: Adam Tauber <asciimoo@gmail.com>
Date: Tue, 19 May 2015 11:12:19 +0200
Subject: [PATCH] [doc] search api

---
 Home.md       |  1 +
 Search-API.md | 15 +++++++++++++++
 2 files changed, 16 insertions(+)
 create mode 100644 Search-API.md

diff --git a/Home.md b/Home.md
index 7e24a3b..5de1541 100644
--- a/Home.md
+++ b/Home.md
@@ -2,6 +2,7 @@
 
 * Available public [searx instances](https://github.com/asciimoo/searx/wiki/Searx-instances)
 * [Search syntax](https://github.com/asciimoo/searx/wiki/Query-language)
+* [Search API](https://github.com/asciimoo/searx/wiki/Search-API)
 
 ## admin documentation
 
diff --git a/Search-API.md b/Search-API.md
new file mode 100644
index 0000000..c3e33b3
--- /dev/null
+++ b/Search-API.md
@@ -0,0 +1,15 @@
+#### Search API endpoints: `/`, `/search`
+
+Endpoints have equivalent functionality.
+
+
+#### Parameters
+
+| Name         | Description                                                                                   |                         |
+| ------------ | --------------------------------------------------------------------------------------------- | ----------------------- |
+| `q`          | The search query, see [Query language](https://github.com/asciimoo/searx/wiki/Query-language) | required                |
+| `categories` | Comma separated list, specifies the active search categories                                  | optional                |
+| `engines`    | Comma separated list, specifies the active search engines                                     | optional                |
+| `pageno`     | Search page number                                                                            | optional (default: `1`) |
+
+Both `GET` and `POST` methods are supported.