Broker Service API
The Broker Service is available to use via the OpenAIRE Content Provider Dashboard. Thanks to the Broker, repositories, publishers or aggregators can exchange metadata and enrich their local metadata collection by subscribing to notifications of different types. The Broker is able to notify providers when the OpenAIRE Graph contains information that is not available in the original collection of the data source. In particular, the data source manager can subscribe via the Content Provider Dashboard and be notified about:
- Additional PIDs of its publications (e.g. DOIs)
- Links to projects
- ORCID that can be associated to an author of datasource publications
- Links to Open Access versions
- Additional classification subjects (e.g. subjects from standard schemes like ACM, JEL and DDC)
- Abstracts identified in duplicate publications
- Missing publication dates
The following commands indicates how the broker API documented at api.openaire.eu/broker can be used to access the set of enrichments
- get the list of subscriptions for a given subscriber, e.g.
curl -X GET --header 'Accept: application/json' 'https://api.openaire.eu/broker/subscriptions?email=[subscriber_email]'
- extract the subscription ID and use it to access the 1st page of enrichment notification records
curl -X GET --header 'Accept: application/json' 'https://api.openaire.eu/broker/scroll/notifications/bySubscriptionId/[sub-1234]'
- extract the scroll ID from the response to request subsequent pages
curl -X GET --header 'Accept: application/json' 'https://api.openaire.eu/broker/scroll/notifications/[scroll_id]'
To simplify accessing the enrichment notification records, please check the OpenAIRE broker cmdline client available on GitHub.
APIs are free-to-use (no sign-up needed) by any third-party service
Metadata license is CC-BY: the metadata records retuned by the service can be freely re-used by commercial and non-commercial partners under CC-BY license, hence as long as OpenAIRE is acknowledged as content provider.
Quality of Service: all API services are running in production 24/7 within the OpenAIRE infrastructure premises deployed at the data center facilities of the Interdisciplinary Centre for Mathematical and Computational Modelling (ICM).
APIs rate limits
Please check here