The API allows accessing the database outside web interface. It thus allows one to build a mirror website or to
incorporate the database in an application. The entry point URI for the API is
https://lsd.univ-lille.fr/api/
Table below contains the description of
different endpoints: their parameters and returned results. All endpoints are accessible via standard HTTP GET method.
Endpoint | Output format | Parameters | Description |
---|---|---|---|
entries |
JSON | no parameters | Returns a table of database entries (tables) in a format close to the web table available at https://lsd.univ-lille.fr/entries |
entries_xml |
XML | ||
entry |
JSON | tag - table tag (required) | Returns basic information including partition functions on particular entry (table) referenced by tag parameter |
entry_xml |
XML | ||
cat |
CAT+BIB+TXT | tag - table tag (required) | Returns a table with predicted transitions in cat format for particular entry referenced by tag parameter. By default, the frequency units in the table are MHz, and those of intensity are nm2 MHz calculated at T = 300 K. The cat file is downloaded in an archive containing two other files: a .bib file with a recommended citation, and readme.txt file with data description including a table of partition function values |
search |
CAT | min - minimum frequency value (required); max - maximum frequency value (required); u - frequency units of min and max: MHz, GHz or wn for wavenumber (optional, default value GHz); hfs - search within tables containing hyperfine transitions: yes or no (optional, default value no) | Returns a table in cat format with predicted transitions by searching within all entries and within the frequency range identified by min and max values. The values may be expressed in MHz, GHz or wn=wavenumbers=cm-1. Optional hfs parameter allows choosing between search within tables with hyperfine and non-hyperfine transitions in the cases when both types of transitions are stored in the database |
GET https://lsd.univ-lille.fr/api/entries
returns a .json table with the list of all database entries and their basic description; the same table may be returned
in XML format at entries_xml
endpointGET https://lsd.univ-lille.fr/api/search?min=202500&max=203500&u=MHz
returns a .cat file with search results in the frequency range between 202500 and 203500 MHz.