/unpaywall/works

curl --request POST \
  --url https://api.anysite.io/api/unpaywall/works \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "doi": "<string>",
  "timeout": 300
}
'

[
  {
    "doi": "<string>",
    "@type": "@unpaywall_work",
    "doi_url": "<string>",
    "title": "<string>",
    "genre": "<string>",
    "data_standard": 123,
    "is_oa": true,
    "oa_status": "<string>",
    "is_paratext": true,
    "has_repository_copy": true,
    "published_date": "<string>",
    "year": 123,
    "updated_at": "<string>",
    "publisher": "<string>",
    "journal": {
      "@type": "@unpaywall_journal",
      "name": "<string>",
      "issn_l": "<string>",
      "issns": [],
      "is_oa": true,
      "is_in_doaj": true
    },
    "best_oa_location": {
      "@type": "@unpaywall_oa_location",
      "url": "<string>",
      "url_for_pdf": "<string>",
      "url_for_landing_page": "<string>",
      "license": "<string>",
      "version": "<string>",
      "host_type": "<string>",
      "is_best": true,
      "oa_date": "<string>",
      "repository_institution": "<string>",
      "evidence": "<string>",
      "endpoint_id": "<string>",
      "pmh_id": "<string>"
    },
    "first_oa_location": {
      "@type": "@unpaywall_oa_location",
      "url": "<string>",
      "url_for_pdf": "<string>",
      "url_for_landing_page": "<string>",
      "license": "<string>",
      "version": "<string>",
      "host_type": "<string>",
      "is_best": true,
      "oa_date": "<string>",
      "repository_institution": "<string>",
      "evidence": "<string>",
      "endpoint_id": "<string>",
      "pmh_id": "<string>"
    },
    "oa_locations": [],
    "oa_locations_embargoed": [],
    "authors": []
  }
]

/unpaywall

/unpaywall/works

Get open-access status and full-text locations for a scholarly work by its DOI

Price: 1 credit

💡 AI Hint: Get the open-access (OA) status and full-text locations of a scholarly work by its DOI. Returns the title, genre, publisher, publication date and year, whether the work is open access and its OA color status (gold, green, hybrid, bronze, or closed), the journal it appeared in (name, ISSN-L, ISSNs, whether the journal is fully OA and listed in DOAJ), and the catalog of open-access copies — the best and first OA location plus all known and embargoed locations, each with its PDF and landing-page URLs, license, version (submitted/published), host type (publisher or repository), hosting repository, and OA date. Also returns the authors with their position, corresponding-author flag, and raw affiliations.

⚠️ Common errors: 412: Work not found

POST

api

unpaywall

works

/unpaywall/works

curl --request POST \
  --url https://api.anysite.io/api/unpaywall/works \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "doi": "<string>",
  "timeout": 300
}
'

[
  {
    "doi": "<string>",
    "@type": "@unpaywall_work",
    "doi_url": "<string>",
    "title": "<string>",
    "genre": "<string>",
    "data_standard": 123,
    "is_oa": true,
    "oa_status": "<string>",
    "is_paratext": true,
    "has_repository_copy": true,
    "published_date": "<string>",
    "year": 123,
    "updated_at": "<string>",
    "publisher": "<string>",
    "journal": {
      "@type": "@unpaywall_journal",
      "name": "<string>",
      "issn_l": "<string>",
      "issns": [],
      "is_oa": true,
      "is_in_doaj": true
    },
    "best_oa_location": {
      "@type": "@unpaywall_oa_location",
      "url": "<string>",
      "url_for_pdf": "<string>",
      "url_for_landing_page": "<string>",
      "license": "<string>",
      "version": "<string>",
      "host_type": "<string>",
      "is_best": true,
      "oa_date": "<string>",
      "repository_institution": "<string>",
      "evidence": "<string>",
      "endpoint_id": "<string>",
      "pmh_id": "<string>"
    },
    "first_oa_location": {
      "@type": "@unpaywall_oa_location",
      "url": "<string>",
      "url_for_pdf": "<string>",
      "url_for_landing_page": "<string>",
      "license": "<string>",
      "version": "<string>",
      "host_type": "<string>",
      "is_best": true,
      "oa_date": "<string>",
      "repository_institution": "<string>",
      "evidence": "<string>",
      "endpoint_id": "<string>",
      "pmh_id": "<string>"
    },
    "oa_locations": [],
    "oa_locations_embargoed": [],
    "authors": []
  }
]

Authorizations

access-token

string

header

required

API token from the dashboard

Headers

access-token

string

required

Body

application/json

doi

string

required

Work DOI

Minimum string length: 1

Examples:

"10.1038/nature12373"

"10.1371/journal.pone.0000308"

timeout

integer

default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500

Response

Successful Response

doi

string

required

@type

string

default:@unpaywall_work

doi_url

string | null

title

string | null

genre

string | null

data_standard

integer | null

is_oa

boolean | null

oa_status

string | null

is_paratext

boolean | null

has_repository_copy

boolean | null

published_date

string | null

year

integer | null

updated_at

string | null

publisher

string | null

journal

UnpaywallJournal · object

Show child attributes

best_oa_location

UnpaywallOaLocation · object

Show child attributes

first_oa_location

UnpaywallOaLocation · object

Show child attributes

oa_locations

UnpaywallOaLocation · object[]

Show child attributes

oa_locations_embargoed

UnpaywallOaLocation · object[]

Show child attributes

authors

UnpaywallAuthor · object[]

Show child attributes

/semanticscholar/papers/search /zenodo/records