Welcome to E-utilities’s documentation!

This documentation will serve as a guide on how to use the E-utilites php library. It will not thoroughly discuss the NCBI E-utilities itself.

• Installation
  • Composer
• How to use
  • The abstract base
  • EUtility- & Query interface
  • Use an EUtility
  • Building a Query

E-Utilities

NCBI has created a HTTP API to query data against their databases. There are a few different utilities you can use. The details for every utility is decribed here.

• EInfo
  • Basic example
  • EInfo parameters
• ESearch
  • Basic example
  • ESearch parameters
  • Changing the query
• ESummary
  • Basic example
  • ESummary parameters

Current state of the php library

At this point in time I’ve implemented the calls to use:

• EInfo
• ESearch
• ESummary

API Key

As of december 2018 NCBI requires the usage of an api key. You can create one here.

Once you’ve got an api key, add it in your .env file and call it NCBI_API_KEY

Indices and tables

• Index
• Module Index
• Search Page