Skip to main content

Social

The social APIs cover follow relationships, follow requests, blocking, and muting. All operations require authentication.

Following (client.following)

Follow a user

final user = await client.following.create(userId: userId);

If the target user requires follow approval, a request is sent instead of an immediate follow. The method returns the updated MisskeyUser.

Pass withReplies: true to include the followed user's replies in your timeline:

await client.following.create(userId: userId, withReplies: true);

Unfollow

await client.following.delete(userId: userId);

Update follow settings

Change notification and reply display settings for an individual follow relationship.

await client.following.update(
userId: userId,
notify: 'normal', // 'normal' or 'none'
withReplies: true,
);

Update all follows at once

Apply the same settings to every account you follow. Rate limit: 10 requests/hour.

await client.following.updateAll(notify: 'none', withReplies: false);

Remove a follower

Forcibly removes someone who is following you.

await client.following.invalidate(userId: userId);

Follow requests (client.following.requests)

Incoming requests

// List pending requests sent to you
final incoming = await client.following.requests.list(limit: 20);
for (final req in incoming) {
print(req.follower.username);
}

// Accept a request
await client.following.requests.accept(userId: userId);

// Reject a request
await client.following.requests.reject(userId: userId);

Outgoing requests

// List requests you have sent
final sent = await client.following.requests.sent(limit: 20);

// Cancel a request you sent
await client.following.requests.cancel(userId: userId);

All list methods accept sinceId / untilId and sinceDate / untilDate for pagination.

Blocking (client.blocking)

Blocking removes the mutual follow relationship between you and the target. A blocked user cannot follow you, and you will not see their content.

Block a user

await client.blocking.create(userId: userId);

Unblock

await client.blocking.delete(userId: userId);

List blocked users

final blocked = await client.blocking.list(limit: 20);
for (final b in blocked) {
print(b.blockee.username);
}

Paginate with sinceId / untilId or sinceDate / untilDate.

Muting (client.mute)

Muting hides a user's notes, renotes, and reactions from your timeline. Unlike blocking, the target user is unaware they have been muted.

Mute a user

// Permanent mute
await client.mute.create(userId: userId);

Timed mute

Pass a Unix timestamp in milliseconds to expire the mute automatically.

// Mute for 24 hours
final expiresAt = DateTime.now()
.add(const Duration(hours: 24))
.millisecondsSinceEpoch;

await client.mute.create(userId: userId, expiresAt: expiresAt);

Unmute

await client.mute.delete(userId: userId);

List muted users

final muted = await client.mute.list(limit: 20);
for (final m in muted) {
print(m.mutee.username);
}

Renote muting (client.renoteMute)

Renote muting suppresses only a user's renotes from your timeline. Their original notes remain visible. This is useful when you want to follow someone's original content but not their reposted content.

Renote-mute a user

await client.renoteMute.create(userId: userId);

Remove a renote mute

await client.renoteMute.delete(userId: userId);

List renote-muted users

final renoteMuted = await client.renoteMute.list(limit: 20);
for (final rm in renoteMuted) {
print(rm.mutee.username);
}

Paginate with sinceId / untilId or sinceDate / untilDate.

Comparison: mute vs renote mute

Regular muteRenote mute
Original notes hiddenYesNo
Renotes hiddenYesYes
Target notifiedNoNo
Timed expiryYesNo