zelo72
/
documentation
mirror of https://github.com/mastodon/documentation
1
0
Fork 0
Code Issues 6 Releases Wiki Activity

Reformates all tables 

Because of my OCD.
This commit is contained in:
Ornithologist Coder 2017-05-01 20:01:32 +02:00 committed by GitHub
parent cda33062e8
commit 014ec91ba3
1 changed files with 121 additions and 120 deletions
Using-the-API
API.md

85
Using-the-API/API.md
View File

@ -40,8 +40,8 @@ ___
## Available libraries
| Language | Library | Developer(s) |
|-------|--------|------------|
| .Net | [Mastodon.Net](https://github.com/Tlaster/Mastodon.Net) | |
| -------------------- | --------------------------------------------------------------- | ------------------------------------------------------------------------------ |
| .NET | [Mastodon.Net](https://github.com/Tlaster/Mastodon.Net) | |
| .NET Standard | [Mastonet](https://github.com/glacasa/Mastonet) | |
| C# | [mastodon-api-cs](https://github.com/pawotter/mastodon-api-cs) | |
| C# (.NET Standard) | [Mastodot](https://github.com/yamachu/Mastodot) | |
@ -108,8 +108,8 @@ Returns the authenticated user's [Account](#account).
Form data:
| field | description | optional |
|-------|-------------|-----------|
| Field | Description | Optional |
| -------------- | -------------------------------------------------------------------------------------------------------------------------------------- | ---------- |
| `display_name` | The name to display in the user's profile | yes |
| `note` | A new biography for the user | yes |
| `avatar` | A base64 encoded image to display as the user's avatar (e.g. `data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAUoAAADrCAYAAAA...`) | yes |
@ -121,8 +121,8 @@ Form data:
Query parameters:
| field | description | optional |
|-------|-------------|----------|
| Field | Description | Optional |
| ---------- | -------------------------------------------------------------- | ---------- |
| `max_id` | Get a list of followers with ID less than or equal this value | yes |
| `since_id` | Get a list of followers with ID greater than this value | yes |
| `limit` | Maximum number of accounts to get (Default 40, Max 80) | yes |
@ -137,8 +137,8 @@ Returns an array of [Accounts](#account).
Query parameters:
| field | description | optional |
|-------|-------------|----------|
| Field | Description | Optional |
| ---------- | -------------------------------------------------------------- | ---------- |
| `max_id` | Get a list of followings with ID less than or equal this value | yes |
| `since_id` | Get a list of followings with ID greater than this value | yes |
| `limit` | Maximum number of accounts to get (Default 40, Max 80) | yes |
@ -153,8 +153,8 @@ Returns an array of [Accounts](#account).
Query parameters:
| field | description | optional |
|-------|-------------|----------|
| Field | Description | Optional |
| ----------------- | ----------------------------------------------------------- | ---------- |
| `only_media` | Only return statuses that have media attachments | yes |
| `exclude_replies` | Skip statuses that reply to other statuses | yes |
| `max_id` | Get a list of statuses with ID less than or equal this value | yes |
@ -192,8 +192,8 @@ Returns the target account's [Relationship](#relationship).
Query parameters:
| field | description | optional |
|-------|-------------|----------|
| Field | Description | Optional |
| ----- | ---------------------------- | ---------- |
| `id` | Account IDs (can be an array) | no |
Returns an array of [Relationships](#relationships) of the current user to a list of given accounts.
@ -204,8 +204,8 @@ Returns an array of [Relationships](#relationships) of the current user to a lis
Query parameters:
| field | description | optional |
|-------|-------------|----------|
| Field | Description | Optional |
| ----------------- | ------------------------------------------------------------- | ---------- |
| `q` | What to search for | no |
| `limit` | Maximum number of matching accounts to return (default: `40`) | yes |
@ -221,8 +221,8 @@ Will lookup an account remotely if the search term is in the `username@domain` f
Form data:
| field | description | optional |
|-------|-------------|----------|
| Field | Description | Optional |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- |
| `client_name` | Name of your application | no |
| `redirect_uris` | Where the user should be redirected after authorization (for no redirect, use `urn:ietf:wg:oauth:2.0:oob`) | no |
| `scopes` | This can be a space-separated list of the following items: "read", "write" and "follow" (see [this page](OAuth-details.md) for details on what the scopes do) | no |
@ -242,8 +242,8 @@ These values should be requested in the app itself from the API for each new app
Query parameters:
| field | description | optional |
|-------|-------------|----------|
| Field | Description | Optional |
| ----------------- | ------------------------------------------------------------- | ---------- |
| `max_id` | Get a list of blocks with ID less than or equal this value | yes |
| `since_id` | Get a list of blocks with ID greater than this value | yes |
| `limit` | Maximum number of accounts to get (Default 40, Max 80) | yes |
@ -260,8 +260,8 @@ Returns an array of [Accounts](#account) blocked by the authenticated user.
Query parameters:
| field | description | optional |
|-------|-------------|----------|
| Field | Description | Optional |
| ----------------- | -------------------------------------------------------------- | ---------- |
| `max_id` | Get a list of favourites with ID less than or equal this value | yes |
| `since_id` | Get a list of favourites with ID greater than this value | yes |
| `limit` | Maximum number of accounts to get (Default 20, Max 40) | yes |
@ -278,8 +278,8 @@ Returns an array of [Statuses](#status) favourited by the authenticated user.
Query parameters:
| field | description | optional |
|-------|-------------|----------|
| Field | Description | Optional |
| ----------------- | ------------------------------------------------------------------- | ---------- |
| `max_id` | Get a list of follow requests with ID less than or equal this value | yes |
| `since_id` | Get a list of follow requests with ID greater than this value | yes |
| `limit` | Maximum number of accounts to get (Default 40, Max 80) | yes |
@ -295,8 +295,8 @@ Returns an array of [Accounts](#account) which have requested to follow the auth
Parameters:
| field | description | optional |
|-------|-------------|----------|
| Field | Description | Optional |
| ----------------- | ------------------------------------------------------------------- | ---------- |
| `id` | The id of the account to authorize or reject | no |
Returns an empty object.
@ -309,8 +309,8 @@ Returns an empty object.
Form data:
| field | description | optional |
|-------|-------------|----------|
| Field | Description | Optional |
| ----------------- | ------------------------------------------------------------------- | ---------- |
| `uri` | `username@domain` of the person you want to follow | no |
Returns the local representation of the followed account, as an [Account](#account).
@ -333,8 +333,8 @@ Does not require authentication.
Form data:
| field | description | optional |
|-------|-------------|----------|
| Field | Description | Optional |
| ----------------- | ------------------------------------------------------------------- | ---------- |
| `file` | Media to be uploaded | no |
Returns an [Attachment](#attachment) that can be used when creating a status.
@ -347,8 +347,8 @@ Returns an [Attachment](#attachment) that can be used when creating a status.
Query parameters:
| field | description | optional |
|-------|-------------|----------|
| Field | Description | Optional |
| ----------------- | ------------------------------------------------------------------- | ---------- |
| `max_id` | Get a list of mutes with ID less than or equal this value | yes |
| `since_id` | Get a list of mutes with ID greater than this value | yes |
| `limit` | Maximum number of accounts to get (Default 40, Max 80) | yes |
@ -365,8 +365,8 @@ Returns an array of [Accounts](#account) muted by the authenticated user.
Query parameters:
| field | description | optional |
|-------|-------------|----------|
| Field | Description | Optional |
| ----------------- | ------------------------------------------------------------------- | ---------- |
| `max_id` | Get a list of notifications with ID less than or equal this value | yes |
| `since_id` | Get a list of notifications with ID greater than this value | yes |
| `limit` | Maximum number of accounts to get (Default 15, Max 30) | yes |
@ -402,8 +402,8 @@ Returns a list of [Reports](#report) made by the authenticated user.
Form data:
| field | description | optional |
|-------|-------------|----------|
| Field | Description | Optional |
| ----------------- | ------------------------------------------------------------------- | ---------- |
| `account_id` | The ID of the account to report | no |
| `status_ids` | The IDs of statuses to report (can be an array) | no |
| `comment` | A comment to associate with the report | no |
@ -418,8 +418,8 @@ Returns the finished [Report](#report).
Form data:
| field | description | optional |
|-------|-------------|----------|
| Field | Description | Optional |
| ----------------- | ------------------------------------------------------------------- | ---------- |
| `q` | The search query | no |
| `resolve` | Whether to resolve non-local accounts | no |
@ -462,8 +462,8 @@ Does not require authentication.
Query parameters:
| field | description | optional |
|-------|-------------|----------|
| Field | Description | Optional |
| ----------------- | ------------------------------------------------------------------------ | ---------- |
| `max_id` | Get a list of reblogged/favourited with ID less than or equal this value | yes |
| `since_id` | Get a list of reblogged/favourited with ID greater than this value | yes |
| `limit` | Maximum number of accounts to get (Default 40, Max 80) | yes |
@ -480,8 +480,8 @@ Does not require authentication.
Form data:
| field | description | optional |
|-------|-------------|----------|
| Field | Description | Optional |
| ----------------- | ------------------------------------------------------------------------ | ---------- |
| `status` | The text of the status | no |
| `in_reply_to_id` | local ID of the status you want to reply to | yes |
| `media_ids` | Array of media IDs to attach to the status (maximum 4) | yes |
@ -521,8 +521,8 @@ Returns the target [Status](#status).
Query parameters:
| field | description | optional |
|-------|-------------|----------|
| Field | Description | Optional |
| ----------------- | ----------------------------------------------------------------------------------- | ---------- |
| `local` | Only return statuses originating from this instance (public and tag timelines only) | yes |
| `max_id` | Get a list of timelines with ID less than or equal this value | yes |
| `since_id` | Get a list of timelines with ID greater than this value | yes |
@ -533,6 +533,7 @@ Query parameters:
Returns an array of [Statuses](#status), most recent ones first.
'public' and 'tag' timelines do not require authentication.
___
## Entities