{ "openapi": "3.0.1", "info": { "title": "ORCID Researcher Profile Search", "description": "ORCID Researcher Profile Search finds public researcher profiles by query, institution, or ORCID iD. Export names, affiliations, works, identifiers, profile quality signals, and analysis rows.", "version": "0.1", "x-build-id": "BFDKMooaJavKAeFL0" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/maximedupre~orcid-researcher-profile-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-maximedupre-orcid-researcher-profile-search", "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/maximedupre~orcid-researcher-profile-search/runs": { "post": { "operationId": "runs-sync-maximedupre-orcid-researcher-profile-search", "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/maximedupre~orcid-researcher-profile-search/run-sync": { "post": { "operationId": "run-sync-maximedupre-orcid-researcher-profile-search", "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", "maxItems": 50, "type": "array", "description": "Find researchers by name, topic, affiliation, keyword, or ORCID Lucene query.", "items": { "type": "string" } }, "orcidIds": { "title": "ORCID iDs", "maxItems": 100, "type": "array", "description": "Fetch known researchers by ORCID iD.", "items": { "type": "string", "pattern": "^\\d{4}-\\d{4}-\\d{4}-\\d{3}[\\dX]$" } }, "institutions": { "title": "Institutions", "maxItems": 6, "type": "array", "description": "Enter one institution to map, or 2-6 institutions to compare.", "items": { "type": "string" } }, "discoveryQuery": { "title": "Discovery topic or query", "type": "string", "description": "Build a shortlist from a research field, topic, name, affiliation, or Lucene query." }, "discoveryGoal": { "title": "Discovery goal", "enum": [ "experts", "reviewers", "collaborators", "fieldRadar" ], "type": "string", "description": "Choose the shortlist or radar view you want from the discovery target.", "default": "experts" }, "seedOrcidId": { "title": "Seed ORCID iD", "type": "string", "description": "Use with collaborator matches to compare candidates against one known researcher." }, "conflictAffiliations": { "title": "Conflict affiliations", "maxItems": 50, "type": "array", "description": "Use with reviewer shortlists to flag candidates from these organizations.", "items": { "type": "string" } }, "publicationDetail": { "title": "Publication detail", "enum": [ "countsOnly", "recentWorks", "fullWorks" ], "type": "string", "description": "Choose how much works data to include for each researcher.", "default": "recentWorks" }, "maxWorksPerProfile": { "title": "Maximum works per profile", "minimum": 1, "maximum": 500, "type": "integer", "description": "Used when publication detail collects recent or full works.", "default": 25 }, "profileFormat": { "title": "Profile format", "enum": [ "standard", "full", "spreadsheet" ], "type": "string", "description": "Choose the profile depth for exports and API reads.", "default": "standard" }, "includeRelationshipMap": { "title": "Include relationship map", "type": "boolean", "description": "Add cohort similarity and graph records when a run returns multiple researchers.", "default": false }, "maxResultsPerTarget": { "title": "Maximum profiles per search target", "minimum": 1, "maximum": 200, "type": "integer", "description": "Applies to search, institution, and discovery targets.", "default": 125 } } }, "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 } } } } } } } } } }