{ "openapi": "3.0.1", "info": { "title": "ORCID Researcher Lookup — Public Profile API", "description": "Look up researchers by ORCID iD against the official, free ORCID public registry. Get name, biography, country, employment history, keywords, and total works count. Pay only for iDs that resolve to a real record.", "version": "1.0", "x-build-id": "sVzR4NrUxH4rOBrb8" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/accountable_eel~orcid-researcher-lookup/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-accountable_eel-orcid-researcher-lookup", "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/accountable_eel~orcid-researcher-lookup/runs": { "post": { "operationId": "runs-sync-accountable_eel-orcid-researcher-lookup", "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/accountable_eel~orcid-researcher-lookup/run-sync": { "post": { "operationId": "run-sync-accountable_eel-orcid-researcher-lookup", "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": [ "orcidIds" ], "properties": { "orcidIds": { "title": "ORCID iDs to look up", "type": "array", "description": "One ORCID iD per line, in 0000-0002-1825-0097 format (a full orcid.org URL also works). Accepted formats: 0000-0002-1825-0097, https://orcid.org/0000-0002-1825-0097. You're only charged for the ones we actually find — a miss costs nothing.", "items": { "type": "string" } }, "testRun": { "title": "Try it first — only process the first 5", "type": "boolean", "description": "Turn this on to test your input on a small sample before running the full list. Turn it off to process everything.", "default": false }, "onlyFound": { "title": "Hide rows with no result", "type": "boolean", "description": "Only keep rows where something was actually found. Misses are always free, whether or not you show them here.", "default": false }, "includeKeywords": { "title": "Only keep rows containing", "type": "array", "description": "Optional. Only keep results that mention at least one of these words (e.g. a job title, a city, a product name). Leave empty to keep everything.", "items": { "type": "string" } }, "excludeKeywords": { "title": "Skip rows containing", "type": "array", "description": "Optional. Drop any result that mentions one of these words. Leave empty to skip nothing.", "items": { "type": "string" } }, "maxResults": { "title": "Stop after this many results", "minimum": 1, "type": "integer", "description": "Optional. Stop the run once this many results have been found — useful for a quick, cheap sample. Leave blank for no limit." }, "columns": { "title": "Which columns do you want?", "type": "array", "description": "Choose which pieces of information to include in each result row. All are included by default.", "items": { "type": "string", "enum": [ "displayName", "orcid", "givenName", "familyName", "biography", "country", "keywords", "currentEmployer", "employments", "worksCount" ], "enumTitles": [ "Name", "ORCID iD", "Given name", "Family name", "Biography", "Country", "Keywords", "Current employer", "Employment history (full)", "Works count" ] }, "default": [ "displayName", "orcid", "givenName", "familyName", "biography", "country", "keywords", "currentEmployer", "employments", "worksCount" ] }, "expandRows": { "title": "One row per employment record (instead of one row per ORCID iD)", "type": "boolean", "description": "When on, each employment record found gets its own row instead of being grouped under its ORCID iD. You're still only charged once per ORCID iD, no matter how many rows it produces.", "default": false }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Parallel requests. Keep conservative — this target has no browser fallback, so getting blocked costs more than slow-and-steady.", "default": 5 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy config. Residential recommended for anti-bot-sensitive targets.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }