224 lines
6.5 KiB
Markdown
224 lines
6.5 KiB
Markdown
---
|
|
title: instance
|
|
description: Informational endpoint to discover information about a Mastodon website.
|
|
menu:
|
|
docs:
|
|
weight: 70
|
|
parent: methods
|
|
identifier: methods-instance
|
|
---
|
|
|
|
{{< api-method method="get" host="https://mastodon.example" path="/api/v1/instance" title="Fetch instance" >}}
|
|
{{< api-method-description >}}
|
|
|
|
Information about the server.
|
|
|
|
**Returns:** Instance\
|
|
**OAuth:** Public\
|
|
**Version history:**
|
|
|
|
- 1.1.0 - added
|
|
- 3.0.0 - requires user token if instance is in whitelist mode
|
|
- 3.1.4 - added `invites_enabled` to response
|
|
|
|
{{< endapi-method-description >}}
|
|
{{< api-method-spec >}}
|
|
{{< api-method-request >}}
|
|
{{< api-method-response >}}
|
|
{{< api-method-response-example httpCode=200 >}}
|
|
{{< api-method-response-example-description >}}
|
|
{{< endapi-method-response-example-description >}}
|
|
|
|
|
|
```javascript
|
|
|
|
"uri": "mastodon.social",
|
|
"title": "Mastodon",
|
|
"short_description": "Server run by the main developers of the project <img draggable=\"false\" alt=\"🐘\" class=\"emojione\" src=\"https://mastodon.social/emoji/1f418.svg\" /> It is not focused on any particular niche interest - everyone is welcome as long as you follow our code of conduct!",
|
|
"description": "Server run by the main developers of the project <img draggable=\"false\" alt=\"🐘\" class=\"emojione\" src=\"https://mastodon.social/emoji/1f418.svg\" /> It is not focused on any particular niche interest - everyone is welcome as long as you follow our code of conduct!",
|
|
"email": "staff@mastodon.social",
|
|
"version": "3.0.1",
|
|
"urls": {
|
|
"streaming_api": "wss://mastodon.social"
|
|
},
|
|
"stats": {
|
|
"user_count": 415526,
|
|
"status_count": 17085754,
|
|
"domain_count": 11834
|
|
},
|
|
"thumbnail": "https://files.mastodon.social/site_uploads/files/000/000/001/original/vlcsnap-2018-08-27-16h43m11s127.png",
|
|
"languages": [
|
|
"en"
|
|
],
|
|
"registrations": true,
|
|
"approval_required": false,
|
|
"contact_account": {
|
|
"id": "1",
|
|
"username": "Gargron",
|
|
"acct": "Gargron",
|
|
"display_name": "Eugen",
|
|
"locked": false,
|
|
"bot": false,
|
|
"created_at": "2016-03-16T14:34:26.392Z",
|
|
"note": "<p>Developer of Mastodon and administrator of mastodon.social. I post service announcements, development updates, and personal stuff.</p>",
|
|
"url": "https://mastodon.social/@Gargron",
|
|
"avatar": "https://files.mastodon.social/accounts/avatars/000/000/001/original/d96d39a0abb45b92.jpg",
|
|
"avatar_static": "https://files.mastodon.social/accounts/avatars/000/000/001/original/d96d39a0abb45b92.jpg",
|
|
"header": "https://files.mastodon.social/accounts/headers/000/000/001/original/c91b871f294ea63e.png",
|
|
"header_static": "https://files.mastodon.social/accounts/headers/000/000/001/original/c91b871f294ea63e.png",
|
|
"followers_count": 317112,
|
|
"following_count": 453,
|
|
"statuses_count": 60903,
|
|
"last_status_at": "2019-11-26T21:14:44.522Z",
|
|
"emojis": [],
|
|
"fields": [
|
|
{
|
|
"name": "Patreon",
|
|
"value": "<a href=\"https://www.patreon.com/mastodon\" rel=\"me nofollow noopener noreferrer\" target=\"_blank\"><span class=\"invisible\">https://www.</span><span class=\"\">patreon.com/mastodon</span><span class=\"invisible\"></span></a>",
|
|
"verified_at": null
|
|
},
|
|
{
|
|
"name": "Homepage",
|
|
"value": "<a href=\"https://zeonfederated.com\" rel=\"me nofollow noopener noreferrer\" target=\"_blank\"><span class=\"invisible\">https://</span><span class=\"\">zeonfederated.com</span><span class=\"invisible\"></span></a>",
|
|
"verified_at": "2019-07-15T18:29:57.191+00:00"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
```
|
|
{{< endapi-method-response-example >}}
|
|
{{< endapi-method-response >}}
|
|
{{< endapi-method-spec >}}
|
|
{{< endapi-method >}}
|
|
{{< api-method method="get" host="https://mastodon.example" path="/api/v1/instance/peers" title="List of connected domains" >}}
|
|
{{< api-method-description >}}
|
|
|
|
Domains that this instance is aware of.
|
|
|
|
**Returns:** Array of String\
|
|
**OAuth:** Public\
|
|
**Version history:**
|
|
|
|
- 2.1.2 - added
|
|
- 3.0.0 - requires user token if instance is in whitelist mode
|
|
|
|
{{< endapi-method-description >}}
|
|
{{< api-method-spec >}}
|
|
{{< api-method-request >}}
|
|
{{< api-method-response >}}
|
|
{{< api-method-response-example httpCode=200 >}}
|
|
{{< api-method-response-example-description >}}
|
|
{{< endapi-method-response-example-description >}}
|
|
|
|
|
|
```javascript
|
|
["tilde.zone","mspsocial.net",...,"conf.tube"]
|
|
```
|
|
{{< endapi-method-response-example >}}
|
|
{{< endapi-method-response >}}
|
|
{{< endapi-method-spec >}}
|
|
{{< endapi-method >}}
|
|
{{< api-method method="get" host="https://mastodon.example" path="/api/v1/instance/activity" title="Weekly activity" >}}
|
|
{{< api-method-description >}}
|
|
|
|
Instance activity over the last 3 months, binned weekly.
|
|
|
|
**Returns:** Array of Activity\
|
|
**OAuth:** Public\
|
|
**Version history:**
|
|
|
|
- 2.1.2 - added
|
|
- 3.0.0 - requires user token if instance is in whitelist mode
|
|
|
|
{{< endapi-method-description >}}
|
|
{{< api-method-spec >}}
|
|
{{< api-method-request >}}
|
|
{{< api-method-response >}}
|
|
{{< api-method-response-example httpCode=200 >}}
|
|
{{< api-method-response-example-description >}}
|
|
{{< endapi-method-response-example-description >}}
|
|
|
|
|
|
```
|
|
[
|
|
{
|
|
"week": "1574640000",
|
|
"statuses": "37125",
|
|
"logins": "14239",
|
|
"registrations": "542"
|
|
},
|
|
{
|
|
"week": "1574035200",
|
|
"statuses": "244447",
|
|
"logins": "28820",
|
|
"registrations": "4425"
|
|
},
|
|
{
|
|
"week": "1573430400",
|
|
"statuses": "270615",
|
|
"logins": "35388",
|
|
"registrations": "8781"
|
|
},
|
|
{
|
|
"week": "1572825600",
|
|
"statuses": "309722",
|
|
"logins": "44433",
|
|
"registrations": "26165"
|
|
},
|
|
{
|
|
"week": "1572220800",
|
|
"statuses": "116227",
|
|
"logins": "19739",
|
|
"registrations": "2926"
|
|
},
|
|
{
|
|
"week": "1571616000",
|
|
"statuses": "119932",
|
|
"logins": "19247",
|
|
"registrations": "3188"
|
|
},
|
|
{
|
|
"week": "1571011200",
|
|
"statuses": "117892",
|
|
"logins": "19164",
|
|
"registrations": "3107"
|
|
},
|
|
{
|
|
"week": "1570406400",
|
|
"statuses": "109092",
|
|
"logins": "18763",
|
|
"registrations": "2986"
|
|
},
|
|
{
|
|
"week": "1569801600",
|
|
"statuses": "107554",
|
|
"logins": "19614",
|
|
"registrations": "2904"
|
|
},
|
|
{
|
|
"week": "1569196800",
|
|
"statuses": "118067",
|
|
"logins": "19703",
|
|
"registrations": "3295"
|
|
},
|
|
{
|
|
"week": "1568592000",
|
|
"statuses": "110199",
|
|
"logins": "19791",
|
|
"registrations": "3026"
|
|
},
|
|
{
|
|
"week": "1567987200",
|
|
"statuses": "106029",
|
|
"logins": "19089",
|
|
"registrations": "2769"
|
|
}
|
|
]
|
|
```
|
|
{{< endapi-method-response-example >}}
|
|
{{< endapi-method-response >}}
|
|
{{< endapi-method-spec >}}
|
|
{{< endapi-method >}}
|
|
|
|
|