Sign in

v1

latestOpenAPI 3.0.02026-07-143214.7 KB
trapped

Calculate percentile particle flux

at given coordinates and date-time.

get/trapped/flux_percentile

Query parameters

model'AE9' | 'AP9' | 'SPME' | 'SPMH' | 'SPMHE' | 'SPMO' required
Example:AE9

<br>Which model to use: <br><br> - Energetic electrons (AE9) <br> - Energetic protons (AP9) <br> - Space plasma model for electrons (SPME) <br> - for hydrogen (SPMH) <br> - for helium (SPMHE) <br> - for oxygen (SPMO)

coord_sys'GDZ' | 'GEO' | 'GEI' required
Example:GEI

<br>Coordinate system to use: <br><br> - Geodetic/WGS84 (GDZ) <br> - Geocentric Cartesian (GEO) <br> - Geocentric Earth Inertial (GEI) <br> See "Bhavnani, K. H., & Vancour, R. P. (1991). Coordinate systems for space and geophysical applications" for coord system definitions.

coord_units'KM' | 'RE' required
Example:KM

<br>Coordinate units to use: km (KM) or Earth Radii (RE)

coord1number required
Example:3216.6

<br>First coordinate value to specify position. <br><br> Ordering for GEI, GEO coords:X, Y, Z<br> Ordering for GDZ coords: Alt, Lat, Long<br> Valid ranges for latitude: -90, 90<br> Valid ranges for longitude: 0, 360<br>

coord2number required
Example:35426

<br>Second coordinate value.

coord3number required
Example:603.4

<br>Third coordinate value.

yearinteger required
Example:2017
<br>
monthinteger required
Example:1
<br>
dayinteger required
Example:1
<br>
hourinteger required
<br>
minuteinteger required
<br>
secondinteger required
<br>
percentileinteger required
Example:50

<br>Integer percentile at which to calc flux (50 is the median value).

Response

Successful flux calculation