Skip to main content
Ctrl+K

ScienceScraper

  • Getting Started
  • User Guide
  • How to Contribute
  • API Reference
  • GitHub
  • Getting Started
  • User Guide
  • How to Contribute
  • API Reference
  • GitHub

Section Navigation

  • sciencescraper
    • sciencescraper.pmc
      • sciencescraper.pmc.pmc_clean
      • sciencescraper.pmc.pmc_extract
      • sciencescraper.pmc.pmc_scrape
      • sciencescraper.pmc.pmc_search
    • sciencescraper.sciencedirect
      • sciencescraper.sciencedirect.scidir_clean
      • sciencescraper.sciencedirect.scidir_extract
      • sciencescraper.sciencedirect.scidir_scrape
      • sciencescraper.sciencedirect.scidir_search
  • API Reference
  • sciencescraper.sciencedirect

sciencescraper.sciencedirect.scidir_search#

Functions for searching for articles on ScienceDirect.

Module Contents#

Functions#

search_scidir(api_key, query[, sortBy, startDate, ...])

Get articles from Elsevier's ScienceDirect database that are relevant to a specified search query.

get_new_articles(api_key, query, start_date[, chunk_size])

Get open access articles from Elsevier's ScienceDirect database that have been published after a specified date.

notify_new_articles(articles)

Notify the user of new articles.

check_new_articles(api_key, query, days)

Check for new articles in Elsevier's ScienceDirect database and notify the user of any new articles.

sciencescraper.sciencedirect.scidir_search.search_scidir(api_key, query, sortBy='relevance', startDate=None, max_results=25, offset=0)[source]#

Get articles from Elsevier’s ScienceDirect database that are relevant to a specified search query.

Parameters:
  • api_key (str) – The API key for the ScienceDirect API. API keys can be obtained by creating an account at https://dev.elsevier.com/.

  • query (str) – The search query to be used to search for articles.

  • sortBy (str, optional) – The sorting order for the search results. Options are: - “relevance”: Sort by relevance - “date”: Sort by date Default is “relevance”.

  • startDate (str, optional) – The start date for the search query in the format ‘YYYY-MM-DD’.

  • max_results (int, optional) – The maximum number of results to return. Default is 25. Permitted values: 10, 25, 50, 100.

  • offset (int, optional) – The number of results to skip. Default is 0.

Return type:

list of DOIs of the articles

sciencescraper.sciencedirect.scidir_search.get_new_articles(api_key, query, start_date, chunk_size=None)[source]#

Get open access articles from Elsevier’s ScienceDirect database that have been published after a specified date.

Parameters:
  • api_key (str) – The API key for the ScienceDirect API. API keys can be obtained by creating an account at https://dev.elsevier.com/.

  • query (str) – The search query to be used to search for new articles.

  • start_date (str) – The start date for the search query in the format ‘YYYY-MM-DD’.

  • chunk_size (int, optional) – The size of the chunks to split the full text into. Default is None.

Returns:

A list of dictionaries containing the title, authors, journal, year, URL, open access status, keywords, abstract, methods, results, discussion, and references of the new articles.

Return type:

list of dict

sciencescraper.sciencedirect.scidir_search.notify_new_articles(articles)[source]#

Notify the user of new articles.

Parameters:

articles (list of dict) – A list of dictionaries containing the title, authors, journal, year, URL, open access status, keywords, abstract, methods, results, discussion, and references of the new articles.

sciencescraper.sciencedirect.scidir_search.check_new_articles(api_key, query, days)[source]#

Check for new articles in Elsevier’s ScienceDirect database and notify the user of any new articles.

Parameters:
  • api_key (str) – The API key for the ScienceDirect API. API keys can be obtained by creating an account at https://dev.elsevier.com/.

  • query (str) – The search query to be used to search for new articles.

  • days (int) – The number of days to search for new articles.

Returns:

A list of dictionaries containing the title, authors, journal, year, URL, open access status, keywords, abstract, methods, results, discussion, and references of the new articles.

Return type:

list of dict

previous

sciencescraper.sciencedirect.scidir_scrape

On this page
  • Module Contents
    • Functions
      • search_scidir()
      • get_new_articles()
      • notify_new_articles()
      • check_new_articles()
Show Source

© Copyright 2024, Joshua Blomgren, Elizabeth Gilson, Jeffrey Jacob. Project structure based on the Computational Molecular Science Python Cookiecutter version 1.1.

Created using Sphinx 7.3.7.

Built with the PyData Sphinx Theme 0.15.2.