All endpoints will follow the HTTP response status codes
/api/login
METHOD POST
Body:
{
"username": "test",
"password": "letmein",
"device_name": "John's iPhone"
}
Successful response:
{
"token": "ab98a396873f61d054b3365db7184fe0322c8765"
}
Failure response:
{
"error_code": "login_fail",
"error_message": "Invalid username and/or password."
}
/api/logout
METHOD POST
Header:
Authorization: Token ab98a396873f61d054b3365db7184fe0322c8765
/api/register
METHOD POST
Body:
{
"username": "test",
"password": "letmein",
"email": "email@example.com",
"device_name": "John's iPhone"
}
Successful response:
{
"token": "ab98a396873f61d054b3365db7184fe0322c8765"
}
/api/follow
METHOD POST
Header:
Authorization: Token ab98a396873f61d054b3365db7184fe0322c8765
Body:
{
"nickname": "therealuser"
}
/api/unfollow
METHOD POST
Header:
Authorization: Token ab98a396873f61d054b3365db7184fe0322c8765
Body:
{
"user_url": "https://twtxt.net/user/therealuser/twtxt.txt"
}
/api/feeds
METHOD GET
Header:
Authorization: Token ab98a396873f61d054b3365db7184fe0322c8765
Response:
[
{
"nickname": "therealuser",
"user_url": "https://twtxt.net/user/therealuser/twtxt.txt"
},
{
"nickname": "justauser",
"user_url": "https://twtxt.net/user/justauser/twtxt.txt"
}
]
/api/feeds/create
METHOD PUT
Header:
Authorization: Token ab98a396873f61d054b3365db7184fe0322c8765
Response:
{
"feed_name": "News feed"
}
/api/timeline
METHOD GET
Header:
Authorization: Token ab98a396873f61d054b3365db7184fe0322c8765
Parameters:
last_upadted_at=<timestamp>
Format:
<timestamp>
-> Last time the request was successfully made by client YYYY-MM-DDThh:mm:ssTZD
Response:
[{
"nickname": "therealuser",
"user_url": "https://twtxt.net/user/therealuser/twtxt.txt",
"text": "My first twtxt post",
"timestamp": "2020-07-23T05:58:00Z"
},
{
"nickname": "justauser",
"user_url": "https://twtxt.net/user/justauser/twtxt.txt",
"text": "My first twtxt post",
"timestamp": "2020-07-23T07:15:00Z"
}
]
/api/discover
METHOD GET
Header:
Authorization: Token ab98a396873f61d054b3365db7184fe0322c8765
Response:
[{
"nickname": "therealuser",
"user_url": "https://twtxt.net/user/therealuser/twtxt.txt",
"text": "My first twtxt post",
"timestamp": "2020-07-23T05:58:00Z"
},
{
"nickname": "justauser",
"user_url": "https://twtxt.net/user/justauser/twtxt.txt",
"text": "My first twtxt post",
"timestamp": "2020-07-23T07:15:00Z"
}
]
/api/post
METHOD POST
Header:
Authorization: Token ab98a396873f61d054b3365db7184fe0322c8765
Body:
{
"text": "My first twtxt post",
"timestamp": "2020-07-23T05:58:00Z"
}
/api/search/?q=
METHOD GET
Header:
Authorization: Token ab98a396873f61d054b3365db7184fe0322c8765
Parameters:
q=<search term>&last_update_at=2020-07-23T05:58:00Z
Supports @mention
searchers:
q=@therealuser
last_update_at
-> timestamp for when the client last requested an update
or
or
By clicking below, you agree to our terms of service.
New to HackMD? Sign up
Syntax | Example | Reference | |
---|---|---|---|
# Header | Header | 基本排版 | |
- Unordered List |
|
||
1. Ordered List |
|
||
- [ ] Todo List |
|
||
> Blockquote | Blockquote |
||
**Bold font** | Bold font | ||
*Italics font* | Italics font | ||
~~Strikethrough~~ | |||
19^th^ | 19th | ||
H~2~O | H2O | ||
++Inserted text++ | Inserted text | ||
==Marked text== | Marked text | ||
[link text](https:// "title") | Link | ||
 | Image | ||
`Code` | Code |
在筆記中貼入程式碼 | |
```javascript var i = 0; ``` |
|
||
:smile: | ![]() |
Emoji list | |
{%youtube youtube_id %} | Externals | ||
$L^aT_eX$ | LaTeX | ||
:::info This is a alert area. ::: |
This is a alert area. |
On a scale of 0-10, how likely is it that you would recommend HackMD to your friends, family or business associates?
Please give us some advice and help us improve HackMD.
Do you want to remove this version name and description?
Syncing