{"openapi":"3.0.0","servers":[{"url":""}],"info":{"contact":{"x-twitter":"amentumspace"},"description":"Space has a hostile radiation environment that increases the risk of cancers in humans and malfunctions in spacecraft electronics. The types of space radiation of primary concern are:\n \n\nUnderstanding the space radiation environment for a particular mission profile is becoming increasingly important. Commercial off-the-shelf electronic components that aren't resilient to space radiation are now prevalent. Longer duration missions to cislunar space, Mars, and beyond are placing astronauts at greater risk of radiation exposure.

\nAPI requests must contain a key \"API-Key\" in the header (see code samples). Obtain a key from here.

\nHelp us improve the quality of our web APIs by completing our 2 minute survey here.

\nAmentum Pty Ltd is not responsible nor liable for any loss or damage of any sort incurred as a result of using the API.

\nCopyright Amentum Pty Ltd 2022.\n","title":"Space Radiation API","version":"1.1.2","x-apisguru-categories":["location","open_data"],"x-logo":{"altText":"Amentum Aerospace","backgroundColor":"#FFFFFF","url":"https://twitter.com/amentumspace/profile_image?size=original"},"x-origin":[{"format":"openapi","url":"https://spaceradiation.amentum.space/openapi.json","version":"3.0"}],"x-providerName":"amentum.space","x-serviceName":"space_radiation"},"tags":[{"description":"AE9/AP9/SPM is a set of models developed by the US Air Force Research Laboratory that calculates the fluxes of trapped radiation (radiation belt and plasma particles in near-Earth space) for use in space system design, mission planning, and other climatological applications.

\nA description of the AE9/AP9/SPM models, including energy ranges for which the respective models are valid, can be found here.

\nThe following endpoints wrap the original Ae9Ap9 code (version 1.50.001) which is available here.

\nNote: The AE9/AP9/SPM models use the International Geomagnetic Reference Field 12 that is valid for dates between decimal years 2015.0 and 2020.0. If a decimal year greater than 2020.0 is specified as input, the IGRF values are approximated by those of 31st December 2019. According to the model authors, this approximation is insignificant compared to other uncertainties, and will be improved with the release of v1.6 of the Ae9Ap9 code (scheduled for 2023).

\n","name":"trapped","x-displayName":"AE9/AP9/SPM trapped radiation models"},{"description":"This endpoint provides access to Amentum's implementation of the DLR Galactic Cosmic Radiation model.

A description of the model can be found in the scientific article \"A ready-to-use galactic cosmic ray model\", Matthiä, Daniel, et al., Advances in Space Research 51.3 (2013): 329-338.

It accounts for solar modulation using a single parameter, W, derived from measurements of carbon flux by the Cosmic Ray Isotope Spectrometer aboard the Advanced Composition Explorer spacecraft.

A linear relationship between W and terrestrial based neutron monitor count rates (measured at the Oulu station in Finland) has been established:
W = -0.093 cr + 638.7
Our implementation uses Oulu station count rates as input, calculating galactic cosmic ray flux on a particular date. \n","name":"gcr","x-displayName":"DLR galactic cosmic radiation model"}],"paths":{"/gcr/flux_dlr":{"get":{"description":"for the given energy, atomic number, and date.\n","operationId":"app.api.endpoints.GCR.calculate_dlr_flux","parameters":[{"$ref":"#/components/parameters/Year"},{"$ref":"#/components/parameters/Month"},{"$ref":"#/components/parameters/Day"},{"$ref":"#/components/parameters/Z"},{"$ref":"#/components/parameters/Energy"}],"responses":{"200":{"content":{"application/json":{"example":{"flux":{"units":"/m^2/s/sr/(MeV/n)","value":0.006709578488527858}},"schema":{"$ref":"#/components/schemas/FluxAtEnergy"}}},"description":"Successful flux calculation"}},"summary":"Calculate particle flux \n","tags":["gcr"],"x-codeSamples":[{"lang":"Shell","source":"curl -X GET \"https://spacerad.amentum.io/gcr/flux_dlr?year=2017&month=1&day=1&z=6&energy=100\" -H \"API-Key: \" -H \"accept: application/json\"\n"},{"lang":"Python","source":"import requests\n\nparams = dict(\n year=2017,\n month=1,\n day=1, \n z=6,\n energy=100\n)\nheaders = {\"API-Key\" : \"\"}\n# Make the API call\ntry:\n response = requests.get(\"https://spacerad.amentum.io/gcr/flux_dlr\", params=params, headers=headers)\n response_json = response.json()\n response.raise_for_status()\nexcept requests.exceptions.HTTPError as e:\n print(response_json['error'])\nelse:\n # Extract the flux\n flux = response_json['flux']['value']\n f_unit = response_json['flux']['units']\n print(\"Flux: \", flux, f_unit)\n"}]}},"/trapped/flux_mean":{"get":{"description":"at given coordinates and date-time.\n","operationId":"app.api.endpoints.TrappedRadiation.calculate_flux_mean","parameters":[{"$ref":"#/components/parameters/Model"},{"$ref":"#/components/parameters/CoordSystem"},{"$ref":"#/components/parameters/CoordUnits"},{"$ref":"#/components/parameters/Coord1"},{"$ref":"#/components/parameters/Coord2"},{"$ref":"#/components/parameters/Coord3"},{"$ref":"#/components/parameters/Year"},{"$ref":"#/components/parameters/Month"},{"$ref":"#/components/parameters/Day"},{"$ref":"#/components/parameters/Hour"},{"$ref":"#/components/parameters/Minute"},{"$ref":"#/components/parameters/Second"}],"responses":{"200":{"content":{"application/json":{"example":{"energies":{"data":[0.04,0.07,0.1,0.25,0.5,0.75,1,1.5,2,2.5,3,3.5,4,4.5,5,5.5,6,6.5,7,8.5,10],"units":"MeV"},"flux":{"data":[854635898.3161561,564685905.5669771,178490117.91626602,47643571.94054352,12254101.813260391,4549350.837767644,1803653.1511005901,654692.4848865604,207898.83220077943,64091.642036893325,21119.72803543081,7526.08326415376,2847.94993909225,1117.8011168229402,490.68560475708034,269.114292404757,177.84563745629936,128.22793816827138,78.49896611035479,43.74101815451732,30.335272788461896],"units":"/cm^2/s/MeV"}},"schema":{"$ref":"#/components/schemas/Flux"}}},"description":"Successful flux calculation"}},"summary":"Calculate mean particle flux\n","tags":["trapped"],"x-codeSamples":[{"lang":"Shell","source":"curl -X GET \"https://spacerad.amentum.io/trapped/flux_mean?model=AE9&coord_sys=GEI&coord_units=KM&coord1=3216.6&coord2=35426&coord3=603.4&year=2017&month=1&day=1&hour=0&minute=0&second=0\" -H \"API-Key: \" -H \"accept: application/json\"\n"},{"lang":"Python","source":"import requests\n\nparams = dict(\n model=\"AE9\", # proton flux\n coord_sys=\"GEI\", # Geocentric equatorial inertial\n coord_units=\"KM\", # kilometers\n coord1=3216.6, # in KM\n coord2=35426,\n coord3=603.4,\n year=2017,\n month=1,\n day=1, \n hour=0,\n minute=0,\n second=0,\n)\nheaders = {\"API-Key\" : \"\"}\n# Make the API call\ntry:\n response = requests.get(\"https://spacerad.amentum.io/trapped/flux_mean\", params=params, headers=headers)\n response_json = response.json()\n response.raise_for_status()\nexcept requests.exceptions.HTTPError as e:\n print(response_json['error'])\nelse:\n # Extract the flux\n energies = response_json['energies']['data']\n e_unit = response_json['energies']['units']\n flux = response_json['flux']['data']\n f_unit = response_json['flux']['units']\n print(\"Energies: \", energies, e_unit)\n print(\"Mean Fluxes: \", flux, f_unit)\n"}]}},"/trapped/flux_percentile":{"get":{"description":"at given coordinates and date-time.\n","operationId":"app.api.endpoints.TrappedRadiation.calculate_flux_percentile","parameters":[{"$ref":"#/components/parameters/Model"},{"$ref":"#/components/parameters/CoordSystem"},{"$ref":"#/components/parameters/CoordUnits"},{"$ref":"#/components/parameters/Coord1"},{"$ref":"#/components/parameters/Coord2"},{"$ref":"#/components/parameters/Coord3"},{"$ref":"#/components/parameters/Year"},{"$ref":"#/components/parameters/Month"},{"$ref":"#/components/parameters/Day"},{"$ref":"#/components/parameters/Hour"},{"$ref":"#/components/parameters/Minute"},{"$ref":"#/components/parameters/Second"},{"$ref":"#/components/parameters/Percentile"}],"responses":{"200":{"content":{"application/json":{"example":{"energies":{"data":[0.04,0.07,0.1,0.25,0.5,0.75,1,1.5,2,2.5,3,3.5,4,4.5,5,5.5,6,6.5,7,8.5,10],"units":"MeV"},"flux":{"data":[448667784.4812672,322139086.68134594,116785893.33177781,32665389.706181422,7991547.299112285,2586068.6893010717,839339.9184292991,251004.07802610364,69547.20063526293,19974.510921688125,6379.793949894077,2089.794228005704,779.5936616445822,313.1551441702104,141.5097428322324,71.78622535090953,40.65088904584258,25.06786549513947,12.794710202598523,5.620209093649994,3.319852121012902],"units":"/cm^2/s/MeV"}},"schema":{"$ref":"#/components/schemas/Flux"}}},"description":"Successful flux calculation"}},"summary":"Calculate percentile particle flux\n","tags":["trapped"],"x-codeSamples":[{"lang":"Shell","source":"curl -X GET \"https://spacerad.amentum.io/trapped/flux_percentile?model=AE9&coord_sys=GEI&coord_units=KM&coord1=3216.6&coord2=35426&coord3=603.4&year=2017&month=1&day=1&hour=0&minute=0&second=0&percentile=50\" -H \"API-Key: \" -H \"accept: application/json\"\n"},{"lang":"Python","source":"import requests\n\nparams = dict(\n model=\"AE9\", # proton flux\n coord_sys=\"GEI\", # Geocentric equatorial inertial\n coord_units=\"KM\", # kilometers\n coord1=3216.6, # in KM\n coord2=35426,\n coord3=603.4,\n year=2017,\n month=1,\n day=1, \n hour=0,\n minute=0,\n second=0,\n percentile=50 # median flux\n)\n\nheaders = {\"API-Key\" : \"\"}\n\n# Make the API call\ntry:\n response = requests.get(\"https://spacerad.amentum.io/trapped/flux_percentile\", params=params, headers=headers)\n response_json = response.json()\n response.raise_for_status()\nexcept requests.exceptions.HTTPError as e:\n print(response_json['error'])\nelse:\n # Extract the flux\n energies = response_json['energies']['data']\n e_unit = response_json['energies']['units']\n flux = response_json['flux']['data']\n f_unit = response_json['flux']['units']\n print(\"Energies: \", energies, e_unit)\n print(\"Median Fluxes: \", flux, f_unit)\n \n"}]}}},"components":{"parameters":{"Coord1":{"description":"
First coordinate value to specify position.

Ordering for GEI, GEO coords:X, Y, Z
Ordering for GDZ coords: Alt, Lat, Long
Valid ranges for latitude: -90, 90
Valid ranges for longitude: 0, 360
\n","in":"query","name":"coord1","required":true,"schema":{"example":3216.6,"type":"number"}},"Coord2":{"description":"
Second coordinate value.","in":"query","name":"coord2","required":true,"schema":{"example":35426,"type":"number"}},"Coord3":{"description":"
Third coordinate value.","in":"query","name":"coord3","required":true,"schema":{"example":603.4,"type":"number"}},"CoordSystem":{"description":"
Coordinate system to use:

- Geodetic/WGS84 (GDZ)
- Geocentric Cartesian (GEO)
- Geocentric Earth Inertial (GEI)
See \"Bhavnani, K. H., & Vancour, R. P. (1991). Coordinate systems for space and geophysical applications\" for coord system definitions.\n","in":"query","name":"coord_sys","required":true,"schema":{"enum":["GDZ","GEO","GEI"],"example":"GEI","type":"string"}},"CoordUnits":{"description":"
Coordinate units to use: km (KM) or Earth Radii (RE)\n","in":"query","name":"coord_units","required":true,"schema":{"enum":["KM","RE"],"example":"KM","type":"string"}},"Date":{"description":"
Decimal year (eg 1997.65)","in":"query","name":"date","required":true,"schema":{"type":"number"}},"Day":{"description":"
","in":"query","name":"day","required":true,"schema":{"example":1,"type":"integer"}},"Energy":{"description":"
Particle energy in MeV/n
Valid range: [0, 106] MeV/n
\n","in":"query","name":"energy","required":true,"schema":{"example":100,"type":"number"}},"Hour":{"description":"
","in":"query","name":"hour","required":true,"schema":{"example":"0","type":"integer"}},"Minute":{"description":"
","in":"query","name":"minute","required":true,"schema":{"example":"0","type":"integer"}},"Model":{"description":"
Which model to use:

- Energetic electrons (AE9)
- Energetic protons (AP9)
- Space plasma model for electrons (SPME)
- for hydrogen (SPMH)
- for helium (SPMHE)
- for oxygen (SPMO) \n","in":"query","name":"model","required":true,"schema":{"enum":["AE9","AP9","SPME","SPMH","SPMHE","SPMO"],"example":"AE9","type":"string"}},"Month":{"description":"
","in":"query","name":"month","required":true,"schema":{"example":1,"type":"integer"}},"Percentile":{"description":"
Integer percentile at which to calc flux (50 is the median value).\n","in":"query","name":"percentile","required":true,"schema":{"example":50,"type":"integer"}},"Second":{"description":"
","in":"query","name":"second","required":true,"schema":{"example":"0","type":"integer"}},"Year":{"description":"
","in":"query","name":"year","required":true,"schema":{"example":2017,"type":"integer"}},"Z":{"description":"
Particle atomic number","in":"query","name":"z","required":true,"schema":{"example":6,"type":"number"}}},"schemas":{"Flux":{"properties":{"energies":{"description":"Particle energies at which omnidirectional flux values are calculated, and their units.\n","properties":{"data":{"items":{"type":"number"},"type":"array"},"units":{"type":"string"}},"type":"object"},"flux":{"description":"Corresponding omnidirectional flux values, and their units.\n","properties":{"data":{"items":{"type":"number"},"type":"array"},"units":{"type":"string"}},"type":"object"}},"type":"object"},"FluxAtEnergy":{"properties":{"flux":{"description":"Particle flux value and units.\n","properties":{"units":{"type":"string"},"value":{"type":"number"}},"type":"object"}},"type":"object"}}},"x-tagGroups":[{"name":"Trapped Radiation","tags":["trapped"]},{"name":"Galactic Cosmic Radiation","tags":["gcr"]}]}