コンテンツです

Application Programming Interface

Outline

Web APIs are available to get data concerning QZSS/GPS in this QZSS site. Feel free to make use of these APIs for your tool/service developing.

QZSS archive data (about Satellite Positioning, Navigation and Timing Service) have been available since April 14, 2017. At present, you can download all the data since April 1, 2017.

Request method

The APIs are based on the HTTP protocol GET method. The description in the request shall be URL encoded. The response from the search request is in XML format. The response from the get request is the public data file which an appropriate HTTP header was set.

Warning

The APIs shall only be used for not-for-profit tools and services. Neither the integrity of the API behavior nor the data attained from it are guaranteed. At the moment, there are no limits on the users' API actions, although we may place limits on the actions in the future without prior notice. The APIs are subject to updates without prior notice. The usage of archive data via APIs shall be deemed to have been agreed to the disclaimer of liability for public archives.

Search

Searches for Public Archives

Request URL(Ex. Almanac)

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

This API returns a list of Public Archives available in a designated time span. The following table show Public Archives category.

Public Archives List

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

Request Parameter

Parameters	Format	Description
since_datetime	string(optional)	date & time to search starting since(UTC) [YYYY-MM-DD hh:mm:ss]
until_datetime	string(optional)	date & time to search until(UTC) [YYYY-MM-DD hh:mm:ss]
since_week	integer(optional)	GPS Week to search starting since
until_week	integer(optional)	GPS Week to search until
since_weeksec	integer(optional)	second of week to search starting since
until_weeksec	integer(optional)	second of week to search until

Usage

Request

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

Response

            <search>
             <id>qg2010352.alm</id>
             <id>qg2010351.alm</id>
             <id>qg2010350.alm</id>
            </search>

Searches for NAQUs

Request URL

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

This API return a list of NAQUs available in a designated time span.

Request Parameter

Parameters	Format	Description
since_datetime	string(optional)	date & time to search starting since(UTC) [YYYY-MM-DD hh:mm:ss]
until_datetime	string(optional)	date & time to search until(UTC) [YYYY-MM-DD hh:mm:ss]
since_week	integer(optional)	GPS Week to search starting since
until_week	integer(optional)	GPS Week to search until
since_weeksec	integer(optional)	second of week to search starting since
until_weeksec	integer(optional)	second of week to search until

Usage

Request

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

Response

            <search>
             <id>2017004</id>
             <id>2017003</id>
             <id>2017002</id>
             <id>2017001</id>
            </search>

Get

Gets an Public Archive

Request URL(Ex. Almanac)

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

This API returns a designated Public Archive. The following table show Public Archives category.

Public Archives List

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

Request Parameter

Parameters	Format	Description
id	string(optional)	file name If no file name is designated, the API will return the latest Public Archive.

Usage

Request

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

Response

The response from the get request is the following HTTP headers and the HTTP body which the contents of public archive data were set.

Content-Type:application/octet-stream

Content-Disposition:attachment;filename=(Public Archive file name)

Content-Length:(Public Archive file size)

Gets a NAQU

Request URL

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

This API returns a designated NAQU.

Request Parameter

Parameters	Format	Description
id	string(optional)	NAQU number If no NAQU number is designated, the API will return the latest NAQU.

Usage

Request

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

Response

The response from the get request is the following HTTP headers and the HTTP body which the contents of NAQU were set.

Content-Type:text/plain

            NOTICE ADVISORY TO QZSS USERS (NAQU) 2016836
            SUBJ: SVN002 (PRN194) UNUSABLE JDAY 224/0000 - JDAY 225/2359
            1.      NAQU TYPE: PNT_UNUNOREF
                    NAQU NUMBER: 2016836
                    NAQU DTG: 101147Z AUG 2016
                    REFERENCE NAQU: N/A
                    REF NAQU DTG: N/A
                    SVN: 002
                    PRN: 194
                    START JDAY: 224
                    START TIME ZULU: 0000
                    START CALENDAR DATE: 11 AUG 2016
                    STOP JDAY: 225
                    STOP TIME ZULU: 2359
                    STOP CALENDAR DATE: 12 AUG 2016
            
            2.  CONDITION: QZSS SATELLITE SVN002 (PRN194) WAS UNUSABLE ON JDAY 224
                (11 AUG 2016) BEGINNING 0000 ZULU UNTIL JDAY 225 (12 AUG 2016)
                ENDING 2359 ZULU.
            
            3.  POC: - QZSS Services, HTTPS://QZSS.GO.JP/