Skip to content

Mastodon Look up a fediverse account API

GET https://api.fetchproof.com/v1/mastodon/profile

Looks up acct (user@instance) on that instance's public API. No application token.

Default cost: 1 credit per call 0 credits on error & cache hits
Code & Payload

Quick start

Open interactive playground in Docs ↗

cURL

curl --request GET 'https://api.fetchproof.com/v1/mastodon/profile?acct=Gargron%40mastodon.social' \
  --header 'x-api-key: YOUR_API_KEY'

JavaScript

const response = await fetch("https://api.fetchproof.com/v1/mastodon/profile?acct=Gargron%40mastodon.social", {
  method: 'GET',
  headers: {
    'x-api-key': process.env.FETCHPROOF_API_KEY,
  },
});
const data = await response.json();
console.log(data);

Python

import os
import requests

response = requests.get(
    "https://api.fetchproof.com/v1/mastodon/profile?acct=Gargron%40mastodon.social",
    headers={"x-api-key": os.environ["FETCHPROOF_API_KEY"]},
)
print(response.json())

Go

package main

import (
  "fmt"
  "io"
  "net/http"
  "os"
)

func main() {
  req, _ := http.NewRequest("GET", "https://api.fetchproof.com/v1/mastodon/profile?acct=Gargron%40mastodon.social", nil)
  req.Header.Set("x-api-key", os.Getenv("FETCHPROOF_API_KEY"))
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)
  fmt.Println(string(body))
}

PHP

<?php
$ch = curl_init("https://api.fetchproof.com/v1/mastodon/profile?acct=Gargron%40mastodon.social");
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    'x-api-key: ' . getenv('FETCHPROOF_API_KEY'),
  ],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
{
  "success": true,
  "credits_remaining": 100,
  "credits_charged": 1,
  "id": "1",
  "username": "Gargron",
  "acct": "Gargron",
  "display_name": "Eugen Rochko",
  "note": "<p>Executive Strategy &amp; Product Advisor of <span class=\"h-card\" translate=\"no\"><a href=\"https://mastodon.social/@Mastodon\" class=\"u-url mention\">@<span>Mastodon</span></a></span>. Film photography, prog metal, Dota 2. Likes all thing...",
  "note_text": "Executive Strategy & Product Advisor of @Mastodon. Film photography, prog metal, Dota 2. Likes all things analog. Luddite.",
  "url": "https://mastodon.social/@Gargron",
  "avatar": "https://files.mastodon.social/accounts/avatars/000/000/001/original/6b2384b33799a0dd.png",
  "locked": false,
  "bot": false,
  "created_at": "2016-03-16T00:00:00.000Z",
  "followers_count": 381397,
  "following_count": 768,
  "statuses_count": 82861,
  "fields": [
    {
      "name": "GitHub",
      "value": "<a href=\"https://github.com/Gargron\" target=\"_blank\" rel=\"nofollow noopener me\" translate=\"no\"><span class=\"invisible\">https://</span><span class=\"\">github.com/Gargron</span><span class=\"invisible\"></span></a>",
      "value_text": "https://github.com/Gargron"
    },
    {
      "name": "Portfolio",
      "value": "<a href=\"https://eugenrochko.com\" target=\"_blank\" rel=\"nofollow noopener me\" translate=\"no\"><span class=\"invisible\">https://</span><span class=\"\">eugenrochko.com</span><span class=\"invisible\"></span></a>",
      "value_text": "https://eugenrochko.com"
    },
    {
      "name": "Buy my prints",
      "value": "<a href=\"https://www.etsy.com/shop/ERPhotographyPrints\" target=\"_blank\" rel=\"nofollow noopener me\" translate=\"no\"><span class=\"invisible\">https://www.</span><span class=\"ellipsis\">etsy.com/shop/ERPhotographyPri</span><span class=\"invisib...",
      "value_text": "https://www.etsy.com/shop/ERPhotographyPrints"
    }
  ]
}
Response JSON · /v1/mastodon/profile

What it returns

success boolean
credits_remaining integer
credits_charged integer
id string
username string
acct string
display_name string
note string
Profile HTML as returned by the instance.
note_text string
note with tags removed.
url string

Parameters

acct string query required

Account in the form user@instance.

cache_max_age string query optional

Serve a cached response when it is newer than this. A cache hit costs 0 credits.

Use cases

Billing

Errors cost zero credits, and so do cache hits through cache_max_age. Empty results follow this operation’s rules.

Default: 1 credit

An empty result costs 0 credits.

How charges are determined

Cost is decided per call, not per endpoint: the same operation can cost different amounts depending on what it returns.

A call that fails costs 0 credits. A result served from cache costs 0 credits.

`default` is the cost when no rule matches. Rules are evaluated in order and the first whose conditions all hold wins.

A `when` condition is one of: `param` (the request parameter is true), `outcome` (the classifier's outcome), `empty` / `nonEmpty` (a response field is empty and absent, or a non-empty array or string), `flag` (a response field is exactly true).

A cost of `{ perStartedMinute: n, of: [fields] }` is n x max(1, ceil(seconds / 60)), so even a short result bills at least one minute.

Guides

FAQ

How much does the Mastodon Look up a fediverse account API cost?

A call costs 1 credit by default. Errors cost 0 credits, and a cached result served through cache_max_age costs 0. New accounts get 100 free credits with no card. After that, credits come in one-time packs that never expire: 25,000 for $27 and 500,000 for $297 (plus any tax). There is no subscription.

What do I need to call it?

An API key in the x-api-key header, plus acct. You don't need a Mastodon account or developer app.

What does it return?

Typed JSON. Top-level fields include id, username, acct, display_name, note and note_text. The full schema and a real sample response are on this page and in the API reference.

Is this an official Mastodon API?

No. Fetchproof is an unofficial API that returns public Mastodon data only.