GET lists/subscriptions - 購読しているリストを取得する
公開日:
lists/subscriptions(GETメソッド)は、対象のユーザーが購読しているリストの一覧を取得するエンドポイントです。
- GET lists/subscriptions
- Twitterの公式リファレンス(英語)。lists/subscriptionsに関する説明があります。
リソース
エンドポイント
GET https://api.twitter.com/1.1/lists/subscriptions.json
条件
項目 | ユーザー認証 | アプリケーション認証 |
---|---|---|
利用 | ● | ● |
パーミッション | Read | - |
レートリミット | 15 / 15min | 15 / 15min |
パラメータ
user_id
指定例: 1528352858
対象ユーザーのユーザーID。
screen_name
指定例: arayutw
対象ユーザーのスクリーンネーム。
count
指定例: 10
結果の数。1
〜1000
の間で指定する。
cursor
指定例: 599056298085224449
ページングをする際の取得開始位置を示すカーソルを指定する。カーソルは、リクエストした際のprevious_cursor
(前ページ)、またはnext_cursor
(次ページ)に含まれる。
レスポンス
アクセストークン(OAuth1.0)でリクエストをした場合の例です。
リクエストURL
https://api.twitter.com/1.1/lists/subscriptions.json?user_id=1528352858&count=3
リクエストヘッダー
Authorization: OAuth count=3,oauth_consumer_key=:consumer_key,oauth_nonce=0.93330600+1484715429,oauth_signature_method=HMAC-SHA1,oauth_timestamp=1484715429,oauth_token=:access_token,oauth_version=1.0,user_id=1528352858,oauth_signature=R9L7FDTRh4XIdnd8eFPmeS1Cm7w%3D
レスポンスボディ (JSON)
JSON
{"next_cursor":1501481487694737812,"next_cursor_str":"1501481487694737812","previous_cursor":0,"previous_cursor_str":"0","lists":[{"id":198828364,"id_str":"198828364","name":"SYNCER","uri":"\/SyncerJP\/lists\/syncer1","subscriber_count":1,"member_count":3,"mode":"public","description":"SYNCER\u304c\u904b\u7528\u3059\u308b\u30a2\u30ab\u30a6\u30f3\u30c8\u306e\u30ea\u30b9\u30c8\u3067\u3059\u3002","slug":"syncer1","full_name":"@SyncerJP\/syncer1","created_at":"Sat Mar 14 16:25:36 +0000 2015","following":true,"user":{"id":2905085521,"id_str":"2905085521","name":"SYNCER","screen_name":"SyncerJP","location":"Tokyo","description":"\u30d6\u30ed\u30b0\u300cSYNCER\u300d\u306e\u30a2\u30ab\u30a6\u30f3\u30c8\u3067\u3059\u3002\u8a18\u4e8b\u306b\u8a00\u53ca\u3057\u3066\u304f\u308c\u305f\u30c4\u30a4\u30fc\u30c8\u3092\u304a\u6c17\u306b\u5165\u308a\u767b\u9332\u3057\u305f\u308a\u3057\u307e\u3059\u3002 \u6700\u7d42\u66f4\u65b0\u65e5:2015\/05\/22","url":"https:\/\/t.co\/J5bOOK7ugS","entities":{"url":{"urls":[{"url":"https:\/\/t.co\/J5bOOK7ugS","expanded_url":"https:\/\/syncer.jp","display_url":"syncer.jp","indices":[0,23]}]},"description":{"urls":[]}},"protected":false,"followers_count":266,"friends_count":2,"listed_count":10,"created_at":"Thu Nov 20 11:17:51 +0000 2014","favourites_count":1621,"utc_offset":32400,"time_zone":"Tokyo","geo_enabled":true,"verified":false,"statuses_count":641,"lang":"ja","contributors_enabled":false,"is_translator":false,"is_translation_enabled":false,"profile_background_color":"000000","profile_background_image_url":"http:\/\/pbs.twimg.com\/profile_background_images\/600501255656448000\/1qe0CVbE.png","profile_background_image_url_https":"https:\/\/pbs.twimg.com\/profile_background_images\/600501255656448000\/1qe0CVbE.png","profile_background_tile":true,"profile_image_url":"http:\/\/pbs.twimg.com\/profile_images\/604130129762074624\/5c0Rku36_normal.jpg","profile_image_url_https":"https:\/\/pbs.twimg.com\/profile_images\/604130129762074624\/5c0Rku36_normal.jpg","profile_banner_url":"https:\/\/pbs.twimg.com\/profile_banners\/2905085521\/1432005636","profile_link_color":"D36015","profile_sidebar_border_color":"C6E2EE","profile_sidebar_fill_color":"DAECF4","profile_text_color":"663B12","profile_use_background_image":true,"has_extended_profile":false,"default_profile":false,"default_profile_image":false,"following":true,"follow_request_sent":false,"notifications":false,"translator_type":"none"}},{"id":212343934,"id_str":"212343934","name":"\u3042\u3089\u3086","uri":"\/spyder1211\/lists\/list","subscriber_count":2,"member_count":1,"mode":"public","description":"","slug":"list","full_name":"@spyder1211\/list","created_at":"Tue Jun 30 06:20:41 +0000 2015","following":true,"user":{"id":1490549834,"id_str":"1490549834","name":"SPYDER","screen_name":"spyder1211","location":"","description":"CakePHP\u3001PHP\u3001mysql\u3001linux\u306a\u3069\u306a\u3069\u3067\u958b\u767a\u4e2d\u3002\u30ac\u30f3\u60a3\u8005\u3060\u3063\u305f\u308a\u3057\u307e\u3059","url":"http:\/\/t.co\/zCF0kvk1Sf","entities":{"url":{"urls":[{"url":"http:\/\/t.co\/zCF0kvk1Sf","expanded_url":"http:\/\/blog.livedoor.jp\/spyder_5615\/","display_url":"blog.livedoor.jp\/spyder_5615\/","indices":[0,22]}]},"description":{"urls":[]}},"protected":false,"followers_count":74,"friends_count":108,"listed_count":1,"created_at":"Fri Jun 07 14:39:52 +0000 2013","favourites_count":306,"utc_offset":null,"time_zone":null,"geo_enabled":false,"verified":false,"statuses_count":1503,"lang":"ja","contributors_enabled":false,"is_translator":false,"is_translation_enabled":false,"profile_background_color":"C0DEED","profile_background_image_url":"http:\/\/abs.twimg.com\/images\/themes\/theme1\/bg.png","profile_background_image_url_https":"https:\/\/abs.twimg.com\/images\/themes\/theme1\/bg.png","profile_background_tile":false,"profile_image_url":"http:\/\/pbs.twimg.com\/profile_images\/482334264386535425\/zbSmgTIG_normal.jpeg","profile_image_url_https":"https:\/\/pbs.twimg.com\/profile_images\/482334264386535425\/zbSmgTIG_normal.jpeg","profile_banner_url":"https:\/\/pbs.twimg.com\/profile_banners\/1490549834\/1403832794","profile_link_color":"1DA1F2","profile_sidebar_border_color":"C0DEED","profile_sidebar_fill_color":"DDEEF6","profile_text_color":"333333","profile_use_background_image":true,"has_extended_profile":false,"default_profile":true,"default_profile_image":false,"following":true,"follow_request_sent":false,"notifications":false,"translator_type":"none"}},{"id":169431392,"id_str":"169431392","name":"Active Developers","uri":"\/chicagodesign\/lists\/active-developers","subscriber_count":9,"member_count":1998,"mode":"public","description":"","slug":"active-developers","full_name":"@chicagodesign\/active-developers","created_at":"Thu Sep 11 19:40:13 +0000 2014","following":true,"user":{"id":21170191,"id_str":"21170191","name":"Michael Sim \u2197\ufe0f","screen_name":"chicagodesign","location":"Chicago, IL","description":"Superhero Dad - Fan of #StarWars & #MTG - Art Director, UI\/UX Designer @LearnCore - Vindicated lifelong @Cubs fan! Doritos connoisseur.","url":"https:\/\/t.co\/WVBnHrI97e","entities":{"url":{"urls":[{"url":"https:\/\/t.co\/WVBnHrI97e","expanded_url":"http:\/\/be.net\/msim","display_url":"be.net\/msim","indices":[0,23]}]},"description":{"urls":[]}},"protected":false,"followers_count":88277,"friends_count":55115,"listed_count":2450,"created_at":"Wed Feb 18 04:50:31 +0000 2009","favourites_count":4810,"utc_offset":-21600,"time_zone":"Central Time (US & Canada)","geo_enabled":false,"verified":false,"statuses_count":15728,"lang":"en","contributors_enabled":false,"is_translator":false,"is_translation_enabled":false,"profile_background_color":"000000","profile_background_image_url":"http:\/\/pbs.twimg.com\/profile_background_images\/477109199445303296\/ILIe1GQv.jpeg","profile_background_image_url_https":"https:\/\/pbs.twimg.com\/profile_background_images\/477109199445303296\/ILIe1GQv.jpeg","profile_background_tile":false,"profile_image_url":"http:\/\/pbs.twimg.com\/profile_images\/485426285963780096\/PWkgtRBZ_normal.jpeg","profile_image_url_https":"https:\/\/pbs.twimg.com\/profile_images\/485426285963780096\/PWkgtRBZ_normal.jpeg","profile_banner_url":"https:\/\/pbs.twimg.com\/profile_banners\/21170191\/1404869522","profile_link_color":"000000","profile_sidebar_border_color":"000000","profile_sidebar_fill_color":"1F1F1F","profile_text_color":"7A7A7A","profile_use_background_image":true,"has_extended_profile":false,"default_profile":false,"default_profile_image":false,"following":false,"follow_request_sent":false,"notifications":false,"translator_type":"none"}}]}
レスポンスヘッダー
HTTP/1.1 200 OK
cache-control: no-cache, no-store, must-revalidate, pre-check=0, post-check=0
content-disposition: attachment; filename=json.json
content-length: 6639
content-type: application/json;charset=utf-8
date: Wed, 18 Jan 2017 04:57:10 GMT
expires: Tue, 31 Mar 1981 05:00:00 GMT
last-modified: Wed, 18 Jan 2017 04:57:10 GMT
pragma: no-cache
server: tsa_m
set-cookie: lang=ja; Path=/
set-cookie: guest_id=v1%3A148471542999791101; Domain=.twitter.com; Path=/; Expires=Fri, 18-Jan-2019 04:57:10 UTC
status: 200 OK
strict-transport-security: max-age=631138519
x-access-level: read
x-connection-hash: c0b83acf890d21f462c02e232599a1f2
x-content-type-options: nosniff
x-frame-options: SAMEORIGIN
x-rate-limit-limit: 15
x-rate-limit-remaining: 14
x-rate-limit-reset: 1484716329
x-response-time: 178
x-transaction: 0043eb73003e1180
x-twitter-response-tags: BouncerCompliant
x-xss-protection: 1; mode=block
デモ
lists/subscriptionsのリクエストを試すことができます。ユーザー認証のデモを試す場合は、アプリケーション(読取権限)の連携を許可する必要があります。利用後、お手数ですが連携の解除をお願いします。連携を解除し忘れたとしても、当アプリケーションが許可なくデータにアクセスすることはありません。
サンプルコード
lists/subscriptionsのエンドポイントを利用するためのサンプルプログラムです。各種トークンの情報をセットしてからPHPで起動して下さい。リクエストに成功すると、$json
という変数に目的のデータが代入されます。このデータを整形するなり保存するなり、活用して下さい。
ベアラートークン
PHP (OAuth2.0)
<?php
/**************************************************
[GET lists/subscriptions]のお試しプログラム
認証方式: ベアラートークン
配布: SYNCER
公式ドキュメント: https://dev.twitter.com/rest/reference/get/lists/subscriptions
日本語解説ページ: https://syncer.jp/Web/API/Twitter/REST_API/GET/lists/subscriptions/
**************************************************/
// 設定
$bearer_token = '' ; // ベアラートークン
$request_url = 'https://api.twitter.com/1.1/lists/subscriptions.json' ; // エンドポイント
// パラメータ (オプション)
$params = array(
"user_id" => "1528352858",
// "screen_name" => "arayutw",
// "count" => "10",
// "cursor" => "599056298085224449",
) ;
// パラメータがある場合
if( $params ) {
$request_url .= '?' . http_build_query( $params ) ;
}
// リクエスト用のコンテキスト
$context = array(
'http' => array(
'method' => 'GET' , // リクエストメソッド
'header' => array( // ヘッダー
'Authorization: Bearer ' . $bearer_token ,
) ,
) ,
) ;
// cURLを使ってリクエスト
$curl = curl_init() ;
curl_setopt( $curl , CURLOPT_URL , $request_url ) ;
curl_setopt( $curl , CURLOPT_HEADER, 1 ) ;
curl_setopt( $curl , CURLOPT_CUSTOMREQUEST , $context['http']['method'] ) ; // メソッド
curl_setopt( $curl , CURLOPT_SSL_VERIFYPEER , false ) ; // 証明書の検証を行わない
curl_setopt( $curl , CURLOPT_RETURNTRANSFER , true ) ; // curl_execの結果を文字列で返す
curl_setopt( $curl , CURLOPT_HTTPHEADER , $context['http']['header'] ) ; // ヘッダー
curl_setopt( $curl , CURLOPT_TIMEOUT , 5 ) ; // タイムアウトの秒数
$res1 = curl_exec( $curl ) ;
$res2 = curl_getinfo( $curl ) ;
curl_close( $curl ) ;
// 取得したデータ
$json = substr( $res1, $res2['header_size'] ) ; // 取得したデータ(JSONなど)
$header = substr( $res1, 0, $res2['header_size'] ) ; // レスポンスヘッダー (検証に利用したい場合にどうぞ)
// [cURL]ではなく、[file_get_contents()]を使うには下記の通りです…
// $json = @file_get_contents( $request_url , false , stream_context_create( $context ) ) ;
// JSONをオブジェクトに変換 (処理をする場合)
// $obj = json_decode( $json ) ;
// HTML用
$html = '' ;
// タイトル
$html .= '<h1 style="text-align:center; border-bottom:1px solid #555; padding-bottom:12px; margin-bottom:48px; color:#D36015;">GET lists/subscriptions</h1>' ;
// 検証用
$html .= '<h2>取得したデータ</h2>' ;
$html .= '<p>下記のデータを取得できました。</p>' ;
$html .= '<h3>ボディ(JSON)</h3>' ;
$html .= '<p><textarea style="width:80%" rows="8">' . $json . '</textarea></p>' ;
$html .= '<h3>レスポンスヘッダー</h3>' ;
$html .= '<p><textarea style="width:80%" rows="8">' . $header . '</textarea></p>' ;
// 検証用
$html .= '<h2>リクエストしたデータ</h2>' ;
$html .= '<p>下記内容でリクエストをしました。</p>' ;
$html .= '<h3>URL</h3>' ;
$html .= '<p><textarea style="width:80%" rows="8">' . $context['http']['method'] . ' ' . $request_url . '</textarea></p>' ;
$html .= '<h3>ヘッダー</h3>' ;
$html .= '<p><textarea style="width:80%" rows="8">' . implode( "\r\n" , $context['http']['header'] ) . '</textarea></p>' ;
// フッター
$html .= '<small style="display:block; border-top:1px solid #555; padding-top:12px; margin-top:72px; text-align:center; font-weight:700;">プログラムの説明: <a href="https://syncer.jp/Web/API/Twitter/REST_API/GET/lists/subscriptions/" target="_blank">SYNCER</a></small>' ;
// 出力 (本稼働時はHTMLのヘッダー、フッターを付けよう)
echo $html ;
アクセストークン
PHP (OAuth1.0)
<?php
/**************************************************
[GET lists/subscriptions]のお試しプログラム
認証方式: アクセストークン
配布: SYNCER
公式ドキュメント: https://dev.twitter.com/rest/reference/get/lists/subscriptions
日本語解説ページ: https://syncer.jp/Web/API/Twitter/REST_API/GET/lists/subscriptions/
**************************************************/
// 設定
$api_key = '' ; // APIキー
$api_secret = '' ; // APIシークレット
$access_token = '' ; // アクセストークン
$access_token_secret = '' ; // アクセストークンシークレット
$request_url = 'https://api.twitter.com/1.1/lists/subscriptions.json' ; // エンドポイント
$request_method = 'GET' ;
// パラメータA (オプション)
$params_a = array(
"user_id" => "1528352858",
// "screen_name" => "arayutw",
// "count" => "10",
// "cursor" => "599056298085224449",
) ;
// キーを作成する (URLエンコードする)
$signature_key = rawurlencode( $api_secret ) . '&' . rawurlencode( $access_token_secret ) ;
// パラメータB (署名の材料用)
$params_b = array(
'oauth_token' => $access_token ,
'oauth_consumer_key' => $api_key ,
'oauth_signature_method' => 'HMAC-SHA1' ,
'oauth_timestamp' => time() ,
'oauth_nonce' => microtime() ,
'oauth_version' => '1.0' ,
) ;
// パラメータAとパラメータBを合成してパラメータCを作る
$params_c = array_merge( $params_a , $params_b ) ;
// 連想配列をアルファベット順に並び替える
ksort( $params_c ) ;
// パラメータの連想配列を[キー=値&キー=値...]の文字列に変換する
$request_params = http_build_query( $params_c , '' , '&' ) ;
// 一部の文字列をフォロー
$request_params = str_replace( array( '+' , '%7E' ) , array( '%20' , '~' ) , $request_params ) ;
// 変換した文字列をURLエンコードする
$request_params = rawurlencode( $request_params ) ;
// リクエストメソッドをURLエンコードする
// ここでは、URL末尾の[?]以下は付けないこと
$encoded_request_method = rawurlencode( $request_method ) ;
// リクエストURLをURLエンコードする
$encoded_request_url = rawurlencode( $request_url ) ;
// リクエストメソッド、リクエストURL、パラメータを[&]で繋ぐ
$signature_data = $encoded_request_method . '&' . $encoded_request_url . '&' . $request_params ;
// キー[$signature_key]とデータ[$signature_data]を利用して、HMAC-SHA1方式のハッシュ値に変換する
$hash = hash_hmac( 'sha1' , $signature_data , $signature_key , TRUE ) ;
// base64エンコードして、署名[$signature]が完成する
$signature = base64_encode( $hash ) ;
// パラメータの連想配列、[$params]に、作成した署名を加える
$params_c['oauth_signature'] = $signature ;
// パラメータの連想配列を[キー=値,キー=値,...]の文字列に変換する
$header_params = http_build_query( $params_c , '' , ',' ) ;
// リクエスト用のコンテキスト
$context = array(
'http' => array(
'method' => $request_method , // リクエストメソッド
'header' => array( // ヘッダー
'Authorization: OAuth ' . $header_params ,
) ,
) ,
) ;
// パラメータがある場合、URLの末尾に追加
if( $params_a ) {
$request_url .= '?' . http_build_query( $params_a ) ;
}
// オプションがある場合、コンテキストにPOSTフィールドを作成する (GETの場合は不要)
// if( $params_a ) {
// $context['http']['content'] = http_build_query( $params_a ) ;
// }
// cURLを使ってリクエスト
$curl = curl_init() ;
curl_setopt( $curl, CURLOPT_URL , $request_url ) ;
curl_setopt( $curl, CURLOPT_HEADER, 1 ) ;
curl_setopt( $curl, CURLOPT_CUSTOMREQUEST , $context['http']['method'] ) ; // メソッド
curl_setopt( $curl, CURLOPT_SSL_VERIFYPEER , false ) ; // 証明書の検証を行わない
curl_setopt( $curl, CURLOPT_RETURNTRANSFER , true ) ; // curl_execの結果を文字列で返す
curl_setopt( $curl, CURLOPT_HTTPHEADER , $context['http']['header'] ) ; // ヘッダー
// if( isset( $context['http']['content'] ) && !empty( $context['http']['content'] ) ) { // GETの場合は不要
// curl_setopt( $curl , CURLOPT_POSTFIELDS , $context['http']['content'] ) ; // リクエストボディ
// }
curl_setopt( $curl , CURLOPT_TIMEOUT , 5 ) ; // タイムアウトの秒数
$res1 = curl_exec( $curl ) ;
$res2 = curl_getinfo( $curl ) ;
curl_close( $curl ) ;
// 取得したデータ
$json = substr( $res1, $res2['header_size'] ) ; // 取得したデータ(JSONなど)
$header = substr( $res1, 0, $res2['header_size'] ) ; // レスポンスヘッダー (検証に利用したい場合にどうぞ)
// [cURL]ではなく、[file_get_contents()]を使うには下記の通りです…
// $json = file_get_contents( $request_url , false , stream_context_create( $context ) ) ;
// JSONをオブジェクトに変換
$obj = json_decode( $json ) ;
// HTML用
$html = '' ;
// タイトル
$html .= '<h1 style="text-align:center; border-bottom:1px solid #555; padding-bottom:12px; margin-bottom:48px; color:#D36015;">GET lists/subscriptions</h1>' ;
// エラー判定
if( !$json || !$obj ) {
$html .= '<h2>エラー内容</h2>' ;
$html .= '<p>データを取得することができませんでした…。設定を見直して下さい。</p>' ;
}
// 検証用
$html .= '<h2>取得したデータ</h2>' ;
$html .= '<p>下記のデータを取得できました。</p>' ;
$html .= '<h3>ボディ(JSON)</h3>' ;
$html .= '<p><textarea style="width:80%" rows="8">' . $json . '</textarea></p>' ;
$html .= '<h3>レスポンスヘッダー</h3>' ;
$html .= '<p><textarea style="width:80%" rows="8">' . $header . '</textarea></p>' ;
// 検証用
$html .= '<h2>リクエストしたデータ</h2>' ;
$html .= '<p>下記内容でリクエストをしました。</p>' ;
$html .= '<h3>URL</h3>' ;
$html .= '<p><textarea style="width:80%" rows="8">' . $context['http']['method'] . ' ' . $request_url . '</textarea></p>' ;
$html .= '<h3>ヘッダー</h3>' ;
$html .= '<p><textarea style="width:80%" rows="8">' . implode( "\r\n" , $context['http']['header'] ) . '</textarea></p>' ;
// フッター
$html .= '<small style="display:block; border-top:1px solid #555; padding-top:12px; margin-top:72px; text-align:center; font-weight:700;">プログラムの説明: <a href="https://syncer.jp/Web/API/Twitter/REST_API/GET/lists/subscriptions/" target="_blank">SYNCER</a></small>' ;
// 出力 (本稼働時はHTMLのヘッダー、フッターを付けよう)
echo $html ;