Some of you who have submitted content to us during the first two months of 2021 may have experienced content registration delays. We noticed; you did, too.
The time between us receiving XML from members, to the content being registered with us and the DOI resolving to the correct resolution URL, is usually a matter of minutes. Some submissions take longer - for example, book registrations with large reference lists, or very large files from larger publishers can take up to 24 to 48 hours to process.
TL;DR: We have a Community Forum (yay!), you can come and join it here: community.crossref.org.
Community is fundamental to us at Crossref, we wouldn’t be where we are or achieve the great things we do without the involvement of you, our diverse and engaged members and users. Crossref was founded as a collaboration of publishers with the shared goal of making links between research outputs easier, building a foundational infrastructure making research easier to find, cite, link, assess, and re-use.
Event Data uncovers links between Crossref-registered DOIs and diverse places where they are mentioned across the internet. Whereas a citation links one research article to another, events are a way to create links to locations such as news articles, data sets, Wikipedia entries, and social media mentions. We’ve collected events for several years and make them openly available via an API for anyone to access, as well as creating open logs of how we found each event.
2020 wasn’t all bad. In April of last year, we released our first public data file. Though Crossref metadata is always openly available––and our board recently cemented this by voting to adopt the Principles of Open Scholarly Infrastructure (POSI)––we’ve decided to release an updated file. This will provide a more efficient way to get such a large volume of records. The file (JSON records, 102.6GB) is now available, with thanks once again to Academic Torrents.
Sent to an HTTP(S) URL endpoint hosted by the member
Note that we don’t provide a plugin to directly display Cited-by results on a publisher website. The data is delivered in XML format only and needs to be correctly reformatted.
Using a URL, you can retrieve all citations for a single DOI or prefix within a date range. You will need to provide your Crossref account credentials in the query.
If you use shared, organization-wide role credentials, queries have the following format:
role is the role corresponding to the prefix or title being retrieved;
password is your user credential password
doi can be a full DOI or a prefix
On both versions of the query, date range is optional. Dates in the query refer to when the citation match was made (usually shortly after the DOI of the citing article was registered), not the publication date of the articles being queried for: all citations found in the given period will be returned, regardless of when the cited articles were originally deposited. Queries can also be made for a single day, in which case use the following format:
By default, citations from posted content (including preprints) are not included. To retrieve them as well, include &include_postedcontent=true in the query URL:
Output is XML formatted according to Crossref’s query schema.
If the query times out, we recommend using a smaller query, for example by using a narrower date range or splitting prefixes into individual DOIs. This is unlikely to affect most users, however if you frequently experience very large queries please contact us.
role and password are the role credentials for the prefix or title being retrieved;
content type is J for journal; B for books, conference proceedings, datasets, reports, standards, or dissertations; and S for series;
prefix is the owning prefix of the title being retrieved;
pubID is the publication identification number of the title. This is optional: to query for all titles related to a prefix, simply omit the pubID;
metadataPrefix=cr_citedby indicates that the results should include Cited-by matches rather than item metadata.
A date range is optional. Dates used refer to when the citing articles were last updated, not the publication date of the articles being queried for. All citations found in the given period will be returned, regardless of when the cited articles were originally deposited.
By default, citations from posted content (including preprints) are not included. To retrieve them as well, add &include_postedcontent=true to the query URL.
Output is XML formatted according to Crossref’s query schema and contains a list of the DOIs that cited the specified article or prefix.
Some OAI-PMH 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. Learn more about resumption tokens, and OAI-PMH requests.
OAI-PMH queries return only the DOI of each citation. You can use our REST API or XML API to retrieve the full bibliographic data for each citation.
Retrieve citation matches using an XML query
Citations can also be retrieved through an XML query. The query contains only the DOI of the cited article stored in the fl_query element. For best results, each XML file should contain a single DOI.
Setting the alert attribute to “true” instructs the system to remember this query and to send new Cited-by link results to the specified email address when they occur. Note that an email address cannot be unset from receiving notifications, so only use this option for email addresses that will continue to receive notifications on a long-term basis.
By default, citations from posted content (including preprints) are not included. To retrieve them as well, use <fl_query include_postedcontent="true"> in the body of the query.
Once you have Cited-by enabled, you can find citations to single DOIs using the Crossref admin tool. Log in using your Crossref account credentials, click on the Queries tab, then Cited By Links. This returns a list of DOIs:
Citation notifications
You can receive citation notifications by email or an endpoint notification. In both cases the text of the message is the same: it contains the same output as an XML query, containing details of the citing and cited works.
To select an email address for Cited-by notifications, see the XML query section.
Troubleshooting Cited-by queries
Sometimes citations don’t show up in Cited-by when you would expect them. There could be several reasons for this:
The references haven’t been included in the metadata. We don’t use article PDFs or crawl websites to retrieve references, we rely on them being deposited as metadata by our members. You can use our APIs to check whether references are present.
The DOI of the cited work wasn’t included in the reference and there was either an error in the metadata or insufficient information for us to make a reliable match. In this case, check the metadata for any errors and contact the owner of the citing work to redeposit the references.
If the citing article was registered very recently it can take time to update the cited article’s metadata. If this happens, wait for a few days before trying again.
Note that citations are only retrieved from works registered with a Crossref DOI and will differ from citation counts provided by other services. Not all scholarly publications are registered with Crossref and not all publishers opt to deposit references, so we can’t claim that citation counts are comprehensive.
If you can’t access citation matches for a journal you own: