The IDB Application Programming Interface (API) extends the capabilities of the user interface (UI) to retrieve and access the data.
To view the spectrum details through the UI, identify it with a unique integer (id) at URL:
To access the spectrum via the REST API, add api before spectra in the above URL:
By default, the API endpoint returns the response in JSON format, which can also be specified explicitly by adding format suffixes like format=json in the above URL.
Example:
Response consists of the spectrum id along the spectral information and its associated metadata stored as key/value pairs, as described below:
id: A unique integer value identifying this spectrum.
metadata:
A JSON object contains information about the source material used for the measurement, including its composition at the time of acquisition (decay-corrected mass fractions from certificate values) and measurement configuration, e.g., detector setup, analyzer, and other electronics used, etc.
It also includes metadata on spectrum such as spectrum acquisition date, live time, real time, count rate, etc., which are unique to each spectrum.
data:
A JSON array consisting of counts per channel for this spectrum.
Example:
{
"id": 918,
"metadata": {
"Material type": "Pu",
"Material form": "Pellet",
"Chemical compound of material": "PuO2",
"Decay corrected mass fractions (wt%)": [
{
"238Pu": 0.114
},
{
"239Pu": 77.004
},
...
],
"Detector type": "HPGe",
"Detector geometry": "Planar",
"Detector size": "ORTEC SGD",
"Detector FWHM (keV)": 0.8,
"Energy range of the detector (keV)": "0-1260",
"Source to detector distance (cm)": "Unknown",
"Analyzer name": "DSPEC Plus",
"Analyzer gain (keV/ch)": 0.075,
"Number of channels": 16384,
"Attenuators": [
{
"Material": "Cd",
"Thickness (mm)": 1.524
}
],
"Measurement electronics": "DSPEC Plus",
"Measurement geometry": "No collimation with open face lead-shielded detector",
"Spectrum acquisition date (UTC)": "2008-06-20 10:27:23",
"Spectrum real time (s)": 677.12,
"Spectrum live time (s)": 600,
"Spectrum dead time (%)": 0.1139,
"Input count rate (cps)": 4499.98,
"Total number of counts": 2699985,
"Certificate": {
"Reference date (UTC)": "1988-01-01 00:00:00",
"Mass fractions (wt%)": [
{
"238Pu": {
"value": 0.132077,
"unc": 0.0006
}
},
{
"239Pu": {
"value": 75.9729,
"unc": 0.0073
}
},
....
],
"240Pu effective abundance (wt%)": {
"value":22.6509,
"unc":0.0136
},
"Pu mass (g)": {
"value": "Unknown",
"unc": "Unknown"
},
"Pu content": {
"value": "Unknown",
"unc": "Unknown"
},
"Certificate URL": "https://nds.iaea.org/media-idb/certificates/PIDIE.pdf#page=100"
},
"Data Provider": "United States Support Program",
"Data uploaded on": "2024-01-16"
},
"data": [
0,
0,
....
]
}
The API also offers the spectrum data in CSV and SPE format, which can be retrieved by specifying format=csv and format=spe, respectively at the API endpoint.
Spectra can be queried and retrieved from the UI by selecting a set of metadata attributes at the URL:
To query and access the spectra via the REST API, simply add api before search followed by ? and a list of parameters given as key=value pairs, each separated by &:
The default response to the API endpoint is in JSON format, which returns the same output as in the UI search form results table. The API also provides access to
the archive consisting of SPE files by specifying format=spe.
Acceptable parameters along with data format or current values are described below. Default values, where applicable, are in bold.
| Parameter key | Description | Data type/Current values |
|---|---|---|
materialtype_u |
Material measured: U;
For example,
to retrieve all spectra for U samples set materialtype_u=on& , else materialtype_u=& or simply delete the parameter key.
|
on/empty string |
materialtype_pu | Material measured: Pu | on/empty string |
materialtype_mox | Material measured: MOX | on/empty string |
u_pu_ratio_min | If MOX, minimum value for the U/Pu ratio range | Number |
u_pu_ratio_max | If MOX, maximum value for the U/Pu ratio range | Number |
u_pu_ratio_unknown |
Either "on" or "empty string" to include or exclude MOX samples with unknown U/Pu ratio. The default value is set to "on". | on/empty string |
isotope{id} |
To search for a specific material composition, the parameter key "isotope" can be used with a unique identifier. Currently, IDB contains data on the following isotopes:
isotope1: 238Puisotope2: 239Puisotope3: 240Puisotope4: 241Puisotope5: 242Puisotope6: 234Uisotope7: 235Uisotope8: 236Uisotope9: 238Uisotope10: 241Am |
on/empty string |
mass_fraction{id}_min
|
Minimum of the mass fraction range of isotope{id} |
Number |
mass_fraction{id}_max | Maximum of the mass fraction range of isotope{id} | Number |
mass_fraction{id}_unknown | isotope{id} with unknown mass fractions | on/empty string |
material_form |
Physical form of the material | Multiple choices* |
chemical_compound_of_material |
Chemical compound of the material | Multiple choices* |
certificate_of_analysis |
Whether a spectrum has a certificate of analysis or not | Multiple choices* |
detector_type_material |
Detector material | Multiple choices* |
detector_type_geometry |
Shape of the detector | Multiple choices* |
detector_gain |
Energy gain of analyzer | Multiple choices* |
detector_number_of_channels | Number of channels | Multiple choices* |
attenuator_material | Attenuator Material | Multiple choices* |
attenuator_thickness_min | Minimum thickness of attenuator material | Number |
attenuator_thickness_max | Maximum thickness of attenuator material | Number |
attenuator_thickness_unknown | Attenuators with unknown thickness | on/empty string |
sample_live_time_min | Minimum value of spectrum live time | Number |
sample_live_time_max | Maximum value of spectrum live time | Number |
dead_time_min | Minimum value of spectrum dead time | Number |
dead_time_max | Maximum value of spectrum dead time | Number |
total_counts_min | Minimum value of total counts in spectrum | Number |
total_counts_max | Maximum value of total counts in spectrum | Number |
data_provider | Data provider | Multiple choices* |