figshare help

How to use Figshare's OAI-PMH

Figshare supports OAI-PMH, which gives a simple technical option for data providers to make their metadata available to services, based on the open standards HTTP (Hypertext Transport Protocol) and XML (Extensible Markup Language). For detailed information on OAI-PMH please visit: https://www.openarchives.org/pmh/

For Figshare's OAI-PMH documentation please head to https://docs.figshare.com/#oai_pmh.

OAI-PMH provides a standard way to retrieve metadata records mapped to a standard metadata schema. Depending on the repository, you may have several metadata schema options. For example, Figshare provides 7 schema options: Dublin Core, Datacite, RDF, CERIF XML, Qualified Dublin Core, Metadata Encoding and Transmission Standard, and UKETD_DC.

As one example, this is useful for repositories that aggregate content. A national level repository could harvest metadata from all research repositories in the country that provide an OAI-PMH endpoint. Because all the metadata will already be in a standard scheme, it is much easier to properly display the fields in the aggregating system without errors.

To see a what the metadata looks like visit https://docs.figshare.com/#oai_pmh_some_examples

Or paste the urls below into a bowser tab:

  • Dublin Core from a repository: https://api.figshare.com/v2/oai?verb=ListRecords&metadataPrefix=oai_dc&set=portal_63
  • RDF for a category: https://api.figshare.com/v2/oai?verb=ListRecords&metadataPrefix=rdf&set=category_150

When you request information from the OAI-PMH endpoint, Figshare labels the metadata content from the Figshare database that matches your requirements and provides it in the XML format.

Share this article: