コンテンツです

Application Programming Interface

概要

準天頂衛星システムでは、QZSS・GPSに関わるデータ取得機能をWeb APIとして公開しています。さまざまなツール開発やサービスの開発にお役立てください。

衛星測位サービスの公開アーカイブデータはApr.14, 2017よりダウンロードできるようになりました。Apr.1, 2017からのデータを利用できます。

リクエスト方法

全てHTTPプロトコルのGETメソッドによって行われます。リクエストパラメータはURLエンコードされている必要があります。レスポンスについては検索の場合はXML形式にて返却されます。取得の場合は公開データの種別毎に適切なHTTPヘッダを設定し、公開データファイルを返却します。

注意点

提供する全てのAPIは、非商用の目的でのみご利用頂けます。APIの動作の完全性やデータの正確性を保証するものではありません。現在、APIの利用回数に関する制限は設けておりませんが、状況に応じて事前の告知なしに制限をかける可能性があります。APIは事前の告知なしにアップデートする可能性があります。

検索

公開アーカイブデータを検索

リクエストURL(例:アルマナック)

http://sys.qzss.go.jp/dod/api/search/almanac

取得可能な公開アーカイブデータの検索機能を提供します。公開アーカイブデータの種類を下表に示します。

公開アーカイブデータ一覧

Data Type URL
Almanac
QZSS+GPS Almanac http://sys.qzss.go.jp/dod/api/search/almanac
QZSS Almanac
GPS Almanac
Ephemeris(Rinex Extension version)
QZSS Ephemeris http://sys.qzss.go.jp/dod/api/search/ephemeris-qzss
GPS ephemeris
Ephemeris
QZSS Ephemeris http://sys.qzss.go.jp/dod/api/search/ephemeris
GPS ephemeris
Ultra Rapid Products
QZU Orbit http://sys.qzss.go.jp/dod/api/search/ultra-rapid-sp3
QZU ERP http://sys.qzss.go.jp/dod/api/search/ultra-rapid-erp
Rapid Products
QZR Orbit http://sys.qzss.go.jp/dod/api/search/rapid-sp3
QZR Clock http://sys.qzss.go.jp/dod/api/search/rapid-clk
QZR ERP http://sys.qzss.go.jp/dod/api/search/rapid-erp
Final Products
QZF Orbit http://sys.qzss.go.jp/dod/api/search/final-sp3
QZF Clock http://sys.qzss.go.jp/dod/api/search/final-clk
QZF ERP http://sys.qzss.go.jp/dod/api/search/final-erp
QZF Station Coordinate(in a day) http://sys.qzss.go.jp/dod/api/search/final-snx
QZF Station Coordinate(in a week) http://sys.qzss.go.jp/dod/api/search/final-snx-w
Sub-meter Level Augmentation Service
L1S Signal http://sys.qzss.go.jp/dod/api/search/l1s
Centimeter Level Augmentation Service
L6 Signal http://sys.qzss.go.jp/dod/api/search/l6
QZSS Safety Confirmation Service
Anpi http://sys.qzss.go.jp/dod/api/search/anpi

リクエストパラメータ

パラメータ フォーマット 説明
since_datetime 文字列(optional) 検索開始ファイル公開日時(UTC)
[YYYY-MM-DD hh:mm:ss]
until_datetime 文字列(optional) 検索終了ファイル公開日時(UTC)
[YYYY-MM-DD hh:mm:ss]
since_week 整数(optional) 検索開始ファイル公開GPS Week
until_week 整数(optional) 検索終了ファイル公開GPS Week
since_weeksec 整数(optional) 検索開始ファイル公開週内秒
until_weeksec 整数(optional) 検索終了ファイル公開週内秒

使用例

リクエスト

http://sys.qzss.go.jp/dod/api/search/almanac?since_datetime=2010-12-14 00:00:00&until_datetime=2010-12-16 00:00:00

NAQU情報を検索

リクエストURL

http://sys.qzss.go.jp/dod/api/search/naqu

取得可能なNAQU情報の検索機能を提供します。

リクエストパラメータ

パラメータ フォーマット 説明
since_datetime 文字列(optional) 検索開始ファイル公開日時(UTC)
[YYYY-MM-DD hh:mm:ss]
until_datetime 文字列(optional) 検索終了ファイル公開日時(UTC)
[YYYY-MM-DD hh:mm:ss]
since_week 整数(optional) 検索開始ファイル公開GPS Week
until_week 整数(optional) 検索終了ファイル公開GPS Week
since_weeksec 整数(optional) 検索開始ファイル公開週内秒
until_weeksec 整数(optional) 検索終了ファイル公開週内秒

使用例

リクエスト

http://sys.qzss.go.jp/dod/api/search/naqu?since_datetime=2017-01-01 00:00:00&until_datetime=2017-12-31 00:00:00

取得

公開アーカイブデータを取得

リクエストURL(例:アルマナック)

http://sys.qzss.go.jp/dod/api/get/almanac

公開アーカイブデータの取得機能を提供します。公開アーカイブデータの種類を下表に示します。

公開アーカイブデータ一覧

Data Type URL
Almanac
QZSS+GPS Almanac http://sys.qzss.go.jp/dod/api/get/almanac
QZSS Almanac
GPS Almanac
Ephemeris(Rinex Extension version)
QZSS Ephemeris http://sys.qzss.go.jp/dod/api/get/ephemeris-qzss
GPS ephemeris
Ephemeris
QZSS Ephemeris http://sys.qzss.go.jp/dod/api/get/ephemeris
GPS ephemeris
Ultra Rapid Products
QZU Orbit http://sys.qzss.go.jp/dod/api/get/ultra-rapid-sp3
QZU ERP http://sys.qzss.go.jp/dod/api/get/ultra-rapid-erp
Rapid Products
QZR Orbit http://sys.qzss.go.jp/dod/api/get/rapid-sp3
QZR Clock http://sys.qzss.go.jp/dod/api/get/rapid-clk
QZR ERP http://sys.qzss.go.jp/dod/api/get/rapid-erp
Final Products
QZF Orbit http://sys.qzss.go.jp/dod/api/get/final-sp3
QZF Clock http://sys.qzss.go.jp/dod/api/get/final-clk
QZF ERP http://sys.qzss.go.jp/dod/api/get/final-erp
QZF Station Coordinate(in a day) http://sys.qzss.go.jp/dod/api/get/final-snx
QZF Station Coordinate(in a week) http://sys.qzss.go.jp/dod/api/get/final-snx-w
Sub-meter Level Augmentation Service
L1S Signal http://sys.qzss.go.jp/dod/api/get/l1s
Centimeter Level Augmentation Service
L6 Signal http://sys.qzss.go.jp/dod/api/get/l6
QZSS Safety Confirmation Service
Anpi http://sys.qzss.go.jp/dod/api/get/anpi

リクエストパラメータ

パラメータ フォーマット 説明
id 文字列(optional) ファイル識別子
指定が無い場合は、最新の公開アーカイブデータを取得します。

使用例

リクエスト

http://sys.qzss.go.jp/dod/api/get/almanac?id=qg2010352.alm

レスポンス

以下のHTTPヘッダが設定され、HTTPボディに公開アーカイブデータの内容が返却されます。

Content-Type:application/octet-stream

Content-Disposition:attachment;filename=(公開アーカイブデータファイル名)

Content-Length:(公開アーカイブデータファイルサイズ)

NAQU情報を取得

リクエストURL

http://sys.qzss.go.jp/dod/api/get/naqu

NAQU情報の取得機能を提供します。

リクエストパラメータ

パラメータ フォーマット 説明
id 文字列(optional) NAQU番号
指定が無い場合は、最新のNAQU情報を取得します

使用例

リクエスト

http://sys.qzss.go.jp/dod/api/get/naqu?id=2016836

以下のHTTPヘッダが設定され、HTTPボディに 指定されたNAQU番号の内容が返却されます。

Content-Type:text/plain