support portal

Solution home General Unpaywall FAQ
How do I make the Unpaywall extension work on my site?
Created by: Richard Orr
Modified on: Mon, 8 Mar, 2021 at 10:07 AM
The Unpaywall browser extension gets open access locations by calling our REST API. The API is called using DOIs, so the extension needs to be able to find the DOI of the article a page is about in order to call it. For example, on​, the extension finds this HTML element:

<meta name="citation_doi" content​=​"​10.1038/nature21360​"​/>

and looks up 10.1038/nature21360 in the API.

If you're a publisher, or run a preprint repository, institutional repository, or any other site with pages about items with DOIs, we'll need to be able to find them for the extension to work. The best, most consistent way for Unpaywall and other applications to find the DOI is by including a meta element as in the example above. The name attributes we recognize are:

Repository software will generally include one of these automatically, often through a plugin. If you're building your own platform, you'll need to include one of these yourself.

Note that the extension can only recognize a page as being "about" one DOI. Sometimes it isn't clear what this should be. For a page that centers on content related to another item with a DOI (a book review, for example) it may not be appropriate to present that DOI as representing the page - especially if the review or other related item has its own DOI.

Richard is the author of this solution article.
Did you find it helpful?
Related Articles
How do I use the title search API?
Link Resolver Integrations
Why does the Unpaywall plugin say this paywalled article is Open Access?
What do the types of oa_status (green, gold, hybrid, and bronze) mean?
Can you index my journal?
Which DOIs does Unpaywall cover?
Preventing Code Injection - Using Text From Unpaywall Safely
What do the fields in the API response and snapshot records mean?
What is an OA license?
Unpaywall Change Notes
Home Solutions Cookie policy
Help Desk Software by Freshdesk
HomeSolutions Cookie policy