Skip to content

Mastodon API

Mastodon (mastodon.social) has 3 public methods: list hashtag posts, get profile and list recent posts. Each costs 1 credit per completed run (1¢ with pay as you go); failed runs are free.

mastodon.social (opens in a new tab)

Unofficial. Not affiliated with or endorsed by Mastodon.

Methods

3

  • List hashtag posts

    Lists the latest public posts for a hashtag on a Mastodon server, newest first. Some servers require login for public timelines.

    Returns posts with author, text, time, boost, favourite and reply counts, image links and post link

    Readmastodon.social/list_hashtag_posts

  • Get profile

    Gets a public Mastodon profile by handle or profile link, with its bio, counts, dates and profile fields. Major servers are read directly. Other servers are looked up through mastodon.social, and their home-server account ID is not available.

    Returns handle, display name, bio, counts, dates, profile fields, avatar, profile URL

    Readmastodon.social/get_profile

  • List recent posts

    Lists a Mastodon account's latest public posts, newest first. Replies and boosts are optional. Private and unlisted posts are left out.

    Returns text, content warning, date, counts, boost info, images, link, id

    Readmastodon.social/list_recent_posts