# ncbi
The NCBI Enrichment middleware uses the unit_id found in NCBI access events to request Pubmed metadata using the NCBI API (opens new window).
# Headers
- ncbi-cache : Set to
falseto disable result caching. Enabled by default. - ncbi-ttl : Lifetime of cached documents, in seconds. Defaults to
7 days (3600 * 24 * 7) - ncbi-throttle : Minimum time to wait between each query, in milliseconds. Defaults to
500ms. Make no more than 3 requests per second unless you are registered with the NCBI API. - ncbi-packet-size : Maximum number of memorized NCBI access events before sending requests. Defaults to
200. - ncbi-buffer-size : Maximum number of memorized access events before sending requests. Defaults to
1000. - ncbi-max-tries : Maximum number of attempts if an enrichment fails. Defaults to
5. - ncbi-email : The email for reference for API calls. Defaults to
ezteam@couperin.org(from config.json of ezPAARSE). The email and tool can be registered with NCBI to increase the number of requests per second for the application. - ncbi-tool : The tool for reference for API calls. Defaults to
ezPAARSE (https://ezpaarse.org; mailto:ezteam@couperin.org). The email and tool can be registered with NCBI to increase the number of requests per second for the application. - ncbi-apikey : Apikey for rights holders to speed up processing (10 requests per second)
# Enriched fields
| Name | Type | Description |
|---|---|---|
| print_identifier | String | International Standard Serial Number for publications. |
| online_identifier | String | Electronic ISSN for publications. |
| publication_title | String | The full name of the journal. |
| doi | String | The digital object identifier. |
| title | String | The article title. |
# Example
curl -v -X POST http://localhost:59599
-H "ezPAARSE-Middlewares: ncbi"
-F "files[]=@access.log"
# API Documentation
https://www.ncbi.nlm.nih.gov/books/NBK25499/#chapter4.Release_Notes