The EDC-API allows users to access the data holding of EDC directly from user-defined scripts. Users can access the EDC-API using their favorite programming language. The principle is based on sending POST/GET requests to the EDC server. The server response will be in JSON format which is language independent. In the following, the implemented functions of the EDC-API are explained in detail with additional code examples (e.g. Python).
List satellites from the EDC.
EDC-API arguments
| Argument | Value | Description |
| username¹ | e.g. 'username' | Username to login on the EDC website |
| password¹ | e.g. 'password' | Password to login on the EDC website |
| action¹ | 'list-satellites' | Action of the request |
| status | 'past', 'present', 'future' | Status of satellite |
¹ required
Status codes of response
| Status Code | Description |
| 200 | Request successful |
| 403 | Access denied |
| 404 | Unknown API action |
| 602 | Invalid value for argument `...` |
Code examples
JSON response from EDC server
[
{
'satellite_name': 'apollo11',
'satellite_id': '0000100',
'ext': 'a11',
'sic_code': '0100',
'norad_number': None
'np_indicator': '2',
'bin_size': None,
'status': 'present'
},
{
'satellite_name': 'luna17',
'satellite_id': '0000101',
'ext': 'l17',
'sic_code': '0101',
'norad_number': None
'np_indicator': '2',
'bin_size': None,
'status': 'present'
},
... ,
{
'satellite_name': 'stella',
'satellite_id': '9306102',
'ext': 'ste',
'sic_code': '0643',
'norad_number': '22824',
'np_indicator': '5',
'bin_size': '30',
'status': 'present'
},
{
'satellite_name': 'spinsat',
'satellite_id': '9806714',
'ext': 'spi',
'sic_code': '1076',
'norad_number': '40314'
'np_indicator': '5',
'bin_size': '30',
'status': 'present',
}
]
Returns detail information about selected satellite from the EDC.
EDC-API arguments
| Argument | Value | Description |
| username¹ | e.g. 'username' | Username to login on the EDC website |
| password¹ | e.g. 'password' | Password to login on the EDC website |
| action¹ | 'satellite-info' | Action of the request |
| satellite_id | e.g. '0901301' | Satellite id |
| satellite_name | e.g. 'goce' | Name of satellite |
¹ required
Status codes of response
| Status Code | Description |
| 200 | Request successful |
| 403 | Access denied |
| 404 | Unknown API action |
| 602 | Invalid value for argument `...` |
| 603 | No data found |
Code examples
JSON response from EDC server
{
'satellite_id' : '0901301',
'sic_code' : '0499',
'norad_number' : '34602',
'satellite_name' : 'goce',
'ext' : 'goc',
'np_indicator' : '1',
'bin_size' : '5',
'status' : 'past'
}
List stations from the EDC.
EDC-API arguments
| Argument | Value | Description |
| username¹ | e.g. 'username' | Username to login on the EDC website |
| password¹ | e.g. 'password' | Password to login on the EDC website |
| action¹ | 'list-stations' | Action of the request |
| active | 'yes', 'no' | Is station active? |
¹ required
Status codes of response
| Status Code | Description |
| 200 | Request successful |
| 403 | Access denied |
| 404 | Unknown API action |
| 602 | Invalid value for argument `...` |
Code examples
JSON response from EDC server
[
{
"station_id": "1824",
"site": "Golosiiv, Ukraine",
"code": "GLSL",
"datacenter": "EDC",
"longitude": "30.4961",
"latitude": "50.3633",
"active": "yes"
},
{
"station_id": "1831",
"site": "Lviv, Ukraine",
"code": "LVIL",
"datacenter": "EDC",
"longitude": "23.9572",
"latitude": "49.9176",
"active": "yes"
},
... ,
{
"station_id": "7941",
"site": "Matera, Italy (MLRO)",
"code": "MATM",
"datacenter": "EDC",
"longitude": "16.7046",
"latitude": "40.6486",
"active": "yes"
},
{
"station_id": "8834",
"site": "Wettzell, Germany (WLRS)",
"code": "WETL",
"datacenter": "EDC",
"longitude": "12.8780",
"latitude": "49.1444",
"active": "yes"
}
]
Returns detail information about selected station from the EDC.
EDC-API arguments
| Argument | Value | Description |
| username¹ | e.g. 'username' | Username to login on the EDC website |
| password¹ | e.g. 'password' | Password to login on the EDC website |
| action¹ | 'station-info' | Action of the request |
| station_id¹ | e.g. '7080' | Station id |
¹ required
Status codes of response
| Status Code | Description |
| 200 | Request successful |
| 403 | Access denied |
| 404 | Unknown API action |
| 601 | Argument `...` is required |
| 602 | Invalid value for argument `...` |
| 603 | No data found |
Code examples
JSON response from EDC server
{
'station_id' : '7080'
'site' : 'McDonald Observatory, Texas'
'code' : 'MDOL'
'datacenter' : 'CDDIS'
'primary_name' : 'Jerry Wiant'
'primary_mail' : 'jerryrw@utexas.edu'
'secondary_name' : 'Anthony Garcia'
'secondary_mail' : 'anthg@utexas.edu'
'longitude' : '255.9848'
'latitude' : '30.6802'
'active' : 'yes'
}
List valid CPF prediction from the EDC data holding.
EDC-API arguments
| Argument | Value | Description |
| username¹ | e.g. 'username' | Username to login on the EDC website |
| password¹ | e.g. 'password' | Password to login on the EDC website |
| action¹ | 'list-predictions' | Action of the request |
| provider | e.g. 'COD', 'ESA' | Prediction provider |
| satellite | e.g. '0606203' | Satellite id |
¹ required
Status codes of response
| Status Code | Description |
| 200 | Request successful |
| 403 | Access denied |
| 404 | Unknown API action |
| 602 | Invalid value for argument `...` |
Code examples
JSON response from EDC server
[
{
'id': '495959',
'satellite': '1503701',
'provider': 'SHA',
'eph_seq': '7671',
'start_data_date': '2016-09-23 00:00:00',
'end_data_date': '2016-10-04 22:40:00'
},
{
'id': '495957',
'satellite': '1505301',
'provider': 'SHA',
'eph_seq': '7671',
'start_data_date': '2016-09-23 00:00:00',
'end_data_date': '2016-10-04 22:40:00'
},
... ,
{
'id': '497433',
'satellite': '1205502',
'provider': 'GAL',
'eph_seq': '7781',
'start_data_date': '2016-10-04 00:00:00'
'end_data_date': '2016-10-09 00:00:00',
},
{
'id': '497418',
'satellite': '7603901',
'provider': 'SGF',
'eph_seq': '7781',
'start_data_date': '2016-10-04 00:00:00'
'end_data_date': '2016-10-08 23:54:00',
}
]
List valid CPF prediction (Version 2) from the EDC data holding.
EDC-API arguments
| Argument | Value | Description |
| username¹ | e.g. 'username' | Username to login on the EDC website |
| password¹ | e.g. 'password' | Password to login on the EDC website |
| action¹ | 'list-predictions-v2' | Action of the request |
| provider | e.g. 'COD', 'ESA' | Prediction provider |
| satellite | e.g. '0606203' | Satellite id |
¹ required
Status codes of response
| Status Code | Description |
| 200 | Request successful |
| 403 | Access denied |
| 404 | Unknown API action |
| 602 | Invalid value for argument `...` |
Code examples
JSON response from EDC server
[
{
'id': '117861',
'satellite': '2109601',
'provider': 'QSS',
'eph_seq': '108',
'eph_seq_daily': '1',
'start_data_date': '2022-04-18 00:00:00',
'end_data_date': '2022-04-26 00:00:00'
},
{
'id': '117862',
'satellite': '1702801',
'provider': 'QSS',
'eph_seq': '108',
'eph_seq_daily': '1',
'start_data_date': '2022-04-18 00:00:00',
'end_data_date': '2022-04-26 00:00:00'
},
... ,
{
'id': '118817',
'satellite': '0702601',
'provider': 'GFZ',
'eph_seq': '115',
'eph_seq_daily': '1',
'start_data_date': '2022-04-25 01:01:42'
'end_data_date': '2022-04-30 00:00:42',
},
{
'id': '118875',
'satellite': '2105922',
'provider': 'TUB',
'eph_seq': '115',
'eph_seq_daily': '1',
'start_data_date': '2022-04-25 06:00:16',
'end_data_date': '2022-05-02 06:00:16',
}
]
Search in the EDC data holding using user-defined criteria.
Data query is limited to maximum 10000 results.
EDC-API arguments
| Argument | Value | Description |
| username¹ | e.g. 'username' | Username to login on the EDC website |
| password¹ | e.g. 'password' | Password to login on the EDC website |
| action¹ | 'data-query' | Action of the request |
| data_type¹ | 'NPT_v2', 'FRD_v2', 'CRD_v2', 'NPT', 'FRD', 'CRD', 'NP', 'FR', 'LTT' |
Name of data type |
| start_data_date | e.g. '2016-02%', '2016-02-01%' | Start data date |
| end_data_date | e.g. '2016-02%', '2016-02-01%' | End data date |
| satellite | e.g. '0803201' | Satellite ID |
| provider | e.g. 'COD' | Prediction provder (only for CPF) |
| station | e.g. '78403501' | Station SOD (not for CPF) |
¹ required
Status codes of response
| Status Code | Description |
| 200 | Request successful |
| 403 | Access denied |
| 404 | Unknown API action |
| 601 | Argument `...` is required |
| 602 | Invalid value for argument `...` |
| 603 | No data found |
Code examples
JSON response from EDC server
[
{
'id': '1184710',
'satellite': '1106402',
'station': '72371901',
'start_data_date': '2016-02-01 00:11:24'
'end_data_date': '2016-02-01 01:31:33',
'version': '00',
'observations': '3',
'wavelength': '532.000',
'status': 'valid',
'errors': '',
'incoming_date': '2016-02-01 04:37:34',
'incoming_filename': '7237_glonass129_crd_20160201_00_00.npt'
},
{
'id': '1186586',
'satellite': '1106402',
'station': '18889801',
'start_data_date': '2016-02-01 12:41:41'
'end_data_date': '2016-02-01 12:46:51',
'version': '00',
'observations': '1',
'wavelength': '532.000',
'status': 'valid',
'errors': '',
'incoming_date': '2016-02-04 06:01:07',
'incoming_filename': '1888_glonass129_CRD_20160201_1241_01.npt',
},
... ,
{
'id': '1185259',
'satellite': '1106402',
'station': '72371901',
'start_data_date': '2016-02-01 20:46:02'
'end_data_date': '2016-02-01 20:48:36',
'version': '00',
'observations': '1',
'wavelength': '532.000',
'status': 'valid',
'errors': '',
'incoming_date': '2016-02-01 22:44:29',
'incoming_filename': '7237_glonass129_crd_20160201_20_00.npt',
},
{
'id': '1185287',
'satellite': '1106402',
'station': '78212801',
'start_data_date': '2016-02-01 21:41:16'
'end_data_date': '2016-02-01 21:55:39',
'version': '00',
'observations': '4',
'wavelength': '532.000',
'status': 'valid',
'errors': '',
'incoming_date': '2016-02-01 22:46:30',
'incoming_filename': '7821_glonass129_crd_20160201_21_00.npt',
}
]
Get detailed information about a certain dataset in the EDC data holding.
EDC-API arguments
| Argument | Value | Description |
| username¹ | e.g. 'username' | Username to login on the EDC website |
| password¹ | e.g. 'password' | Password to login on the EDC website |
| action¹ | 'data-query' | Action of the request |
| id¹ | e.g. '1300505' | ID of dataset |
| data_type¹ | 'NPT_v2', 'FRD_v2', 'CRD_v2', 'NPT', 'FRD', 'CRD', 'NP', 'FR', 'LTT' |
Name of data type |
¹ required
Status codes of response
| Status Code | Description |
| 200 | Request successful |
| 403 | Access denied |
| 404 | Unknown API action |
| 601 | Argument `...` is required |
| 602 | Invalid value for argument `...` |
| 603 | No data found |
Code examples
JSON response from EDC server
{
'id' : '1300505',
'satellite' : '0803201',
'station' : '88341001',
'start_data_date' : '2016-09-27 05:36:55',
'end_data_date' : '2016-09-27 05:40:03',
'version' : '00',
'observations' : '14',
'wavelength' : '532.000',
'incoming_date' : '2016-09-27 05:45:25',
'incoming_filename' : '8834_jason2_crd_20160927_05_00.det1.npt',
'status' : 'valid',
'errors' : ''
}
Download a dataset of the EDC data holding.
EDC-API arguments
| Argument | Value | Description |
| username¹ | e.g. 'username' | Username to login on the EDC website |
| password¹ | e.g. 'password' | Password to login on the EDC website |
| action¹ | 'data-download' | Action of the request |
| id¹ | e.g. '1300505' | ID of dataset |
| data_type¹ | 'NPT_v2', 'FRD_v2', 'CRD_v2', 'NPT', 'FRD', 'CRD', 'NP', 'FR', 'LTT' |
Name of data type |
¹ required
Status codes of response
| Status Code | Description |
| 200 | Request successful |
| 403 | Access denied |
| 404 | Unknown API action |
| 601 | Argument `...` is required |
| 602 | Invalid value for argument `...` |
| 603 | No data found |
Code examples
JSON response from EDC server
[
'h1 CRD 1 2016 9 27 5',
'h2 WETL 8834 10 1 4',
'h3 jason2 803201 1025 33105 0 1',
'h4 1 2016 9 27 5 36 55 2016 9 27 5 40 3 0 0 0 0 1 0 2 0',
'c0 0 532.000 std las1 det1 tim1',
'c1 0 las1 Nd:YAG 1064.00 20.00 30.00 180.0 1.00 1',
'c2 0 det1 PMT210_MCP 532.000 12.00 -4400.0 0.2 photon-dependent 170.0 532.00 45.0 0.0 ORTEC-9327',
'c3 0 tim1 TAC EFOS-18 Dassault2396-201-000 02,09,10,14 0.0',
'60 std 1 2',
'11 20215.500073455576 0.009663975853 std 2 15.0 16 58.0 -1.000 -1.000 -1.0 0.0 0',
'20 20215.500 952.70 283.80 98 1',
'40 20215.500073455576 0 std -1 -1 -1.000 119110.0 16.0 34.0 -1.000 -1.000 -1.0 3 2 0',
'11 20230.900072863158 0.009842272054 std 2 15.0 29 60.0 -1.000 -1.000 -1.0 0.0 0',
'11 20237.900125266620 0.009936374141 std 2 15.0 39 61.0 -1.000 -1.000 -1.0 0.0 0',
'11 20259.049947859454 0.010267350965 std 2 15.0 96 63.0 -1.000 -1.000 -1.0 0.0 0',
'11 20271.599999860931 0.010494820479 std 2 15.0 88 57.0 -1.000 -1.000 -1.0 0.0 0',
'11 20285.950000066926 0.010780972697 std 2 15.0 21 44.0 -1.000 -1.000 -1.0 0.0 0',
'11 20299.800000063265 0.011081542844 std 2 15.0 9 57.0 -1.000 -1.000 -1.0 0.0 0',
'11 20317.799948056163 0.011504764229 std 2 15.0 15 63.0 -1.000 -1.000 -1.0 0.0 0',
'11 20335.400000054930 0.011950628101 std 2 15.0 11 18.0 -1.000 -1.000 -1.0 0.0 0',
'11 20348.250000067470 0.012294122208 std 2 15.0 27 68.0 -1.000 -1.000 -1.0 0.0 0',
'11 20358.250000058551 0.012570995229 std 2 15.0 8 62.0 -1.000 -1.000 -1.0 0.0 0',
'11 20376.850000068391 0.013106204644 std 2 15.0 15 64.0 -1.000 -1.000 -1.0 0.0 0',
'11 20391.700000067837 0.013550567552 std 2 15.0 12 78.0 -1.000 -1.000 -1.0 0.0 0',
'11 20403.449947868794 0.013911805946 std 2 15.0 6 71.0 -1.000 -1.000 -1.0 0.0 0',
'50 std 60.0 -1.000 -1.000 -1.0 0',
'h8',
'H9'
]