認証
Mutes エンドポイントは、プライベートなミュートリストにアクセスするためにユーザー認証を必要とします:| Method | Description |
|---|---|
| OAuth 2.0 Authorization Code with PKCE | 新規アプリケーションには推奨 |
| OAuth 1.0a User Context | レガシーサポート |
App-Only 認証はサポートされていません。必ずユーザーの代理として認証する必要があります。
必要なスコープ (OAuth 2.0)
| Scope | Required for |
|---|---|
mute.read | ミュート中のアカウントの取得 |
mute.write | アカウントのミュート・ミュート解除 |
users.read | mute 系スコープと併せて必要 |
エンドポイントの概要
| Method | Endpoint | Description |
|---|---|---|
| GET | /2/users/:id/muting | ミュート中のアカウントの一覧を取得 |
| POST | /2/users/:id/muting | アカウントをミュート |
| DELETE | /2/users/:source_user_id/muting/:target_user_id | アカウントのミュートを解除 |
Fields と expansions
デフォルトのレスポンス
{
"data": [
{
"id": "1234567890",
"name": "Example User",
"username": "example"
}
]
}
利用可能なフィールド
user.fields
user.fields
| Field | Description |
|---|---|
created_at | アカウント作成日 |
description | ユーザーの bio |
profile_image_url | アバターの URL |
public_metrics | フォロワー/フォロー中の件数 |
verified | 認証済みステータス |
expansions
expansions
| Expansion | Description |
|---|---|
pinned_tweet_id | ユーザーのピン留めした Post |
フィールドを使った例
cURL
curl "https://api.x.com/2/users/123456789/muting?\
user.fields=username,verified,created_at&\
max_results=100" \
-H "Authorization: Bearer $USER_ACCESS_TOKEN"
from xdk import Client
client = Client(bearer_token="YOUR_USER_ACCESS_TOKEN")
# 追加フィールド付きでミュート中のユーザーを取得
for page in client.users.get_muting(
user_id="123456789",
user_fields=["username", "verified", "created_at"],
max_results=100
):
for user in page.data:
print(f"{user.username} - Verified: {user.verified}")
import { Client } from "@xdevplatform/xdk";
const client = new Client({ accessToken: "YOUR_USER_ACCESS_TOKEN" });
const paginator = client.users.getMuting("123456789", {
userFields: ["username", "verified", "created_at"],
maxResults: 100,
});
for await (const page of paginator) {
page.data?.forEach((user) => {
console.log(`${user.username} - Verified: ${user.verified}`);
});
}
ページネーション
ミュートリストが多いユーザーの場合、結果はページネーションされます:cURL
# 最初のリクエスト
curl "https://api.x.com/2/users/123/muting?max_results=100" \
-H "Authorization: Bearer $USER_ACCESS_TOKEN"
# pagination_token を使った後続のリクエスト
curl "https://api.x.com/2/users/123/muting?max_results=100&pagination_token=NEXT_TOKEN" \
-H "Authorization: Bearer $USER_ACCESS_TOKEN"
from xdk import Client
client = Client(bearer_token="YOUR_USER_ACCESS_TOKEN")
# SDK はページネーションを自動で処理します
all_muted = []
for page in client.users.get_muting(user_id="123", max_results=100):
if page.data:
all_muted.extend(page.data)
print(f"Muted {len(all_muted)} users")
import { Client } from "@xdevplatform/xdk";
const client = new Client({ accessToken: "YOUR_USER_ACCESS_TOKEN" });
async function getAllMutedUsers(userId) {
const allMuted = [];
// SDK はページネーションを自動で処理します
const paginator = client.users.getMuting(userId, { maxResults: 100 });
for await (const page of paginator) {
if (page.data) {
allMuted.push(...page.data);
}
}
return allMuted;
}
// 使用例
const muted = await getAllMutedUsers("123");
console.log(`Muted ${muted.length} users`);
ページネーションガイド
ページネーションについて詳しく学ぶ
挙動の違い
ミュートとブロックの違い
| Feature | ミュート | ブロック |
|---|---|---|
| 相手の Post を見る | 見えない (非表示) | 見えない |
| 相手があなたの Post を見る | 見える | 見えない |
| 相手があなたをフォロー | フォローされる (フォロー可) | されない (削除される) |
| 相手が DM を送れる | 送れる | 送れない |
| 通知の送信 | されない | されない |
ミュートはプライベートです — ミュートされたユーザーへの通知はなく、相手はミュートされたことを知ることができません。
エラー処理
| Status | Error | Solution |
|---|---|---|
| 400 | Invalid request | user ID の形式を確認 |
| 401 | Unauthorized | access token を確認 |
| 403 | Forbidden | スコープと権限を確認 |
| 404 | Not Found | ユーザーが存在しない |
| 429 | Too Many Requests | 待機してから再試行 |
次のステップ
クイックスタート
最初の mutes リクエストを行う
Blocks
ミュートの代わりにユーザーをブロック
API リファレンス
エンドポイントの詳細ドキュメント
サンプルコード
動作するコード例