{ "openapi": "3.0.1", "info": { "title": "NIH RePORTER Grant Finder", "description": "Search NIH RePORTER for grants by topic, institution, investigator, institute and year, with award totals and linked PubMed IDs. Official API.", "version": "0.1", "x-build-id": "qcMO0s5vRmVMhLVch" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/a.jonzy~nih-reporter-grant-finder/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-a.jonzy-nih-reporter-grant-finder", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/a.jonzy~nih-reporter-grant-finder/runs": { "post": { "operationId": "runs-sync-a.jonzy-nih-reporter-grant-finder", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/a.jonzy~nih-reporter-grant-finder/run-sync": { "post": { "operationId": "run-sync-a.jonzy-nih-reporter-grant-finder", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "searchText": { "title": "Search text", "type": "string", "description": "Words searched in the project title, abstract and terms, for example glioblastoma immunotherapy. At least one filter in this form is required." }, "searchFields": { "title": "Fields to search", "type": "array", "description": "Where the search text is looked for. Allowed values: title, abstract, terms. Defaults to all three.", "items": { "type": "string" } }, "fiscalYears": { "title": "Fiscal years", "type": "array", "description": "Four-digit NIH fiscal years, for example 2024. Leave empty for all years.", "items": { "type": "string" } }, "organizations": { "title": "Organizations", "type": "array", "description": "Exact institution names as NIH lists them, for example TEXAS CHRISTIAN UNIVERSITY. Case does not matter.", "items": { "type": "string" } }, "investigators": { "title": "Investigators", "type": "array", "description": "Principal investigator names. A last name or a full name, for example Collins or Francis Collins.", "items": { "type": "string" } }, "institutes": { "title": "NIH institutes or centers", "type": "array", "description": "Funding institute abbreviations, for example NCI, NIAID, NHLBI.", "items": { "type": "string" } }, "activityCodes": { "title": "Activity codes", "type": "array", "description": "Grant types, for example R01, R21, K99, F31.", "items": { "type": "string" } }, "states": { "title": "Organization states", "type": "array", "description": "Two-letter US state codes of the awardee organization, for example TX.", "items": { "type": "string" } }, "minAward": { "title": "Minimum award (USD)", "minimum": 0, "type": "integer", "description": "Only grant records with an award amount at or above this value. Optional." }, "maxAward": { "title": "Maximum award (USD)", "minimum": 0, "type": "integer", "description": "Only grant records with an award amount at or below this value. Optional." }, "sortBy": { "title": "Sort by", "enum": [ "startDate", "awardAmount", "fiscalYear" ], "type": "string", "description": "Order of the results, newest or largest first. Allowed values: startDate, awardAmount, fiscalYear.", "default": "startDate" }, "includePublications": { "title": "Attach linked PubMed IDs", "type": "boolean", "description": "Adds the PubMed IDs that NIH links to each grant's core project (all fiscal years of that project). Slower: one extra API call per page of 100 grants.", "default": false }, "includeAbstract": { "title": "Include abstract", "type": "boolean", "description": "Adds the project abstract text to each item.", "default": false }, "maxItems": { "title": "Maximum grants", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Stops after this many grant records. This caps your spend. Maximum 5000.", "default": 100 } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }