{ "openapi": "3.0.1", "info": { "title": "OpenAlex Scraper & API: Papers, Authors, Citations", "description": "OpenAlex scraper & API, $1 per 1,000 results: paste a topic or DOI, get papers, citing papers and authors with h-index as JSON/CSV. A free Google Scholar alternative for literature reviews. Official OpenAlex API, no scraping.", "version": "1.0", "x-build-id": "5Vhdu7yZB04CEhueO" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tuper~openalex-papers/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tuper-openalex-papers", "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/tuper~openalex-papers/runs": { "post": { "operationId": "runs-sync-tuper-openalex-papers", "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/tuper~openalex-papers/run-sync": { "post": { "operationId": "run-sync-tuper-openalex-papers", "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": { "mode": { "title": "What to get", "enum": [ "works", "lookup", "authors" ], "type": "string", "description": "works = papers matching a search and/or filters; lookup = papers by DOI or OpenAlex ID; authors = researchers by name or institution, with h-index and citation counts.", "default": "works" }, "query": { "title": "Search query", "type": "string", "description": "Keywords searched in title, abstract and full text (works) or in author names (authors). Supports AND, OR, NOT and \"quoted phrases\". Leave empty to list by filters only." }, "searchIn": { "title": "Search in", "enum": [ "title_abstract_keywords", "title_and_abstract", "fulltext" ], "type": "string", "description": "Where the query must match (works mode). Title, abstract and keywords is what openalex.org uses; full text is broadest and noisiest.", "default": "title_abstract_keywords" }, "references": { "title": "DOIs or OpenAlex IDs (lookup mode)", "type": "array", "description": "One per line: 10.1038/nature12373, https://doi.org/10.7717/peerj.4375 or W2741809807. Up to 50 per API call; any number per run.", "items": { "type": "string" } }, "yearFrom": { "title": "Published from year", "type": "integer", "description": "e.g. 2020" }, "yearTo": { "title": "Published to year", "type": "integer", "description": "e.g. 2025" }, "dateFrom": { "title": "Published on or after (date)", "type": "string", "description": "YYYY-MM-DD, for exact date ranges." }, "dateTo": { "title": "Published on or before (date)", "type": "string", "description": "YYYY-MM-DD" }, "types": { "title": "Work types", "type": "array", "description": "article, review, preprint, book, book-chapter, dataset, dissertation, letter, editorial, report... Several = any of them.", "items": { "type": "string" } }, "openAccessOnly": { "title": "Open access only", "type": "boolean", "description": "Only works with a free full text somewhere.", "default": false }, "minCitations": { "title": "Minimum citations", "minimum": 0, "type": "integer", "description": "Only works (or authors) cited at least this many times." }, "authorIds": { "title": "OpenAlex author IDs", "type": "array", "description": "A5023888391 or its openalex.org URL (get them with mode 'authors').", "items": { "type": "string" } }, "orcids": { "title": "Author ORCIDs", "type": "array", "description": "0000-0002-1825-0097 or https://orcid.org/...", "items": { "type": "string" } }, "institutionRors": { "title": "Institution ROR IDs", "type": "array", "description": "e.g. 03vek6s52 (Harvard) or https://ror.org/03vek6s52. Find RORs at ror.org. Also works in authors mode (last known institution).", "items": { "type": "string" } }, "countries": { "title": "Author countries", "type": "array", "description": "2-letter ISO codes of the authors' institutions: US, DE, IL. Also works in authors mode.", "items": { "type": "string" } }, "journalIssns": { "title": "Journal ISSNs", "type": "array", "description": "e.g. 0028-0836 (Nature).", "items": { "type": "string" } }, "languages": { "title": "Languages", "type": "array", "description": "ISO 639-1 codes: en, de, es...", "items": { "type": "string" } }, "citesWorkIds": { "title": "Cites this work (citing papers)", "type": "array", "description": "OpenAlex work IDs: returns the papers that cite them. Get a paper's ID with lookup mode.", "items": { "type": "string" } }, "titleSearch": { "title": "Words in the title", "type": "string", "description": "Only works whose title matches these words." }, "excludeRetracted": { "title": "Exclude retracted works", "type": "boolean", "description": "Leave retracted papers out (on by default).", "default": true }, "extraFilter": { "title": "Extra OpenAlex filter (advanced)", "type": "string", "description": "Raw OpenAlex filter string ANDed in, e.g. funders.id:F4320332161 or primary_topic.field.id:17 (docs: help.openalex.org/api/filtering)." }, "sort": { "title": "Sort by", "enum": [ "relevance", "citations", "newest", "oldest" ], "type": "string", "description": "relevance (needs a query), citations (most cited first), newest, oldest. Default: relevance with a query, citations without." }, "includeAbstracts": { "title": "Include abstracts", "type": "boolean", "description": "Rebuilds each abstract as plain text (where the publisher allows OpenAlex to show it).", "default": true }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Stop after this many rows. You pay per row.", "default": 100 }, "apiKey": { "title": "Your OpenAlex API key (optional)", "type": "string", "description": "Free at openalex.org/settings/api (30 seconds): your own $1/day of OpenAlex usage, about 100,000 search results or 1,000,000 filtered results a day. Without it the run uses the Actor's shared key, capped per run." } } }, "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 } } } } } } } } } }