Metadata for Libraries and Aggregators

Metadata feeds

DOAB enables libraries and aggregators to use the metadata of all available titles in the Directory of Open Access Books. The metadata is available in the following formats:

OAI PMH harvesting

The base URL for OAI-PMH harvesting is https://directory.doabooks.org/oai/

(Example: https://directory.doabooks.org/oai/request?verb=ListMetadataFormats)

RSS and Atom feeds

All metadata feeds are openly available CC0 1.0.

Search DOAB using a REST API

Search syntax

You can search DOAB using a REST API, using the following syntax: https://directory.doabooks.org/rest/search?query=[search query]

Examples:

  • Full text query: “water AND fire” - https://directory.doabooks.org/rest/search?query=%22water+AND+fire%22
  • Query using dc.title: “The deliverance of open access books” - https://directory.doabooks.org/rest/search?query=dc.title:%22the+deliverance+of+open+access+books%22
  • Query using HANDLE: “20.500.12854/26303” - https://directory.doabooks.org/rest/search?query=handle:%2220.500.12854/26303%22

List all available metadata

To list all available metadata, use:

https://directory.doabooks.org/rest/search?query=[search query]&expand=metadata

Examples:

  • Full text query: “water AND fire” - https://directory.doabooks.org/rest/search?query=%22water+AND+fire%22&expand=metadata
  • Query using dc.title: “The deliverance of open access books” - https://directory.doabooks.org/rest/search?query=dc.title:%22the+deliverance+of+open+access+books%22&expand=metadata
  • Query using HANDLE: “20.500.12854/26303” - https://directory.doabooks.org/rest/search?query=handle:%2220.500.12854/26303%22&expand=metadata

List all available bitstream objects

To list all available bitstream objects, use:

https://directory.doabooks.org/rest/search?query=[search query]&expand=bitstreams

Examples:

  • Full text query: “water AND fire” - https://directory.doabooks.org/rest/search?query=%22water+AND+fire%22&expand=bitstreams
  • Query using dc.title: “The deliverance of open access books” - https://directory.doabooks.org/rest/search?query=dc.title:%22the+deliverance+of+open+access+books%22&expand=bitstreams
  • Query using HANDLE: “20.500.12854/26303” - https://directory.doabooks.org/rest/search?query=handle:%2220.500.12854/26303%22&expand=bitstreams

List all available metadata and bitstream objects

To list both metadata and bitstream objects at once, use:

https://directory.doabooks.org/rest/search?query=[search query]&expand=metadata,bitstreams

Examples:

  • Full text query: “water AND fire” - https://directory.doabooks.org/rest/search?query=%22water+AND+fire%22&expand=metadata,bitstreams
  • Query using dc.title: “The deliverance of open access books” - https://directory.doabooks.org/rest/search?query=dc.title:%22the+deliverance+of+open+access+books%22&expand=metadata,bitstreams
  • Query using HANDLE: “20.500.12854/26303” - https://directory.doabooks.org/rest/search?query=handle:%2220.500.12854/26303%22&expand=metadata,bitstreams

Selecting fields for your query

To find out which metadata field to use:

  • Select in the web UI an item that corresponds to a possible result of your query
  • Open its full view, using one of these options: Click the “Show full item record” link under the thumbnail or append ?show=full to the item’s URL
  • Select the metadata fields and their corresponding value.

For date fields, best to append the suffix “_dt” after the field’s name, e.g. dc.date.issued_dt if you want the filter to behave as a date and not as text.

Examples:

  • All titles, added in the last week. Query using dc.date.accessioned_dt - https://directory.doabooks.org/rest/search?query=dc.date.accessioned_dt:[NOW-7DAY/DAY+TO+NOW]
  • All titles, classified as “Politics & Government”, added in the last week. Query using dc.subject.classification, dc.date.accessioned_dt - https://directory.doabooks.org/rest/search?query=dc.subject.classification:%22Politics+%26+Government%22+AND+dc.date.accessioned_dt:[NOW-7DAY/DAY+TO+NOW]
  • All titles, added between 1 May 2020 and 10 May 2020. Query using dc.date.accessioned_dt - https://directory.doabooks.org/rest/search?query=dc.date.accessioned_dt:[2020-05-01T00:00:00Z+TO+2020-05-10T23:59:59Z]
  • Find the most recently added title, classified as “Politics & Government”. Query using dc.subject.classification, dc.date.accessioned_dt - https://directory.doabooks.org/rest/search?query=dc.subject.classification:%22Politics+%26+Government%22&sort=dc.date.accessioned_dt&limit=1

If needed, you can expand metadata, bitstreams or both.

Collections

If you want to expose collections, query the oapen.collection field (using the collection label, not an ID). The same expand options are available.

Example:

  • Find the collection “European Research Council” - https://directory.doabooks.org/rest/search?query=oapen.collection:%22European+Research+Council%22

Funders

Retrieving all publications by a funder can be achieved via the relationship metadata fields. To find the actual ID for a funder, search by funder name, using the grantor name field.

Example:

  • Find the funder “Austrian Science Fund (FWF)“ - https://directory.doabooks.org/rest/search?query=grantor.name:Austrian+Science+Fund+%28FWF%29&expand=metadata
  • The ID can be found with the <UUID> tag: <UUID>a39fc2ba-9538-4bcd-965c-6702ff320840</UUID>

Expose the publications, by querying the oapen.relation.isFundedBy field

Example:

  • The ID of funder Austrian Science Fund is a39fc2ba-9538-4bcd-965c-6702ff320840 - https://directory.doabooks.org/rest/search?query=oapen.relation.isFundedBy:%22a39fc2ba-9538-4bcd-965c-6702ff320840%22

If needed, you can expand metadata, bitstreams or both.

Note that querying grantor.name also lists all publications funded by that funder - under the repeated “oapen.relation.funds” field – without the details. Therefore, use the above query to get all details at once instead of using one query per item to get their detailed metadata / files.

Communities and collections

The contents of DOAB are divided into “communities”, and the communities are subdivided into “collections”.

  • List all communities - https://directory.doabooks.org/rest/communities/
  • List all collections - https://directory.doabooks.org/rest/collections/

API: Peer review

To search for peer review entities, you can use this endpoint on the DSpace REST webapp: directory.doabooks.org/rest/peerReviews.

This endpoint requires ONE of the following search parameters to perform a lookup:

  • pId; Publisher legacy ID of a publisher that has been attached to an item that contains peer review information; Publisher UUID of a publisher that has been attached to an item that contains peer review information.
  • isbn: ISBN linked to an item that contains peer review information.
  • doi: DOI of an item that contains peer review information.
  • title: Name of a publisher that can contain multiple peer reviews linked to the publisher.

The endpoint only supports one search paramameter at the same time. In case zero or more than one parameter is provided, an error response (status 400) will be shown.

Based on the query, one or more Peer Review entities will be returned. When no results could be found for a query, an error response containing status 404 will be shown.

Example query: Search for a book, using its DOI: https://directory.doabooks.org/rest/peerReviews?doi=10.11647/OBP.0197