--- title: "GET /udl/sgi" method: GET path: "/udl/sgi" tags: ["Solar/Geomagnetic and Radiation Belt"] --- # GET /udl/sgi `GET /udl/sgi` ## Request - Base URL: `https://unifieddatalibrary.com` - URL: `https://unifieddatalibrary.com/udl/sgi` - Auth: none declared Service operation to dynamically query data by a variety of query parameters not specified in this API documentation. See the queryhelp operation (`/udl//queryhelp`) for more details on valid/required query parameter information. ## Query parameters - `effectiveDate` string, date-time - `sgiDate` string, date-time - `firstResult` integer - `maxResults` integer ## Response `200` OK - SGIAbridged[] - `id` string: Unique identifier of the record, auto-generated by the system. - `classificationMarking` string, required: Classification marking of the data in IC/CAPCO Portion-marked format. - `effectiveDate` string, date-time, required: ISO8601 UTC Time the data was received and processed from the source. Typically a source provides data for a date window with each transmission including past, present, and future predicted values. - `sgiDate` string, date-time, required: ISO8601 UTC Time of the index value. This could be a past, current, or future predicted value. Note: sgiDate defines the start time of the time window for this data record. - `type` string: The type of data contained in this record (e.g. HASDM, JBH09, K-Index, PSD-dB, RBI, RFI-SFU, etc). - `state` 'I' | 'N' | 'P': State indicating Issued (I), Nowcast (N), or Predicted (P) values for this record. - `stationName` string: The name/location of the station that collected the geomagnetic data for this record. - `idSensor` string: Unique identifier of the reporting sensor. - `origSensorId` string: Optional identifier provided by the reporting source to indicate the sensor identifier which produced this data. This may be an internal identifier and not necessarily a valid sensor ID. - `mode` integer: The transmitted DCA mode of the record (1-3). - `precedence` 'O' | 'P' | 'R' | 'Y' | 'Z': The precedence of data in this record (O = Immediate, P = Priority, R = Routine, Y = Emergency, Z = Flash). - `coeffDegree` integer[]: Array containing the degree of the temperature coefficients. The coeffDegree and coeffOrder arrays must be the same length. - `coeffOrder` integer[]: Array containing the order of the temperature coefficients. The coeffDegree and coeffOrder arrays must be the same length. - `ctce` number[]: Array containing the cosine spherical-harmonic coefficients for Exospheric temperature (DTC) difference. Each array element corresponds to the positional index of the coeffDegree and coeffOrder arrays. - `stce` number[]: Array containing the sine spherical-harmonic coefficients for Exospheric temperature (DTC) difference. Each array element corresponds to the positional index of the coeffDegree and coeffOrder arrays. - `ctci` number[]: Array containing the cosine spherical-harmonic coefficients for Inflection temperature (DTX) difference. Each array element corresponds to the positional index of the coeffDegree and coeffOrder arrays. - `stci` number[]: Array containing the sine spherical harmonic coefficients for Inflection temperature (DTX) difference. Each array element corresponds to the positional index of the coeffDegree and coeffOrder arrays. - `e10` number, double: Extreme Ultraviolet (EUV) proxy, E10.7, in x10-22 Watts per meter squared per Hertz, is the integrated solar EUV energy flux at the top of atmosphere and normalized to solar flux units. - `e54` number, double: E54 (E10-Bar), in x10-22 Watts per meter squared per Hertz, uses the past 54-days E10 values to determine the E10 average. - `s10` number, double: Daily S10.7 index for >200 km heating of O by solar chromosphere. 28.4-30.4 nm emissions in x10-22 Watts per meter squared per Hertz. - `s54` number, double: 54 day S10.7 index for >200 km heating of O by solar chromosphere. 28.4-30.4 nm emissions in x10-22 Watts per meter squared per Hertz. - `m10` number, double: Daily M10.7 index for 100-110 km heating of O2 by solar photosphere. 160 nm SRC emissions in x10-22 Watts per meter squared per Hertz. - `m54` number, double: 54 day M10.7 index for 100-110 km heating of O2 by solar photosphere. 160 nm SRC emissions in x10-22 Watts per meter squared per Hertz. - `y10` number, double: Daily Y10.7 index for 85-90 km heating of N2, O2, H2O, NO by solar coronal. 0.1-0.8 nm and Lya 121 nm emissions in x10-22 Watts per meter squared per Hertz. - `y54` number, double: 54 day Y10.7 index for 85-90 km heating of N2, O2, H2O, NO by solar coronal. 0.1-0.8 nm and Lya 121 nm emissions in x10-22 Watts per meter squared per Hertz. - `f10` number, double: Daily solar 10.7 cm radio flux in x10-22 Watts per meter squared per Hertz. - `f54` number, double: 54 day solar 10.7 cm radio flux in x10-22 Watts per meter squared per Hertz. - `f81` number, double: 81 day solar 10.7 cm radio flux in x10-22 Watts per meter squared per Hertz. - `f10High` number, double: Daily F10.7 index - high range, in x10-22 Watts per meter squared per Hertz. This field usually applies to forecast values, based on the consensus of the Solar Cycle 24 Prediction Panel. - `f10Low` number, double: Daily F10.7 index - low range, in x10-22 Watts per meter squared per Hertz. This field usually applies to forecast values, based on the consensus of the Solar Cycle 24 Prediction Panel. - `sunspotNum` number, double: Daily sunspot number. - `sunspotNumHigh` number, double: Daily sunspot number - high range. This field usually applies to forecast values, based on the consensus of the Solar Cycle 24 Prediction Panel. - `sunspotNumLow` number, double: Daily sunspot number - low range. This field usually applies to forecast values, based on the consensus of the Solar Cycle 24 Prediction Panel. - `ap` number, double: Ap is the planetary geomagnetic 2 nT index (00-21 UT) for the timespan specified in apDuration. If apDuration is null, a 3 hour duration should be assumed. - `apDuration` integer: The time, in hours, for which the Ap index value is valid. If null, a span of 3 hours is assumed. - `kIndex` integer: The maximum measured K-Index at the associated station during the kpDuration timespan. The K-Index is a unitless measure (0 - 9) of the deviation in the Earth's magnetic field from normal at the station geographic location, with 0 indicating the absence of geomagnetic disturbance, and 9 indicating the most significant disturbance. If kpDuration is null, a 3 hour duration should be assumed. - `kp` number, double: The Planetary K-index (Kp) over the kpDuration timespan. The Kp-Index is the average K-Index for the entire Earth, utilizing a unitless scale (0-9, in incremenets of 1/3), with 0 indicating the absence of geomagnetic disturbance, and 9 indicating the most significant disturbance. If kpDuration is null, a 3 hour duration should be assumed. - `kpDuration` integer: The time, in hours, over which the K, Kp, and/or gamma index values are measured. If null, a span of 3 hours is assumed. - `gamma` integer: The maximum measured gamma deflection during the kpDuration timespan. If kpDuration is null, a 3 hour duration should be assumed. - `dst` number, double: Disturbance Storm Time geomagnetic index in nT. - `dtc` number, double: delta exospheric temperature correction in units of K. - `rbRegionCode` integer: Region code for the associated radiation belt index. This is the code associated with the corresponding radiation belt location. See the provider card for reference to specific region code definitions. - `rbIndex` number, double: The value of the radiation belt index. This is the ratio of current intensity of a radiation belt to long-term average value. It's long-term average should be close to 1. Depending on the type of belt sensor, this ratio may measure Flux (number of particles / (cm^2 sec energy solid-angle)), dose rate (rad per second), or relative counts of particles per time (counts per second). The index value may also be normalized, the normalization value typically represents an average of the sensor measurements taken within a region over a given time interval. See the normFactor field for the specific normalization factor, if provided. - `normFactor` number, double: The normalization factor that has already been applied to the index value prior to record ingest. Typically used to normalize the index value to a particular interval. Units of the normalization factor may vary depending on the provider of this data (REACH, POES, CEASE3, etc.). - `rbDuration` integer: The timespan over which the associated radiation belt index is factored. If rbDuration is null, a 24 hour duration should be assumed. Note: rbDuration defines the length of the time window for this data record. The time window start time is defined by sgiDate, and the time window end time is defined by sgiDate plus rbDuration. - `analyzerAttenuation` number, double: Signal analyzer's input attenuation level, in decibels. Attenuation is a setting on the hardware that measures the power of a signal. - `rawFileURI` string: Optional URI location in the document repository of the raw file parsed by the system to produce this record. To download the raw file, prepend https://udl-hostname/scs/download?id= to this value. - `transactionId` string: Optional identifier to track a commercial or marketplace transaction executed to produce this data. - `source` string, required: Source of the data. - `origin` string: Originating system or organization which produced the data, if different from the source. The origin may be different than the source if the source was a mediating system which forwarded the data on behalf of the origin system. If null, the source may be assumed to be the origin. - `origNetwork` string: The originating source network on which this record was created, auto-populated by the system. - `dataMode` 'REAL' | 'TEST' | 'SIMULATED' | 'EXERCISE', required: Indicator of whether the data is REAL, TEST, EXERCISE, or SIMULATED data: REAL: Data collected or produced that pertains to real-world objects, events, and analysis. TEST: Specific datasets used to evaluate compliance with specifications and requirements, and for validating technical, functional, and performance characteristics. EXERCISE: Data pertaining to a government or military exercise. The data may include both real and simulated data. SIMULATED: Synthetic data generated by a model to mimic real-world datasets. - `createdAt` string, date-time: Time the row was created in the database, auto-populated by the system. - `createdBy` string: Application user who created the row in the database, auto-populated by the system. ## Other responses - `400`: Bad Request - `401`: Invalid/Missing User Credentials - `403`: User Is Not Authorized - `405`: Method Not Allowed - `406`: MediaType Not Accepted by Request Headers - `429`: Rate of Requests Exceeds Allowed Limit - `500`: Internal Server Error ## Changes > 12 revisions in range; 1 could not be searched. - **2025-05-29** `4e1cbc17e814`: 2 info - added the new optional `query` request parameter `firstResult` - added the new optional `query` request parameter `maxResults` - **2025-04-16** `75f764c843a9`: 7 info - api operation id `findAll_97` removed and replaced with `` - the endpoint scheme security `BasicAuth` was removed from the API - added the optional property `items/f10High` to the response with the `200` status - added the optional property `items/f10Low` to the response with the `200` status - …3 more [Operation history](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api/changes/udl/sgi/get.md) --- [API](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api.md) - [All operations](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api/revisions/bd17bc53681e?raw)