Crossref operates an OAI-PMH service for the distribution of metadata to subscribers. This system is based on the OAI-PMH version 2 repository framework and implements the interface as documented at http://www.openarchives.org/OAI/openarchivesprotocol.html.
We allow public access to two OAI verbs which allow for discovery of coverage information
The OAI-PMH service is open to Enhanced CMS subscribers only. Subscribers may provide 2 IP addresses or CIDR ranges for authentication. Token-based access is also available.
We support selective harvesting according to sets defined by the hierarchy of publisher and title. Setspecs are formatted as follows:
- content type:prefix:pubID (ex: J:10.1002:4 = Journal content by the publisher Wiley, journal title Applied Organometallic Chemistry)
- content type:prefix (ex: J:10.1002, journals owned by publisher Wiley)
The from and until dates in a request capture when a record was deposited or updated, not the published date of the item. This means a request for records from yesterday-today will return all records added or changed between then and now, regardless of the publication dates included in the records.
Content type are:
- J for journals
- B for book or conference proceeding titles
- S for series
Due to the size of the repository it is highly discouraged to perform a ListRecords action for the entire collection. Use of the ListRecords verb must include a set specification.
With the ListSets request the set parameter is optional. Leaving off the set parameter will return a listing of all publishers, all their journal titles and each year of publication for which we have DOIs.
With the ListIdentifiers request the set, from, and until parameters are optional. The from and until parameters are used to specify dates when the DOIs were registered with Crossref and not the publication date.
The default set for both ListIdentifiers and ListRecords is J (journals). A set (B for books or conference proceedings, S for series) must be specified to retrieve non-journal data.
Many OAI requests are too big to be retrieved in a single transaction. If a given response contains a resumption token, the user must make an additional request to retrieve the rest of the data. Resumption tokens remain viable for 24 hours.
The resumption token includes an expiration date of 24 hours:
The token should be appended to the end of the next request:
Metadata Services - What data is available
Crossref's Metadata Service is available based on subscription. After an organization applies for subscription members of Crossref may decide if they wish for their metadata to be included in distributions to the subscribing organization (knows as an opportunity to ‘opt-out’). This may result in the subscribing organization being able to retrieve less than the full set of metadata available at Crossref. Upon acceptance of an application the subscriber will supply Crossref with two IP addresses from which they will be allowed to retrieve metadata. Any request received from these IP addresses will be filtered so as to exclude non-participating Crossref member metadata. The two publicly available requests mentioned above are not subject to this limitation when the requests come from an IP address not assigned to a known subscriber. These two requests when received from a subscriber's registered IP addresses will only return data pertinent to that subscriber (e.g. a ListSets request will omit any publisher who has chosen not to distribute to that subscriber).
Crossref may also establish a subscriber using an ‘opt-in’ model where each publisher must specifically request that their data be enabled for transmission to such a recipient.
Opt-out and opt-in is established at the title level. Titles may have more than one depositor, but OAI delivery is determined by the prefix identified as the owner in the Crossref system.
Initial data loads
As mentioned above, the size of the Crossref repository precludes using one OAI request to retrieve all the available data. Upon request we can produce an archive of all the data available to a given subscriber which can then be downloaded via FTP. We limit archive requests to one per year.
A sample application for harvesting Crossref OAI data is available below (oaipmhRequest.zip). A sample ListIdentifiers, ListSets, and ListIdentifiers responses are also available (oaipmhSamples.zip).