Skip to content
Scrappa Get API key
Mastodon API 1 credit/request

Mastodon Hashtag API Documentation

GET https://scrappa.co/api/mastodon/hashtag?instance=mastodon.social&tag=mastodon&limit=5

Read the public timeline for a hashtag on any Mastodon instance. Returns an array of status objects tagged with the given hashtag. Use max_id or min_id from the Link header for pagination. Supports filtering by media, local/remote, and tag combinations.

Mastodon Hashtag API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/mastodon/hashtag?instance=mastodon.social&tag=mastodon&limit=5
Auth header
x-api-key
Cost
1 credit/request
tag = mastodon
Response preview
200 OK
{
    "success": true,
    "data": [
        {
            "id": "117430370454007257",
            "content": "Soy nueva en #mastodon",
            "content_text": "Soy nueva en #mastodon",
            "url": "https://mastodon.social/@Analia_Belen45/117430370454007257",
            "tags": [
                {
                    "name": "mastodon",
                    "url": "https://mastodon.social/tags/mastodon"
                }
            ]
...

Parameters

Start with the required fields, then add optional filters only when your use case needs them.

Runnable path

1 required parameter needed before sending a request.

7 optional filters available.

tag string Required

Hashtag without the # prefix. Example: mastodon.

Example value mastodon
instance string Optional

Public Mastodon hostname. Defaults to mastodon.social.

Example value mastodon.social
limit integer Optional

Statuses per page, 1 to 40. Defaults to 20.

Example value 5
max_id string Optional

Cursor: return statuses older than this ID.

Example value 1234567890
min_id string Optional

Cursor: return statuses newer than this ID.

Example value 1234567890
only_media boolean Optional

Only statuses with media attachments.

Example value true
local boolean Optional

Only statuses from the local instance.

Example value true
remote boolean Optional

Only statuses from remote instances.

Example value true

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/mastodon/hashtag?instance=mastodon.social&tag=mastodon&limit=5",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "x-api-key: YOUR_API_KEY_HERE"
    ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
    echo "cURL Error #:" . $err;
} else {
    echo $response;
}
PHP
<?php

use Illuminate\Support\Facades\Http;

$response = Http::timeout(30)
    ->withHeaders(['x-api-key' => 'YOUR_API_KEY_HERE'])
    ->get('https://scrappa.co/api/mastodon/hashtag?instance=mastodon.social&tag=mastodon&limit=5');

if ($response->successful()) {
    echo $response->body();
} else {
    echo "Error: " . $response->status();
}
JavaScript
const options = {
    method: 'GET',
    headers: {
        'x-api-key': 'YOUR_API_KEY_HERE'
    }
};

fetch('https://scrappa.co/api/mastodon/hashtag?instance=mastodon.social&tag=mastodon&limit=5', options)
    .then(response => {
        if (!response.ok) {
            throw new Error(`HTTP error! status: ${response.status}`);
        }
        return response.text();
    })
    .then(data => console.log(data))
    .catch(error => console.error('Error:', error));
JavaScript
const axios = require('axios');

const options = {
    method: 'GET',
    url: 'https://scrappa.co/api/mastodon/hashtag?instance=mastodon.social&tag=mastodon&limit=5',
    headers: {
        x-api-key: 'YOUR_API_KEY_HERE',
    }
};

try {
    const response = await axios(options);
    console.log(response.data);
} catch (error) {
    console.error('Error:', error.message);
}
Ruby
require 'net/http'
require 'uri'

uri = URI.parse("https://scrappa.co/api/mastodon/hashtag?instance=mastodon.social&tag=mastodon&limit=5")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == 'https'

request = Net::HTTP::Get.new(uri.request_uri)
request['x-api-key'] = 'YOUR_API_KEY_HERE'

begin
    response = http.request(request)
    puts response.body
rescue => e
    puts "Error: #{e.message}"
end
Python
import http.client
import json

conn = http.client.HTTPSConnection("scrappa.co")

headers = {
    'x-api-key': 'YOUR_API_KEY_HERE',
}

try:
    conn.request("GET", "/api/mastodon/hashtag?instance=mastodon.social&tag=mastodon&limit=5", headers=headers)
    res = conn.getresponse()
    data = res.read()
    print(data.decode("utf-8"))
except Exception as e:
    print(f"Error: {e}")
finally:
    conn.close()
Python
import requests

headers = {
    'x-api-key': 'YOUR_API_KEY_HERE',
}

try:
    response = requests.get('https://scrappa.co/api/mastodon/hashtag?instance=mastodon.social&tag=mastodon&limit=5', headers=headers)
    response.raise_for_status()
    print(response.text)
except requests.exceptions.RequestException as e:
    print(f"Error: {e}")
Java
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import java.io.IOException;

public class ApiExample {
    public static void main(String[] args) {
        OkHttpClient client = new OkHttpClient();

        Request request = new Request.Builder()
            .url("https://scrappa.co/api/mastodon/hashtag?instance=mastodon.social&tag=mastodon&limit=5")
        .addHeader("x-api-key", "YOUR_API_KEY_HERE")
            .build();

        try (Response response = client.newCall(request).execute()) {
            if (response.isSuccessful()) {
                System.out.println(response.body().string());
            } else {
                System.out.println("Error: " + response.code());
            }
        } catch (IOException e) {
            System.out.println("Error: " + e.getMessage());
        }
    }
}
Go
package main

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

func main() {
    client := &http.Client{}
    req, err := http.NewRequest("GET", "https://scrappa.co/api/mastodon/hashtag?instance=mastodon.social&tag=mastodon&limit=5", nil)
    if err != nil {
        fmt.Println("Error creating request:", err)
        return
    }
    req.Header.Set("x-api-key", "YOUR_API_KEY_HERE")

    resp, err := client.Do(req)
    if err != nil {
        fmt.Println("Error making request:", err)
        return
    }
    defer resp.Body.Close()

    body, err := ioutil.ReadAll(resp.Body)
    if err != nil {
        fmt.Println("Error reading response:", err)
        return
    }

    fmt.Println(string(body))
}
Terminal
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/mastodon/hashtag?instance=mastodon.social&tag=mastodon&limit=5"
C#
using System;
using System.Net.Http;
using System.Threading.Tasks;

class Program
{
    static async Task Main()
    {
        using var client = new HttpClient();
        client.DefaultRequestHeaders.Add("x-api-key", "YOUR_API_KEY_HERE");

        try
        {
            var response = await client.SendAsync(new HttpRequestMessage(HttpMethod.Get, "https://scrappa.co/api/mastodon/hashtag?instance=mastodon.social&tag=mastodon&limit=5"));
            var content = await response.Content.ReadAsStringAsync();
            Console.WriteLine(content);
        }
        catch (Exception ex)
        {
            Console.WriteLine($"Error: {ex.Message}");
        }
    }
}
TypeScript
import axios from 'axios';

async function run(): Promise<void> {
    try {
        const response = await axios({
            method: 'GET',
            url: 'https://scrappa.co/api/mastodon/hashtag?instance=mastodon.social&tag=mastodon&limit=5',
            headers: {
        'x-api-key': 'YOUR_API_KEY_HERE',
            },
        });

        console.log(response.data);
    } catch (error) {
        console.error('Error:', error);
    }
}

void run();
RUST
use reqwest::Client;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();

    let response = client
        .get("https://scrappa.co/api/mastodon/hashtag?instance=mastodon.social&tag=mastodon&limit=5")
        .header("x-api-key", "YOUR_API_KEY_HERE")
        .send()
        .await?;

    println!("{}", response.text().await?);

    Ok(())
}

Response Schema

Example response fields are illustrative; inspect the JSON before integrating.

Example response fields

Scan these fields before integrating.

success data

Common data fields

id content content_text url
JSON Response
200 OK
{
    "success": true,
    "data": [
        {
            "id": "117430370454007257",
            "content": "Soy nueva en #mastodon",
            "content_text": "Soy nueva en #mastodon",
            "url": "https://mastodon.social/@Analia_Belen45/117430370454007257",
            "tags": [
                {
                    "name": "mastodon",
                    "url": "https://mastodon.social/tags/mastodon"
                }
            ]
        }
    ]
}

Errors

Handle these documented responses before retrying or showing customer-facing failures.

422

Validation Error

A public parameter or range is invalid. This response is not billable.

{
    "errors": {
        "tag": [
            "The tag parameter is required."
        ]
    },
    "message": "The request validation failed"
}
502

Invalid Source Response

Mastodon returned an unexpected response. This response is not billable.

{
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "The Mastodon API is temporarily unavailable. Please retry."
    },
    "success": false
}

Generate Code with AI

Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.

Try It Live

Test this endpoint in our interactive playground with real data.