Documentation

Matched references

Members can find matched references to a work using the getresolvedrefs endpoint.

References that do not match at the time of deposit will be remembered internally and periodically re-run. These subsequent attempts to match references contribute to Cited-by data. The member who deposited the article containing these references can use getResolvedRefs to retrieve an updated list of the article’s matched references.

On this page:

Quick start

Get recently added references for a single DOI:

https://doi.crossref.org/getResolvedRefs?doi=10.1103/PhysRevE.91.062714&usr=email@address.com/role&pwd=password

Example output:

{
	doi: "10.1103/PhysRevE.91.062714",
	matched-references: [
    	{
        	key: "PhysRevE.91.062714Cc1R1",
        	doi: "10.1038/nature01609",
        	type: "journal_article"
    	},
    	{
        	key: "PhysRevE.91.062714Cc2R1",
        	doi: "10.1016/S0301-4622(02)00177-1",
        	type: "journal_article"
    	},
    	{
        	key: "PhysRevE.91.062714Cc3R1",
        	doi: "10.1073/pnas.1214051110",
        	type: "journal_article"
    	},
    	{
        	key: "PhysRevE.91.062714Cc4R1",
        	doi: "10.1529/biophysj.106.093062",
        	type: "journal_article"
    	}
	]
}

The key field corresponds to the key in the reference section of the original deposit.

Details

Only members have access to getResolvedRefs and can only retrieve resolved references for their own prefixes. Authentication is via the usr and pwd request parameters.

getResolvedRefs returns the output of the Crossref reference matching. It doesn’t include references where the DOI was supplied in a member deposit. The output is in JSON format and contains a list of matched references. Each reference has:

  • key: the reference key from the original deposit.
  • doi: the DOI of the matched reference.
  • type: the content type of the matched reference.

Request parameters

All parameters are required.

Parameter nameExample valueDescription
usrtest@email.com/abcdUse your email address and Crossref role.
pwdmy_passwordYour password.
doi10.1103/PhysRevE.91.062714DOI for which you want to retrieve matched reference DOIs.

Page maintainer: Martyn Rittman
Last updated: 2020-April-08