Sign in

v1

latestOpenAPI 3.0.02026-07-147042.6 KB
routedose

Calculate the ambient equivalent dose along a great circle flight route.

The ambient dose equivalent, H*(10), is an operational quantity that simulates the human body by measuring the dose equivalent at a depth of 10 mm within a tissue equivalent sphere of 300 mm diameter. It is a measurable quantity that is used to calibrate area monitors (radiation detectors) for mixed radiation fields. <br> <br> Use this endpoint if you are comparing model predictions to measurements. <br> <br> This API can run in two modes: <br> <br> Either specify <br> <b>altitude</b>, <b>duration</b><br> for constant altitude calculations; <br> <br> Or specify <br> <b>initial_altitude</b>, <b>cruising_altitudes</b>, <b>climb_times</b>, <b>cruising_times</b>, <b>descent_time</b>, <b>final_altitude</b><br> to calculate dose accounting for a step climb. <br> <br> Note: the airport codes or coordinates (depending on which was specified), and the date in DD/MM/YYYY format, are echoed in the json response as strings.

get/route/ambient_dose

Query parameters

originstring required
Example:YSSY

The ICAO code or IATA code or latitude,longitude pair (in decimal degrees) of the origin airport.

destinationstring required
Example:33.94250107,-118.4079971

The ICAO code or IATA code or latitude,longitude pair (in decimal degrees) of the destination airport.

altitudenumber
Example:10.1

Altitude (in km). The minimum is 0 m, the maximum is 20 km.

durationnumber
Example:5

The flight duration in hours. The minimum is 0, the maximum is 20 hrs.

initial_altitudenumber

Initial altitude (in km). The minimum is 0 m, the maximum is 20 km.

cruising_altitudesnumber[]

Cruising altitudes (in km). The minimum is 0 m, the maximum is 20 km.

[
  10,
  15
]
climb_timesnumber[]

Climb times for each cruising altitude (hours).

[
  0.1,
  0.5
]
cruising_timesnumber[]

Cruising times at each cruising altitude (hours).

[
  1,
  2
]
descent_timenumber
Example:0.5

Descent time from last cruising altitude to final altitude (hours).

final_altitudenumber

Final altitude (in km).

yearinteger required
Example:2019

Year in YYYY.

monthinteger required
Example:5

Month in MM.

dayinteger required
Example:21

Day in DD.

Response

Successful dose calculation

Example response

{
  "dose": {
    "date": "21/05/2019",
    "destination": "33.94250107,-118.4079971",
    "origin": "YSSY",
    "units": "uSv",
    "value": 10.911498908287665
  }
}