{ "success": { "v": 1, "description": "Article metadata", "options": { "parameters": { "pubname": "Publication name (exact match)", "pubname_like": "Publication name (partial match -- all publications containing that string will be included)", "publisher": "Publisher/database source of publications (e.g. USGS, Elsevier). A comma-separated list will provide a UNION of the publishers' results. If not specified, all sources are shown.", "recent": "Returns the most recently acquired articles (NOT necessarily the most recently published articles, but those recently entering the corpus). Requires max parameter to be specified as well.", "term": "Full-text search term. Results will come back sorted by metascore (max 250 results)", "no_word_stemming": "If true, do not apply word stemming to search term (default: stem terms such that a search for 'stromatolite' is reduced to 'stromatolit*' and matches ['stromatolites', 'stromatolitic', 'stromatolite'])", "case_sensitive": "If true, require case sensitivity when searching (default: not case sensitive)", "full_results": "Optional. When this parameter is included (no value required), an overview of total number of matching articles is returned, with a scan-and-scroll cursor that allows client to step through all results page-by-page; default behavior (no full_results parameter included) is to restrict response size to first 10 matching documents.", "per_page": "Maximum number of results to include in one response. Applies to full_results pagination or single-page requests. NOTE: Due to internal mechanisms, actual number of results will be this parameter, floor rounded to a multiple of 25.", "docid": "internal ID of the article to retrieve", "doi": "Digital Object Identifier of the article to retrieve", "title": "Search for an article by title (exact match)", "title_like": "Search for an article by title partially matching search string", "min_acquired": "Optional. Restrict results to documents acquired since the date specified. Can be an ISO compliant string or a range relative to time of request (e.g. 'min_acquired=24h' to restrict results to documents acquired in the previous 24 hours). Possible values: y (year), M (months), w (weeks), d (days), h/H (hours), m (minutes), s (seconds)", "max_acquired": "Optional. Restrict results to documents acquired before the date specified. Can either be a ISO compliant string or a simple range compared to now (e.g. '24h' for the previous 24 hours). Possible parameters: y (year), M (months), w (weeks), d (days), h/H (hours), m (minutes), s (seconds)", "min_published": "Optional. Require publication date to be anytime since the date specified (inclusive). Must be an ISO compliant string (e.g., 2020-01). NOTE: only year and month are used in filtering even if ISO-compliant day and/or time is provided. Note that many journals release publications in advance of their cover published date, meaning that a specified date in the future might return results.", "max_published": "Optional. Require publication date to be anytime prior to the specified date. Must be an ISO compliant string (e.g., 2020-01-01). NOTE: only year and month are used in filtering even if ISO-compliant day and/or time is provided.", "fields": "Fields to return (default: all except contents and processing information)", "firstname": "First name of an author to search for; case insensitive.", "lastname": "Last name of an author to search for; case insensitive.", "max": "Maximum number of articles to return (default is all, but some paramaters require max to be specified)", "dataset": "Filter the results to a predefined dataset (see /sets route for availability and definitions (alternate to set parameter)", "dict_filter": "Filter the results to documents which include at least one term from the specified dictionary.", "dictid_filter": "Filter the results to documents which include at least one term from the specified dictionary (by ID).", "set": "Filter the results to a predefined dataset (see /sets route for availability and definitions (alternate to dataset parameter)", "inclusive": "Optional. When this parameter is included (no value needed), then all comma-separated terms must co-occur in the same document. Default behavior is to show results for documents containing one or more of the search terms/phrases.", "corpus": "Restrict (or expand) the results to one or more of xDD's corpora. By default, results include only xDD's fulltext holdings. Additional optios include 'pubmed_abstracts' or 'all'.", "known_terms": "If true, include summary of known terms indexed within xDD, grouped by dictionary. Also accepts a comma-separated list of dictionary names to filter.", "dict": "Include known terms summary for specified dictionaries for each result. Comma-separated list of dictionary names.", "dict_id": "Include known terms summary for specified dictionaries for each result. Comma-separated list of dictionary IDs.", "known_entities": "Include known entities extracted via external tools. Current options: [drugs, emmaa, stratname_candidates, url_extractions, summaries].", "include_score": "Include the search query score for each document. NOTE: scores will be zero for filtration-type queries. Scores are only meaningful with doing term-based query.", "facets": "If true, include an aggregated summary of the publisher, journal name, and publication name of the search results.", "match": "If true, utilizes a \"match\" instead of a \"match_phrase\" query within Elaticsearch. This has the effect of finding documents which most frequently use the individial terms in the query, rather than looking for the exact phrase.", "include_highlights": "Include highlights of the search terms' utilziation within the text. Not as flexible as snippets, but includes full bibjson response.", "additional_fields": "Extend the query to include fields in addition to the full-text contents (example: abstract,title). The query logic is OR across the search fields." }, "output_formats": [ "json" ], "examples": [ "/api/articles?pubname=Palaeoworld", "/api/articles?pubname_like=Deep Sea Research", "/api/articles?recent&max=10", "/api/articles?term=mesozoic&fields=title,pubname", "/api/articles?term=reverse transcription&full_results", "/api/articles?term=abbott formation&publisher=USGS", "/api/articles?doi=10.1080/01411598708240781", "/api/articles?publisher=Wiley&full_results&fields=doi", "/api/articles?firstname=Albert&lastname=Einstein", "/api/articles?min_acquired=24h", "/api/articles?min_acquired=2020-01-01&max_acquired=2020-01-02", "/api/articles?min_published=2001-01&max_published=2002-01", "/api/articles?term=Chen&case_sensitive=true&no_word_stemming=true&max=10", "/api/articles?term=remdesivir&dict=covid-19&known_entities=drugs&max=10" ], "fields": { "type": "Type of publication (article, book, etc)", "title": "Article title", "journal": "The name of the journal", "link": "An array of objects, each containing the keys 'type' and 'url'. The URL is an external link to the original document.", "link.type": "Type of link -- either a link to the publisher (publisher) or the ScienceDirect page for the article (sciencedirect)", "link.url": "The URL to the document at the publisher's domain", "vol": "Volume", "number": "Issue", "authors": "An array of objects, each containing a key 'name' and a value equal to the name of one author", "publisher": "Publisher (or primary source) of the article (e.g. Elsevier, USGS)", "pages": "Articles' page numbers within the issue", "year": "Year of publication", "identifier": "An array of objects, each containing a 'type' and 'id'. Used for providing DOIs, as well as other external identifiers" } }, "license": "https://creativecommons.org/licenses/by-nc/2.0/" } }