{
"openapi": "3.0.1",
"info": {
"title": "ORCID Scraper - Researcher Profiles & iDs",
"description": "Search ORCID or resolve ORCID iDs to public researcher profiles: name, other names, institutions, country, biography, keywords, researcher URLs, external IDs and public email where shared. For academic lead-gen, recruiting and research. No API key, no browser.",
"version": "0.1",
"x-build-id": "DZUjh8SQwkiAbeTEH"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/scrapesage~orcid-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-scrapesage-orcid-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/scrapesage~orcid-scraper/runs": {
"post": {
"operationId": "runs-sync-scrapesage-orcid-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/scrapesage~orcid-scraper/run-sync": {
"post": {
"operationId": "run-sync-scrapesage-orcid-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": "ORCID search queries, one per line. Plain text searches all fields, or use field syntax - e.g. family-name:Smith, affiliation-org-name:MIT, keyword:genomics, given-and-family-names:\"Jane Doe\". Leave empty and the run returns a small free sample.",
"items": {
"type": "string"
}
},
"orcidIds": {
"title": "ORCID iDs (exact lookup)",
"type": "array",
"description": "Specific ORCID iDs to fetch exactly, one per line - e.g. 0000-0002-1825-0097. A full orcid.org URL also works. iD lookups always return the full profile.",
"items": {
"type": "string"
}
},
"fullProfile": {
"title": "Full profile for search results",
"type": "boolean",
"description": "For SEARCH results, also fetch each researcher's full record (biography, keywords, URLs, country, external IDs). One extra request per researcher - leave off for faster, cheaper name/institution results.",
"default": false
},
"searchQueriesFromFile": {
"title": "Import queries or iDs from a file",
"type": "string",
"description": "Bulk-load search queries or ORCID iDs (auto-detected). Either paste the whole list (one per line), or give a single link to a public .txt/.csv, a Google Sheet/Drive link, or an Apify key-value-store record. A file that cannot be read says so and charges nothing."
},
"maxItemsPerQuery": {
"title": "Max researchers per query",
"minimum": 1,
"type": "integer",
"description": "How many researchers to collect for each search query.",
"default": 50
},
"maxItems": {
"title": "Max researchers (total)",
"minimum": 1,
"type": "integer",
"description": "Overall cap across all queries and iDs. You are only charged for researchers actually saved.",
"default": 1000
},
"outputFields": {
"title": "Output fields (leave empty for all)",
"type": "array",
"description": "Pick the fields you want and every record is trimmed to exactly those - handy for lean CSV/Sheets exports. Profile fields (biography, keywords...) fill only with iD lookups or when Full profile is on.",
"items": {
"type": "string",
"enum": [
"type",
"orcidId",
"givenNames",
"familyName",
"creditName",
"otherNames",
"institutions",
"emails",
"country",
"biography",
"keywords",
"researcherUrls",
"externalIds",
"lastModified",
"orcidUrl",
"scrapedAt"
],
"enumTitles": [
"Record type (type)",
"ORCID iD (orcidId)",
"Given names (givenNames)",
"Family name (familyName)",
"Credit name (creditName)",
"Other names (otherNames)",
"Institutions (institutions)",
"Emails (emails)",
"Country (country)",
"Biography (biography)",
"Keywords (keywords)",
"Researcher URLs (researcherUrls)",
"External IDs (externalIds)",
"Last modified (lastModified)",
"ORCID URL (orcidUrl)",
"Scraped at (scrapedAt)"
]
}
}
}
},
"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
}
}
}
}
}
}
}
}
}
}