{ "openapi": "3.0.1", "info": { "title": "OpenAlex Scraper & Academic Papers API: DOIs, Citations", "description": "Scholarly papers from OpenAlex by keyword or bulk DOI list: title, DOI, year, venue, citations, open-access link, authors, institutions, topics and abstract. Simple year, citation, type and open-access filters. CC0 data.", "version": "0.1", "x-build-id": "MhLk3TBhOTkkSJdiL" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/stazis~openalex-works-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-stazis-openalex-works-api", "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/stazis~openalex-works-api/runs": { "post": { "operationId": "runs-sync-stazis-openalex-works-api", "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/stazis~openalex-works-api/run-sync": { "post": { "operationId": "run-sync-stazis-openalex-works-api", "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": { "query": { "title": "Search query", "type": "string", "description": "Full-text search over titles, abstracts and full text, e.g. 'large language models'. Leave empty to use only filters." }, "dois": { "title": "DOIs to look up (bulk, optional)", "type": "array", "description": "DOIs or doi.org links, one per line. Looked up 50 per request; DOIs OpenAlex doesn't know are listed in the run status and not charged.", "items": { "type": "string" } }, "yearFrom": { "title": "Published from year", "minimum": 1500, "maximum": 2100, "type": "integer", "description": "Only works published in or after this year." }, "yearTo": { "title": "Published up to year", "minimum": 1500, "maximum": 2100, "type": "integer", "description": "Only works published in or before this year." }, "minCitations": { "title": "Minimum citations", "minimum": 1, "type": "integer", "description": "Only works cited at least this many times." }, "type": { "title": "Work type", "enum": [ "", "article", "preprint", "review", "book", "book-chapter", "dataset", "dissertation" ], "type": "string", "description": "Limit to one work type." }, "openAccessOnly": { "title": "Open access only", "type": "boolean", "description": "Only works with a free full-text version (oaUrl in the output).", "default": false }, "filter": { "title": "Advanced: raw OpenAlex filter", "type": "string", "description": "Optional raw OpenAlex filter string, combined with the fields above, e.g. institutions.country_code:de,language:en. See https://docs.openalex.org." }, "sort": { "title": "Sort", "enum": [ "cited_by_count:desc", "publication_date:desc", "relevance_score:desc" ], "type": "string", "description": "Result order (default: relevance when a query is given)." }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Max works to return. Without an API key, capped at 10,000 and limited by OpenAlex's shared keyless daily budget.", "default": 100 }, "apiKey": { "title": "OpenAlex API key (optional, free)", "type": "string", "description": "Your own free OpenAlex API key (openalex.org -> Settings -> API key). Gives 10x daily budget and unlimited cursor paging. Usage counts against your OpenAlex account. Without it, runs may stop with a 429 'budget' error." } } }, "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 } } } } } } } } } }