PeerTube
cpy · Social
The PeerTube API is built on HTTP(S) and is RESTful. You can use your favorite HTTP/REST library for your programming language to use PeerTube. The spec API is fully compatible with [openapi-generator](https://github.com/OpenAPITools/openapi-generator/wiki/API-client-generator-HOWTO) which generates a client SDK in the language of your choice - we generate some client SDKs automatically: - [Python](https://framagit.org/framasoft/peertube/clients/python) - [Go](https://framagit.org/framasoft/pee
Authentication
Sample Requests
List abuses
Hover any highlighted part to learn what it does
curl -X GET "https://api.apis.guru/v2/specs/cpy.re/peertube/5.1.0/api/v1/abuses?id=1&sort=-id&count=15&start=1&state=example&filter=video&search=hello&videoIs=deleted&searchVideo=example&searchReportee=example&searchReporter=example&predefinedReason=example&searchVideoChannel=example"
import requests
params = {
"id": "1",
"sort": "-id",
"count": "15",
"start": "1",
"state": "example",
"filter": "video",
"search": "hello",
"videoIs": "deleted",
"searchVideo": "example",
"searchReportee": "example",
"searchReporter": "example",
"predefinedReason": "example",
"searchVideoChannel": "example"
}
response = requests.get(
"https://api.apis.guru/v2/specs/cpy.re/peertube/5.1.0/api/v1/abuses",
params=params,
)
print(response.json())const url = new URL('https://api.apis.guru/v2/specs/cpy.re/peertube/5.1.0/api/v1/abuses');
url.searchParams.set('id', '1');
url.searchParams.set('sort', '-id');
url.searchParams.set('count', '15');
url.searchParams.set('start', '1');
url.searchParams.set('state', 'example');
url.searchParams.set('filter', 'video');
url.searchParams.set('search', 'hello');
url.searchParams.set('videoIs', 'deleted');
url.searchParams.set('searchVideo', 'example');
url.searchParams.set('searchReportee', 'example');
url.searchParams.set('searchReporter', 'example');
url.searchParams.set('predefinedReason', 'example');
url.searchParams.set('searchVideoChannel', 'example');
const response = await fetch(url);
const data = await response.json();
console.log(data);package main
import (
"fmt"
"io"
"net/http"
"net/url"
)
func main() {
baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/cpy.re/peertube/5.1.0/api/v1/abuses")
q := baseURL.Query()
q.Set("id", "1")
q.Set("sort", "-id")
q.Set("count", "15")
q.Set("start", "1")
q.Set("state", "example")
q.Set("filter", "video")
q.Set("search", "hello")
q.Set("videoIs", "deleted")
q.Set("searchVideo", "example")
q.Set("searchReportee", "example")
q.Set("searchReporter", "example")
q.Set("predefinedReason", "example")
q.Set("searchVideoChannel", "example")
baseURL.RawQuery = q.Encode()
targetURL := baseURL.String()
req, _ := http.NewRequest("GET", targetURL, nil)
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}require "net/http"
require "json"
uri = URI("https://api.apis.guru/v2/specs/cpy.re/peertube/5.1.0/api/v1/abuses")
uri.query = URI.encode_www_form({
"id" => "1",
"sort" => "-id",
"count" => "15",
"start" => "1",
"state" => "example",
"filter" => "video",
"search" => "hello",
"videoIs" => "deleted",
"searchVideo" => "example",
"searchReportee" => "example",
"searchReporter" => "example",
"predefinedReason" => "example",
"searchVideoChannel" => "example"
})
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"
req = Net::HTTP::Get.new(uri)
res = http.request(req)
puts JSON.parse(res.body)<?php
$url = "https://api.apis.guru/v2/specs/cpy.re/peertube/5.1.0/api/v1/abuses?" . http_build_query([
"id" => "1",
"sort" => "-id",
"count" => "15",
"start" => "1",
"state" => "example",
"filter" => "video",
"search" => "hello",
"videoIs" => "deleted",
"searchVideo" => "example",
"searchReportee" => "example",
"searchReporter" => "example",
"predefinedReason" => "example",
"searchVideoChannel" => "example"
]);
$opts = ["http" => [
"method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));List plugins
Hover any highlighted part to learn what it does
curl -X GET "https://api.apis.guru/v2/specs/cpy.re/peertube/5.1.0/api/v1/plugins?sort=-createdAt&count=15&start=1&pluginType=1&uninstalled=true"
import requests
params = {
"sort": "-createdAt",
"count": "15",
"start": "1",
"pluginType": "1",
"uninstalled": "true"
}
response = requests.get(
"https://api.apis.guru/v2/specs/cpy.re/peertube/5.1.0/api/v1/plugins",
params=params,
)
print(response.json())const url = new URL('https://api.apis.guru/v2/specs/cpy.re/peertube/5.1.0/api/v1/plugins');
url.searchParams.set('sort', '-createdAt');
url.searchParams.set('count', '15');
url.searchParams.set('start', '1');
url.searchParams.set('pluginType', '1');
url.searchParams.set('uninstalled', 'true');
const response = await fetch(url);
const data = await response.json();
console.log(data);package main
import (
"fmt"
"io"
"net/http"
"net/url"
)
func main() {
baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/cpy.re/peertube/5.1.0/api/v1/plugins")
q := baseURL.Query()
q.Set("sort", "-createdAt")
q.Set("count", "15")
q.Set("start", "1")
q.Set("pluginType", "1")
q.Set("uninstalled", "true")
baseURL.RawQuery = q.Encode()
targetURL := baseURL.String()
req, _ := http.NewRequest("GET", targetURL, nil)
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}require "net/http"
require "json"
uri = URI("https://api.apis.guru/v2/specs/cpy.re/peertube/5.1.0/api/v1/plugins")
uri.query = URI.encode_www_form({
"sort" => "-createdAt",
"count" => "15",
"start" => "1",
"pluginType" => "1",
"uninstalled" => "true"
})
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"
req = Net::HTTP::Get.new(uri)
res = http.request(req)
puts JSON.parse(res.body)<?php
$url = "https://api.apis.guru/v2/specs/cpy.re/peertube/5.1.0/api/v1/plugins?" . http_build_query([
"sort" => "-createdAt",
"count" => "15",
"start" => "1",
"pluginType" => "1",
"uninstalled" => "true"
]);
$opts = ["http" => [
"method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));Get block status of accounts/hosts
Hover any highlighted part to learn what it does
curl -X GET "https://api.apis.guru/v2/specs/cpy.re/peertube/5.1.0/api/v1/blocklist/status?hosts=example&accounts=example"
import requests
params = {
"hosts": "example",
"accounts": "example"
}
response = requests.get(
"https://api.apis.guru/v2/specs/cpy.re/peertube/5.1.0/api/v1/blocklist/status",
params=params,
)
print(response.json())const url = new URL('https://api.apis.guru/v2/specs/cpy.re/peertube/5.1.0/api/v1/blocklist/status');
url.searchParams.set('hosts', 'example');
url.searchParams.set('accounts', 'example');
const response = await fetch(url);
const data = await response.json();
console.log(data);package main
import (
"fmt"
"io"
"net/http"
"net/url"
)
func main() {
baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/cpy.re/peertube/5.1.0/api/v1/blocklist/status")
q := baseURL.Query()
q.Set("hosts", "example")
q.Set("accounts", "example")
baseURL.RawQuery = q.Encode()
targetURL := baseURL.String()
req, _ := http.NewRequest("GET", targetURL, nil)
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}require "net/http"
require "json"
uri = URI("https://api.apis.guru/v2/specs/cpy.re/peertube/5.1.0/api/v1/blocklist/status")
uri.query = URI.encode_www_form({
"hosts" => "example",
"accounts" => "example"
})
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"
req = Net::HTTP::Get.new(uri)
res = http.request(req)
puts JSON.parse(res.body)<?php
$url = "https://api.apis.guru/v2/specs/cpy.re/peertube/5.1.0/api/v1/blocklist/status?" . http_build_query([
"hosts" => "example",
"accounts" => "example"
]);
$opts = ["http" => [
"method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));Postman Setup Guide
- See official documentation for authentication and setup.
What can you build with PeerTube?
PeerTube is a Social API. Developers commonly use social APIs for:
- adding social login (Sign in with Google/Twitter)
- fetching user-generated content for analysis
- scheduling and publishing social posts
- tracking mentions and engagement metrics
- building community dashboards
No authentication required. This API is open — no signup or key needed. Ideal for quick prototypes and public-facing features. PeerTube is free to use, making it a low-risk choice to experiment with.
New to APIs? Read our beginner's guide · Learn about API keys · What is REST?