https://github.com/christophe77/pubmed-api-wrapper

Pubmed api wrapper javascript
https://github.com/christophe77/pubmed-api-wrapper

nodejs pubmed typescript

Last synced: about 2 months ago
JSON representation

Pubmed api wrapper javascript

• Host: GitHub
• URL: https://github.com/christophe77/pubmed-api-wrapper
• Owner: christophe77
• License: gpl-3.0
• Created: 2021-12-10T07:58:55.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2021-12-13T15:55:20.000Z (almost 4 years ago)
• Last Synced: 2025-04-23T16:37:57.429Z (6 months ago)
• Topics: nodejs, pubmed, typescript
• Language: TypeScript
• Homepage: https://github.com/christophe77/pubmed-api-wrapper
• Size: 217 KB
• Stars: 6
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# PubMed API wrapper

PubMed API wrapper JS.


Feel free to contribute.


## Install

    yarn add pubmed-api

or 


    npm install --save pubmed-api

then import the package in your app : 


    import PubmedApi from 'pubmed-api';

or 


    const PubmedApi = require('pubmed-api');

By default PubmedApi is set to :


retMode = json


apiKey = undefined


    const pubMedApi = new PubmedApi();

You can override this settings in the constructor :


    const pubMedApi = new PubmedApi("xml");

    const pubMedApi = new PubmedApi("xml", "myApiKey");

## Available commands

### eInfo

Explanations here : https://dataguide.nlm.nih.gov/eutilities/utilities.html#einfo


    async function getDbList() {

        try {

            const results = await pubMedApi.eInfo.getDbList();

            console.log(results);

        } catch (error) {

            console.log(error);

        }

    }

    async function getDbInfo() {

        try {

            const results = await pubMedApi.eInfo.getDbInfo('pubmed');

            console.log(results);

        } catch (error) {

            console.log(error);

        }

    }

### eSearch

Explanations here : https://dataguide.nlm.nih.gov/eutilities/utilities.html#esearch


    async function getSearch() {

        try {

            const results = await pubMedApi.eSearch.search('pubmed', 'green');

            console.log(results);

        } catch (error) {

            console.log(error);

        }

    }

    async function getSearchWithOptions() {

        const options = {

            minDate: '2021/01/01',

            maxDate: '2021/02/02',

            retStart: '500',

            retMax: '1000',

            retType: '',

            dateType: 'edat',

            relDate: '',

            useHistory: true,

        };

        try {

            const results = await pubMedApi.eSearch.search('pubmed', 'green', options);

            console.log(results);

        } catch (error) {

            console.log(error);

        }

    }

### eSpell

Explanations here : https://dataguide.nlm.nih.gov/eutilities/utilities.html#espell


    async function getSpell() {

        try {

            const results = await pubMedApi.eSpell.search('pubmed', 'green');

            console.log(results);

        } catch (error) {

            console.log(error);

        }

    }

### eSummary

Explanations here : https://dataguide.nlm.nih.gov/eutilities/utilities.html#esummary


    async function eSummarySearch() {

        try {

            const results = await pubMedApi.eSummary.search(

                'pubmed',

                '11200,11201,11202',

            );

            console.log(results);

        } catch (error) {

            console.log(error);

        }

    }

    async function eSummarySearchWithOptions() {

        const options = {

            retStart: '100',

            retMax: '100',

            version: '2',

        };

        try {

            const results = await pubMedApi.eSearch.search('pubmed', 'green', options);

            console.log(results);

        } catch (error) {

            console.log(error);

        }

    }

### eCitMatch

Explanations here : https://dataguide.nlm.nih.gov/eutilities/utilities.html#ecitmatch


// bdata = journal_title|year|volume|first_page|author_name|your_key|

    async function eCitMatch() {

        try {

            const results = await pubMedApi.eCitMatch.match(

            'pubmed',

            'proc+natl+acad+sci+u+s+a|1991|88|3248|mann+bj|Art1|%0Dscience|1987|235|182|palmenberg+ac|Art2|',

            );

            console.log(results);

        } catch (error) {

            console.log(error);

        }

    }