v1

latestOpenAPI 3.0.02026-07-147042.6 KB

parma

The effective dose rate calculated for a single particle type, or accumulated over all particle types.

Effective dose is a radiation protection quantity defined by the International Commission on Radiological Protection (ICRP) and represents the stochastic health risk to the human body at low levels of radiation. It accounts for the different sensitivities of organs to ionising radiation, as well as the different effectiveness of various types of radiation. Use this endpoint if you need to estimate radiation exposures of personnel.

get/parma/effective_dose

Query parameters

altitudenumber

Example:11

Altitude (in km). The minimum is 0 m, the maximum is 47 km (the upper limit of the stratosphere).

atmospheric_depthnumber

Example:0.92

Atmospheric depth from the top of the atmosphere (in units of g/cm2). The minimum is 0.913 g/cm2, the maximum is 1032.66 g/cm2. WARNING: you can specify either altitude OR atmospheric depth, not both.

latitudenumber required

Example:30

Latitude. -90 (S) to 90 (N).

longitudenumber required

Example:30

Longitude. -180 (W) to 180 (E).

yearinteger required

Example:2019

Year in YYYY.

monthinteger required

Example:12

Month in MM.

dayinteger required

Example:1

Day in DD.

particle'total' | 'e-' | 'e+' | 'mu+' | 'mu-' | 'gamma' | 'neutron' | 'proton' | 'alpha' required

Example:proton

The particle type as a string. Specifying 'total', only used for the dose calculation, returns the dose for all particle types.

Response

Successful dose read operation

Example response

{
  "dose rate": {
    "units": "uSv/hr",
    "value": 1.9456004308224644
  }
}