[doc] search api

Adam Tauber 2015-05-19 11:12:19 +02:00
parent b64600000f
commit 07e5879868
2 changed files with 16 additions and 0 deletions

@ -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

15
Search-API.md Normal file

@ -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.