Svoboda | Graniru | BBC Russia | Golosameriki | Facebook

This website requires cookies, and the limited processing of your personal data in order to function. By using the site you are agreeing to this as outlined in our privacy notice and cookie policy.

Grants RESTful (Grist) API

The Grist database contains details of grants awarded by the Europe PMC Funders.

See a description of the data fields used in Grist.

Use this API to search the Grist database.

Join the Europe PMC web service users' Google group to receive notifications about upcoming web service releases and changes.

We advise that you read our Privacy Notice before using this API. By using our public API you agree to accept the terms of the Europe PMC website Privacy Notice.

URL syntax

Construct your URL for search requests as follows:

https://www.ebi.ac.uk/europepmc/GristAPI/rest/get/query={}[&parameters]

Request Parameters

query

Enter search terms with this parameter. [Note that this is the only obligatory parameter.]

You can use a keyword or combination of keywords; for the definition of a keyword search see Grist API Parameters

https://www.ebi.ac.uk/europepmc/GristAPI/rest/get/query=cluster
https://www.ebi.ac.uk/europepmc/GristAPI/rest/get/query=cluster randomised

Or a phrase with enclosing speech marks:

https://www.ebi.ac.uk/europepmc/GristAPI/rest/get/query="cluster randomised"

Or a fielded search; for a list of available search fields see Grist API Parameters

https://www.ebi.ac.uk/europepmc/GristAPI/rest/get/query=pi:smith
https://www.ebi.ac.uk/europepmc/GristAPI/rest/get/query=title:"Cluster"
https://www.ebi.ac.uk/europepmc/GristAPI/rest/get/query=ga:"Cancer Research UK"
https://www.ebi.ac.uk/europepmc/GristAPI/rest/get/query=ga:"BHF" pi:smith

Note:

Separate search terms within a query should be separated by spaces, not ampersands (&s), and all such search terms are combined with logical ANDs. If a specific field (e.g., pi:, ga:, gr:) is not given for a search term then a keyword (kw:) search is used by default.

So, for example the following query will NOT identify grantholders named "smith" funded by the Wellcome Trust:

https://www.ebi.ac.uk/europepmc/GristAPI/rest/get/query=ga:"Wellcome Trust" & pi:smith

because it is equivalent to this keyword search:

https://www.ebi.ac.uk/europepmc/GristAPI/rest/get/query=ga:"Wellcome Trust" kw:& pi:smith

In this case the correct query would be:

https://www.ebi.ac.uk/europepmc/GristAPI/rest/get/query=ga:"Wellcome Trust" pi:smith

resultType

The result type can either be lite [the default value if parameter unspecified] or core:

  • lite returns key metadata for the given search terms;
  • core returns full metadata for a given search terms, including abstracts, grant start/end dates and institution details.

For example:

https://www.ebi.ac.uk/europepmc/GristAPI/rest/get/query=gid:081052&resultType=core

page

The number of the results page required. Each page contains results for up to 25 grants and page numbering starts at 1 [the default value if parameter unspecified].

For example:

https://www.ebi.ac.uk/europepmc/GristAPI/rest/get/query=malaria&page=4

format

The format can be XML [the default value if parameter unspecified] or JSON or CERIF.

For example:

https://www.ebi.ac.uk/europepmc/GristAPI/rest/get/query=malaria&format=json
https://www.ebi.ac.uk/europepmc/GristAPI/rest/get/query=malaria&format=cerif

Grist API Parameters

[See a description of the data fields used in Grist].

Syntax wordDescriptionExample
ga, grant_agency Search for a term in funder names/abbreviations/FundRef IDs. [See a list of funder names used in Grist.] ga:"Wellcome Trust", ga:BBSRC, grant_agency:501100000381
gid, gr, grant_idSearch for a term in grant numbers/IDs.gid:083611
title, tiSearch for a term or terms in grant titles.title:cancer, ti:"kidney cancer"
abstract, absSearch for a term or terms in grant abstracts.abstract:"diverse functions"
date, active_date Search by active date, where date given is between start and end dates. Format must by yyyy-mm-dd, where month (mm) and day (dd) are optional. date:2011-02-12, date:2012-04, active_date:2010
kw Search for a term or terms in grant titles, abstracts, streams and types. kw:"Physiological Sciences"
piSearch for a PI by last name, and optional initial(s).pi:hubbard, pi:"Hubbard S"
pi_id, author_id Search for a PI by alternative identifier, e.g. ORCID. Format must be {id type}/{id value} pi_id:ORCID/0000-0001-2345-6789
aff Search for a term or terms in institution names/departments. aff:Cambridge, aff:"University of Manchester", aff:"Life Sciences"
cat Search for a category grouping of grants. Grants can be associated with multiple categories. cat:"COVID-19"
epmc_funders Search for funders belonging to the Europe PMC funder group. Accepted values are: yes|no, y|n, and true|false. epmc_funders:yes

CERIF API

Refer to the CERIF XML Schema for details on Response Entities.

How Pagination Works

Paginated resources will be limited to 25 Grants by default and page numbering starts at 1 [the default value if parameter unspecified]. The pagination details are contained within HTTP response header.

For example:

https://www.ebi.ac.uk/europepmc/GristAPI/rest/get/query=pi:smith&format=cerif&page=2

For the search above link header values shown below:

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
HitCount: 407
ResultType: CERIF
Query: pi:smith
Page: 2
Content-Type: text/xml
Transfer-Encoding: chunked

HitCount

An integer defining the total numbers of records: At the time of writing the above search returns the integer: 407.