Class PubMedClient

PubMed/PMC API client

Index

Constructors

Methods

checkPmcAvailability epost executeQuery fetchAllByPmids fetchArticle fetchArticles fetchPmcArticle fetchPmcAsMarkdown fetchSummaries isOaSubset search searchSummaries spellCheck spellCheckDb withConfig

Constructors

constructor

new PubMedClient(): PubMedClient
Create a new PubMed client with default configuration

Returns PubMedClient
- Defined in index.d.ts:6

Methods

checkPmcAvailability

checkPmcAvailability(pmid: string): Promise<string | null>
Check if a PubMed article has full-text available in PMC
Parameters
- pmid: string
  PubMed ID
Returns Promise<string | null>
PMC ID if available, null otherwise
- Defined in index.d.ts:76

epost

epost(pmids: string[]): Promise<EPostResult>
Upload a list of PMIDs to the NCBI History server using EPost

Stores UIDs on the server and returns WebEnv/query_key identifiers that can be used with subsequent API calls.
Parameters
- pmids: string[]
  Array of PubMed IDs as strings
Returns Promise<EPostResult>
EPostResult containing webenv and query_key
Example
```
const client = new PubMedClient();
const result = await client.epost(["31978945", "33515491", "25760099"]);
console.log(`WebEnv: ${result.webenv}, Query Key: ${result.queryKey}`);
```
- Defined in index.d.ts:144

executeQuery

executeQuery(query: SearchQuery): Promise<Article[]>
Execute a search query and return articles
Parameters
- query: SearchQuery
  SearchQuery instance
Returns Promise<Article[]>
Array of article metadata
- Defined in index.d.ts:127

fetchAllByPmids

fetchAllByPmids(pmids: string[]): Promise<Article[]>
Fetch all articles for a list of PMIDs using EPost and the History server

Uploads the PMID list via EPost (HTTP POST), then fetches articles in paginated batches. Recommended for large PMID lists (hundreds or thousands).
Parameters
- pmids: string[]
  Array of PubMed IDs as strings
Returns Promise<Article[]>
Array of article metadata
Example
```
const client = new PubMedClient();
const articles = await client.fetchAllByPmids(["31978945", "33515491", "25760099"]);
articles.forEach(a => console.log(a.title));
```
- Defined in index.d.ts:161

fetchArticle

fetchArticle(pmid: string): Promise<Article>
Fetch a single article by PMID
Parameters
- pmid: string
  PubMed ID
Returns Promise<Article>
Article metadata
- Defined in index.d.ts:33

fetchArticles

fetchArticles(pmids: string[]): Promise<Article[]>
Fetch multiple articles by PMIDs in a single batch request

This is significantly more efficient than fetching articles one by one. For large numbers of PMIDs, requests are automatically batched (200 per request).
Parameters
- pmids: string[]
  Array of PubMed IDs
Returns Promise<Article[]>
Array of article metadata
- Defined in index.d.ts:26

fetchPmcArticle

fetchPmcArticle(pmcid: string): Promise<FullTextArticle>
Fetch full-text article from PMC
Parameters
- pmcid: string
  PMC ID (e.g., "PMC7906746")
Returns Promise<FullTextArticle>
Full-text article data
- Defined in index.d.ts:61

fetchPmcAsMarkdown

fetchPmcAsMarkdown(
pmcid: string,
options?: MarkdownOptions | null,
): Promise<string>
Fetch PMC article and convert to Markdown
Parameters
- pmcid: string
  PMC ID (e.g., "PMC7906746")
- Optionaloptions: MarkdownOptions | null
  Markdown conversion options
Returns Promise<string>
Markdown string
- Defined in index.d.ts:69

fetchSummaries

fetchSummaries(pmids: string[]): Promise<Summary[]>
Fetch lightweight article summaries by PMIDs using the ESummary API

Returns basic metadata (title, authors, journal, dates, DOI) without abstracts, MeSH terms, or chemical lists. Faster than fetchArticles().
Parameters
- pmids: string[]
  Array of PubMed IDs
Returns Promise<Summary[]>
Array of article summaries
- Defined in index.d.ts:43

isOaSubset

isOaSubset(pmcid: string): Promise<OaSubsetInfo>
Check if a PMC article is in the OA (Open Access) subset

The OA subset contains articles with programmatic access to full-text XML. Some publishers restrict programmatic access even though the article may be viewable on the PMC website.
Parameters
- pmcid: string
  PMC ID (e.g., "PMC7906746")
Returns Promise<OaSubsetInfo>
OaSubsetInfo containing detailed information about OA availability
Example
```
const client = new PubMedClient();
const info = await client.isOaSubset("PMC7906746");

if (info.isOaSubset) {
    console.log("Article is in OA subset");
    console.log("Download:", info.downloadLink);
} else {
    console.log("Not in OA subset:", info.errorCode);
}
```
- Defined in index.d.ts:100

search

search(query: string, limit?: number | null): Promise<Article[]>
Search PubMed and fetch article metadata
Parameters
- query: string
  Search query string (PubMed syntax supported)
- Optionallimit: number | null
  Maximum number of results to return
Returns Promise<Article[]>
Array of article metadata
- Defined in index.d.ts:16

searchSummaries

searchSummaries(query: string, limit?: number | null): Promise<Summary[]>
Search PubMed and fetch lightweight summaries

Combines search and ESummary fetch. Faster than search() when you only need basic metadata.
Parameters
- query: string
  Search query string
- Optionallimit: number | null
  Maximum number of results
Returns Promise<Summary[]>
Array of article summaries
- Defined in index.d.ts:54

spellCheck

spellCheck(term: string): Promise<SpellCheckResult>
Check spelling of a search term using the ESpell API

Provides spelling suggestions for terms within a single text query. Uses the PubMed database by default.
Parameters
- term: string
  The search term to spell-check
Returns Promise<SpellCheckResult>
Spelling suggestions with corrected query
- Defined in index.d.ts:110

spellCheckDb

spellCheckDb(term: string, db: string): Promise<SpellCheckResult>
Check spelling of a search term against a specific database using the ESpell API

Spelling suggestions are database-specific, so use the same database you plan to search.
Parameters
- term: string
  The search term to spell-check
- db: string
  The NCBI database to check against (e.g., "pubmed", "pmc")
Returns Promise<SpellCheckResult>
Spelling suggestions with corrected query
- Defined in index.d.ts:120

`Static`withConfig

withConfig(config: Config): PubMedClient
Create a new PubMed client with custom configuration
Parameters
- config: Config
Returns PubMedClient
- Defined in index.d.ts:8

Class PubMedClient

Index

Constructors

Methods

Constructors

constructor

Returns PubMedClient

Methods

checkPmcAvailability

Parameters

Returns Promise<string | null>

epost

Parameters

Returns Promise<EPostResult>

Example

executeQuery

Parameters

Returns Promise<Article[]>

fetchAllByPmids

Parameters

Returns Promise<Article[]>

Example

fetchArticle

Parameters

Returns Promise<Article>

fetchArticles

Parameters

Returns Promise<Article[]>

fetchPmcArticle

Parameters

Returns Promise<FullTextArticle>

fetchPmcAsMarkdown

Parameters

Returns Promise<string>

fetchSummaries

Parameters

Returns Promise<Summary[]>

isOaSubset

Parameters

Returns Promise<OaSubsetInfo>

Example

search

Parameters

Returns Promise<Article[]>

searchSummaries

Parameters

Returns Promise<Summary[]>

spellCheck

Parameters

Returns Promise<SpellCheckResult>

spellCheckDb

Parameters

Returns Promise<SpellCheckResult>

StaticwithConfig

Parameters

Returns PubMedClient

Settings

On This Page

`Static`withConfig