# OpenAlex Scholar Search & Research Metadata (`scrupulous_waterbird_m4w/openalex-scholar`) Actor Search 200M+ scholarly works, authors, concepts, institutions, and venues through OpenAlex's keyless public API. Export citations, open-access status, concepts, and normalized research metadata. - **URL**: https://apify.com/scrupulous\_waterbird\_m4w/openalex-scholar.md - **Developed by:** [Mori](https://apify.com/scrupulous_waterbird_m4w) (community) - **Categories:** AI, Developer tools, Automation - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing Pay per usage This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-usage ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js/docs.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python/docs.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## OpenAlex Scholar Search Search 200M+ scholarly works, authors, concepts, institutions, and venues from OpenAlex's keyless public API. Unified metadata schema with citations, open-access status, and concept scoring.. ### What it does - Extracts ITEM_TYPE from URL_LIST - Outputs structured JSON (SCHEMA_LINK) - Handles pagination, retries, proxy rotation out of the box ### Input | Field | Required | Description | |---|---|---| | `startUrls` | yes | List of URLs to scrape | | `maxRequestsPerRun` | no | Cap on total requests (default 100) | | `proxyConfiguration` | no | Proxy settings (default: Apify Proxy) | ### Output One record per source page: ```json { "url": "...", "title": "...", "items": [...], "scrapedAt": "ISO-8601" } ```` ### Pricing Free tier: 100 runs/month. Pro: $X/mo. ### Limitations - Static HTML only (no JS rendering — use the playwright template for SPAs). - Single-domain by default. Set `enqueueLinks` globs to crawl. ### Changelog - 0.1.0 — initial release. # Actor input Schema ## `searchQuery` (type: `string`): Full-text search query. OpenAlex ranks results by relevance to this string. ## `entityType` (type: `string`): Which OpenAlex collection to search. 'works' indexes 200M+ scholarly papers; 'authors' indexes researchers; 'concepts' indexes hierarchical topics; 'institutions' indexes universities/orgs; 'venues' indexes journals/conferences. ## `perPage` (type: `integer`): Number of records per page (1-200). OpenAlex caps per-page at 200. ## `page` (type: `integer`): 1-indexed page number for pagination through result sets > perPage. ## `yearFrom` (type: `integer`): Filter to records published on or after this year. 0 = no filter (works/authors only). ## `yearTo` (type: `integer`): Filter to records published on or before this year. 0 = no filter (works/authors only). ## `isOa` (type: `boolean`): Restrict to open-access records with a downloadable PDF URL (works only). ## Actor input object example ```json { "searchQuery": "transformer attention", "entityType": "works", "perPage": 10, "page": 1, "yearFrom": 0, "yearTo": 0, "isOa": false } ``` # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = {}; // Run the Actor and wait for it to finish const run = await client.actor("scrupulous_waterbird_m4w/openalex-scholar").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = {} # Run the Actor and wait for it to finish run = client.actor("scrupulous_waterbird_m4w/openalex-scholar").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{}' | apify call scrupulous_waterbird_m4w/openalex-scholar --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=scrupulous_waterbird_m4w/openalex-scholar", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "OpenAlex Scholar Search & Research Metadata", "description": "Search 200M+ scholarly works, authors, concepts, institutions, and venues through OpenAlex's keyless public API. Export citations, open-access status, concepts, and normalized research metadata.", "version": "0.0", "x-build-id": "vmmwXPfnT82cBpKrC" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrupulous_waterbird_m4w~openalex-scholar/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrupulous_waterbird_m4w-openalex-scholar", "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/scrupulous_waterbird_m4w~openalex-scholar/runs": { "post": { "operationId": "runs-sync-scrupulous_waterbird_m4w-openalex-scholar", "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/scrupulous_waterbird_m4w~openalex-scholar/run-sync": { "post": { "operationId": "run-sync-scrupulous_waterbird_m4w-openalex-scholar", "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", "required": [ "searchQuery" ], "properties": { "searchQuery": { "title": "Search query", "type": "string", "description": "Full-text search query. OpenAlex ranks results by relevance to this string.", "default": "transformer attention" }, "entityType": { "title": "Entity type", "enum": [ "works", "authors", "concepts", "institutions", "venues" ], "type": "string", "description": "Which OpenAlex collection to search. 'works' indexes 200M+ scholarly papers; 'authors' indexes researchers; 'concepts' indexes hierarchical topics; 'institutions' indexes universities/orgs; 'venues' indexes journals/conferences.", "default": "works" }, "perPage": { "title": "Results per page", "minimum": 1, "maximum": 200, "type": "integer", "description": "Number of records per page (1-200). OpenAlex caps per-page at 200.", "default": 10 }, "page": { "title": "Page number", "minimum": 1, "type": "integer", "description": "1-indexed page number for pagination through result sets > perPage.", "default": 1 }, "yearFrom": { "title": "Year from", "minimum": 0, "maximum": 2100, "type": "integer", "description": "Filter to records published on or after this year. 0 = no filter (works/authors only).", "default": 0 }, "yearTo": { "title": "Year to", "minimum": 0, "maximum": 2100, "type": "integer", "description": "Filter to records published on or before this year. 0 = no filter (works/authors only).", "default": 0 }, "isOa": { "title": "Open access only", "type": "boolean", "description": "Restrict to open-access records with a downloadable PDF URL (works only).", "default": false } } }, "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 } } }, "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 } } } } } } } } } } ```