UCucalgary
Auroral Transport Model (ATM)

Perform inverse ATM calculation

Perform an inverse calculation using VERSION 2 of the TREx Auroral Transport Model and the supplied input parameters.

NOTE: This version of the model no longer provides extended outputs which are derived when doing a subsequent forward request after the inversion determines the energy flux. Instead, we leave this up to the user to perform the forward request using the parameters of their choosing. This was done to allow further customization of the forward requests which use inversion-derived inputs.

NOTE: As of API version 1.78.0 (released 2026-09-23), the characteristic_energy output flag (deprecated in API version 1.38.0) has been removed. Please use mean_energy instead. Further, the precipitation_flux_spectral_type parameter is now required.

Input notes:

  • By default requests are cached. Use the 'no_cache' parameter to disable this functionality
  • Timestamp
    • Timestamp is expected to be in UTC
    • Only specific dates are valid at this time. A 400 error will be returned if an unsupported date is requested. If you want to get a date that we have not enabled support for yet, please contact us.
    • the 'Z' character at the end of the timestamp is optional, and will be ignored if it is supplied
  • Latitude and longitude
    • Expected to be in geodetic coordinates
    • latitude is currently limited to >=50.0 and <71.5 degrees
    • longitude is currently limited >=-160 and <-75 and degrees
  • Units and defaults
    • intensity_4278: Rayleighs, default is 1000.0
    • intensity_5577: Rayleighs, default is 6000.0
    • intensity_6300: Rayleighs, default is 600.0
    • intensity_8446: Rayleighs, default is 400.0
    • precipitation_flux_spectral_type: required, valid values are "gaussian" or "maxwellian"
    • nrlmsis_model_version: valid values are "00" and "2.0", default is "2.0"
  • Special logic keyword
    • If you would like special logic to be used, the special_logic_keyword parameter can be set with a unique keyword provided by UCalgary staff. This is meant as a way to enable support for certain special use-cases.

Output notes:

  • output parameter of the request are toggles the enable/disable each field's inclusion in the response
  • all output parameters are false by default
  • altitude is in kilometers
  • energy flux: erg/cm2/s
  • mean energy: eV
post/api/v2/atm/inverse

Request

Request body

timestampstring date-time required
geodetic_latitudenumber required
geodetic_longitudenumber required
intensity_4278number
intensity_5577number
intensity_6300number
intensity_8446number
precipitation_flux_spectral_type'gaussian' | 'maxwellian' required
nrlmsis_model_version'00' | '2.0'
special_logic_keywordstring
no_cacheboolean

Response

Calculated outputs

calculation_duration_msnumber required

Changes

No recorded changes to this operation across all 1 revision of this API.