Publishers participating in Cited-by Linking are able to retrieve a list of items that cite a specific target article. Only the owner of the target article will be able to retrieve cited-by matches. New cited-by matches can be detected at any time, as our members regularly register their reference data. To ensure cited-by links are up to date, publishers should plan to either query regularly for cited-by links or set the alert attribute to "true" when performing XML queries.
Cited-by matches may be retrieved through:
Note that cited-by matches for posted content are excluded by default.
We support HTTPS querying for cited-by matches. Results may be retrieved by individual DOI or for an entire prefix, and are returned as XML with some basic metadata included.
DOI query (results by DOI or prefix)
This format retrieves all cited-by matches for a single DOI (or prefix) within a specified date range:
https://doi.crossref.org/servlet/getForwardLinks?usr=username&pwd=password&doi=doi&startDate=YYYY-MM-DD&endDate=YYYY-MM-DD
You may also retrieve cited-by matches established on a single day for a single DOI or prefix:
https://doi.crossref.org/servlet/getForwardLinks?usr=username&pwd=password&doi=prefix&date=YYYY-MM-DD
Date range (startDate and endDate, or YYYY-MM-DD) and doi parameters are required. Results for an entire prefix may be retrieved by supplying the prefix as the doi value. Depending on the volume of matches this query might time out so a short date range is recommended.
Results of HTTPS queries are returned as XML.
OAI-PMH request (results by prefix or title)
This format retrieves cited-by matches established within a date range for a prefix or for a given title. Supply a prefix only (no pubID) to retrieve all results for a prefix. Only the prefix owner may retrieve matches. Date range is required.
http://oai.crossref.org/OAIHandler?verb=ListRecords&usr=username&pwd=password&set=J:prefix:pubID&from=YYYY-MM-DD&until=YYYY-MM-DD&metadataPrefix=cr_citedby
where:
- username and password: system login for the prefix/title being retrieved
- content type: J for journal, B for books, conference proceedings, datasets, reports, standards, or dissertations, and S for series
- prefix: the owning prefix of the title being retrieved
- pubID: the publication identification number assigned by the Crossref system.
OAI-PMH results
OAI-PMH requests only return a list of citing DOIs. Metadata is not included but can be retrieved with a DOI-to-metadata query.
<OAI-PMH xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/ http://www.openarchives.org/OAI/2.0/OAI-PMH.xsd" xmlns="http://www.openarchives.org/OAI/2.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<responseDate>2011-12-13T09:51:59</responseDate>
<request verb="ListRecords" set="J:10.1007:3234">http://oai.crossref.org/OAIHandler</request>
<ListRecords>
<record>
<header>
<identifier>info:doi/10.1007/BF00705816</identifier>
<datestamp>2009-04-21</datestamp>
<setSpec>J:10.1007:3234</setSpec>
</header>
<metadata>
<citations>
<citation xmlns="http://www.crossref.org/schema/crossref_citations_1.0.0">
<doi>10.1007/BF00705816</doi>
<citations-cited-by>
<doi>10.1007/BF01133383</doi>
<doi>10.1016/S0167-577X(97)00196-1</doi>
<doi>10.1016/j.desal.2006.03.578</doi>
<doi>10.1007/s11771-008-0060-5</doi>
<doi>10.1016/S0025-5408(99)00105-1</doi>
<doi>10.1016/j.micromeso.2005.05.016</doi>
<doi>10.1016/S0924-2031(99)00058-2</doi>
<doi>10.1002/jrs.1250260840</doi>
<doi>10.1007/BF02903455</doi>
</citations-cited-by>
</citation>
</citations>
</metadata>
</record>
...
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. See OAI-PMH for details.
You may submit a simple XML query to retrieve cited-by matches. 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 Crossref system to remember this query and to send new cited-by link results to the specified email address when they occur.
<?xml version = "1.0" encoding="UTF-8"?>
<query_batch version="2.0" xmlns = "http://www.crossref.org/qschema/2.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.crossref.org/qschema/2.0 http://www.crossref.org/qschema/crossref_query_input2.0.xsd">
<head>
<email_address>your@email.com</email_address>
<doi_batch_id>fl_001</doi_batch_id>
</head>
<body>
<fl_query alert="true">
<doi>10.1053/sonc.2002.35642</doi>
</fl_query>
</body>
</query_batch>
Cited-by linking XML queries can be submitted just like any other XML query.
XML and HTTP Query results
Both HTTP and XML queries will return results as XML, formatted using our query output schema. Only basic bibliographic metadata is returned. If you want to retrieve complete or non-bibliographic metadata you can perform OAI-PMH queries to retrieve DOI matches, then do DOI-to-metadata queries to retrieve a full metadata record for each DOI.
Result with matches:
<?xml version="1.0" encoding="UTF-8"?>
<crossref_result version="2.0" xmlns="http://www.crossref.org/qrschema/2.0.xsd">
<query_result>
<head>
<email_address>support@crossref.org</email_address>
<doi_batch_id>fl_001</doi_batch_id>
</head>
<body>
<forward_link doi="10.1053/sonc.2002.35642">
<journal_cite>
<issn type="electronic">15321827</issn>
<issn type="print">00070920</issn>
<journal_title>British Journal of Cancer</journal_title>
<article_title>Introduction</article_title>
<contributors>
<contributor first-author="true">
<given_name>U</given_name>
<surname>Gatzemeier</surname>
</contributor>
</contributors>
<volume>89</volume>
<first_page>S1</first_page>
<year>2003</year>
<publication_type>full_text</publication_type>
<doi type="journal_article">10.1038/sj.bjc.6601475</doi>
</journal_cite>
</forward_link>
<forward_link doi="10.1053/sonc.2002.35642">
<journal_cite>
<issn type="print">10870156</issn>
<journal_title>Nature Biotechnology</journal_title>
<article_title>Monoclonal antibody therapy of cancer</article_title>
<contributors>
<contributor first-author="true">
<given_name>Gregory P</given_name>
<surname>Adams</surname>
</contributor>
<contributor first-author="false">
<given_name>Louis M</given_name>
<surname>Weiner</surname>
</contributor>
</contributors>
<volume>23</volume>
<issue>9</issue>
<first_page>1147</first_page>
<year>2005</year>
<publication_type>full_text</publication_type>
<doi type="journal_article">10.1038/nbt1137</doi>
</journal_cite>
</forward_link>
<forward_link doi="10.1053/sonc.2002.35642">
<journal_cite>
<issn type="print">08853177</issn>
....
Response with no matches:
Responses with no cited-by matches will return an empty body tag (<body/>
<?xml version="1.0" encoding="UTF-8"?>
<crossref_result version="2.0" xsi:schemaLocation="http://www.crossref.org/qrschema/2.0 http://www.crossref.org/qrschema/crossref_query_output2.0.xsd" xmlns="http://www.crossref.org/qrschema/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<query_result>
<head>
<email_address>none</email_address>
<doi_batch_id>none</doi_batch_id>
</head>
<body/>
</query_result>
</crossref_result>
Sample alert email
Note that alerts are not emailed immediately when a cited-by match is made, there is sometimes a delay of several weeks.
From: CrossRef Query System <admin@crossref.org>
Subject: Aggregated notifications from Crossref [forward-link]
Date: July 27, 2017 at 2:01:16 AM EDT
To: "user@example.org" <user@example.org>
<?xml version="1.0" encoding="UTF-8"?><crossref_result xmlns="http://www.crossref.org/qrschema/2.0" version="2.0"><query_result><head><email_address>admin@crossref.org</email_address><doi_batch_id>aggregated</doi_batch_id></head><body><forward_link doi="10.xxx/xxxx">
<journal_cite fl_count="0">
<issn type="print">1367-9430</issn>
<journal_title>Animal Conservation</journal_title>
<journal_abbreviation>Anim Conserv</journal_abbreviation>
<article_title>How to make (in)effective conservation projects: look at the internal context!</article_title>
<contributors>
<contributor first-author="true" sequence="first" contributor_role="author">
<given_name>C.</given_name>
<surname>Battisti</surname>
</contributor>
</contributors>
<volume>20</volume>
<issue>4</issue>
<first_page>305</first_page>
<year>2017</year>
<publication_type>full_text</publication_type>
<doi type="journal_article">10.xxx/xxx.xxxx</doi>
</journal_cite>
</forward_link></body></query_result></crossref_result>
Cited-by matches and posted content
Members querying for cited-by matches may elect to include posted content (such as preprints) matches in their results. By default, posted content is not included. To retrieve matches including posted content:
HTTP queries: add the “include_postedcontent=true” parameter to your query, for example:
http://doi.crossref.org/servlet/getForwardLinks?usr=xxx&pwd=xxx&doi=10.5555/12345678&include_postedcontent=true
XML queries: add the “include_postedcontent="true" attribute to your fl_query element, for example:
<?xml version = "1.0" encoding="UTF-8"?>
<query_batch version="2.0" xmlns = "http://www.crossref.org/qschema/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<head><doi_batch_id>eXtyles Request AMP.dodge0724.doc__76</doi_batch_id></head>
<body>
<fl_query include_postedcontent="true"
><doi>10.5555/12345678</doi></fl_query>
</body>
</query_batch>
Result
http://oai.crossref.org/OAIHandler?verb=ListRecords&usr=[username]&pwd=[password]&set=J:10.21061:300318&from=2019-07-01&until=2019-12-31&metadataPrefix=cr_citedbySo if you, as a publisher, are querying the cited-by relations of YOUR DOI, it does not matter what the update date of YOUR DOI is. If ANY DOI that “cites” YOUR DOI was updated during the timeframe, YOUR DOI and ALL DOIs citing YOUR DOI will be returned (regardless of any of the other dates) because the cited-by relations for YOUR DOI have in fact changed during that timeframe.
Comparatively, for: https://doi.crossref.org/servlet/getForwardLinks?usr=[username]&pwd=[password]&doi=10.21061/jte.v26i2.a.2&startDate=2019-07-01&endDate=2019-12-31
This one is essentially the same as the previous one except that this ONLY shows 10.21061/jte.v26i2.a.2 and the ONE citer (10.1111/ssm.12376) that changed during the date range. It omits the other DOIs for that journal since only the one DOI was queried but the data for the given DOI is the same in both results.
And, for: https://doi.crossref.org/servlet/getForwardLinks?usr=[username]&pwd=[password]&doi=10.21061/jte.v26i2.a.2
This call one only queries the one DOI and omits a date range so this shows all 13 relations just as the first OAIHandler request does, though the format is somewhat different
Goal 2
To query Crossref APIs to get a list of all of my DOIs that have been cited for my prefix as a whole for a specified timeframe.
Result
For the last year:https://doi.crossref.org/servlet/getForwardLinks?usr=[username]&pwd=[password]&doi=10.21061&startDate=2019-01-01&endDate=2019-12-31
https://doi.crossref.org/servlet/getForwardLinks?usr=[username]&pwd=[password]&doi=10.21061&startDate=2020-01-01&endDate=2020-03-22
Comments
0 comments
Please sign in to leave a comment.