Link copied to your clipboard
Failed to copy link to your clipboard

Acces JSON data (REST API)

  • API
Last updated: 27-10-2026

RERO ILS resources

A resource is a type of entity stored in the database and/or index.

See: Data model

Access the data

RERO ILS's API are accessed with the following URL template:

https://<instance>/api/<ressource>

Resources can be accessed via HTTP requests in the usual way, such as:

  • a web browser
  • curl or similar tools
  • your own scripts

Some resources are publicly accessible, such as documents (api/documents) or items (api/items). Others require authentication, such as patrons (api/patrons), loans (api/loans) or circulation policies (api/circ_policies). To obtain an API token for access to protected resources, contact the system administrator of your RERO ILS installation.

CSV and Excel exports

Some resource lists can be exported as CSV or Excel (XLSX) files, without any limit on the number of results, using the following URL form:

https://<instance>/api/export/<resource>/?format=csv
https://<instance>/api/export/<resource>/?format=xlsx

The exportable resources are items (inventory list, librarians only), acq_accounts, acq_orders, loans and patron_transaction_events. As for searches, a query (q) and filters can be added. Statistics reports are exported with /api/stats/<pid>?format=csv or format=xlsx.

The list of requests to validate of a library is exported with /api/loan/requests/<library pid>?format=csv (or json, xlsx). This export is restricted to the librarians of the organisation.

Data structure and indexing

Understanding data structure and indexing enables you to build queries.

See: Understanding how search works

Search examples

See: Search examples


Import data (migration tool) | Interoperability applications