Merge pull request #4097 from Rudloff/feature/search_api

[friendica.git] / doc / api.md

diff --git a/doc/api.md b/doc/api.md
index ba8625a44f793cb15879980c4467b08ff7ebb29a..9dfd39ae2759d011b1dea66f52f883691c12823e 100644 (file)
--- a/doc/api.md
+++ b/doc/api.md
@@ -462,6 +462,24 @@ It shows all direct answers (excluding the original post) to a given id.
 
 Friendica doesn't allow showing followers of other users.
 
+---
+### search (*; AUTH)
+#### Parameters
+* q: search query
+* page: the page number (starting at 1) to return
+* rpp: the number of statuses to return per page
+* count: alias for the rpp parameter
+* since_id: returns statuses with ids greater than the given id
+* max_id: returns statuses with ids lower or equal to the given id
+
+#### Unsupported parameters
+* geocode
+* lang
+* locale
+* result_type
+* until
+* include_entities
+
 ---
 ### users/search (*)
 #### Parameters