{ "openapi": "3.0.1", "info": { "title": "ORCID Researchers Scraper (Profiles, Affiliations & Works)", "description": "Scrape ORCID researcher profiles: ORCID iD, names, biography, country, keywords, websites, external IDs, employment and education affiliations (org, role, dates, city) and recent works (title, type, year, DOI). Search by name, affiliation, keyword or ORCID iD. Export to JSON, CSV or Excel.", "version": "0.1", "x-build-id": "RWAqA44NaHyUZM7r9" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapers_lat~orcid-researchers-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapers_lat-orcid-researchers-scraper", "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/scrapers_lat~orcid-researchers-scraper/runs": { "post": { "operationId": "runs-sync-scrapers_lat-orcid-researchers-scraper", "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/scrapers_lat~orcid-researchers-scraper/run-sync": { "post": { "operationId": "run-sync-scrapers_lat-orcid-researchers-scraper", "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": { "searchQueries": { "title": "Search queries", "type": "array", "description": "One or more free-text searches by researcher name, institution or topic. One run searches every term, for example [\"Geoffrey Hinton\", \"quantum computing\", \"Stanford University\"].", "items": { "type": "string" } }, "orcidIds": { "title": "ORCID iDs", "type": "array", "description": "Optional. One or more exact ORCID iDs to look up directly, e.g. [\"0000-0001-5109-3700\"].", "items": { "type": "string" } }, "familyName": { "title": "Family name", "type": "string", "description": "Optional. Filter by researcher family (last) name." }, "givenNames": { "title": "Given names", "type": "string", "description": "Optional. Filter by researcher given (first) names." }, "affiliationOrg": { "title": "Affiliation organization", "type": "string", "description": "Optional. Filter by affiliation organization name, e.g. \"Stanford University\"." }, "keyword": { "title": "Research keyword", "type": "string", "description": "Optional. Filter by a research keyword listed on the profile, e.g. \"machine learning\"." }, "country": { "title": "Country (ISO code)", "type": "string", "description": "Optional. Keep only researchers whose profile country matches this 2-letter ISO code, e.g. \"US\", \"GB\", \"DE\"." }, "includeWorks": { "title": "Include recent works", "type": "boolean", "description": "Include each researcher's recent works / publications (title, type, year, DOI).", "default": true }, "maxResearchers": { "title": "Max researchers to scrape", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Maximum number of researcher profiles to return across all searches." }, "withAiSummary": { "title": "AI biography summary (paid add-on)", "type": "boolean", "description": "Off by default. When on, generates a 1-2 sentence summary from each researcher's biography (skipped when no biography). Requires a paid Apify plan. Billed only when a summary is produced.", "default": false }, "withAiKeywords": { "title": "AI research keywords (paid add-on)", "type": "boolean", "description": "Off by default. When on, infers 5-10 research-topic keywords per researcher from bio, stated keywords and recent works. Requires a paid Apify plan. Billed only when keywords are produced.", "default": false }, "withAiField": { "title": "AI field classification (paid add-on)", "type": "boolean", "description": "Off by default. When on, classifies each researcher's primary field/discipline. Requires a paid Apify plan. Billed only when a classification is produced.", "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 } } } } } } } } } }