Search & hashtags

GET/api/v2/search

Search

Mastodon compatible Supports _pe User token Scope read

Query parameters

qstringrequired

typestring

resolveboolean

limitinteger

offsetinteger

account_idstring

_peboolean

Returns

curl "https://pixelfed.social/api/v2/search?q=dansup&limit=5" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $TOKEN"

const res = await fetch("https://pixelfed.social/api/v2/search?q=dansup&limit=5", {
  headers: {
    Accept: "application/json",
    Authorization: `Bearer ${token}`,
  },
});

const results = await res.json();

import requests

res = requests.get(
    "https://pixelfed.social/api/v2/search",
    headers={"Accept": "application/json", "Authorization": f"Bearer {token}"},
    params={
        "q": "dansup",
        "limit": 5,
    },
)

results = res.json()

use Illuminate\Support\Facades\Http;

$results = Http::acceptJson()
    ->withToken($token)
    ->get('https://pixelfed.social/api/v2/search', [
        'q' => 'dansup',
        'limit' => 5,
    ])
    ->json();

Response

{
  "accounts": [{
    "id": "2",
    "username": "dansup",
    "acct": "dansup",
    "display_name": "dansup",
    "locked": false,
    "bot": false,
    "discoverable": true,
    "followers_count": 318,
    "following_count": 204,
    "statuses_count": 96,
    "note": "Harbour walks and film cameras.",
    "url": "https://pixelfed.social/dansup",
    "avatar": "https://pixelfed.social/storage/avatars/412/760/avatar.jpg",
    "avatar_static": "https://pixelfed.social/storage/avatars/412/760/avatar.jpg",
    "header": "https://pixelfed.social/storage/headers/missing.png",
    "header_static": "https://pixelfed.social/storage/headers/missing.png",
    "emojis": [],
    "fields": [],
    "created_at": "2024-03-02T15:20:11.000Z",
    "last_status_at": null
  }],
  "hashtags": [{
    "name": "marathon",
    "url": "https://pixelfed.social/discover/tags/marathon"
  }],
  "statuses": []
}

{
  "message": "The q field is required.",
  "errors": {
    "q": ["The q field is required."]
  }
}

GET/api/v1/trends

Trending hashtags

Mastodon compatible User token Scope read

Returns

curl "https://pixelfed.social/api/v1/trends" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $TOKEN"

const res = await fetch("https://pixelfed.social/api/v1/trends", {
  headers: {
    Accept: "application/json",
    Authorization: `Bearer ${token}`,
  },
});

const trends = await res.json();

import requests

res = requests.get(
    "https://pixelfed.social/api/v1/trends",
    headers={"Accept": "application/json", "Authorization": f"Bearer {token}"},
)

trends = res.json()

use Illuminate\Support\Facades\Http;

$trends = Http::acceptJson()
    ->withToken($token)
    ->get('https://pixelfed.social/api/v1/trends')
    ->json();

Response

[]

{
  "error": "Unauthenticated."
}

GET/api/v1/tags/{id}

Get a hashtag

Mastodon compatible Supports _pe User token

Path parameters

idstringrequired

Query parameters

_peboolean

Returns

curl "https://pixelfed.social/api/v1/tags/goldenhour" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $TOKEN"

const res = await fetch("https://pixelfed.social/api/v1/tags/goldenhour", {
  headers: {
    Accept: "application/json",
    Authorization: `Bearer ${token}`,
  },
});

const tag = await res.json();

import requests

res = requests.get(
    "https://pixelfed.social/api/v1/tags/goldenhour",
    headers={"Accept": "application/json", "Authorization": f"Bearer {token}"},
)

tag = res.json()

use Illuminate\Support\Facades\Http;

$tag = Http::acceptJson()
    ->withToken($token)
    ->get('https://pixelfed.social/api/v1/tags/goldenhour')
    ->json();

Response

{
  "name": "goldenhour",
  "url": "https://pixelfed.social/i/web/hashtag/goldenhour",
  "history": [],
  "following": true
}

{
  "error": "Unauthenticated."
}

GET/api/v1/tags/{id}/related

Related hashtags

Pixelfed only User token Scope read

Path parameters

idstringrequired

Returns

curl "https://pixelfed.social/api/v1/tags/goldenhour/related" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $TOKEN"

const res = await fetch("https://pixelfed.social/api/v1/tags/goldenhour/related", {
  headers: {
    Accept: "application/json",
    Authorization: `Bearer ${token}`,
  },
});

const related = await res.json();

import requests

res = requests.get(
    "https://pixelfed.social/api/v1/tags/goldenhour/related",
    headers={"Accept": "application/json", "Authorization": f"Bearer {token}"},
)

related = res.json()

use Illuminate\Support\Facades\Http;

$related = Http::acceptJson()
    ->withToken($token)
    ->get('https://pixelfed.social/api/v1/tags/goldenhour/related')
    ->json();

Response

[{
  "name": "sunset",
  "related_count": 412
}, {
  "name": "seascape",
  "related_count": 157
}]

{
  "error": "No query results for model [App\\Models\\Hashtag]."
}

GET/api/v1/followed_tags

List followed hashtags

Mastodon compatible User token

Query parameters

limitinteger

cursorstring

Returns

curl "https://pixelfed.social/api/v1/followed_tags?limit=50" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $TOKEN"

const res = await fetch("https://pixelfed.social/api/v1/followed_tags?limit=50", {
  headers: {
    Accept: "application/json",
    Authorization: `Bearer ${token}`,
  },
});

const tags = await res.json();

import requests

res = requests.get(
    "https://pixelfed.social/api/v1/followed_tags",
    headers={"Accept": "application/json", "Authorization": f"Bearer {token}"},
    params={
        "limit": 50,
    },
)

tags = res.json()

use Illuminate\Support\Facades\Http;

$tags = Http::acceptJson()
    ->withToken($token)
    ->get('https://pixelfed.social/api/v1/followed_tags', [
        'limit' => 50,
    ])
    ->json();

Response

[{
  "name": "goldenhour",
  "url": "https://pixelfed.social/i/web/hashtag/goldenhour",
  "history": [],
  "following": true
}, {
  "name": "filmphotography",
  "url": "https://pixelfed.social/i/web/hashtag/filmphotography",
  "history": [],
  "following": true
}]

{
  "message": "The limit field must not be greater than 200.",
  "errors": {
    "limit": ["The limit field must not be greater than 200."]
  }
}

POST/api/v1/tags/{id}/follow

Follow a hashtag

Mastodon compatible User token

Path parameters

idstringrequired

Returns

curl -X POST "https://pixelfed.social/api/v1/tags/goldenhour/follow" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $TOKEN"

const res = await fetch("https://pixelfed.social/api/v1/tags/goldenhour/follow", {
  method: "POST",
  headers: {
    Accept: "application/json",
    Authorization: `Bearer ${token}`,
  },
});

const tag = await res.json();

import requests

res = requests.post(
    "https://pixelfed.social/api/v1/tags/goldenhour/follow",
    headers={"Accept": "application/json", "Authorization": f"Bearer {token}"},
)

tag = res.json()

use Illuminate\Support\Facades\Http;

$tag = Http::acceptJson()
    ->withToken($token)
    ->post('https://pixelfed.social/api/v1/tags/goldenhour/follow')
    ->json();

Response

{
  "name": "goldenhour",
  "url": "https://pixelfed.social/i/web/hashtag/goldenhour",
  "history": [],
  "following": true
}

{
  "error": "Unknown hashtag"
}

{
  "error": "You cannot follow more than 100 hashtags."
}

POST/api/v1/tags/{id}/unfollow

Unfollow a hashtag

Mastodon compatible User token

Path parameters

idstringrequired

Returns

curl -X POST "https://pixelfed.social/api/v1/tags/goldenhour/unfollow" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $TOKEN"

const res = await fetch("https://pixelfed.social/api/v1/tags/goldenhour/unfollow", {
  method: "POST",
  headers: {
    Accept: "application/json",
    Authorization: `Bearer ${token}`,
  },
});

const tag = await res.json();

import requests

res = requests.post(
    "https://pixelfed.social/api/v1/tags/goldenhour/unfollow",
    headers={"Accept": "application/json", "Authorization": f"Bearer {token}"},
)

tag = res.json()

use Illuminate\Support\Facades\Http;

$tag = Http::acceptJson()
    ->withToken($token)
    ->post('https://pixelfed.social/api/v1/tags/goldenhour/unfollow')
    ->json();

Response

{
  "name": "goldenhour",
  "url": "https://pixelfed.social/i/web/hashtag/goldenhour",
  "history": [],
  "following": false
}

{
  "error": "Unknown hashtag"
}

Pixelfed is free and open source software. Edit this page Report a docs issue