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 159bc6991449d2060434a84795b2cd9a945a7ded..9dfd39ae2759d011b1dea66f52f883691c12823e 100644 (file)
--- a/doc/api.md
+++ b/doc/api.md
@@ -278,6 +278,19 @@ Friendica doesn't allow showing the friends of other users.
 
 * include_entities: "true" shows entities for pictures and links (Default: false)
 
+---
+### blocks/list (*; AUTH)
+
+#### Parameters
+
+* include_entities: "true" shows entities for pictures and links (Default: false)
+* count: Items per page (default: 20).
+* page: page number
+
+#### Unsupported parameters
+* cursor
+* skip_status
+
 ---
 ### statuses/friends_timeline (*; AUTH)
 #### Parameters
@@ -449,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
@@ -941,7 +972,6 @@ The following API calls from the Twitter API are not implemented in either Frien
 * account/update_delivery_device
 * account/update_profile
 * account/update_profile_background_image
-* blocks/list
 * blocks/ids
 * users/lookup
 * users/show