From 28809f9b8a3ad004c5e0c17ffd352979e8d814a2 Mon Sep 17 00:00:00 2001 From: Eugen Date: Wed, 16 Mar 2016 22:34:06 +0100 Subject: [PATCH] Created API (markdown) --- API.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 API.md diff --git a/API.md b/API.md new file mode 100644 index 0000000..97ef56a --- /dev/null +++ b/API.md @@ -0,0 +1,39 @@ +## Posting a new status + +**POST /api/statuses** + +Form data: + +- status: The text of the status +- in_reply_to_id (optional): local ID of the status you want to reply to + +Returns the new status. + +## Retrieving a timeline + +**GET /api/statuses/home** + +Returns statuses, most recent ones first. + +Query parameters: + +- offset (optional, default 0): Skip this many statuses +- limit (optional, default 20): Return this many statuses + +## Following a remote user + +**POST /api/follows** + +Form data: + +- uri: username@domain of the person you want to follow + +Returns the local representation of the followed account. + +## Reblogging and favouriting a status + +TODO + +## Following and unfollowing users + +TODO \ No newline at end of file