YOLP(地図)
気象情報API
【重要】常時SSL(AOSSL)対応にともないリクエストURLが変更されています。詳しくはこちらをご確認ください。リクエストURL
XML
https://map.yahooapis.jp/weather/V1/place
JSONP
https://map.yahooapis.jp/weather/V1/place
目次
概要
- 指定した緯度経度の雨の強さを取得できるAPIです。
- 現在時刻の降水強度実測値から、60分後までの降水強度予測値を取得できます。
リクエストパラメーター一覧
「RESTリクエストの構築(GET)」をご参照ください。
パラメーター | 値 | 説明 |
---|---|---|
appid(必須) | string | アプリケーションID。詳細はこちらをご覧ください。 |
coordinates(必須) | string | 緯度経度です。
|
output | string | 出力形式です。
|
callback | string | JSONPとして出力する際のコールバック関数名を入力するためのパラメーター。UTF-8でエンコードした文字列を指定してください。 |
date | string | 日時を指定します(YYYYMMDDHHMI形式)。現在から2時間前までの日時を指定できます。 |
past | integer | 過去の降水強度実測値を取得する場合に指定できます。
|
interval | integer | 取得間隔を指定してください。
|
サンプルリクエストURL
東京都港区六本木付近の緯度:35.663613、経度:139.732293のリクエストです。
https://map.yahooapis.jp/weather/V1/place?coordinates=139.732293,35.663613&appid=<あなたのアプリケーションID>
API使用上の注意
URLの最大の長さは2048バイトです。
URLをエンコードして指定するパラメーターもありますが、エンコード後のURLの長さが2048バイトを超えないようにしてください。
レスポンス
出力形式にXMLを指定(output=xml)した場合、XMLを返します。レスポンスフィールドをご参照ください。
レスポンスフィールド
フィールド | 説明 |
---|---|
YDF | クエリーレスポンスのすべてを含みます。 |
ResultInfo | レスポンスのまとめ情報です。 |
Count | レスポンスに含まれるデータ件数です。 |
Total | 全データ件数です。 |
Start | 全データからの取得開始位置です。 |
Status | リクエストに処理結果を伝えるためのコードです。正常終了の場合、200を出力します。エラーの場合は、下記エラー項目を参照してください。 |
Latency | レスポンスを生成するのに要した時間です。 |
Description | データの説明です。詳細情報がある場合に表示されます。 |
Copyright | コピーライトです。 |
Feature | 検索結果1件分のデータです。 |
Id | データの識別子です。 |
Name | データの名称です。 |
Geometry | 拠点の場所を表すGeometry要素です(世界測地系)。 |
Type | 図形種別です。 |
Coordinates | 座標情報です。 |
Property | 地点の詳細情報です。 |
WeatherAreaCode | 一次細分コード(4桁)です。 |
WeatherList | 気象情報リストです(実測値および予測値)。 |
Weather | 気象情報です。 |
Type | 気象情報の区分です。
|
Date | 日付と時刻です(YYYYMMDDHHMI形式)。 |
Rainfall | 降水強度です(単位:mm/h)。小数点第二位までの精度です。 ※降水強度は、気象レーダーで観測された降水の強さを時間雨量(mm/h)に換算した値で、実際の雨量とは異なります。 |
サンプルレスポンス
東京都港区六本木付近の緯度:35.663613、経度:139.732293のサンプルレスポンスです。
<YDF xmlns="http://olp.yahooapis.jp/ydf/1.0" firstResultPosition="1" totalResultsAvailable="1" totalResultsReturned="1"> <ResultInfo> <Count>1</Count> <Total>1</Total> <Start>1</Start> <Status>200</Status> <Latency>0.004408</Latency> <Description/> <Copyright>(C) Yahoo Japan Corporation.</Copyright> </ResultInfo> <Feature> <Id>201210191610_139.73229_35.663613</Id> <Name> 地点(139.73229,35.663613)の2012年10月19日 16時10分から60分間の天気情報 </Name> <Geometry> <Type>point</Type> <Coordinates>139.73229,35.663613</Coordinates> </Geometry> <Property> <WeatherAreaCode>4410</WeatherAreaCode> <WeatherList> <Weather> <Type>observation</Type> <Date>201210191610</Date> <Rainfall>1.65</Rainfall> </Weather> <Weather> <Type>forecast</Type> <Date>201210191620</Date> <Rainfall>0.00</Rainfall> </Weather> <Weather> <Type>forecast</Type> <Date>201210191630</Date> <Rainfall>0.00</Rainfall> </Weather> <Weather> <Type>forecast</Type> <Date>201210191640</Date> <Rainfall>0.85</Rainfall> </Weather> <Weather> <Type>forecast</Type> <Date>201210191650</Date> <Rainfall>1.15</Rainfall> </Weather> <Weather> <Type>forecast</Type> <Date>201210191700</Date> <Rainfall>0.85</Rainfall> </Weather> <Weather> <Type>forecast</Type> <Date>201210191710</Date> <Rainfall>1.15</Rainfall> </Weather> </WeatherList> </Property> </Feature> </YDF>
エラー
コード | 説明 |
---|---|
400 | 渡されたパラメーターがWeb APIで期待されたものと一致しない場合に返されます。 |
503 | 内部的な問題によってデータを返すことができない場合に返されます。 |
リクエストに対するエラーレスポンスです。
<?xml version="1.0" encoding="UTF-8"?> <Error> <Code>400</Code> <Message>Bad Request</Message> </Error>
利用制限
気象情報APIは、24時間中1アプリケーションIDにつき50000件のリクエストが上限となっています。詳しくは「利用制限」をご参照ください。