Rework API documentation
- Split API pages by target software - Added API entities list
This commit is contained in:
parent
c6d422a188
commit
e1ba53fec3
1458
doc/API-Entities.md
Normal file
1458
doc/API-Entities.md
Normal file
File diff suppressed because it is too large
Load diff
682
doc/API-Friendica.md
Normal file
682
doc/API-Friendica.md
Normal file
|
|
@ -0,0 +1,682 @@
|
||||||
|
# Friendica API
|
||||||
|
|
||||||
|
* [Home](help)
|
||||||
|
* [Using the APIs](help/api)
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
Friendica provides the following specific endpoints.
|
||||||
|
|
||||||
|
Authentication is the same as described in [Using the APIs](help/api#Authentication).
|
||||||
|
|
||||||
|
## Entities
|
||||||
|
|
||||||
|
These endpoints uses the [Friendica API entities](help/API-Entities).
|
||||||
|
|
||||||
|
## Endpoints
|
||||||
|
|
||||||
|
### GET api/externalprofile/show
|
||||||
|
|
||||||
|
Returns a [Contact](help/API-Entities#Contact) entity for the provided profile URL.
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
- `profileurl`: Profile URL
|
||||||
|
|
||||||
|
### GET api/statuses/public_timeline
|
||||||
|
|
||||||
|
Returns a list of public [Items](help/API-Entities#Item) posted on this node.
|
||||||
|
Equivalent of the local community page.
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
* `count`: Items per page (default: 20)
|
||||||
|
* `page`: page number
|
||||||
|
* `since_id`: minimum id
|
||||||
|
* `max_id`: maximum id
|
||||||
|
* `exclude_replies`: don't show replies (default: false)
|
||||||
|
* `conversation_id`: Shows all statuses of a given conversation.
|
||||||
|
* `include_entities`: "true" shows entities for pictures and links (Default: false)
|
||||||
|
|
||||||
|
#### Unsupported parameters
|
||||||
|
|
||||||
|
* `trim_user`
|
||||||
|
|
||||||
|
### GET api/statuses/networkpublic_timeline
|
||||||
|
|
||||||
|
Returns a list of public [Items](help/API-Entities#Item) this node is aware of.
|
||||||
|
Equivalent of the global community page.
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
* `count`: Items per page (default: 20)
|
||||||
|
* `page`: page number
|
||||||
|
* `since_id`: minimum id
|
||||||
|
* `max_id`: maximum id
|
||||||
|
* `exclude_replies`: don't show replies (default: false)
|
||||||
|
* `conversation_id`: Shows all statuses of a given conversation.
|
||||||
|
* `include_entities`: "true" shows entities for pictures and links (Default: false)
|
||||||
|
|
||||||
|
### GET api/statuses/replies
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
* `count`: Items per page (default: 20)
|
||||||
|
* `page`: page number
|
||||||
|
* `since_id`: minimum id
|
||||||
|
* `max_id`: maximum id
|
||||||
|
* `include_entities`: "true" shows entities for pictures and links (Default: false)
|
||||||
|
|
||||||
|
#### Unsupported parameters
|
||||||
|
|
||||||
|
* `include_rts`
|
||||||
|
* `trim_user`
|
||||||
|
* `contributor_details`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### GET api/conversation/show
|
||||||
|
|
||||||
|
Unofficial Twitter command. It shows all direct answers (excluding the original post) to a given id.
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
* `id`: id of the post
|
||||||
|
* `count`: Items per page (default: 20)
|
||||||
|
* `page`: page number
|
||||||
|
* `since_id`: minimum id
|
||||||
|
* `max_id`: maximum id
|
||||||
|
* `include_entities`: "true" shows entities for pictures and links (Default: false)
|
||||||
|
|
||||||
|
#### Unsupported parameters
|
||||||
|
|
||||||
|
* `include_rts`
|
||||||
|
* `trim_user`
|
||||||
|
* `contributor_details`
|
||||||
|
|
||||||
|
### GET api/statusnet/conversation
|
||||||
|
|
||||||
|
Alias of [`api/conversation/show`](#GET+api%2Fconversation%2Fshow).
|
||||||
|
|
||||||
|
### GET api/statusnet/config
|
||||||
|
|
||||||
|
Returns the public Friendica node configuration.
|
||||||
|
|
||||||
|
### GET api/gnusocial/config
|
||||||
|
|
||||||
|
Alias of [`api/statusnet/config`](#GET+api%2Fstatusnet%2Fconfig).
|
||||||
|
|
||||||
|
### GET api/statusnet/version
|
||||||
|
|
||||||
|
Returns a fake static StatusNet protocol version.
|
||||||
|
|
||||||
|
### GET api/gnusocial/version
|
||||||
|
|
||||||
|
Alias of [`api/statusnet/version`](#GET+api%2Fstatusnet%2Fversion).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### POST api/friendica/activity/[verb]
|
||||||
|
|
||||||
|
Add or remove an activity from an item.
|
||||||
|
'verb' can be one of:
|
||||||
|
|
||||||
|
* `like`
|
||||||
|
* `dislike`
|
||||||
|
* `attendyes`
|
||||||
|
* `attendno`
|
||||||
|
* `attendmaybe`
|
||||||
|
|
||||||
|
To remove an activity, prepend the verb with "un", eg. "unlike" or "undislike"
|
||||||
|
Attend verbs disable eachother: that means that if "attendyes" was added to an item, adding "attendno" remove previous "attendyes".
|
||||||
|
Attend verbs should be used only with event-related items (there is no check at the moment).
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
* `id`: item id
|
||||||
|
|
||||||
|
#### Return values
|
||||||
|
|
||||||
|
On success:
|
||||||
|
json:
|
||||||
|
|
||||||
|
```"ok"```
|
||||||
|
|
||||||
|
xml:
|
||||||
|
|
||||||
|
```<ok>true</ok>```
|
||||||
|
|
||||||
|
On error:
|
||||||
|
HTTP 400 BadRequest
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### GET api/direct_messages
|
||||||
|
|
||||||
|
Deprecated Twitter received direct message list endpoint.
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
* `count`: Items per page (default: 20)
|
||||||
|
* `page`: page number
|
||||||
|
* `since_id`: minimum id
|
||||||
|
* `max_id`: maximum id
|
||||||
|
* `getText`: Defines the format of the status field. Can be "html" or "plain"
|
||||||
|
* `include_entities`: "true" shows entities for pictures and links (Default: false)
|
||||||
|
* `friendica_verbose`: "true" enables different error returns (default: "false")
|
||||||
|
|
||||||
|
#### Unsupported parameters
|
||||||
|
|
||||||
|
* `skip_status`
|
||||||
|
|
||||||
|
### GET api/direct_messages/all
|
||||||
|
|
||||||
|
Returns all [Private Messages](help/API-Entities#Private+message).
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
* `count`: Items per page (default: 20)
|
||||||
|
* `page`: page number
|
||||||
|
* `since_id`: minimum id
|
||||||
|
* `max_id`: maximum id
|
||||||
|
* `getText`: Defines the format of the status field. Can be "html" or "plain"
|
||||||
|
* `friendica_verbose`: "true" enables different error returns (default: "false")
|
||||||
|
|
||||||
|
### GET api/direct_messages/conversation
|
||||||
|
|
||||||
|
Returns all replies of a single private message conversation. Returns [Private Messages](help/API-Entities#Private+message)
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
* `count`: Items per page (default: 20)
|
||||||
|
* `page`: page number
|
||||||
|
* `since_id`: minimum id
|
||||||
|
* `max_id`: maximum id
|
||||||
|
* `getText`: Defines the format of the status field. Can be "html" or "plain"
|
||||||
|
* `uri`: URI of the conversation
|
||||||
|
* `friendica_verbose`: "true" enables different error returns (default: "false")
|
||||||
|
|
||||||
|
### GET api/direct_messages/sent
|
||||||
|
|
||||||
|
Deprecated Twitter sent direct message list endpoint. Returns [Private Messages](help/API-Entities#Private+message).
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
* `count`: Items per page (default: 20)
|
||||||
|
* `page`: page number
|
||||||
|
* `since_id`: minimum id
|
||||||
|
* `max_id`: maximum id
|
||||||
|
* `getText`: Defines the format of the status field. Can be "html" or "plain"
|
||||||
|
* `include_entities`: "true" shows entities for pictures and links (Default: false)
|
||||||
|
* `friendica_verbose`: "true" enables different error returns (default: "false")
|
||||||
|
|
||||||
|
|
||||||
|
### POST/PUT api/direct_messages/new
|
||||||
|
|
||||||
|
Deprecated Twitter direct message submission endpoint.
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
* `user_id`: id of the user
|
||||||
|
* `screen_name`: screen name (for technical reasons, this value is not unique!)
|
||||||
|
* `text`: The message
|
||||||
|
* `replyto`: ID of the replied direct message
|
||||||
|
* `title`: Title of the direct message
|
||||||
|
|
||||||
|
### POST/DELETE api/direct_messages/destroy
|
||||||
|
|
||||||
|
Deprecated Twitter direct message deletion endpoint.
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
* `id`: id of the message to be deleted
|
||||||
|
* `include_entities`: optional, currently not yet implemented
|
||||||
|
* `friendica_parenturi`: optional, can be used for increased safety to delete only intended messages
|
||||||
|
* `friendica_verbose`: "true" enables different error returns (default: "false")
|
||||||
|
|
||||||
|
#### Return values
|
||||||
|
|
||||||
|
On success:
|
||||||
|
|
||||||
|
* JSON return as defined for Twitter API not yet implemented
|
||||||
|
* on friendica_verbose=true: JSON return {"result":"ok","message":"message deleted"}
|
||||||
|
|
||||||
|
On error:
|
||||||
|
HTTP 400 BadRequest
|
||||||
|
|
||||||
|
* on friendica_verbose=true: different JSON returns {"result":"error","message":"xyz"}
|
||||||
|
|
||||||
|
### GET api/friendica/direct_messages_setseen
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
* `id`: id of the message to be updated as seen
|
||||||
|
|
||||||
|
#### Return values
|
||||||
|
|
||||||
|
On success:
|
||||||
|
|
||||||
|
* JSON return `{"result": "ok", "message": "message set to seen"}`
|
||||||
|
|
||||||
|
On error:
|
||||||
|
|
||||||
|
* different JSON returns `{"result": "error", "message": "xyz"}`
|
||||||
|
|
||||||
|
|
||||||
|
### GET api/friendica/direct_messages_search (GET; AUTH)
|
||||||
|
|
||||||
|
Returns [Private Messages](help/API-Entities#Private+message) matching the provided search string.
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
* `searchstring`: string for which the API call should search as '%searchstring%' in field 'body' of all messages of the authenticated user (caption ignored)
|
||||||
|
* `getText` (optional): `plain`|`html` If ommited, the title is prepended to the plaintext body in the `text` attribute of the private message objects.
|
||||||
|
* `getUserObjects` (optional): `true`|`false` If `false`, the `sender` and `recipient` attributes of the private message object are absent.
|
||||||
|
|
||||||
|
#### Return values
|
||||||
|
|
||||||
|
Returns only tested with JSON, XML might work as well.
|
||||||
|
|
||||||
|
On success:
|
||||||
|
|
||||||
|
* JSON return `{"success":"true", "search_results": array of found messages}`
|
||||||
|
* JSOn return `{"success":"false", "search_results": "nothing found"}`
|
||||||
|
|
||||||
|
On error:
|
||||||
|
|
||||||
|
* different JSON returns `{"result": "error", "message": "searchstring not specified"}`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### GET api/friendica/group_show
|
||||||
|
|
||||||
|
Return all or a specified group of the user with the containing contacts as array.
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
* `gid`: optional, if not given, API returns all groups of the user
|
||||||
|
|
||||||
|
#### Return values
|
||||||
|
|
||||||
|
Array of:
|
||||||
|
|
||||||
|
* `name`: name of the group
|
||||||
|
* `gid`: id of the group
|
||||||
|
* `user`: array of [Contacts](help/API-Entities#Contact)
|
||||||
|
|
||||||
|
### POST/PUT api/friendica/group_create
|
||||||
|
|
||||||
|
Create the group with the posted array of contacts as members.
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
* `name`: name of the group to be created
|
||||||
|
|
||||||
|
#### POST data
|
||||||
|
|
||||||
|
JSON data as Array like the result of [GET api/friendica/group_show](#GET+api%2Ffriendica%2Fgroup_show):
|
||||||
|
|
||||||
|
* `gid`
|
||||||
|
* `name`
|
||||||
|
* List of [Contacts](help/API-Entities#Contact)
|
||||||
|
|
||||||
|
#### Return values
|
||||||
|
|
||||||
|
Array of:
|
||||||
|
|
||||||
|
* `success`: true if successfully created or reactivated
|
||||||
|
* `gid`: gid of the created group
|
||||||
|
* `name`: name of the created group
|
||||||
|
* `status`: "missing user" | "reactivated" | "ok"
|
||||||
|
* `wrong users`: array of users, which were not available in the contact table
|
||||||
|
|
||||||
|
### POST api/friendica/group_update
|
||||||
|
|
||||||
|
Update the group with the posted array of contacts as members (post all members of the group to the call; function will remove members not posted).
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
* `gid`: id of the group to be changed
|
||||||
|
* `name`: name of the group to be changed
|
||||||
|
|
||||||
|
#### POST data
|
||||||
|
|
||||||
|
JSON data as array like the result of [GET api/friendica/group_show](#GET+api%2Ffriendica%2Fgroup_show):
|
||||||
|
|
||||||
|
* `gid`
|
||||||
|
* `name`
|
||||||
|
* List of [Contacts](help/API-Entities#Contact)
|
||||||
|
|
||||||
|
#### Return values
|
||||||
|
|
||||||
|
Array of:
|
||||||
|
|
||||||
|
* `success`: true if successfully updated
|
||||||
|
* `gid`: gid of the changed group
|
||||||
|
* `name`: name of the changed group
|
||||||
|
* `status`: "missing user" | "ok"
|
||||||
|
* `wrong users`: array of users, which were not available in the contact table
|
||||||
|
|
||||||
|
### POST/DELETE api/friendica/group_delete
|
||||||
|
|
||||||
|
Delete the specified group of contacts; API call need to include the correct gid AND name of the group to be deleted.
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
* `gid`: id of the group to be deleted
|
||||||
|
* `name`: name of the group to be deleted
|
||||||
|
|
||||||
|
#### Return values
|
||||||
|
|
||||||
|
Array of:
|
||||||
|
|
||||||
|
* `success`: true if successfully deleted
|
||||||
|
* `gid`: gid of the deleted group
|
||||||
|
* `name`: name of the deleted group
|
||||||
|
* `status`: "deleted" if successfully deleted
|
||||||
|
* `wrong users`: empty array
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### GET api/friendica/notifications
|
||||||
|
|
||||||
|
Return last 50 [Notifications](help/API-Entities#Notification) for the current user, ordered by date with unseen item on top.
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
none
|
||||||
|
|
||||||
|
### POST api/friendica/notifications/seen
|
||||||
|
|
||||||
|
Set notification as seen.
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
- `id`: id of the notification to set seen
|
||||||
|
|
||||||
|
#### Return values
|
||||||
|
|
||||||
|
If the note is linked to an item, returns an [Item](help/API-Entities#Item).
|
||||||
|
|
||||||
|
Otherwise, a success status is returned:
|
||||||
|
|
||||||
|
* `success` (json) | `<status>success</status>` (xml)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### GET api/friendica/photo
|
||||||
|
|
||||||
|
Returns a [Photo](help/API-Entities#Photo).
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
* `photo_id`: Resource id of a photo.
|
||||||
|
* `scale`: (optional) scale value of the photo
|
||||||
|
|
||||||
|
Returns data of a picture with the given resource.
|
||||||
|
If 'scale' isn't provided, returned data include full url to each scale of the photo.
|
||||||
|
If 'scale' is set, returned data include image data base64 encoded.
|
||||||
|
|
||||||
|
possibile scale value are:
|
||||||
|
|
||||||
|
* 0: original or max size by server settings
|
||||||
|
* 1: image with or height at <= 640
|
||||||
|
* 2: image with or height at <= 320
|
||||||
|
* 3: thumbnail 160x160
|
||||||
|
* 4: Profile image at 300x300
|
||||||
|
* 5: Profile image at 80x80
|
||||||
|
* 6: Profile image at 48x48
|
||||||
|
|
||||||
|
An image used as profile image has only scale 4-6, other images only 0-3
|
||||||
|
|
||||||
|
#### Return values
|
||||||
|
|
||||||
|
json:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"id": "photo id"
|
||||||
|
"created": "date(YYYY-MM-DD HH:MM:SS)",
|
||||||
|
"edited": "date(YYYY-MM-DD HH:MM:SS)",
|
||||||
|
"title": "photo title",
|
||||||
|
"desc": "photo description",
|
||||||
|
"album": "album name",
|
||||||
|
"filename": "original file name",
|
||||||
|
"type": "mime type",
|
||||||
|
"height": "number",
|
||||||
|
"width": "number",
|
||||||
|
"profile": "1 if is profile photo",
|
||||||
|
"link": {
|
||||||
|
"<scale>": "url to image"
|
||||||
|
...
|
||||||
|
},
|
||||||
|
// if 'scale' is set
|
||||||
|
"datasize": "size in byte",
|
||||||
|
"data": "base64 encoded image data"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
xml:
|
||||||
|
|
||||||
|
```xml
|
||||||
|
<photo>
|
||||||
|
<id>photo id</id>
|
||||||
|
<created>date(YYYY-MM-DD HH:MM:SS)</created>
|
||||||
|
<edited>date(YYYY-MM-DD HH:MM:SS)</edited>
|
||||||
|
<title>photo title</title>
|
||||||
|
<desc>photo description</desc>
|
||||||
|
<album>album name</album>
|
||||||
|
<filename>original file name</filename>
|
||||||
|
<type>mime type</type>
|
||||||
|
<height>number</height>
|
||||||
|
<width>number</width>
|
||||||
|
<profile>1 if is profile photo</profile>
|
||||||
|
<links type="array">
|
||||||
|
<link type="mime type" scale="scale number" href="image url"/>
|
||||||
|
...
|
||||||
|
</links>
|
||||||
|
</photo>
|
||||||
|
```
|
||||||
|
|
||||||
|
### GET api/friendica/photos/list
|
||||||
|
|
||||||
|
Returns the API user's [Photo List Items](help/API-Entities#Photo+List+Item).
|
||||||
|
|
||||||
|
#### Return values
|
||||||
|
|
||||||
|
json:
|
||||||
|
|
||||||
|
```json
|
||||||
|
[
|
||||||
|
{
|
||||||
|
id: "resource_id",
|
||||||
|
album: "album name",
|
||||||
|
filename: "original file name",
|
||||||
|
type: "image mime type",
|
||||||
|
thumb: "url to thumb sized image"
|
||||||
|
},
|
||||||
|
...
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
|
xml:
|
||||||
|
|
||||||
|
```xml
|
||||||
|
<photos type="array">
|
||||||
|
<photo id="resource_id"
|
||||||
|
album="album name"
|
||||||
|
filename="original file name"
|
||||||
|
type="image mime type">
|
||||||
|
"url to thumb sized image"
|
||||||
|
</photo>
|
||||||
|
...
|
||||||
|
</photos>
|
||||||
|
```
|
||||||
|
|
||||||
|
### POST api/friendica/photo/create
|
||||||
|
|
||||||
|
Alias of [`api/friendica/photo/update`](#POST+api%2Ffriendica%2Fphoto%2Fupdate)
|
||||||
|
|
||||||
|
### POST api/friendica/photo/update
|
||||||
|
|
||||||
|
Saves data for the scales 0-2 to database (see above for scale description).
|
||||||
|
Call adds non-public entries to items table to enable authenticated contacts to comment/like the photo.
|
||||||
|
Client should pay attention to the fact that updated access rights are not transferred to the contacts. i.e. public photos remain publicly visible if they have been commented/liked before setting visibility back to a limited group.
|
||||||
|
Currently it is best to inform user that updating rights is not the right way to do this, and offer a solution to add photo as a new photo with the new rights instead.
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
* `photo_id` (optional): if specified the photo with this id will be updated
|
||||||
|
* `media` (optional): image data as base64, only optional if photo_id is specified (new upload must have media)
|
||||||
|
* `desc` (optional): description for the photo, updated when photo_id is specified
|
||||||
|
* `album`: name of the album to be deleted (always necessary)
|
||||||
|
* `album_new` (optional): can be used to change the album of a single photo if photo_id is specified
|
||||||
|
* `allow_cid`/`allow_gid`/`deny_cid`/`deny_gid` (optional):
|
||||||
|
- on create: empty string or omitting = public photo, specify in format ```<x><y><z>``` for private photo
|
||||||
|
- on update: keys need to be present with empty values for changing a private photo to public
|
||||||
|
|
||||||
|
#### Return values
|
||||||
|
|
||||||
|
On success:
|
||||||
|
|
||||||
|
* new photo uploaded: JSON return with photo data (see [GET api/friendica/photo](#GET+api%2Ffriendica%2Fphoto))
|
||||||
|
* photo updated - changed photo data: JSON return with photo data (see [GET api/friendica/photo](#GET+api%2Ffriendica%2Fphoto))
|
||||||
|
* photo updated - changed info: JSON return `{"result": "updated", "message":"Image id 'xyz' has been updated."}`
|
||||||
|
* photo updated - nothing changed: JSON return `{"result": "cancelled","message": "Nothing to update for image id 'xyz'."}`
|
||||||
|
|
||||||
|
On error:
|
||||||
|
|
||||||
|
* 403 FORBIDDEN: if not authenticated
|
||||||
|
* 400 BADREQUEST: "no albumname specified", "no media data submitted", "photo not available", "acl data invalid"
|
||||||
|
* 500 INTERNALSERVERERROR: "image size exceeds PHP config settings, file was rejected by server",
|
||||||
|
"image size exceeds Friendica Config setting (uploaded size: x)",
|
||||||
|
"unable to process image data",
|
||||||
|
"image upload failed",
|
||||||
|
"unknown error - uploading photo failed, see Friendica log for more information",
|
||||||
|
"unknown error - update photo entry in database failed",
|
||||||
|
"unknown error - this error on uploading or updating a photo should never happen"
|
||||||
|
|
||||||
|
### DELETE api/friendica/photo/delete
|
||||||
|
|
||||||
|
Deletes a single image with the specified id, is not reversible -> ensure that client is asking user for being sure to do this
|
||||||
|
Sets item table entries for this photo to deleted = 1.
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
* `photo_id`: id of the photo to be deleted
|
||||||
|
|
||||||
|
#### Return values
|
||||||
|
|
||||||
|
On success:
|
||||||
|
|
||||||
|
* JSON return
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"result": "deleted",
|
||||||
|
"message": "photo with id 'xyz' has been deleted from server."
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
On error:
|
||||||
|
|
||||||
|
* 403 FORBIDDEN: if not authenticated
|
||||||
|
* 400 BADREQUEST: "no photo_id specified", "photo not available"
|
||||||
|
* 500 INTERNALSERVERERROR: "unknown error on deleting photo", "problem with deleting items occurred"
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### POST/DELETE api/friendica/photoalbum/delete
|
||||||
|
|
||||||
|
Deletes all images with the specified album name, is not reversible -> ensure that client is asking user for being sure to do this.
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
* `album`: name of the album to be deleted
|
||||||
|
|
||||||
|
#### Return values
|
||||||
|
|
||||||
|
On success:
|
||||||
|
|
||||||
|
* JSON return
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"result": "deleted",
|
||||||
|
"message": "album 'xyz' with all containing photos has been deleted."
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
On error:
|
||||||
|
|
||||||
|
* 403 FORBIDDEN: if not authenticated
|
||||||
|
* 400 BADREQUEST: "no albumname specified", "album not available"
|
||||||
|
* 500 INTERNALSERVERERROR: "problem with deleting item occured", "unknown error - deleting from database failed"
|
||||||
|
|
||||||
|
### POST/PUT api/friendica/photoalbum/update
|
||||||
|
|
||||||
|
Changes the album name to album_new for all photos in album.
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
* `album`: name of the album to be updated
|
||||||
|
* `album_new`: new name of the album
|
||||||
|
|
||||||
|
#### Return values
|
||||||
|
|
||||||
|
On success:
|
||||||
|
|
||||||
|
* JSON return
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"result": "updated",
|
||||||
|
"message":"album 'abc' with all containing photos has been renamed to 'xyz'."
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
On error:
|
||||||
|
|
||||||
|
* 403 FORBIDDEN: if not authenticated
|
||||||
|
* 400 BADREQUEST: "no albumname specified", "no new albumname specified", "album not available"
|
||||||
|
* 500 INTERNALSERVERERROR: "unknown error - updating in database failed"
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### GET api/friendica/profile/show
|
||||||
|
|
||||||
|
Returns the [Profile](help/API-Entities#Profile) data of all profiles or a single profile of the authenticated user.
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
* `profile_id` (optional): id of the profile to be returned. If omitted all profiles are returned by default.
|
||||||
|
|
||||||
|
#### Return values
|
||||||
|
|
||||||
|
On success: Array of:
|
||||||
|
|
||||||
|
* `multi_profiles`: true if user has activated multi_profiles
|
||||||
|
* `global_dir`: URL of the global directory set in server settings
|
||||||
|
* `friendica_owner`: user data of the authenticated user
|
||||||
|
* `profiles`: array of the profile data
|
||||||
|
|
||||||
|
On error:
|
||||||
|
HTTP 403 Forbidden: when no authentication was provided
|
||||||
|
HTTP 400 Bad Request: if given profile_id is not in the database or is not assigned to the authenticated user
|
||||||
|
|
||||||
|
General description of profile data in API returns:
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### GET api/friendica/remoteauth
|
||||||
|
|
||||||
|
Similar as /redir, redirects to `url` after DFRN authentication.
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
- `c_url`: url of remote contact to auth to
|
||||||
|
- `url`: string, url to redirect after auth
|
||||||
|
|
||||||
|
## Deprecated endpoints
|
||||||
|
|
||||||
|
- POST api/statuses/mediap
|
||||||
81
doc/API-GNU-Social.md
Normal file
81
doc/API-GNU-Social.md
Normal file
|
|
@ -0,0 +1,81 @@
|
||||||
|
# GNU Social API
|
||||||
|
|
||||||
|
* [Home](help)
|
||||||
|
* [Using the APIs](help/api)
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
Friendica provides the following endpoints defined in [the official GNU Social Twitter-like API reference](https://gnusocial.net/doc/twitterapi).
|
||||||
|
|
||||||
|
Authentication is the same as described in [Using the APIs](help/api#Authentication).
|
||||||
|
|
||||||
|
## Entities
|
||||||
|
|
||||||
|
These endpoints use the [Friendica API entities](help/API-Entities).
|
||||||
|
|
||||||
|
## Implemented endpoints
|
||||||
|
|
||||||
|
- GET api/account/rate_limit_status
|
||||||
|
- POST api/account/update_profile_image
|
||||||
|
- GET api/account/verify_credentials
|
||||||
|
|
||||||
|
- GET api/direct_messages
|
||||||
|
- POST/DELETE api/direct_messages/destroy
|
||||||
|
- POST api/direct_messages/new
|
||||||
|
- GET api/direct_messages/sent
|
||||||
|
- GET api/favorites
|
||||||
|
- POST api/favorites/create/:id
|
||||||
|
- POST api/favorites/destroy/:id
|
||||||
|
- GET api/followers/ids
|
||||||
|
- POST api/friendships/destroy
|
||||||
|
- GET api/friends/ids
|
||||||
|
- GET/POST api/help/test
|
||||||
|
- POST api/oauth/access_token
|
||||||
|
- POST api/oauth/request_token
|
||||||
|
- GET api/search
|
||||||
|
- GET api/statuses/show/:id
|
||||||
|
- POST api/statuses/destroy/:id
|
||||||
|
- GET api/statuses/followers
|
||||||
|
- GET api/statuses/friends
|
||||||
|
- GET api/statuses/friends_timeline
|
||||||
|
- GET api/statuses/friends_timeline/:username
|
||||||
|
- GET api/statuses/home_timeline
|
||||||
|
- GET api/statuses/mentions
|
||||||
|
- GET api/statuses/replies
|
||||||
|
- GET api/statuses/replies/:username
|
||||||
|
- POST api/statuses/retweet/:id
|
||||||
|
- GET api/statuses/public_timeline
|
||||||
|
- POST api/statuses/update
|
||||||
|
- GET api/statuses/user_timeline
|
||||||
|
- GET api/users/show
|
||||||
|
|
||||||
|
## Non-implemented endpoints
|
||||||
|
|
||||||
|
- statuses/retweeted_to_me
|
||||||
|
- statuses/retweeted_by_me
|
||||||
|
- statuses/retweets_of_me
|
||||||
|
- friendships/create
|
||||||
|
- friendships/exists
|
||||||
|
- friendships/show
|
||||||
|
- account/end_session
|
||||||
|
- account/update_delivery_device
|
||||||
|
- account/update_profile_background_image
|
||||||
|
- notifications/follow
|
||||||
|
- notifications/leave
|
||||||
|
- blocks/create
|
||||||
|
- blocks/destroy
|
||||||
|
- blocks/exists
|
||||||
|
- blocks/blocking
|
||||||
|
- oauth/authorize
|
||||||
|
- statusnet/groups/timeline
|
||||||
|
- statusnet/groups/show
|
||||||
|
- statusnet/groups/create
|
||||||
|
- statusnet/groups/join
|
||||||
|
- statusnet/groups/leave
|
||||||
|
- statusnet/groups/list
|
||||||
|
- statusnet/groups/list_all
|
||||||
|
- statusnet/groups/membership
|
||||||
|
- statusnet/groups/is_member
|
||||||
|
- statusnet/tags/timeline
|
||||||
|
- statusnet/media/upload
|
||||||
|
- statusnet/config
|
||||||
24
doc/API-Mastodon.md
Normal file
24
doc/API-Mastodon.md
Normal file
|
|
@ -0,0 +1,24 @@
|
||||||
|
# Mastodon API
|
||||||
|
|
||||||
|
* [Home](help)
|
||||||
|
* [Using the APIs](help/api)
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
Friendica provides the following endpoints defined in [the official Mastodon API reference](https://docs.joinmastodon.org/api/).
|
||||||
|
|
||||||
|
Authentication is the same as described in [Using the APIs](help/api#Authentication).
|
||||||
|
|
||||||
|
## Entities
|
||||||
|
|
||||||
|
These endpoints use the [Mastodon API entities](https://docs.joinmastodon.org/api/entities/).
|
||||||
|
|
||||||
|
## Implemented endpoints
|
||||||
|
|
||||||
|
- [GET /api/v1/follow_requests](https://docs.joinmastodon.org/api/rest/follow-requests/#get-api-v1-follow-requests)
|
||||||
|
|
||||||
|
## Non-implemented endpoints
|
||||||
|
|
||||||
|
- [POST /api/v1/follow_requests/:id/authorize](https://docs.joinmastodon.org/api/rest/follow-requests/#post-api-v1-follow-requests-id-authorize)
|
||||||
|
- [POST /api/v1/follow_requests/:id/reject](https://docs.joinmastodon.org/api/rest/follow-requests/#post-api-v1-follow-requests-id-reject)
|
||||||
|
|
||||||
298
doc/API-Twitter.md
Normal file
298
doc/API-Twitter.md
Normal file
|
|
@ -0,0 +1,298 @@
|
||||||
|
# Twitter API
|
||||||
|
|
||||||
|
* [Home](help)
|
||||||
|
* [Using the APIs](help/api)
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
Friendica provides the following endpoints defined in the [official Twitter API reference](https://developer.twitter.com/en/docs/api-reference-index).
|
||||||
|
|
||||||
|
Authentication is the same as described in [Using the APIs](help/api#Authentication).
|
||||||
|
|
||||||
|
## Entities
|
||||||
|
|
||||||
|
These endpoints use the [Friendica API entities](help/API-Entities).
|
||||||
|
|
||||||
|
## Different behaviour
|
||||||
|
|
||||||
|
* `screen_name`: The nick name in Friendica is only unique in each network but not for all networks. The users are searched in the following priority: Friendica, StatusNet/GNU Social, Diaspora, pump.io, Twitter. If no contact was found by this way, then the first contact is taken.
|
||||||
|
* `include_entities`: Default is "false". If set to "true" then the plain text is formatted so that links are having descriptions.
|
||||||
|
|
||||||
|
## Friendica-specific return values
|
||||||
|
|
||||||
|
* `cid`: Contact id of the user (important for "contact_allow" and "contact_deny")
|
||||||
|
* `network`: network of the user
|
||||||
|
|
||||||
|
## Unsupported parameters
|
||||||
|
|
||||||
|
* `cursor`
|
||||||
|
* `trim_user`
|
||||||
|
* `contributor_details`
|
||||||
|
* `place_id`
|
||||||
|
* `display_coordinates`
|
||||||
|
* `include_rts`: To-Do
|
||||||
|
* `include_my_retweet`: Retweets in Friendica are implemented in a different way
|
||||||
|
|
||||||
|
## Implemented endpoints
|
||||||
|
|
||||||
|
- [POST api/oauth/access_token](https://developer.twitter.com/en/docs/basics/authentication/api-reference/access_token)
|
||||||
|
- Unsupported parameters:
|
||||||
|
- `x_auth_password`
|
||||||
|
- `x_auth_username`
|
||||||
|
- `x_auth_mode`
|
||||||
|
- [POST api/oauth/request_token](https://developer.twitter.com/en/docs/basics/authentication/api-reference/request_token)
|
||||||
|
- Unsupported parameter:
|
||||||
|
- `x_auth_access_type`
|
||||||
|
|
||||||
|
|
||||||
|
- [GET api/account/verify_credentials](https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/get-account-verify_credentials)
|
||||||
|
- Unsupported parameter:
|
||||||
|
- `include_email`
|
||||||
|
- [POST api/account/update_profile](https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/post-account-update_profile)
|
||||||
|
- Unsupported parameters:
|
||||||
|
- `url`
|
||||||
|
- `location`
|
||||||
|
- `profile_link_color`
|
||||||
|
- `include_entities`
|
||||||
|
- `skip_status`
|
||||||
|
- [POST api/account/update_profile_image](https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/post-account-update_profile_image)
|
||||||
|
- Additional parameter:
|
||||||
|
- `profile_id` (optional): Numerical id of the profile for which the image should be used, default is changing the default profile.
|
||||||
|
|
||||||
|
|
||||||
|
- [POST api/statuses/update](https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-update)
|
||||||
|
- Unsupported parameter:
|
||||||
|
- `display_coordinates`
|
||||||
|
- [POST api/statuses/update_with_media (deprecated)](https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-update_with_media)
|
||||||
|
|
||||||
|
|
||||||
|
- [POST api/media/upload](https://developer.twitter.com/en/docs/media/upload-media/api-reference/post-media-upload)
|
||||||
|
- Additional return value:
|
||||||
|
- `image.friendica_preview_url`: image preview url
|
||||||
|
- [POST api/media/metadata/create](https://developer.twitter.com/en/docs/media/upload-media/api-reference/post-media-metadata-create)
|
||||||
|
|
||||||
|
|
||||||
|
- [GET api/users/show](https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-show)
|
||||||
|
- [GET api/users/search](https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-search)
|
||||||
|
- Unsupported parameters:
|
||||||
|
- `page`
|
||||||
|
- `count`
|
||||||
|
- `include_entities`
|
||||||
|
- [GET api/users/lookup](https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-lookup)
|
||||||
|
- Unsupported parameters:
|
||||||
|
- `screen_name`
|
||||||
|
- `include_entities`
|
||||||
|
|
||||||
|
|
||||||
|
- [GET api/search/tweets](https://developer.twitter.com/en/docs/tweets/search/api-reference/get-search-tweets)
|
||||||
|
- Unsupported parameters:
|
||||||
|
- `geocode`
|
||||||
|
- `lang`
|
||||||
|
- `locale`
|
||||||
|
- `result_type`
|
||||||
|
- `until`
|
||||||
|
- `include_entities`
|
||||||
|
|
||||||
|
|
||||||
|
- [GET api/saved_searches/list](https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/get-saved_searches-list)
|
||||||
|
|
||||||
|
|
||||||
|
- [GET api/statuses/home_timeline](https://developer.twitter.com/en/docs/tweets/timelines/api-reference/get-statuses-home_timeline)
|
||||||
|
- Alias: `GET api/statuses/friends_timeline`
|
||||||
|
- [GET api/statuses/user_timeline](https://developer.twitter.com/en/docs/tweets/timelines/api-reference/get-statuses-user_timeline)
|
||||||
|
- [GET api/statuses/mentions (deprecated)](https://developer.twitter.com/en/docs/tweets/timelines/api-reference/get-statuses-mentions_timeline)
|
||||||
|
- [GET api/statuses/show/:id](https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/get-statuses-show-id)
|
||||||
|
- [POST api/statuses/retweet/:id](https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-retweet-id)
|
||||||
|
- [POST api/statuses/destroy/:id](https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-destroy-id)
|
||||||
|
- [GET api/statuses/followers (deprecated)](https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-followers-list)
|
||||||
|
- Alias: `GET api/statuses/friends`
|
||||||
|
|
||||||
|
|
||||||
|
- [GET api/favorites (deprecated)](https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/get-favorites-list)
|
||||||
|
- Unsupported parameters:
|
||||||
|
- `user_id`: Favorites aren't returned for other users than self
|
||||||
|
- `screen_name`: Favorites aren't returned for other users than self
|
||||||
|
- [POST api/favorites/create](https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-favorites-create)
|
||||||
|
- [POST api/favorites/destroy](https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-favorites-destroy)
|
||||||
|
|
||||||
|
|
||||||
|
- [GET api/lists/list](https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-list)
|
||||||
|
- [GET api/lists/ownerships](https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-ownerships)
|
||||||
|
- Unsupported parameters:
|
||||||
|
- `slug`
|
||||||
|
- `owner_screen_name`
|
||||||
|
- `owner_id`
|
||||||
|
- `include_entities`
|
||||||
|
- [GET api/lists/statuses](https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-statuses)
|
||||||
|
- Unsupported parameters:
|
||||||
|
- `screen_name`
|
||||||
|
- `count`
|
||||||
|
- [GET api/lists/subscriptions](https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-subscriptions)
|
||||||
|
- [POST api/lists/update](https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-update)
|
||||||
|
- Unsupported parameters:
|
||||||
|
- `slug`
|
||||||
|
- `name`
|
||||||
|
- `mode`
|
||||||
|
- `description`
|
||||||
|
- `owner_screen_name`
|
||||||
|
- `owner_id`
|
||||||
|
- [POST api/lists/create](https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-create)
|
||||||
|
- Unsupported parameters:
|
||||||
|
- `mode`
|
||||||
|
- `description`
|
||||||
|
- [POST api/lists/destroy](https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-destroy)
|
||||||
|
- Unsupported parameters:
|
||||||
|
- `owner_screen_name`
|
||||||
|
- `owner_id`
|
||||||
|
- `slug`
|
||||||
|
|
||||||
|
- [GET api/blocks/list](https://developer.twitter.com/en/docs/accounts-and-users/mute-block-report-users/api-reference/get-blocks-list)
|
||||||
|
|
||||||
|
|
||||||
|
- [GET api/friendships/incoming](https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friendships-incoming)
|
||||||
|
- Unsupported parameters
|
||||||
|
- `stringify_ids`
|
||||||
|
- [GET api/followers/ids](https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-followers-ids)
|
||||||
|
- Unsupported parameters:
|
||||||
|
- `user_id`: Relationships aren't returned for other users than self
|
||||||
|
- `screen_name`: Relationships aren't returned for other users than self
|
||||||
|
- [GET api/friends/ids](https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friends-ids)
|
||||||
|
- Unsupported parameters:
|
||||||
|
- `user_id`: Relationships aren't returned for other users than self
|
||||||
|
- `screen_name`: Relationships aren't returned for other users than self
|
||||||
|
|
||||||
|
|
||||||
|
- [POST api/friendships/destroy](https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/post-friendships-destroy)
|
||||||
|
|
||||||
|
|
||||||
|
## Non-implemented endpoints
|
||||||
|
|
||||||
|
- [GET oauth/authenticate](https://developer.twitter.com/en/docs/basics/authentication/api-reference/authenticate)
|
||||||
|
- [GET oauth/authorize](https://developer.twitter.com/en/docs/basics/authentication/api-reference/authorize)
|
||||||
|
- [POST oauth/invalidate_token](https://developer.twitter.com/en/docs/basics/authentication/api-reference/invalidate_access_token)
|
||||||
|
- [POST oauth2/invalidate_token](https://developer.twitter.com/en/docs/basics/authentication/api-reference/invalidate_bearer_token)
|
||||||
|
- [POST oauth2/token](https://developer.twitter.com/en/docs/basics/authentication/api-reference/token)
|
||||||
|
|
||||||
|
|
||||||
|
- [GET lists/members](https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-members)
|
||||||
|
- [GET lists/members/show](https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-members-show)
|
||||||
|
- [GET lists/memberships](https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-memberships)
|
||||||
|
- [GET lists/show](https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-show)
|
||||||
|
- [GET lists/subscribers](https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-subscribers)
|
||||||
|
- [GET lists/subscribers/show](https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-subscribers-show)
|
||||||
|
- [POST lists/members/create](https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-members-create)
|
||||||
|
- [POST lists/members/create_all](https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-members-create_all)
|
||||||
|
- [POST lists/members/destroy](https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-members-destroy)
|
||||||
|
- [POST lists/members/destroy_all](https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-members-destroy_all)
|
||||||
|
- [POST lists/subscribers/create](https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-subscribers-create)
|
||||||
|
- [POST lists/subscribers/destroy](https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-subscribers-destroy)
|
||||||
|
|
||||||
|
|
||||||
|
- [GET followers/list](https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-followers-list)
|
||||||
|
- [GET friends/list](https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friends-list)
|
||||||
|
- [GET friendships/lookup](https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friendships-lookup)
|
||||||
|
- [GET friendships/no_retweets/ids](https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friendships-no_retweets-ids)
|
||||||
|
- [GET friendships/outgoing](https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friendships-outgoing)
|
||||||
|
- [GET friendships/show](https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friendships-show)
|
||||||
|
- [GET users/suggestions (deprecated)](https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-suggestions)
|
||||||
|
- [GET users/suggestions/:slug (deprecated)](https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-suggestions-slug)
|
||||||
|
- [GET users/suggestions/:slug/members (deprecated)](https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-suggestions-slug-members)
|
||||||
|
- [POST friendships/create](https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/post-friendships-create)
|
||||||
|
- [POST friendships/update](https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/post-friendships-update)
|
||||||
|
|
||||||
|
|
||||||
|
- [GET account/settings](https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/get-account-settings)
|
||||||
|
- [GET saved_searches/show/:id](https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/get-saved_searches-show-id)
|
||||||
|
- [GET users/profile_banner](https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/get-users-profile_banner)
|
||||||
|
- [POST account/remove_profile_banner](https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/post-account-remove_profile_banner)
|
||||||
|
- [POST account/settings](https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/post-account-settings)
|
||||||
|
- [POST account/update_profile_background_image (deprecated)](https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/post-account-update_profile_background_image)
|
||||||
|
- [POST account/update_profile_banner](https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/post-account-update_profile_banner)
|
||||||
|
- [POST saved_searches/create](https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/post-saved_searches-create)
|
||||||
|
- [POST saved_searches/destroy/:id](https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/post-saved_searches-destroy-id)
|
||||||
|
|
||||||
|
|
||||||
|
- [GET blocks/ids](https://developer.twitter.com/en/docs/accounts-and-users/mute-block-report-users/api-reference/get-blocks-ids)
|
||||||
|
- [GET mutes/users/ids](https://developer.twitter.com/en/docs/accounts-and-users/mute-block-report-users/api-reference/get-mutes-users-ids)
|
||||||
|
- [GET mutes/users/list](https://developer.twitter.com/en/docs/accounts-and-users/mute-block-report-users/api-reference/get-mutes-users-list)
|
||||||
|
- [POST blocks/create](https://developer.twitter.com/en/docs/accounts-and-users/mute-block-report-users/api-reference/post-blocks-create)
|
||||||
|
- [POST blocks/destroy](https://developer.twitter.com/en/docs/accounts-and-users/mute-block-report-users/api-reference/post-blocks-destroy)
|
||||||
|
- [POST mutes/users/create](https://developer.twitter.com/en/docs/accounts-and-users/mute-block-report-users/api-reference/post-mutes-users-create)
|
||||||
|
- [POST mutes/users/destroy](https://developer.twitter.com/en/docs/accounts-and-users/mute-block-report-users/api-reference/post-mutes-users-destroy)
|
||||||
|
- [POST users/report_spam](https://developer.twitter.com/en/docs/accounts-and-users/mute-block-report-users/api-reference/post-users-report_spam)
|
||||||
|
|
||||||
|
|
||||||
|
- [GET collections/entries](https://developer.twitter.com/en/docs/tweets/curate-a-collection/api-reference/get-collections-entries)
|
||||||
|
- [GET collections/list](https://developer.twitter.com/en/docs/tweets/curate-a-collection/api-reference/get-collections-list)
|
||||||
|
- [GET collections/show](https://developer.twitter.com/en/docs/tweets/curate-a-collection/api-reference/get-collections-show)
|
||||||
|
- [POST collections/create](https://developer.twitter.com/en/docs/tweets/curate-a-collection/api-reference/post-collections-create)
|
||||||
|
- [POST collections/destroy](https://developer.twitter.com/en/docs/tweets/curate-a-collection/api-reference/post-collections-destroy)
|
||||||
|
- [POST collections/entries/add](https://developer.twitter.com/en/docs/tweets/curate-a-collection/api-reference/post-collections-entries-add)
|
||||||
|
- [POST collections/entries/curate](https://developer.twitter.com/en/docs/tweets/curate-a-collection/api-reference/post-collections-entries-curate)
|
||||||
|
- [POST collections/entries/move](https://developer.twitter.com/en/docs/tweets/curate-a-collection/api-reference/post-collections-entries-move)
|
||||||
|
- [POST collections/entries/remove](https://developer.twitter.com/en/docs/tweets/curate-a-collection/api-reference/post-collections-entries-remove)
|
||||||
|
- [POST collections/update](https://developer.twitter.com/en/docs/tweets/curate-a-collection/api-reference/post-collections-update)
|
||||||
|
|
||||||
|
|
||||||
|
- [POST statuses/filter](https://developer.twitter.com/en/docs/tweets/filter-realtime/api-reference/post-statuses-filter)
|
||||||
|
|
||||||
|
|
||||||
|
- [GET statuses/mentions_timeline](https://developer.twitter.com/en/docs/tweets/timelines/api-reference/get-statuses-mentions_timeline)
|
||||||
|
|
||||||
|
|
||||||
|
- [GET favorites/list](https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/get-favorites-list)
|
||||||
|
- [GET statuses/lookup](https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/get-statuses-lookup)
|
||||||
|
- [GET statuses/oembed](https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/get-statuses-oembed)
|
||||||
|
- [GET statuses/retweeters/ids](https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/get-statuses-retweeters-ids)
|
||||||
|
- [GET statuses/retweets/:id](https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/get-statuses-retweets-id)
|
||||||
|
- [GET statuses/retweets_of_me](https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/get-statuses-retweets_of_me)
|
||||||
|
- [POST statuses/unretweet/:id](https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-unretweet-id)
|
||||||
|
|
||||||
|
|
||||||
|
- [GET statuses/sample](https://developer.twitter.com/en/docs/tweets/sample-realtime/api-reference/get-statuses-sample)
|
||||||
|
|
||||||
|
|
||||||
|
- [GET compliance/firehose](https://developer.twitter.com/en/docs/tweets/compliance/api-reference/compliance-firehose)
|
||||||
|
|
||||||
|
|
||||||
|
- [DELETE custom_profiles/destroy.json](https://developer.twitter.com/en/docs/direct-messages/custom-profiles/api-reference/delete-profile)
|
||||||
|
- [GET custom_profiles/:id](https://developer.twitter.com/en/docs/direct-messages/custom-profiles/api-reference/get-profile)
|
||||||
|
- [GET custom_profiles/list](https://developer.twitter.com/en/docs/direct-messages/custom-profiles/api-reference/get-profile-list)
|
||||||
|
- [POST custom_profiles/new.json](https://developer.twitter.com/en/docs/direct-messages/custom-profiles/api-reference/new-profile)
|
||||||
|
|
||||||
|
|
||||||
|
- [DELETE direct_messages/events/destroy](https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/delete-message-event)
|
||||||
|
- [GET direct_messages/events/list](https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/list-events)
|
||||||
|
- [GET direct_messages/events/show](https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/get-event)
|
||||||
|
- [POST direct_messages/events/new (message_create)](https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/new-event)
|
||||||
|
- [POST direct_messages/indicate_typing](https://developer.twitter.com/en/docs/direct-messages/typing-indicator-and-read-receipts/api-reference/new-typing-indicator)
|
||||||
|
- [POST direct_messages/mark_read](https://developer.twitter.com/en/docs/direct-messages/typing-indicator-and-read-receipts/api-reference/new-read-receipt)
|
||||||
|
|
||||||
|
|
||||||
|
- [DELETE direct_messages/welcome_messages/destroy](https://developer.twitter.com/en/docs/direct-messages/welcome-messages/api-reference/delete-welcome-message)
|
||||||
|
- [DELETE direct_messages/welcome_messages/rules/destroy](https://developer.twitter.com/en/docs/direct-messages/welcome-messages/api-reference/delete-welcome-message-rule)
|
||||||
|
- [PUT direct_messages/welcome_messages/update](https://developer.twitter.com/en/docs/direct-messages/welcome-messages/api-reference/update-welcome-message)
|
||||||
|
- [GET direct_messages/welcome_messages/list](https://developer.twitter.com/en/docs/direct-messages/welcome-messages/api-reference/list-welcome-messages)
|
||||||
|
- [GET direct_messages/welcome_messages/rules/list](https://developer.twitter.com/en/docs/direct-messages/welcome-messages/api-reference/list-welcome-message-rules)
|
||||||
|
- [GET direct_messages/welcome_messages/rules/show](https://developer.twitter.com/en/docs/direct-messages/welcome-messages/api-reference/get-welcome-message-rule)
|
||||||
|
- [GET direct_messages/welcome_messages/show](https://developer.twitter.com/en/docs/direct-messages/welcome-messages/api-reference/get-welcome-message)
|
||||||
|
- [POST direct_messages/welcome_messages/new](https://developer.twitter.com/en/docs/direct-messages/welcome-messages/api-reference/new-welcome-message)
|
||||||
|
- [POST direct_messages/welcome_messages/rules/new](https://developer.twitter.com/en/docs/direct-messages/welcome-messages/api-reference/new-welcome-message-rule)
|
||||||
|
|
||||||
|
|
||||||
|
- [GET media/upload (STATUS)](https://developer.twitter.com/en/docs/media/upload-media/api-reference/get-media-upload-status)
|
||||||
|
- [POST media/subtitles/create](https://developer.twitter.com/en/docs/media/upload-media/api-reference/post-media-subtitles-create)
|
||||||
|
- [POST media/subtitles/delete](https://developer.twitter.com/en/docs/media/upload-media/api-reference/post-media-subtitles-delete)
|
||||||
|
- [POST media/upload (APPEND)](https://developer.twitter.com/en/docs/media/upload-media/api-reference/post-media-upload-append)
|
||||||
|
- [POST media/upload (FINALIZE)](https://developer.twitter.com/en/docs/media/upload-media/api-reference/post-media-upload-finalize)
|
||||||
|
- [POST media/upload (INIT)](https://developer.twitter.com/en/docs/media/upload-media/api-reference/post-media-upload-init)
|
||||||
|
|
||||||
|
|
||||||
|
- [GET trends/available](https://developer.twitter.com/en/docs/trends/locations-with-trending-topics/api-reference/get-trends-available)
|
||||||
|
- [GET trends/closest](https://developer.twitter.com/en/docs/trends/locations-with-trending-topics/api-reference/get-trends-closest)
|
||||||
|
- [GET trends/place](https://developer.twitter.com/en/docs/trends/trends-for-location/api-reference/get-trends-place)
|
||||||
|
|
||||||
|
|
||||||
|
- [GET geo/id/:place_id](https://developer.twitter.com/en/docs/geo/place-information/api-reference/get-geo-id-place_id)
|
||||||
|
- [GET geo/reverse_geocode](https://developer.twitter.com/en/docs/geo/places-near-location/api-reference/get-geo-reverse_geocode)
|
||||||
|
- [GET geo/search](https://developer.twitter.com/en/docs/geo/places-near-location/api-reference/get-geo-search)
|
||||||
1427
doc/api.md
1427
doc/api.md
File diff suppressed because it is too large
Load diff
Loading…
Reference in a new issue