GET geo/search - 場所を検索する
公開日:
geo/search(GETメソッド)は、場所を検索するエンドポイントです。キーワード、緯度と経度、IPアドレスのいずれかを材料に検索できます。
- GET geo/search
- Twitterの公式リファレンス(英語)。geo/searchに関する説明があります。
リソース
エンドポイント
GET https://api.twitter.com/1.1/geo/search.json
条件
項目 | ユーザー認証 | アプリケーション認証 |
---|---|---|
利用 | ● | × |
パーミッション | Read | - |
レートリミット | 15 / 15min | - |
パラメータ
query
指定例: Tokyo
検索キーワード。
lat
指定例: 35.79449997305192
緯度。
long
指定例: 139.79078800000002
経度。
ip
指定例: 1.2.3.4
IPアドレス。Geolocationを利用して検索できる。
granularity
指定例: neighborhood
取得する場所の精度を指定する。大まかに、場所の種類という認識で支障はない…はず。neighborhood
、poi
、city
、admin
、country
から指定可。省略した場合は、neighborhood
となる。
accuracy
指定例: 500m
誤差の範囲を半径を示す数値で指定する。単位はm
(メートル)、またはft
(フィート)を指定でき、省略した場合はメートルになる。
max_results
指定例: max_results
最大取得件数。省略した場合は、全て取得する。
contained_within
指定例: 06ef846bfc783874
場所IDを指定することで、検索範囲をその場所内に絞ることができる。
attribute:street_address
指定例: 795 Folsom St
番地で場所を絞り込める。指定できるのは、場所として登録されているもの。場所の情報のattributes.street_address
で確認できる。
callback
指定例: myFunction
コールバックの関数名。JSONPで取得した場合に、その関数を呼び出してくれる。
レスポンス
アクセストークン(OAuth1.0)でリクエストをした場合の例です。
リクエストURL
https://api.twitter.com/1.1/geo/search.json?query=Tokyo
リクエストヘッダー
Authorization: OAuth oauth_consumer_key=:consumer_key,oauth_nonce=0.71955200+1484650768,oauth_signature_method=HMAC-SHA1,oauth_timestamp=1484650768,oauth_token=:access_token,oauth_version=1.0,query=Tokyo,oauth_signature=r%2BNjqPUHLKiFyPQUgtm0AK%2BV%2Ffs%3D
レスポンスボディ (JSON)
JSON
{"result":{"places":[{"id":"a56612250c754f23","url":"https:\/\/api.twitter.com\/1.1\/geo\/id\/a56612250c754f23.json","place_type":"admin","name":"Tokyo-to","full_name":"Tokyo-to, Japan","country_code":"JP","country":"Japan","contained_within":[{"id":"06ef846bfc783874","url":"https:\/\/api.twitter.com\/1.1\/geo\/id\/06ef846bfc783874.json","place_type":"country","name":"Japan","full_name":"Japan","country_code":"JP","country":"Japan","centroid":[138.33054107905528,36.260548400000005],"bounding_box":{"type":"Polygon","coordinates":[[[122.9040343,24.0133434],[122.9040343,45.562897],[153.9976966,45.562897],[153.9976966,24.0133434],[122.9040343,24.0133434]]]},"attributes":{}}],"centroid":[139.4914357589862,35.699818500000006],"bounding_box":{"type":"Polygon","coordinates":[[[138.942847,24.224701],[138.942847,35.89849],[153.986676,35.89849],[153.986676,24.224701],[138.942847,24.224701]]]},"attributes":{}}]},"query":{"url":"https:\/\/api.twitter.com\/1.1\/geo\/search.json?query=Tokyo","type":"search","params":{"accuracy":0.0,"granularity":"neighborhood","query":"Tokyo","autocomplete":false,"trim_place":false}}}
レスポンスヘッダー
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: 1120
content-type: application/json;charset=utf-8
date: Tue, 17 Jan 2017 10:59:28 GMT
expires: Tue, 31 Mar 1981 05:00:00 GMT
last-modified: Tue, 17 Jan 2017 10:59:28 GMT
pragma: no-cache
server: tsa_m
set-cookie: guest_id=v1%3A148465076879053350; Domain=.twitter.com; Path=/; Expires=Thu, 17-Jan-2019 10:59:28 UTC
status: 200 OK
strict-transport-security: max-age=631138519
x-access-level: read
x-connection-hash: 41b016ed3e3fa13510af29761d6ea7e9
x-content-type-options: nosniff
x-frame-options: SAMEORIGIN
x-rate-limit-limit: 15
x-rate-limit-remaining: 14
x-rate-limit-reset: 1484651668
x-response-time: 122
x-transaction: 00a9969a00e7289e
x-twitter-response-tags: BouncerCompliant
x-xss-protection: 1; mode=block
デモ
geo/searchのリクエストを試すことができます。ユーザー認証のデモを試す場合は、アプリケーション(読取権限)の連携を許可する必要があります。利用後、お手数ですが連携の解除をお願いします。連携を解除し忘れたとしても、当アプリケーションが許可なくデータにアクセスすることはありません。
サンプルコード
geo/searchのエンドポイントを利用するためのサンプルプログラムです。各種トークンの情報をセットしてからPHPで起動して下さい。リクエストに成功すると、$json
という変数に目的のデータが代入されます。このデータを整形するなり保存するなり、活用して下さい。
アクセストークン
PHP (OAuth1.0)
<?php
/**************************************************
[GET geo/search]のお試しプログラム
認証方式: アクセストークン
配布: SYNCER
公式ドキュメント: https://dev.twitter.com/rest/reference/get/geo/search
日本語解説ページ: https://syncer.jp/Web/API/Twitter/REST_API/GET/geo/search/
**************************************************/
// 設定
$api_key = '' ; // APIキー
$api_secret = '' ; // APIシークレット
$access_token = '' ; // アクセストークン
$access_token_secret = '' ; // アクセストークンシークレット
$request_url = 'https://api.twitter.com/1.1/geo/search.json' ; // エンドポイント
$request_method = 'GET' ;
// パラメータA (オプション)
$params_a = array(
"query" => "Tokyo",
// "lat" => "35.79449997305192",
// "long" => "139.79078800000002",
// "ip" => "1.2.3.4",
// "granularity" => "neighborhood",
// "accuracy" => "500m",
// "max_results" => "max_results",
// "contained_within" => "06ef846bfc783874",
// "attribute:street_address" => "795 Folsom St",
// "callback" => "myFunction",
) ;
// キーを作成する (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 geo/search</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/geo/search/" target="_blank">SYNCER</a></small>' ;
// 出力 (本稼働時はHTMLのヘッダー、フッターを付けよう)
echo $html ;