{
  "openapi": "3.0.1",
  "info": {
    "title": "ORCID Researcher Profile Search",
    "description": "Search and extract detailed researcher profiles from ORCID -- the global digital identifier system used by over 18 million academic and scientific researchers worldwide. Find researchers by name, institutional affiliation, research keyword, or advanced Lucene query.",
    "version": "2.0",
    "x-build-id": "oOMGr8KY76FGtiNOG"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/ryanclinton~orcid-researcher-search/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-ryanclinton-orcid-researcher-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/ryanclinton~orcid-researcher-search/runs": {
      "post": {
        "operationId": "runs-sync-ryanclinton-orcid-researcher-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/ryanclinton~orcid-researcher-search/run-sync": {
      "post": {
        "operationId": "run-sync-ryanclinton-orcid-researcher-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": {
          "mode": {
            "title": "Mode",
            "enum": [
              "auto",
              "search",
              "lookup",
              "institutionMap",
              "institutionComparison",
              "expertDiscovery",
              "reviewerDiscovery",
              "collaboratorDiscovery",
              "fieldRadar",
              "talentMovement"
            ],
            "type": "string",
            "description": "What the run does. 'auto' (default) infers from your input. 'search' = name/keyword/affiliation discovery. 'lookup' = resolve specific ORCID iDs. 'institutionMap' = map one organization. 'institutionComparison' = compare several institutions. 'expertDiscovery' / 'reviewerDiscovery' / 'collaboratorDiscovery' = rank a field's researchers for a purpose (proxy from ORCID profile signals, not citation impact). 'fieldRadar' = track a research field's researcher population over scheduled runs. 'talentMovement' = track who joined/left an institution over scheduled runs.",
            "default": "auto"
          },
          "query": {
            "title": "Search Query",
            "type": "string",
            "description": "Free-text search query. Use Lucene syntax for advanced searches (e.g., 'family-name:Einstein AND affiliation-org-name:Princeton'). If provided, overrides individual filters below.",
            "default": "machine learning"
          },
          "familyName": {
            "title": "Family Name (Last Name)",
            "type": "string",
            "description": "Filter by researcher's last name.",
            "default": ""
          },
          "givenNames": {
            "title": "Given Names (First Name)",
            "type": "string",
            "description": "Filter by researcher's first name.",
            "default": ""
          },
          "affiliation": {
            "title": "Affiliation",
            "type": "string",
            "description": "Filter by organization affiliation (e.g., 'MIT', 'Harvard University').",
            "default": ""
          },
          "keyword": {
            "title": "Research Keyword",
            "type": "string",
            "description": "Filter by research keyword (e.g., 'machine learning', 'genomics').",
            "default": ""
          },
          "institution": {
            "title": "Institution (map / talent-movement mode)",
            "type": "string",
            "description": "Map one organization's ORCID footprint. Returns every matching researcher plus an institution-map summary record (departments, top keywords, career-stage distribution, active researchers, external-ID coverage, top funders) aggregated over the researchers analyzed this run. With mode=talentMovement + a watchlist, also tracks who joined/left over scheduled runs.",
            "default": ""
          },
          "institutions": {
            "title": "Institutions (comparison mode)",
            "maxItems": 6,
            "type": "array",
            "description": "Compare several organizations side by side (e.g. ['MIT', 'Stanford', 'Oxford']). Emits an institution-comparison record with per-institution researcher counts, active researchers, average completeness, external-ID coverage, career-stage mix and top keywords/funders. Up to 6 institutions per run.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "seedOrcidId": {
            "title": "Seed ORCID iD (collaborator discovery)",
            "type": "string",
            "description": "For mode=collaboratorDiscovery: rank the searched pool by similarity to this researcher (shared keywords, affiliations, external-ID systems, career stage).",
            "default": ""
          },
          "conflictAffiliations": {
            "title": "Conflict affiliations (reviewer discovery)",
            "maxItems": 50,
            "type": "array",
            "description": "For mode=reviewerDiscovery: organizations to flag as a conflict of interest. A candidate affiliated with any of these is marked conflictRisk=high. Without this, conflictRisk is 'unknown' (the actor cannot infer a conflict it has no target to check against).",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "orcidIds": {
            "title": "ORCID iDs (direct lookup)",
            "maxItems": 100,
            "type": "array",
            "description": "Look up specific researchers directly by ORCID iD (e.g. '0000-0002-1825-0097'), skipping search. When set, this takes priority over the search filters. Best when you already have the iDs and want full profiles.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "names": {
            "title": "Names (batch search)",
            "maxItems": 50,
            "type": "array",
            "description": "Search several researchers by name in one run (e.g. ['Geoffrey Hinton', 'Yann LeCun']). Each name is searched separately and the results are merged and deduplicated.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "dedupe": {
            "title": "Deduplicate by ORCID iD",
            "type": "boolean",
            "description": "Remove duplicate researchers when the same ORCID iD is matched by more than one name or filter. On by default.",
            "default": true
          },
          "includeSimilarity": {
            "title": "Compute researcher similarity",
            "type": "boolean",
            "description": "When on (and the run returns 2+ researchers), emit a similarity record linking each researcher to the most similar others in this run's results, scored on shared keywords, affiliations, external-ID systems and career stage. Computed over this run's cohort, not all of ORCID. Useful for expert / collaborator / reviewer discovery.",
            "default": false
          },
          "includeGraph": {
            "title": "Build researcher relationship graph",
            "type": "boolean",
            "description": "When on (and the run returns 2+ researchers), emit a graph record (nodes + weighted edges) of relationships between the researchers in this run's results, inferred from shared affiliations, keywords, external-ID systems and career stage. Neo4j / Cytoscape ready. Cohort-scoped, not all of ORCID.",
            "default": false
          },
          "fetchWorks": {
            "title": "Fetch Publications",
            "type": "boolean",
            "description": "If enabled, fetches the list of publications for each researcher. This makes additional API calls per result.",
            "default": false
          },
          "maxResults": {
            "title": "Max Results",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "Maximum number of researcher profiles to return (1-100).",
            "default": 25
          },
          "outputProfile": {
            "title": "Output Detail",
            "enum": [
              "minimal",
              "standard",
              "full",
              "flatCsv"
            ],
            "type": "string",
            "description": "How much per-researcher detail to return. 'minimal' = identity confidence + completeness + recommended action + badges + a one-line summary (best for disambiguation and agent routing). 'standard' = adds career, activity, affiliations, record sections, identity links, works quality and data gaps. 'full' = everything including the publications list and the scoring component breakdowns. 'flatCsv' = one flat row per researcher (no nested objects), best for Excel / Google Sheets export.",
            "default": "standard"
          },
          "watchlistName": {
            "title": "Watchlist Name (monitoring)",
            "type": "string",
            "description": "Optional. Set a name to monitor these researchers over time. The actor stores a snapshot per ORCID iD under this watchlist and, on the next run with the same name, flags each profile NEW / UPDATED / UNCHANGED with the change in works count and affiliations. Leave blank for a one-off search. The first run with a new name is a baseline (every profile is NEW).",
            "default": ""
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}