about summary refs log tree commit diff
path: root/docs/Using-the-API
diff options
context:
space:
mode:
authorKibigo <marrus-sh@users.noreply.github.com>2017-02-27 04:06:25 -0800
committerKibigo <marrus-sh@users.noreply.github.com>2017-02-27 04:06:25 -0800
commit620f70e42c16c324459ca2da52c68f1def8683de (patch)
treedf563e2aac96f44e65d204146ec6246ae5ed8472 /docs/Using-the-API
parentaf5cb0f853d523fe577da83c54040a05151ac90d (diff)
Adds site metadata access to the API
Diffstat (limited to 'docs/Using-the-API')
-rw-r--r--docs/Using-the-API/API.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/Using-the-API/API.md b/docs/Using-the-API/API.md
index 07c1b25a9..8dcf2a842 100644
--- a/docs/Using-the-API/API.md
+++ b/docs/Using-the-API/API.md
@@ -19,6 +19,7 @@ API overview
   - Who reblogged/favourited a status
   - Following/unfollowing accounts
   - Blocking/unblocking accounts
+  - Getting site information
   - Creating OAuth apps
 - [Entities](#entities)
   - Status
@@ -207,6 +208,13 @@ Returns the updated relationship to the user.
 
 Returns the updated relationship to the user.
 
+### Getting site information
+
+**GET /api/v1/site**
+
+Returns an object containing the `title`, character limit (`max_chars`), and an object of `links` for the site.
+Does not require authentication.
+
 ### OAuth apps
 
 **POST /api/v1/apps**