UMONS member ? Use the "Widget" functionality in MyORBi to help you create the URL you need. Form your query with the widget, then copy/paste the link you'll find under Link: REST. You can then get ORBi's data.
If you need more than this API can provide or want some additional information, please contact us :
API Items
Allows you to get metadata of the publications on ORBi.
method
GET/POST /items - Return a list of items.
Each item is a publication on ORBi.
parameters
Optional parameters:
HTTP HEADER (Accept) : if needed you can format the output in json or xml 'Accept:application/json' or 'Accept:application/xml' (default:'application/xml').
limit : number of references returned (default:10/maximum:2000).
offset : offset applied to the result, if the offset is greater than the max result then the API will return an empty list of references (default:0).
mode : format used in the citation output - can be 'apa', 'chicago' or 'html' (default:'apa').
lang : language used for output - can be 'en' or 'fr' (default:'en').
Get a single publication with its handle identifier : query=handle:$handle
Get all the publications published in 2020 : query=issued:2020
sort_1, sort_2 and sort_3 : Sorting order
"title_sort": sort by title alphabetical order ("asc" for A to Z and "desc" for Z to A)
"issued_dt": sort by publication date ("asc" for ascending and "desc" for descending)
"lastModified": sort by last modification date ("asc" for ascending and "desc" for descending)
"author_sort": sort by first author's name ("asc" for A to Z and "desc" for Z to A)
"score": sort by relevance ("asc" for ascending and "desc" for descending)
"citation_max_i": sort by the highest number of citations received, all citations sources taken together ("asc" for ascending and "desc" for descending)
field: Additionnal fields available in the output, if not specify all fields will be present. You have to use ',' separator for multiple values. Values allowed: type_top_authority , classification_top_authority , author_qualifier_filter , affil , orcid , author , pubmed , abstract , lang_authority , subject , title , review , journal , issn , publisher , book , editor , researchcenter , sponsor , sponsor_ror , project , series , isbn , academy , degree , jury , promotor , proceeding , sponsor_keyword , europroject , researchcenter_keyword.
result
The main metadata you can find in the result are:
type: Document type used by ORBi (see Typology and definitions). The attribute 'code' is the authority identifier of the document type.
classification: Research fields (see the full list). The attribute 'code' is the authority identifier of the document classification.
author : main authors of the publication. The exact function is indicated in "author_qualifier_filter".
editor : editor or publishing director of the main book for book parts.
affil : Affiliations of the authors
contributors : internal ORBi id's for university authors
handle : The handle identifier of the reference. This identifier allows you to form the persistent URL to the publication on ORBi (for exemple handle:20.500.12907/13246 gives the URL https://hdl.handle.net/20.500.12907/13246).
book : Book title for parts of books
journal : Journal title for articles
publisher : Publisher's name
orcid : ORCID id's
title : Title of the item (the publication)
doi : Digital Object Identifier (permanent identifier given to online publications)
arxiv : ArXiv identifier
pubmed : Pubmed identifier
isbn : International Standard Book Number
issn : International Standard Serial Number
dataset : Link to the dataset
abstract : Publication's abstract
europroject : European project name, acronym and grant agreement number (selected from a list provided by OpenAire)
project : Project name
proceeding : name of the congress
sponsor_keyword : Funders of the research (name and acronym). Each funder appears only once.
sponsor : All known names of the funders.
sponsor_ror : Funders ROR identifier
subject : Keywords of the publication
researchcenter : Research centers and Research units (selected from an internal list of UMONS research Unit) - all known names.
researchcenter_keyword : Research centers and Research units (selected from an internal list of UMONS research Unit) - each entity appears only once under its main name.
access : The access to the full text, it can be : 0-Open Access, 1-Open Access after embargo (but currently in Restricted Access), 2-Restricted access, 3-Private access (UMONS author's only).
review : Peer reviewed, the publication can be "Peer reviewed" (revised by experts outside the editorial board) or "Editorial reviewed" (internal review by the editorial board). "Peer reviewed verified by ORBi" or "Editorial reviewed verified by ORBi" means that the information comes from our scientific journal database and has been verified by the ORBi team. The attribute 'code' is the authority identifier of the peer reviewed status.
citation : The citation of the publication. Citation format depends on the mode used (can be apa/chicago/html).
format : The file format of the fulltext.
lastModified : The last modification date of the publication's data on ORBi.
publicationDate: The publication date written YYYY or YYYY-MM or YYYY-MM-DD. "In press" publications have "9999" as publication date and "Undated" have "0000".
metrics: Number of citations received by the publication coming from publicly available sources : OpenCitations (OCI) and OpenAlex.
type_top_authority : main document type authority
classification_top_authority : main research domain
author_qualifier_filter: author's function (author, translator...).
lang_authority: main language of the publication (ISO 639-1 code)
series : name of the book series for books and book parts
academy : name of the institution for a thesis
degree : name of the degree for a thesis
jury : Doctoral thesis jury members
promotor : Doctoral thesis promotor
Examples :
Publications with "Université de Mons" (exact string) in affiliations and "in press" as publication date. Results with the reference citation in APA format, in english, limited to the first 100 results :
Journal articles and Communications published in a journal with an european project. Results with the reference citation in HTML format, in english, sorted by ascending issue date and limited to the first 250 results :
If you're a UMONS member, you can use the "Widget" functionality in MyORBi to help you create the URL you need.
Form your query with the widget, then copy/paste the link you'll find under Link: REST. You can then use it to integrate a publication list in a UMONS website or get ORBi's data.
get a single publication
You can get a single publication's data by using one of these identifiers:
"fulltext" : Full text (first 10 000 words of the full text files are indexed whenever possible)
issued.year : Year of publication.
for a range of publication years use [YYYY TO YYYY]. For example for publications from 2023 to 2025 : issued.year:[2023 TO 2025]
for publications issued from a define year : query=issued.year:[2019 TO *]
for publications issued until a define year : query=issued.year:[* TO 2019]
"lang_authority" : main language of the publication (ISO 639-1 code)
"main_authority:hasfile" : get only publications with a full text file
"main_authority:isoa" : get only publications with a full text in Open access
"main_authority:peerreviewed": get only peer reviewed publications
"main_authority:hasdataset" : get only publication with a link to a dataset
Use quotes to search for an exact character string. Example: to search for publication with "Université de Mons" in affiliations (instead of searching for publications where you'll find the words "Université" and "de" and "Mons" in all affiliations of all authors), use:
