{ "openapi": "3.0.1", "info": { "title": "Research Topic Institutions and Authors", "description": "Give a research topic and get the institutions and authors with the most works on it, from OpenAlex: one ranked row each with ROR, ORCID, counts, h-index, and their newest papers on the topic. For research scouting and academic lead lists.", "version": "0.1", "x-build-id": "os691wtwzqouktH5K" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/mambalabs~research-topic-institutions-authors/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-mambalabs-research-topic-institutions-authors", "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/mambalabs~research-topic-institutions-authors/runs": { "post": { "operationId": "runs-sync-mambalabs-research-topic-institutions-authors", "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/mambalabs~research-topic-institutions-authors/run-sync": { "post": { "operationId": "run-sync-mambalabs-research-topic-institutions-authors", "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": { "topics": { "title": "Topics", "type": "array", "description": "Keywords such as perovskite solar cells, or OpenAlex topic IDs such as T10247, up to 20. Each one gets its own ranked rows.", "items": { "type": "string" } }, "row_types": { "title": "Row types", "type": "array", "description": "institutions, authors, or both. Default both.", "items": { "type": "string" } }, "max_institutions": { "title": "Maximum institutions per topic", "type": "string", "description": "Institution rows per topic, up to 200. Default 25.", "default": "25" }, "max_authors": { "title": "Maximum authors per topic", "type": "string", "description": "Author rows per topic, up to 200. Default 25.", "default": "25" }, "recent_papers": { "title": "Recent papers per row", "type": "string", "description": "Newest papers on the topic to add to each row, 0 to 10. Default 3. 0 skips them and uses far less of the OpenAlex budget.", "default": "3" }, "from_year": { "title": "From year", "type": "string", "description": "Count works published from this year. Default 5 years before the current year." }, "to_year": { "title": "To year", "type": "string", "description": "Count works published up to this year. Default no end." }, "countries": { "title": "Countries", "type": "array", "description": "Two letter codes such as US or DE. Institution rows must be in one of these. Author rows come from works with an institution in one of these, and the author may be elsewhere.", "items": { "type": "string" } }, "institution_types": { "title": "Institution types", "type": "array", "description": "Any of education, healthcare, company, archive, nonprofit, government, facility, funder, other. Institution rows must be one of these. Author rows come from works with such an institution.", "items": { "type": "string" } }, "search_scope": { "title": "Search scope", "type": "string", "description": "title_abstract (default): a keyword must be in the title or abstract. fulltext: also the full text where OpenAlex holds it, which matches more and less precisely. Ignored for topic IDs.", "default": "title_abstract" }, "openalex_api_key": { "title": "OpenAlex API key", "type": "string", "description": "Optional. Your own free key from openalex.org/settings/api, with its own 1 USD a day of OpenAlex usage. Without one, the run shares a 0.10 USD daily budget with everyone on its address and keyword search can be limited. Never stored or logged." }, "max_charge_usd": { "title": "Maximum charge for this run (USD)", "type": "string", "description": "Optional. The run stops before a charge that would pass this amount. Summary rows are always returned." }, "source_tag": { "title": "Source tag", "type": "string", "description": "Internal attribution tag. Leave empty." } } }, "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 } } } } } } } } } }