Application Program InterfaceAPI
APIOutline
Web APIs are available to get data concerning QZSS/GPS in this QZ-vision site.
Feel free to make use of these APIs for your tool/service developing.
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 request is in XML format.
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.
APISearch
Searches for Almanacs
Request URL
http://qz-vision.jaxa.jp/api/search/almanac
This API returns a list of Almanacs 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
http://qz-vision.jaxa.jp/api/search/almanac?since_datetime=2010-12-14%2000:00:00&until_datetime=2010-12-16%2000:00:00
response
Searches for NAQUs
Request URL
http://qz-vision.jaxa.jp/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
http://qz-vision.jaxa.jp/api/search/naqu?since_datetime=2010-1-1&until_datetime=2010-12-31
response
APIGet
Gets an Almanac
Request URL
http://qz-vision.jaxa.jp/api/get/almanac
This API returns a designated Almanac.
request parameter
| parameters | format | description |
|---|---|---|
| id | string(optional) | file name If no file name is designated, the API will return the latest Almanac. |
response
The XML is in conformity wtih the schema denoted below.
http://qz-vision.jaxa.jp/Schema/Yuma/1/01
usage
request
http://qz-vision.jaxa.jp/api/get/almanac?id=qg2010352.alm.xml
response
Gets a NAQU
Request URL
http://qz-vision.jaxa.jp/api/get/naqu
This API returns a designated NAQU.
request parameter
| parameters | format | description |
|---|---|---|
| id | string(optional) | file name If no file name is designated, the API will return the latest NAQU. |
response
The XML is in conformity wtih the schema denoted below.
http://qz-vision.jaxa.jp/Schema/NAQU/1/01
usage
request
http://qz-vision.jaxa.jp/api/get/naqu?id=2010001
response
