連携ガイド

このページでは、Lists エンドポイントと統合するためのツールと重要な概念について説明します。

便利なツール

このエンドポイントを統合するうえで役立つ重要な概念に入る前に、あらかじめ次のツールに慣れておくことをおすすめします。

Postman

Postman は、エンドポイントのテストに利用できる便利なツールです。各 Postman リクエストには、利用可能な項目をすばやく把握できるように、すべてのパスパラメータおよびボディパラメータが含まれています。Postman コレクションの詳細については、“Using Postman” ページをご覧ください。

コードサンプル

お好みのプログラミング言語でこのエンドポイントを使い始めたい場合は、GitHub ページに、ベースとして利用できるコードサンプルをいくつか用意しています。

サードパーティライブラリ

コミュニティが提供しているサードパーティライブラリを活用して、導入を始めましょう。v2 エンドポイントに対応したライブラリは、対応するバージョンタグが付いたものを探すことで見つけられます。

主要な概念

認証

すべての X API v2 エンドポイントでは、キーやトークンとも呼ばれる一連の認証情報を使ってリクエストを認証する必要があります。これらのエンドポイントでは OAuth 1.0a User Context の利用が必要です。つまり、リクエストを正常に行うためには、一連の API キーとユーザーアクセストークンを使用しなければなりません。アクセストークンは、あなたが代理でリクエストを行う対象のユーザーに紐づいている必要があります。別のユーザー向けのアクセストークン一式を生成したい場合は、そのユーザーに 3-legged OAuth フローを使ってあなたの App を認可または認証してもらう必要があります。 OAuth 1.0a の利用は難しい場合がある点に注意してください。この認証方式に慣れていない場合は、ライブラリや Postman のようなツールを使用して、リクエストを適切に認証することを推奨します。

開発者コンソール、プロジェクト、開発者 App

X API v2 のエンドポイントで利用できる認証情報一式を取得するには、まず開発者アカウントに登録し、そのアカウント内でプロジェクトを作成し、そのプロジェクト内に開発者 Appを作成する必要があります。これらの手順を完了すると、開発者 App 内でキーとトークンを確認できます。

レート制限

毎日、何千人もの開発者が X API にリクエストを送信しています。この膨大な数のリクエストを管理するために、各エンドポイントにはレート制限が設定されており、あなたの App または認証済みユーザーに代わって行えるリクエストの数が制限されています。これらのエンドポイントはユーザーレベルでレート制限されており、あなたがリクエストを実行する対象の認証済みユーザーは、どの開発者向け App からのリクエストであっても、そのエンドポイントを呼び出せる回数が一定数に制限されます。以下の表は、各エンドポイントのレート制限を示しています。


エンドポイント	HTTP メソッド	レート制限
/2/lists	POST	15 分あたり 300 リクエスト
/2/lists/:id	DELETE / PUT	15 分あたり 300 リクエスト

コードサンプル

リストを作成する

cURL

curl -X POST "https://api.x.com/2/lists" \
  -H "Authorization: OAuth ..." \
  -H "Content-Type: application/json" \
  -d '{"name": "My List", "description": "A list of interesting accounts"}'

from xdk import Client
from xdk.oauth1_auth import OAuth1

oauth1 = OAuth1(
    api_key="YOUR_API_KEY",
    api_secret="YOUR_API_SECRET",
    access_token="YOUR_ACCESS_TOKEN",
    access_token_secret="YOUR_ACCESS_TOKEN_SECRET"
)

client = Client(auth=oauth1)

# 新しいリストを作成します
response = client.lists.create(
    name="My List",
    description="A list of interesting accounts"
)
print(response.data)

import { Client, OAuth1 } from "@xdevplatform/xdk";

const oauth1 = new OAuth1({
  apiKey: "YOUR_API_KEY",
  apiSecret: "YOUR_API_SECRET",
  accessToken: "YOUR_ACCESS_TOKEN",
  accessTokenSecret: "YOUR_ACCESS_TOKEN_SECRET",
});

const client = new Client({ oauth1 });

// 新しいリストを作成します
const response = await client.lists.create({
  name: "My List",
  description: "A list of interesting accounts",
});
console.log(response.data);

リストを更新する

cURL

curl -X PUT "https://api.x.com/2/lists/123456789" \
  -H "Authorization: OAuth ..." \
  -H "Content-Type: application/json" \
  -d '{"name": "Updated List Name"}'

from xdk import Client
from xdk.oauth1_auth import OAuth1

oauth1 = OAuth1(
    api_key="YOUR_API_KEY",
    api_secret="YOUR_API_SECRET",
    access_token="YOUR_ACCESS_TOKEN",
    access_token_secret="YOUR_ACCESS_TOKEN_SECRET"
)

client = Client(auth=oauth1)

# リストを更新する
response = client.lists.update(
    list_id="123456789",
    name="Updated List Name"
)
print(response.data)

import { Client, OAuth1 } from "@xdevplatform/xdk";

const oauth1 = new OAuth1({
  apiKey: "YOUR_API_KEY",
  apiSecret: "YOUR_API_SECRET",
  accessToken: "YOUR_ACCESS_TOKEN",
  accessTokenSecret: "YOUR_ACCESS_TOKEN_SECRET",
});

const client = new Client({ oauth1 });

// リストを更新する
const response = await client.lists.update("123456789", {
  name: "Updated List Name",
});
console.log(response.data);

概要

投稿

ユーザー

ダイレクトメッセージ

いいね

リスト

スペース

コミュニティ

コミュニティノート

トレンド

ニュース

メディア

X のアクティビティ

利用状況

ストリーム接続

コンプライアンス

Enterprise v2

いいねのストリーム

GNIP 2.0

便利なツール

Postman

コードサンプル

サードパーティライブラリ

主要な概念

認証

開発者コンソール、プロジェクト、開発者 App

レート制限

コードサンプル

リストを作成する

リストを更新する

​便利なツール

​Postman

​コードサンプル

​サードパーティライブラリ

​主要な概念

​認証

​開発者コンソール、プロジェクト、開発者 App

​レート制限

​コードサンプル

​リストを作成する

​リストを更新する

便利なツール

Postman

コードサンプル

サードパーティライブラリ

主要な概念

認証

開発者コンソール、プロジェクト、開発者 App

レート制限

コードサンプル

リストを作成する

リストを更新する