Get Accounts Following with Mastodon API

Pipedream makes it easy to connect APIs for Mastodon and 3,000+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Get Accounts Following with the Mastodon API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Get Accounts Following with the Mastodon API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Get Accounts Following action
1. Connect your Mastodon account
2. Optional- Configure Max Results
3. Optional- Configure Max ID
4. Optional- Configure Min ID
5. Optional- Configure Since ID
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Get Accounts Following on Mastodon

Description:Get the accounts that the given account is following. [See the documentation](https://docs.joinmastodon.org/methods/accounts/#following)

Version:0.0.3

Key:mastodon-get-accounts-following

View on GitHub

Code#

import mastodon from "../../mastodon.app.mjs";

export default {
  key: "mastodon-get-accounts-following",
  name: "Get Accounts Following",
  description: "Get the accounts that the given account is following. [See the documentation](https://docs.joinmastodon.org/methods/accounts/#following)",
  version: "0.0.3",
  type: "action",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: true,
  },
  props: {
    mastodon,
    max: {
      propDefinition: [
        mastodon,
        "max",
      ],
    },
    maxId: {
      type: "string",
      label: "Max ID",
      description: "The max ID from a previous response for pagination",
      optional: true,
    },
    minId: {
      type: "string",
      label: "Min ID",
      description: "The min ID from a previous response for pagination",
      optional: true,
    },
    sinceId: {
      type: "string",
      label: "Since ID",
      description: "The since ID from a previous response for pagination",
      optional: true,
    },
  },
  methods: {
    getMaxIdFromLinkHeader(linkHeader) {
      const match = linkHeader.match(/max_id=([^&>]+)/);
      return match
        ? match[1]
        : null;
    },
  },
  async run({ $ }) {
    const { max } = this;
    const accounts = [];
    let done = false, paginationLinks;
    const args = {
      $,
      params: {
        max_id: this.maxId,
        min_id: this.minId,
        since_id: this.sinceId,
        limit: 80, // max allowed by api
      },
      returnFullResponse: true,
    };
    do {
      const {
        headers, data,
      } = await this.mastodon.getAccountsFollowing(args);
      accounts.push(...data);
      if (headers?.link) {
        args.params.max_id = this.getMaxIdFromLinkHeader(headers.link);
        paginationLinks = headers.link;
      } else {
        done = true;
      }
      if (data?.length < args.params.limit) {
        done = true;
      }
    } while (accounts.length < max && !done);

    if (accounts.length > max) {
      accounts.length = max;
    }

    $.export("$summary", `Successfully retrieved ${accounts.length} account(s) that the user is following`);
    return {
      accounts,
      paginationLinks,
    };
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Mastodon	`mastodon`	`app`	This component uses the Mastodon app.
Max Results	`max`	`integer`	The maximum number of results to return. Defaults to 20.
Max ID	`maxId`	`string`	The max ID from a previous response for pagination
Min ID	`minId`	`string`	The min ID from a previous response for pagination
Since ID	`sinceId`	`string`	The since ID from a previous response for pagination