Contents
Please note that this API has been superseded by the ARDC Research Activities API. If you have any questions or concerns please contact [email protected].
The Research Grants API provides access to data relating to Australian Research Grants and Researchers.
This service allows users to discover published research grants based on their title, or relationship to specific individuals or institutions.
Example use cases for the service include:
- Populating a lookup form input to search for grant numbers
- Enabling richer RIF-CS relationship mappings
- Determining grants that have been allocated to a particular researcher
The service currently provides a searchable index for all NHMRC grants deposited into the RDA Registry as part of the Activity Infrastructure project.
Usage
Before you start! To use this service, institutions or individuals must register for a free API key .
Resource URL
https://researchdata.edu.au/registry/services/{YOUR API KEY}/getGrants?{params}
- This API is a RESTful Web Service. Simply replace the blue parameters with the appropriate values and issue a HTTP GET request.
- Replace
{YOUR API KEY}
with the key your organisation registered (no API key? register for free) - Replace
{params}
with some combination of the parameters below. Note: all parameter values must be URL-encoded. - By default, results are limited to 10 records per request. Use the
start
androws
parameters to step through additional results
Service Parameters
These parameters have the same meaning as defined by SOLR Common Query Parameters (SOLR enterprise search server ).
Parameter | Description | Example Usage |
id | the id of the grant (or part thereof) | getGrants?id=1031221 |
title | the title of the grant (or part thereof) | getGrants?title=cancer |
institution | filter results to those grants which are managed by this institution | getGrants?institution=University%20of%20Sydney |
principalInvestigator | filter results to those grants which have this principal/lead investigator | getGrants?principalInvestigator=Jacob%20George |
person | filter results to those grants which have this person listed as a lead OR co-investigator | getGrants?person=Prof%20Jacob%20George |
rows | limit the number of grants returned to this number (default: 999) | getGrants?title=fish&rows=5 |
start | offset the grants returned by this number (used to “cursor” through large result sets) | getGrants?title=fish&rows=15&start=75 |
Response Format
- Responses from this service are returned in JSON format. See example below for response schema.
- Results are wrapped inside a
messages
object, which is returned when the status issuccess
- If no grants matched your result, the
messages
object will be an empty array
Example Usage
Grants for a particular organisation and researcher
Return all grants whose chief investigator was “Dr Ming Tat (Patrick) Ling” and were managed by Queensland University of Technology:
getGrants?institution=Queensland%20University%20of%20Technology&principalInvestigator=Dr%20Ming%20Tat%20%28Patrick%29%20Ling
Grants matching a certain title by a particular researcher
Return all grants involving “Prof David Cook” which contain sodium channels in the title:
getGrants?person=Prof%20David%20Cook&title=sodium%20channels
This page has no comments.