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:

• KBART – tab delimited text file (date: 13-06-2024)
• CSV – comma delimited text file - updated until 29 July 2024
• CSV – comma delimited text file - recent updates

Due to technical issues, the following formats are temporarily unavailable:

• [ONIX (3.0) – XML]
• [MARCXML – based on the MARC 21 XML Schema, can be converted easily using MARCEdit]
• [RIS – Research Information Systems]

MARC21 metadata provided by Penn State University Libraries

Penn State University Libraries provides MARC21 records created from metadata supplied by DOAB. There are three files:

• CC-licenced titles
• “Free-to-read” titles
• Titles where only a limited number of chapters are available in DOAB

Download the data here: https://dx.doi.org/10.26207/jdfm-n376

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)

There are several metadata formats available. The xoai format lists all metadata fields, see https://directory.doabooks.org/oai/request?verb=ListRecords&metadataPrefix=xoai.

(Example: https://directory.doabooks.org/oai/request?verb=GetRecord&identifier=oai:doabooks.org:20.500.12854/26303&metadataPrefix=xoai)

RSS and Atom feeds

• RSS 1.0
• RSS 2.0
• Atom

All metadata feeds are openly available CC0 1.0.

Selective Export

It is also possible to make use of our ‘Selective Export’ functionality. This enables you to export metadata in a flexible way: first by selecting the relevant titles and secondly by choosing the export format. The selective export functionality makes it easier for specialist libraries, subject repositories and frequent users to only retrieve specified subsets of open access books according to their preferences - for instance by publisher or subject field. Please be aware that this export function is optimised for sets up to 500 titles. More information can be found here

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.

Publishers

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

Example:

• Find the publisher “Oxford University Press“ - https://directory.doabooks.org/rest/search?query=publisher.name:Oxford+University+Press&expand=metadata
• The ID can be found with the <UUID> tag: <UUID>b9501915-cdee-4f2a-8030-9c0b187854b2</UUID>

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

Example:

• The ID of publisher Oxford University Press is b9501915-cdee-4f2a-8030-9c0b187854b2 - https://directory.doabooks.org/rest/search?query=oapen.relation.isPublishedBy:%22b9501915-cdee-4f2a-8030-9c0b187854b2%22

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

Note that querying publisher.name also lists all publications from that publisher - under the repeated “oapen.relation.isPublisherOf” 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/

XML or JSON format

You must set your request header’s “Accept” property to either JSON (application/json) or XML (application/xml) depending on the format you prefer to work with. 

Example:

• JSON format - curl -s -H "Accept: application/json" "https://directory.doabooks.org/rest/search?query=handle:%2220.500.12854/26303%22&expand=metadata,bitstreams"
• XML format - curl -s -H "Accept: application/xml" "https://directory.doabooks.org/rest/search?query=handle:%2220.500.12854/26303%22&expand=metadata,bitstreams"

PRISM API

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 parameter 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.3998/tfcp.13240726.0001.001