The Library List Endpoint is designed to facilitate the integration of the LibKey API into host settings where the affiliation of the client is not known but whereby the client wants to present for the user browsable/searchable list of subscribing LibKey organizations by selecting an organization the host can know the Library ID of the selected organization.
Contact Third Iron Support to Request your API Key
Email us at support@thirdiron.com to request your API Key. The Third Iron API can only be used by institutions subscribing to the Third Iron Complete and LibKey Service.
There are two types of API Key’s available:
Individual Library - A key to be used (and only authorized) for a subscribing institution.
Integration Partner - This “Universal” key can be used to access any subscribing Library ID with a single API Key and is required for using the Library List Endpoint. Please contact support@thirdiron.com for more details!
Submit a GET request against this endpoint with and get returned a json array of matching organizations and library ID’s.
Third Iron Library List Endpoint:
Supported Methods | GET |
|---|---|
Endpoint Location | /public/v1/libraries/libraries?filter[libkey_subscription_status]=active,trial |
Library List Response:
The Library List will respond with a JSON array of all libraries along with their library ID.
Response Object:
Property | Type | Description |
|---|---|---|
data | Object | An Article Result object is returned if the DOI or PMID is recognized by the Lookup Endpoint |
Article Result:
An article result represents an article that the LibKey system is aware of. Responses from the "DOI/PMID lookup" endpoint then describe articles that have DOI/PMID's that LibKey is aware of but are not in the specified BrowZine Library (:library_id) as well as articles that are within that library. A response indicates whether the article referenced by a DOI/PMID is available at the specified library by setting the article result's "availableThroughBrowZine" property to true when the article is available at the library, and false when it is not.
The full list of properties that may appear on a journal result are described in detail in the table below:
If you utilize the optional ?include=journal parameter, you will also receive journal information. The list of properties appearing when this is done is included below:
Example Request, no include for DOI:
GET /public/v1/libraries/73/articles/doi/10.1056/NEJMe1702728
Example Request, no include for PMID
GET /public/v1/libraries/73/articles/pmid/28317425
Example Response, no include (for either request above):
{
"data": {
"id": 76582654,
"type": "articles",
"title": "Assessment of Stable Coronary Lesions",
"date": "2017-05-11",
"authors": "Bhatt, Deepak L.",
"inPress": false,
"doi": "10.1056/NEJMe1702728",
"pmid: "28317425",
"openAccess": false,
"fullTextFile": "https://libkey.io/libraries/73/articles/143256905/full-text-file",
"contentLocation": "https://libkey.io/libraries/73/articles/143256905",
"availableThroughBrowzine": true,
"startPage": "1879",
"endPage": "1881",
"browzineWebLink": "https://browzine.com/libraries/73/journals/10292/issues/36167007?showArticleInContext=doi:10.1056/NEJMe1702728"
}
}
Example Request, with ?include=journal
GET /public/v1/libraries/73/articles/doi/10.1056/NEJMe1708704?include=journal
Example Response, with ?include=journal
{
"data": {
"id": 76582654,
"type": "articles",
"title": "Assessment of Stable Coronary Lesions",
"date": "2017-05-11",
"authors": "Bhatt, Deepak L.",
"inPress": false,
"doi": "10.1056/NEJMe1702728",
"pmid: "28317425",
"openAccess": false,
"fullTextFile": "https://libkey.io/libraries/73/articles/143256905/full-text-file",
"contentLocation": "https://libkey.io/libraries/73/articles/143256905",
"availableThroughBrowzine": true,
"startPage": "1879",
"endPage": "1881",
"browzineWebLink": "https://browzine.com/libraries/73/journals/10292/issues/36167007?showArticleInContext=doi:10.1056/NEJMe1702728"
"relationships": {
"journal": {
"data": {
"type": "journals",
"id": 10292
}
}
}
},
"included": [
{
"id": 10292,
"type": "journals",
"title": "New England Journal of Medicine (NEJM)",
"issn": "00284793",
"sjrValue": 14.619,
"coverImageUrl": "https://assets.thirdiron.com/images/covers/0028-4793.png",
"browzineEnabled": true,
"browzineWebLink": "https://browzine.com/libraries/73/journals/10292"
}
]
}