API Documentation
The Nucleati Abstract API is organized using REST principles. API has predictable URLs and returns JSON responses. It also uses standard HTTP response codes. All API endpoints use simple authentication method using API tokens, that should be pass along with each request.
Base URL
https://abstracts.nucleati.com/api/v1
/articles
A key endpoint to query database using either NlmId, Year of publication or series of PMIDs.
Query by Journal's NLM Id GET
- Query abstracts database using journal's NLM Id.
- The easiest way to find NLM id of a journal is using NLM Catalog. If you know the journal name make sure to use double quotes to search the journal (e.g. search for "PLOS One"). The NLM id for a journal is given at the end of the journal page.
- Query can send out several MBs of data.
- We will soon put up a specialized service to quickly search for NLM Ids.
Query Parameters
Response
Example cURL
curl https://abstracts.nucleati.com/api/v1/articles?nlmId=101285081&apikey={YOUR API KEY}
Query by Year GET
- Query abstracts database using year.
- As there can be a million articles published in a year, query may send out tens or even hundred MBs of data.
Before you start this query
- The response from this query might be perceived as slow. However, it is essential to note that there are 1,071,503 articles published in the year 2017. Therefore, the response you will receive when you query for this year is nearly 1.5 GB.
- The query processing time is just ~20 seconds on the server-side; downloading the data (response) depends on your internet connection (our servers have 1 GBPS speed).
Query Parameters
Response
Example cURL
curl https://abstracts.nucleati.com/api/v1/articles?year=1995&apikey={YOUR API KEY}
Query by Year POST
- Bulk query articles using payload.
- Payload requires series of PMIDs for which the user needs information.
- If the article is not found (when you search using fictious PMIDs), the corresponding entry in the response will include error message.
Query Parameters
Request Body
7534103
7534102
98345443323
Response
Example cURL
curl -X POST https://abstracts.nucleati.com/api/v1/articles?apikey={YOUR API KEY} --data-binary "7534103
7534102
98345443323"
