...
Property | Type | Description | Optional |
|---|---|---|---|
id | number | The article's unique id in the Third Iron system | No |
type | string | has the value "articles" | No |
title | string | The article's title | Yes |
date | string | The date of the article | No |
authors | string | The authors of the article | Yes |
inPress | boolean | True when the article is not yet assigned to a regularly published issue and is considered an "Article in Press". False when it is in a regularly published issue | No |
doi | string | The DOI of the given record | No |
ILLURL | URL | For libraries who have configured an ILL system, this property will be available and could be used to provide a path for fulfillment should no fullTextFile or contentLocation URLs be available. Optionally a library who does not have an ILL system for LibKey to build a link for may request LibKey instead construct a "mailto" which includes all the metadata for an article pointed at a specific email address(es) to help the user request assistance in retrieving the articles from the library. That information is held in this field as well, even though it is not a URL but a "mailto". | Yes |
pmid | string | For articles that have a PMID value it will be provided here | Yes |
openAccess | boolean | True if the article is open access via the publisher and False if it is not. LibKey.io links corresponding to this article which have an openAccess value of "True" will not include any institutional authentication. | No |
unpaywallUsable | boolean | True indicates that if the V1 API is used in conjunction with the Third Iron produced “Discovery Adapters”, those adapters have a feature whereby a live unpaywall service call can optionally be done to pick up accepted manuscripts. However, since this call is live, Third Iron/LibKey may learn that an article flagged by unpaywall actually should have a paywall. When this happens, this value becomes “false” so that users of the discovery adapter don’t have the unpaywall live call script “override” what Third Iron/LibKey know to be false. Third parties could potentially use this value in the same way if they are using LibKey alongside Unpaywall’s API for more accurate data. | No |
fullTextFile | URL | On articles where LibKey is aware of a path directly to the PDF file, this property will be available | Yes |
contentLocation | URL | On articles where LibKey is aware of a path to the web page where the article is available, this property will be available. This can include non-publisher sources such as aggregators and repositories. | Yes |
availableThroughBrowZine | boolean | True when the article is available within Browzine at the specified library | No |
startPage | string | The page the article starts on | Yes |
endPage | string | The page the article ends on | Yes |
abstract | string | Abstract for the article if available | Yes |
retractionNoticeUrl | URL | Will appear if the article has been retracted with a link to a LibKey.io URL which provides more information about the retraction with data from Retraction Watch. | Yes |
browzineWebLink | URL | On titles that are BrowZine enabled, this property will be present and will link to the article in the context of its issue (or articles in press list as appropriate) on browzine.com | No |
...