{
  "data": {
    "id": "N7bYgi4PEsoNePL68",
    "actId": "KRVXCtklGxsJ0N9lt",
    "userId": "NL4ThgItAwaoBlffQ",
    "startedAt": "2026-11-22T08:18:54.122Z",
    "finishedAt": "2026-11-22T08:18:58.844Z",
    "status": "SUCCEEDED",
    "meta": {
      "origin": "CLI"
    },
    "stats": {
      "durationMillis": 4604,
      "runTimeSecs": 4.604,
      "computeUnits": 0.0051155555555555555,
      "imageSizeBytes": 319225856
    },
    "options": {
      "useCache": true,
      "betaPackages": false,
      "memoryMbytes": 4096,
      "diskMbytes": 8192
    },
    "createdByOrganizationMemberUserId": "6GwdnIcc2aWR7LzCS",
    "exitCode": 0,
    "inputSchema": "{\n  \"title\": \"OpenAlex works, citations & open access\",\n  \"description\": \"Search OpenAlex's open scholarly index, pull works by ID / author / journal / institution, or walk citations in either direction. No cookies or login required. An optional free OpenAlex API key only unlocks cursor paging beyond 10,000 results.\",\n  \"type\": \"object\",\n  \"schemaVersion\": 1,\n  \"properties\": {\n    \"mode\": {\n      \"title\": \"What to fetch\",\n      \"type\": \"string\",\n      \"description\": \"Pick a search mode, a direct-lookup mode, or a citation direction.\",\n      \"editor\": \"select\",\n      \"enum\": [\n        \"searchWorks\",\n        \"getCitations\",\n        \"getReferences\",\n        \"getCitationGraph\",\n        \"searchAuthors\",\n        \"byWorkIds\",\n        \"byAuthorIds\",\n        \"byVenueIds\",\n        \"byInstitutionIds\"\n      ],\n      \"enumTitles\": [\n        \"Search works (keyword + filters)\",\n        \"Works that cite a paper (forward citations)\",\n        \"Works a paper cites (references / backward citations)\",\n        \"Both citation directions\",\n        \"Search authors\",\n        \"Fetch specific works by ID / DOI / PMID\",\n        \"Every work by an author ID / ORCID\",\n        \"Every work in a venue / journal ID / ISSN\",\n        \"Every work affiliated with an institution ID / ROR\"\n      ],\n      \"default\": \"searchWorks\",\n      \"prefill\": \"byWorkIds\"\n    },\n    \"searchQuery\": {\n      \"title\": \"Search query\",\n      \"type\": \"string\",\n      \"description\": \"Keyword, phrase, or OpenAlex Boolean query. Used by searchWorks and searchAuthors. In searchWorks it may be omitted when at least one filter is set (filter-only browsing).\",\n      \"editor\": \"textfield\",\n      \"default\": \"large language models\",\n      \"prefill\": \"large language models\"\n    },\n    \"searchField\": {\n      \"title\": \"Search in\",\n      \"type\": \"string\",\n      \"description\": \"Which text field the query searches. Title/abstract options are much cheaper and faster than full text.\",\n      \"editor\": \"select\",\n      \"enum\": [\n        \"default\",\n        \"title\",\n        \"titleAbstractKeywords\",\n        \"titleAndAbstract\",\n        \"abstract\",\n        \"fulltext\"\n      ],\n      \"enumTitles\": [\n        \"Everything OpenAlex searches (title, abstract, full text, keywords)\",\n        \"Title only\",\n        \"Title, abstract and keywords (OpenAlex website default)\",\n        \"Title and abstract only\",\n        \"Abstract only\",\n        \"Full text when available, plus title and abstract\"\n      ],\n      \"default\": \"default\",\n      \"prefill\": \"default\"\n    },\n    \"workIds\": {\n      \"title\": \"Work IDs / DOIs / PMIDs\",\n      \"type\": \"array\",\n      \"description\": \"Used by byWorkIds and as the citation seeds for getCitations / getReferences / getCitationGraph. Accepts OpenAlex W-IDs, DOI URLs, bare DOIs, PMIDs, PMCIDs and MAG IDs. Examples: W2741809807, https://doi.org/10.1145/3442188.3445922, pmid:25524000.\",\n      \"editor\": \"stringList\",\n      \"default\": [],\n      \"prefill\": [\n        \"W2741809807\"\n      ]\n    },\n    \"authorIds\": {\n      \"title\": \"Author IDs / ORCIDs\",\n      \"type\": \"array\",\n      \"description\": \"OpenAlex author IDs (A...) or ORCIDs, for byAuthorIds.\",\n      \"editor\": \"stringList\",\n      \"default\": [],\n      \"prefill\": []\n    },\n    \"venueIds\": {\n      \"title\": \"Venue / source IDs / ISSNs\",\n      \"type\": \"array\",\n      \"description\": \"OpenAlex source IDs (S..., journal / repository / conference) or ISSNs, for byVenueIds. Examples: S4306400194 (arXiv), S137773608 (Nature), 0028-0836.\",\n      \"editor\": \"stringList\",\n      \"default\": [],\n      \"prefill\": []\n    },\n    \"institutionIds\": {\n      \"title\": \"Institution IDs / ROR IDs\",\n      \"type\": \"array\",\n      \"description\": \"OpenAlex institution IDs (I...) or ROR URLs, for byInstitutionIds. Examples: I136199984 (Harvard), I32971472 (MIT), https://ror.org/042nb2s44.\",\n      \"editor\": \"stringList\",\n      \"default\": [],\n      \"prefill\": []\n    },\n    \"citationDirection\": {\n      \"title\": \"Citation direction (getCitationGraph)\",\n      \"type\": \"string\",\n      \"description\": \"Which side of the citation graph to walk when mode is getCitationGraph.\",\n      \"editor\": \"select\",\n      \"enum\": [\n        \"both\",\n        \"citations\",\n        \"references\"\n      ],\n      \"enumTitles\": [\n        \"Both directions\",\n        \"Forward: works that cite the seed\",\n        \"Backward: works the seed cites\"\n      ],\n      \"default\": \"both\",\n      \"prefill\": \"both\"\n    },\n    \"publicationYearMin\": {\n      \"title\": \"Publication year from\",\n      \"type\": \"integer\",\n      \"description\": \"Drop works published before this year. Sent to OpenAlex as a server-side filter.\",\n      \"minimum\": 1800,\n      \"maximum\": 2100\n    },\n    \"publicationYearMax\": {\n      \"title\": \"Publication year to\",\n      \"type\": \"integer\",\n      \"description\": \"Drop works published after this year. Sent to OpenAlex as a server-side filter.\",\n      \"minimum\": 1800,\n      \"maximum\": 2100\n    },\n    \"minCitedBy\": {\n      \"title\": \"Minimum citations\",\n      \"type\": \"integer\",\n      \"description\": \"Drop works cited fewer times than this. 0 means no minimum.\",\n      \"minimum\": 0,\n      \"maximum\": 1000000\n    },\n    \"openAccessOnly\": {\n      \"title\": \"Open access only\",\n      \"type\": \"boolean\",\n      \"description\": \"Only return works with a free, legal full-text copy.\",\n      \"default\": false,\n      \"prefill\": false\n    },\n    \"oaStatus\": {\n      \"title\": \"Open-access status\",\n      \"type\": \"string\",\n      \"description\": \"Filter by OpenAlex's OA colour. Any status other than 'any' also implies open access.\",\n      \"editor\": \"select\",\n      \"enum\": [\n        \"any\",\n        \"diamond\",\n        \"gold\",\n        \"green\",\n        \"hybrid\",\n        \"bronze\",\n        \"closed\"\n      ],\n      \"enumTitles\": [\n        \"Any\",\n        \"Diamond (free journal, no APC)\",\n        \"Gold (fully OA journal)\",\n        \"Green (free repository copy)\",\n        \"Hybrid (open license in a toll journal)\",\n        \"Bronze (free to read, no open license)\",\n        \"Closed\"\n      ],\n      \"default\": \"any\",\n      \"prefill\": \"any\"\n    },\n    \"hasFulltextOnly\": {\n      \"title\": \"Has searchable full text only\",\n      \"type\": \"boolean\",\n      \"description\": \"Only works where OpenAlex has machine-readable full text.\",\n      \"default\": false,\n      \"prefill\": false\n    },\n    \"workType\": {\n      \"title\": \"Work type\",\n      \"type\": \"string\",\n      \"description\": \"Optional OpenAlex work type filter.\",\n      \"editor\": \"select\",\n      \"enum\": [\n        \"any\",\n        \"article\",\n        \"book\",\n        \"book-chapter\",\n        \"book-review\",\n        \"conference-abstract\",\n        \"conference-paper\",\n        \"data-paper\",\n        \"dataset\",\n        \"dissertation\",\n        \"editorial\",\n        \"erratum\",\n        \"letter\",\n        \"other\",\n        \"paratext\",\n        \"peer-review\",\n        \"preprint\",\n        \"reference-entry\",\n        \"report\",\n        \"retraction\",\n        \"review\",\n        \"software\",\n        \"software-paper\",\n        \"standard\",\n        \"study-registration\",\n        \"supplementary-materials\"\n      ],\n      \"default\": \"any\",\n      \"prefill\": \"any\"\n    },\n    \"sortBy\": {\n      \"title\": \"Sort by\",\n      \"type\": \"string\",\n      \"description\": \"Ordering for works. Relevance requires a search query; filter-only modes fall back to most cited.\",\n      \"editor\": \"select\",\n      \"enum\": [\n        \"relevance_score:desc\",\n        \"cited_by_count:desc\",\n        \"cited_by_count:asc\",\n        \"publication_date:desc\",\n        \"publication_date:asc\",\n        \"publication_year:desc\",\n        \"publication_year:asc\",\n        \"fwci:desc\"\n      ],\n      \"enumTitles\": [\n        \"Relevance (default for keyword searches)\",\n        \"Most cited first\",\n        \"Least cited first\",\n        \"Newest publication date first\",\n        \"Oldest publication date first\",\n        \"Newest publication year first\",\n        \"Oldest publication year first\",\n        \"Highest field-weighted citation impact\"\n      ],\n      \"default\": \"relevance_score:desc\",\n      \"prefill\": \"relevance_score:desc\"\n    },\n    \"perPage\": {\n      \"title\": \"Results per API page\",\n      \"type\": \"integer\",\n      \"description\": \"How many records to request per page (1-100). Smaller pages keep the daily test cheap.\",\n      \"minimum\": 1,\n      \"maximum\": 100,\n      \"default\": 50,\n      \"prefill\": 3\n    },\n    \"startPage\": {\n      \"title\": \"Start page\",\n      \"type\": \"integer\",\n      \"description\": \"Resume page-based paging from this page (1-10000 combined with perPage must stay within 10,000 results).\",\n      \"minimum\": 1,\n      \"maximum\": 10000,\n      \"default\": 1,\n      \"prefill\": 1\n    },\n    \"useCursor\": {\n      \"title\": \"Use cursor paging\",\n      \"type\": \"boolean\",\n      \"description\": \"Follow OpenAlex next_cursor pages instead of page numbers. Needs the optional free API key; without it the actor uses page paging.\",\n      \"default\": false,\n      \"prefill\": false\n    },\n    \"startCursor\": {\n      \"title\": \"Start cursor\",\n      \"type\": \"string\",\n      \"description\": \"Optional saved OpenAlex cursor for a resumable cursor-paged run. Leave empty to start from the beginning.\",\n      \"editor\": \"textfield\",\n      \"default\": \"\",\n      \"prefill\": \"\"\n    },\n    \"customFilter\": {\n      \"title\": \"Raw OpenAlex filter\",\n      \"type\": \"string\",\n      \"description\": \"Advanced: an extra OpenAlex filter expression, e.g. language:en,is_retracted:false or topics.id:T10102. Combined with the filters above.\",\n      \"editor\": \"textfield\",\n      \"default\": \"\",\n      \"prefill\": \"\"\n    },\n    \"includeAbstract\": {\n      \"title\": \"Include abstract\",\n      \"type\": \"boolean\",\n      \"description\": \"Reconstruct readable abstract text from OpenAlex's inverted index. No extra API calls.\",\n      \"default\": true,\n      \"prefill\": true\n    },\n    \"includeAuthorships\": {\n      \"title\": \"Include full authorships\",\n      \"type\": \"boolean\",\n      \"description\": \"Include every author, their affiliations and corresponding-author flag.\",\n      \"default\": true,\n      \"prefill\": true\n    },\n    \"includeConcepts\": {\n      \"title\": \"Include legacy concepts\",\n      \"type\": \"boolean\",\n      \"description\": \"Include OpenAlex's deprecated concept tags (kept for backward compatibility). Prefer topics.\",\n      \"default\": true,\n      \"prefill\": true\n    },\n    \"includeTopics\": {\n      \"title\": \"Include topics, keywords and SDGs\",\n      \"type\": \"boolean\",\n      \"description\": \"Include the current OpenAlex topic hierarchy, keyword tags and UN Sustainable Development Goals.\",\n      \"default\": true,\n      \"prefill\": true\n    },\n    \"includeOpenAccessLocations\": {\n      \"title\": \"Include every open-access copy\",\n      \"type\": \"boolean\",\n      \"description\": \"Include all OA landing pages / PDFs, licenses and the OpenAlex full-text PDF and TEI links when available.\",\n      \"default\": true,\n      \"prefill\": true\n    },\n    \"includeCitationIds\": {\n      \"title\": \"Include citation ID lists\",\n      \"type\": \"boolean\",\n      \"description\": \"Include referencedWorks / relatedWorks ID arrays and the citedBy API URL. Off by default because long reference lists make records large.\",\n      \"default\": false,\n      \"prefill\": false\n    },\n    \"userAgentEmail\": {\n      \"title\": \"Contact email (polite pool)\",\n      \"type\": \"string\",\n      \"description\": \"Email sent in the User-Agent so OpenAlex can contact you about API usage. The default works; supply your own for high-volume runs.\",\n      \"editor\": \"textfield\",\n      \"default\": \"apify-actor@noreply.apify.com\",\n      \"prefill\": \"apify-actor@noreply.apify.com\"\n    },\n    \"apiKey\": {\n      \"title\": \"OpenAlex API key (optional)\",\n      \"type\": \"string\",\n      \"description\": \"Optional free key from openalex.org/settings/api. Only needed for cursor paging past 10,000 results or a larger daily request budget. Never required.\",\n      \"editor\": \"textfield\",\n      \"default\": \"\",\n      \"prefill\": \"\"\n    },\n    \"maxItems\": {\n      \"title\": \"Max records\",\n      \"type\": \"integer\",\n      \"description\": \"Hard cap on emitted records.\",\n      \"minimum\": 1,\n      \"maximum\": 10000,\n      \"default\": 50,\n      \"prefill\": 1\n    }\n  },\n  \"required\": [\n    \"mode\"\n  ]\n}",
    "readme": "# OpenAlex Citation & Open-Access Works Explorer\n\nOpenAlex is a free, open index of scholarly works, authors, institutions and venues. This actor searches it, pulls records by ID, walks citations in either direction, and returns the evidence around open access: every OA copy, its license, and the PDF/TEI links where OpenAlex has full text. No cookies, login or proxy.\n\n## Modes\n\n| Mode | What it returns |\n|---|---|\n| `searchWorks` | Works matching a keyword/Boolean query and/or server-side filters. A query is optional when at least one filter is set, so you can browse e.g. every 2024 open-access review. |\n| `getCitations` | Works that cite each seed work (forward citations). |\n| `getReferences` | Works each seed work cites (backward citations / references). |\n| `getCitationGraph` | Both directions for each seed, with a `citationContext` on every row. |\n| `searchAuthors` | Author profiles: ORCID, works/citation counts, h-index, affiliations, topics. |\n| `byWorkIds` | Fetch specific works by OpenAlex ID, DOI, PMID, PMCID or MAG ID. |\n| `byAuthorIds` | Every work by an author ID or ORCID. |\n| `byVenueIds` | Every work in a journal / repository / conference source ID or ISSN. |\n| `byInstitutionIds` | Every work with an author affiliated to an institution ID or ROR. |\n\n## What each work record contains\n\n- **Identifiers:** `openalexId`, `doi`, `pmid`, `pmcid`, `magId`, `openalexUrl`\n- **Bibliographic:** `title`, `publicationDate`, `publicationYear`, `type`, `language`, `biblio` (volume/issue/pages)\n- **Citations:** `citedByCount`, `referencedWorksCount`, `fwci`, `citationPercentile`, `citedByPercentileYear`, `countsByYear`\n- **Open access:** `isOa`, `openAccessStatus` (diamond/gold/green/hybrid/bronze/closed), `openAccessOaUrl`, `bestOaUrl`, `anyRepositoryHasFulltext`, `oaLocations[]` (every OA landing page/PDF with license, version and source), `contentUrls` (OpenAlex PDF and Grobid TEI when cached)\n- **Authors:** `authorships[]` with author ID, ORCID, position, corresponding flag, raw name, institution names, institution details and countries; scalar `primaryAuthor`\n- **Topics:** `primaryTopic`, `topics[]` (topic → subfield → field → domain), `keywords[]`, `sdgs[]`, plus legacy `concepts[]`\n- **Abstract:** reconstructed readable text from OpenAlex's inverted index\n- **Flags:** `isRetracted`, `isParatext`, `isPulled`, `isXpac`, `isTraditional`, `hasFulltext`, `hasContent`\n- **Cost data:** `apcPaid`, `apcList`\n- **Citation mode only:** `citationContext` (`seedWorkId`, `seedDoi`, `seedTitle`, `direction`)\n- **Meta:** `recordType`, `scrapedAt`\n\nOpt in to `referencedWorks` / `relatedWorks` ID arrays and `citedByApiUrl` with `includeCitationIds=true`.\n\nAuthor rows carry `openalexId`, `name`, `fullName`, `orcid`, `worksCount`, `citedByCount`, `summaryStats` (h-index, i10-index, 2-year mean citedness), `affiliations[]`, `lastKnownInstitutions`, `topics[]`, `nameAlternatives`, `worksApiUrl`, `recordType` and `scrapedAt`.\n\n## Inputs\n\n| Field | Default | Notes |\n|---|---|---|\n| `mode` | `searchWorks` | One of the nine modes above. |\n| `searchQuery` | `large language models` | Used by `searchWorks` / `searchAuthors`. OpenAlex Boolean syntax is supported. |\n| `searchField` | `default` | `title`, `titleAbstractKeywords`, `titleAndAbstract`, `abstract` or `fulltext` for cheaper scoped searches. |\n| `workIds` | – | Work IDs/DOIs/PMIDs for direct lookup **and** citation seeds. |\n| `authorIds` / `venueIds` / `institutionIds` | – | IDs, ORCIDs, ISSNs or RORs for the matching lookup modes. |\n| `citationDirection` | `both` | `citations`, `references` or `both` for `getCitationGraph`. |\n| `publicationYearMin` / `publicationYearMax` | – | Server-side publication-year range. |\n| `minCitedBy` | – | Server-side citation floor; `0` means no minimum. |\n| `openAccessOnly` | `false` | Server-side OA filter. |\n| `oaStatus` | `any` | `diamond`, `gold`, `green`, `hybrid`, `bronze` or `closed`. |\n| `hasFulltextOnly` | `false` | Only works with searchable full text. |\n| `workType` | `any` | Article, book, dataset, preprint, review, etc. |\n| `sortBy` | `relevance_score:desc` | Citation/date/year/FWCI sorts; filter-only modes fall back to most cited. |\n| `perPage` | `50` | 1–100 records per API page. |\n| `startPage` | `1` | Resume page paging. Page × perPage must stay within 10,000. |\n| `useCursor` | `false` | Optional cursor paging; needs the optional free API key. |\n| `startCursor` | — | Cursor value to resume a cursor-paged run. |\n| `customFilter` | – | Extra raw OpenAlex filter, e.g. `language:en,is_retracted:false`. |\n| `includeAbstract` / `includeAuthorships` / `includeConcepts` | `true` | Toggle those blocks. |\n| `includeTopics` | `true` | Current topics, keywords and SDGs. |\n| `includeOpenAccessLocations` | `true` | All OA copies plus full-text links. |\n| `includeCitationIds` | `false` | Referenced/related ID arrays and cited-by API URL. |\n| `userAgentEmail` | `apify-actor@noreply.apify.com` | Contact address for OpenAlex's polite pool. |\n| `apiKey` | empty | Optional free key from openalex.org/settings/api; never required. |\n| `maxItems` | `50` | Hard cap, 1–10,000. |\n\nLegacy saved-task keys are mapped in code, not kept in the input form: `query`/`searchTerm` → `searchQuery`, `ids`/`dois` → `workIds`, `authorId` → `authorIds`, `venueId` → `venueIds`, `institutionId` → `institutionIds`, `maxResults`/`limit` → `maxItems`, `fromYear`/`toYear` → publication-year bounds, `minCitations` → `minCitedBy`, `oaOnly`/`openAccess` → `openAccessOnly`, `type` → `workType`, `sort` → `sortBy`, `email`/`mailto` → `userAgentEmail`, `includeAbstracts` → `includeAbstract`. A legacy key wins when the new field still holds its schema default, so old tasks keep their saved limits and filters.\n\n## Examples\n\nTop-cited open-access 2024 articles:\n\n```json\n{\n  \"mode\": \"searchWorks\",\n  \"searchQuery\": \"large language models\",\n  \"publicationYearMin\": 2024,\n  \"minCitedBy\": 50,\n  \"openAccessOnly\": true,\n  \"workType\": \"article\",\n  \"sortBy\": \"cited_by_count:desc\",\n  \"maxItems\": 100\n}\n```\n\nForward citations of a paper:\n\n```json\n{\n  \"mode\": \"getCitations\",\n  \"workIds\": [\"W2741809807\"],\n  \"sortBy\": \"cited_by_count:desc\",\n  \"maxItems\": 50\n}\n```\n\nBoth directions with OA copies:\n\n```json\n{\n  \"mode\": \"getCitationGraph\",\n  \"workIds\": [\"https://doi.org/10.7717/peerj.4375\"],\n  \"citationDirection\": \"both\",\n  \"includeOpenAccessLocations\": true,\n  \"maxItems\": 100\n}\n```\n\nBrowse every 2024 open-access review without a keyword:\n\n```json\n{\n  \"mode\": \"searchWorks\",\n  \"publicationYearMin\": 2024,\n  \"publicationYearMax\": 2024,\n  \"openAccessOnly\": true,\n  \"workType\": \"review\",\n  \"maxItems\": 200\n}\n```\n\n## Pagination\n\nPage paging is the default and needs no key. `startPage` resumes a page-paged run; the first 10,000 results are reachable. Cursor paging (`useCursor=true`) follows OpenAlex `next_cursor` values beyond that and needs the optional free API key. `startCursor` resumes a cursor-paged run. The actor stops only on `maxItems`, source exhaustion, or the cursor/page limit — never on a wall-clock timer.\n\n## OpenAlex API budget\n\nOpenAlex is free but its anonymous list/search calls share a small daily budget per IP. Single-record lookups (the default prefill) are free. For heavy use, add a free API key from [openalex.org/settings/api](https://openalex.org/settings/api); it raises the daily budget and enables cursor paging. The actor treats the key as optional and never requires it.\n\n## FAQ\n\n**Do I need an API key?** No. Everything works without one. A free key only helps with very large runs and cursor paging.\n\n**Why is an abstract sometimes missing?** OpenAlex omits it when the publisher's license does not allow redistribution. The row still contains the work; only the `abstract` field is omitted.\n\n**Why does the citation count differ from Google Scholar?** OpenAlex matches reference lists to records in its index. Unmatched references are left out, so counts are usually lower than a publisher PDF's reference list.\n\n**What is `fwci`?** Field-Weighted Citation Impact: citations received divided by the field-year-type average. `1.0` is the world average.\n\n**Why are some OA fields missing?** OpenAlex only emits OA evidence when it has found a free copy. Closed works have `isOa=false` and no OA locations; fields are omitted rather than set to null.\n\n**Can I get the full text?** `contentUrls.pdf` and `contentUrls.grobidXml` point to OpenAlex's cached copies for works where `hasFulltext` is true; `oaLocations` lists publisher and repository copies.\n\n**Is this affiliated with OpenAlex?** No. It is an independent third-party actor that reads OpenAlex's public API. OpenAlex is run by OurResearch.\n",
    "actorDefinition": {
      "actorSpecification": 1,
      "name": "openalex-citation-and-open-access-works-explorer",
      "title": "OpenAlex Citation & Open-Access Works Explorer",
      "description": "Search OpenAlex's open catalog of scholarly works and authors, walk forward or backward citations, or pull every work tied to an author, journal/source or institution. Returns citation counts, every open-access copy with PDF/license, abstracts, authorships, topics and DOI/PMID links.",
      "version": "2.0",
      "buildTag": "latest",
      "dockerfile": "../Dockerfile",
      "readme": "# OpenAlex Citation & Open-Access Works Explorer\n\nOpenAlex is a free, open index of scholarly works, authors, institutions and venues. This actor searches it, pulls records by ID, walks citations in either direction, and returns the evidence around open access: every OA copy, its license, and the PDF/TEI links where OpenAlex has full text. No cookies, login or proxy.\n\n## Modes\n\n| Mode | What it returns |\n|---|---|\n| `searchWorks` | Works matching a keyword/Boolean query and/or server-side filters. A query is optional when at least one filter is set, so you can browse e.g. every 2024 open-access review. |\n| `getCitations` | Works that cite each seed work (forward citations). |\n| `getReferences` | Works each seed work cites (backward citations / references). |\n| `getCitationGraph` | Both directions for each seed, with a `citationContext` on every row. |\n| `searchAuthors` | Author profiles: ORCID, works/citation counts, h-index, affiliations, topics. |\n| `byWorkIds` | Fetch specific works by OpenAlex ID, DOI, PMID, PMCID or MAG ID. |\n| `byAuthorIds` | Every work by an author ID or ORCID. |\n| `byVenueIds` | Every work in a journal / repository / conference source ID or ISSN. |\n| `byInstitutionIds` | Every work with an author affiliated to an institution ID or ROR. |\n\n## What each work record contains\n\n- **Identifiers:** `openalexId`, `doi`, `pmid`, `pmcid`, `magId`, `openalexUrl`\n- **Bibliographic:** `title`, `publicationDate`, `publicationYear`, `type`, `language`, `biblio` (volume/issue/pages)\n- **Citations:** `citedByCount`, `referencedWorksCount`, `fwci`, `citationPercentile`, `citedByPercentileYear`, `countsByYear`\n- **Open access:** `isOa`, `openAccessStatus` (diamond/gold/green/hybrid/bronze/closed), `openAccessOaUrl`, `bestOaUrl`, `anyRepositoryHasFulltext`, `oaLocations[]` (every OA landing page/PDF with license, version and source), `contentUrls` (OpenAlex PDF and Grobid TEI when cached)\n- **Authors:** `authorships[]` with author ID, ORCID, position, corresponding flag, raw name, institution names, institution details and countries; scalar `primaryAuthor`\n- **Topics:** `primaryTopic`, `topics[]` (topic → subfield → field → domain), `keywords[]`, `sdgs[]`, plus legacy `concepts[]`\n- **Abstract:** reconstructed readable text from OpenAlex's inverted index\n- **Flags:** `isRetracted`, `isParatext`, `isPulled`, `isXpac`, `isTraditional`, `hasFulltext`, `hasContent`\n- **Cost data:** `apcPaid`, `apcList`\n- **Citation mode only:** `citationContext` (`seedWorkId`, `seedDoi`, `seedTitle`, `direction`)\n- **Meta:** `recordType`, `scrapedAt`\n\nOpt in to `referencedWorks` / `relatedWorks` ID arrays and `citedByApiUrl` with `includeCitationIds=true`.\n\nAuthor rows carry `openalexId`, `name`, `fullName`, `orcid`, `worksCount`, `citedByCount`, `summaryStats` (h-index, i10-index, 2-year mean citedness), `affiliations[]`, `lastKnownInstitutions`, `topics[]`, `nameAlternatives`, `worksApiUrl`, `recordType` and `scrapedAt`.\n\n## Inputs\n\n| Field | Default | Notes |\n|---|---|---|\n| `mode` | `searchWorks` | One of the nine modes above. |\n| `searchQuery` | `large language models` | Used by `searchWorks` / `searchAuthors`. OpenAlex Boolean syntax is supported. |\n| `searchField` | `default` | `title`, `titleAbstractKeywords`, `titleAndAbstract`, `abstract` or `fulltext` for cheaper scoped searches. |\n| `workIds` | – | Work IDs/DOIs/PMIDs for direct lookup **and** citation seeds. |\n| `authorIds` / `venueIds` / `institutionIds` | – | IDs, ORCIDs, ISSNs or RORs for the matching lookup modes. |\n| `citationDirection` | `both` | `citations`, `references` or `both` for `getCitationGraph`. |\n| `publicationYearMin` / `publicationYearMax` | – | Server-side publication-year range. |\n| `minCitedBy` | – | Server-side citation floor; `0` means no minimum. |\n| `openAccessOnly` | `false` | Server-side OA filter. |\n| `oaStatus` | `any` | `diamond`, `gold`, `green`, `hybrid`, `bronze` or `closed`. |\n| `hasFulltextOnly` | `false` | Only works with searchable full text. |\n| `workType` | `any` | Article, book, dataset, preprint, review, etc. |\n| `sortBy` | `relevance_score:desc` | Citation/date/year/FWCI sorts; filter-only modes fall back to most cited. |\n| `perPage` | `50` | 1–100 records per API page. |\n| `startPage` | `1` | Resume page paging. Page × perPage must stay within 10,000. |\n| `useCursor` | `false` | Optional cursor paging; needs the optional free API key. |\n| `startCursor` | — | Cursor value to resume a cursor-paged run. |\n| `customFilter` | – | Extra raw OpenAlex filter, e.g. `language:en,is_retracted:false`. |\n| `includeAbstract` / `includeAuthorships` / `includeConcepts` | `true` | Toggle those blocks. |\n| `includeTopics` | `true` | Current topics, keywords and SDGs. |\n| `includeOpenAccessLocations` | `true` | All OA copies plus full-text links. |\n| `includeCitationIds` | `false` | Referenced/related ID arrays and cited-by API URL. |\n| `userAgentEmail` | `apify-actor@noreply.apify.com` | Contact address for OpenAlex's polite pool. |\n| `apiKey` | empty | Optional free key from openalex.org/settings/api; never required. |\n| `maxItems` | `50` | Hard cap, 1–10,000. |\n\nLegacy saved-task keys are mapped in code, not kept in the input form: `query`/`searchTerm` → `searchQuery`, `ids`/`dois` → `workIds`, `authorId` → `authorIds`, `venueId` → `venueIds`, `institutionId` → `institutionIds`, `maxResults`/`limit` → `maxItems`, `fromYear`/`toYear` → publication-year bounds, `minCitations` → `minCitedBy`, `oaOnly`/`openAccess` → `openAccessOnly`, `type` → `workType`, `sort` → `sortBy`, `email`/`mailto` → `userAgentEmail`, `includeAbstracts` → `includeAbstract`. A legacy key wins when the new field still holds its schema default, so old tasks keep their saved limits and filters.\n\n## Examples\n\nTop-cited open-access 2024 articles:\n\n```json\n{\n  \"mode\": \"searchWorks\",\n  \"searchQuery\": \"large language models\",\n  \"publicationYearMin\": 2024,\n  \"minCitedBy\": 50,\n  \"openAccessOnly\": true,\n  \"workType\": \"article\",\n  \"sortBy\": \"cited_by_count:desc\",\n  \"maxItems\": 100\n}\n```\n\nForward citations of a paper:\n\n```json\n{\n  \"mode\": \"getCitations\",\n  \"workIds\": [\"W2741809807\"],\n  \"sortBy\": \"cited_by_count:desc\",\n  \"maxItems\": 50\n}\n```\n\nBoth directions with OA copies:\n\n```json\n{\n  \"mode\": \"getCitationGraph\",\n  \"workIds\": [\"https://doi.org/10.7717/peerj.4375\"],\n  \"citationDirection\": \"both\",\n  \"includeOpenAccessLocations\": true,\n  \"maxItems\": 100\n}\n```\n\nBrowse every 2024 open-access review without a keyword:\n\n```json\n{\n  \"mode\": \"searchWorks\",\n  \"publicationYearMin\": 2024,\n  \"publicationYearMax\": 2024,\n  \"openAccessOnly\": true,\n  \"workType\": \"review\",\n  \"maxItems\": 200\n}\n```\n\n## Pagination\n\nPage paging is the default and needs no key. `startPage` resumes a page-paged run; the first 10,000 results are reachable. Cursor paging (`useCursor=true`) follows OpenAlex `next_cursor` values beyond that and needs the optional free API key. `startCursor` resumes a cursor-paged run. The actor stops only on `maxItems`, source exhaustion, or the cursor/page limit — never on a wall-clock timer.\n\n## OpenAlex API budget\n\nOpenAlex is free but its anonymous list/search calls share a small daily budget per IP. Single-record lookups (the default prefill) are free. For heavy use, add a free API key from [openalex.org/settings/api](https://openalex.org/settings/api); it raises the daily budget and enables cursor paging. The actor treats the key as optional and never requires it.\n\n## FAQ\n\n**Do I need an API key?** No. Everything works without one. A free key only helps with very large runs and cursor paging.\n\n**Why is an abstract sometimes missing?** OpenAlex omits it when the publisher's license does not allow redistribution. The row still contains the work; only the `abstract` field is omitted.\n\n**Why does the citation count differ from Google Scholar?** OpenAlex matches reference lists to records in its index. Unmatched references are left out, so counts are usually lower than a publisher PDF's reference list.\n\n**What is `fwci`?** Field-Weighted Citation Impact: citations received divided by the field-year-type average. `1.0` is the world average.\n\n**Why are some OA fields missing?** OpenAlex only emits OA evidence when it has found a free copy. Closed works have `isOa=false` and no OA locations; fields are omitted rather than set to null.\n\n**Can I get the full text?** `contentUrls.pdf` and `contentUrls.grobidXml` point to OpenAlex's cached copies for works where `hasFulltext` is true; `oaLocations` lists publisher and repository copies.\n\n**Is this affiliated with OpenAlex?** No. It is an independent third-party actor that reads OpenAlex's public API. OpenAlex is run by OurResearch.\n",
      "input": {
        "title": "OpenAlex works, citations & open access",
        "description": "Search OpenAlex's open scholarly index, pull works by ID / author / journal / institution, or walk citations in either direction. No cookies or login required. An optional free OpenAlex API key only unlocks cursor paging beyond 10,000 results.",
        "type": "object",
        "schemaVersion": 1,
        "properties": {
          "mode": {
            "title": "What to fetch",
            "type": "string",
            "description": "Pick a search mode, a direct-lookup mode, or a citation direction.",
            "editor": "select",
            "enum": [
              "searchWorks",
              "getCitations",
              "getReferences",
              "getCitationGraph",
              "searchAuthors",
              "byWorkIds",
              "byAuthorIds",
              "byVenueIds",
              "byInstitutionIds"
            ],
            "enumTitles": [
              "Search works (keyword + filters)",
              "Works that cite a paper (forward citations)",
              "Works a paper cites (references / backward citations)",
              "Both citation directions",
              "Search authors",
              "Fetch specific works by ID / DOI / PMID",
              "Every work by an author ID / ORCID",
              "Every work in a venue / journal ID / ISSN",
              "Every work affiliated with an institution ID / ROR"
            ],
            "default": "searchWorks",
            "prefill": "byWorkIds"
          },
          "searchQuery": {
            "title": "Search query",
            "type": "string",
            "description": "Keyword, phrase, or OpenAlex Boolean query. Used by searchWorks and searchAuthors. In searchWorks it may be omitted when at least one filter is set (filter-only browsing).",
            "editor": "textfield",
            "default": "large language models",
            "prefill": "large language models"
          },
          "searchField": {
            "title": "Search in",
            "type": "string",
            "description": "Which text field the query searches. Title/abstract options are much cheaper and faster than full text.",
            "editor": "select",
            "enum": [
              "default",
              "title",
              "titleAbstractKeywords",
              "titleAndAbstract",
              "abstract",
              "fulltext"
            ],
            "enumTitles": [
              "Everything OpenAlex searches (title, abstract, full text, keywords)",
              "Title only",
              "Title, abstract and keywords (OpenAlex website default)",
              "Title and abstract only",
              "Abstract only",
              "Full text when available, plus title and abstract"
            ],
            "default": "default",
            "prefill": "default"
          },
          "workIds": {
            "title": "Work IDs / DOIs / PMIDs",
            "type": "array",
            "description": "Used by byWorkIds and as the citation seeds for getCitations / getReferences / getCitationGraph. Accepts OpenAlex W-IDs, DOI URLs, bare DOIs, PMIDs, PMCIDs and MAG IDs. Examples: W2741809807, https://doi.org/10.1145/3442188.3445922, pmid:25524000.",
            "editor": "stringList",
            "default": [],
            "prefill": [
              "W2741809807"
            ]
          },
          "authorIds": {
            "title": "Author IDs / ORCIDs",
            "type": "array",
            "description": "OpenAlex author IDs (A...) or ORCIDs, for byAuthorIds.",
            "editor": "stringList",
            "default": [],
            "prefill": []
          },
          "venueIds": {
            "title": "Venue / source IDs / ISSNs",
            "type": "array",
            "description": "OpenAlex source IDs (S..., journal / repository / conference) or ISSNs, for byVenueIds. Examples: S4306400194 (arXiv), S137773608 (Nature), 0028-0836.",
            "editor": "stringList",
            "default": [],
            "prefill": []
          },
          "institutionIds": {
            "title": "Institution IDs / ROR IDs",
            "type": "array",
            "description": "OpenAlex institution IDs (I...) or ROR URLs, for byInstitutionIds. Examples: I136199984 (Harvard), I32971472 (MIT), https://ror.org/042nb2s44.",
            "editor": "stringList",
            "default": [],
            "prefill": []
          },
          "citationDirection": {
            "title": "Citation direction (getCitationGraph)",
            "type": "string",
            "description": "Which side of the citation graph to walk when mode is getCitationGraph.",
            "editor": "select",
            "enum": [
              "both",
              "citations",
              "references"
            ],
            "enumTitles": [
              "Both directions",
              "Forward: works that cite the seed",
              "Backward: works the seed cites"
            ],
            "default": "both",
            "prefill": "both"
          },
          "publicationYearMin": {
            "title": "Publication year from",
            "type": "integer",
            "description": "Drop works published before this year. Sent to OpenAlex as a server-side filter.",
            "minimum": 1800,
            "maximum": 2100
          },
          "publicationYearMax": {
            "title": "Publication year to",
            "type": "integer",
            "description": "Drop works published after this year. Sent to OpenAlex as a server-side filter.",
            "minimum": 1800,
            "maximum": 2100
          },
          "minCitedBy": {
            "title": "Minimum citations",
            "type": "integer",
            "description": "Drop works cited fewer times than this. 0 means no minimum.",
            "minimum": 0,
            "maximum": 1000000
          },
          "openAccessOnly": {
            "title": "Open access only",
            "type": "boolean",
            "description": "Only return works with a free, legal full-text copy.",
            "default": false,
            "prefill": false
          },
          "oaStatus": {
            "title": "Open-access status",
            "type": "string",
            "description": "Filter by OpenAlex's OA colour. Any status other than 'any' also implies open access.",
            "editor": "select",
            "enum": [
              "any",
              "diamond",
              "gold",
              "green",
              "hybrid",
              "bronze",
              "closed"
            ],
            "enumTitles": [
              "Any",
              "Diamond (free journal, no APC)",
              "Gold (fully OA journal)",
              "Green (free repository copy)",
              "Hybrid (open license in a toll journal)",
              "Bronze (free to read, no open license)",
              "Closed"
            ],
            "default": "any",
            "prefill": "any"
          },
          "hasFulltextOnly": {
            "title": "Has searchable full text only",
            "type": "boolean",
            "description": "Only works where OpenAlex has machine-readable full text.",
            "default": false,
            "prefill": false
          },
          "workType": {
            "title": "Work type",
            "type": "string",
            "description": "Optional OpenAlex work type filter.",
            "editor": "select",
            "enum": [
              "any",
              "article",
              "book",
              "book-chapter",
              "book-review",
              "conference-abstract",
              "conference-paper",
              "data-paper",
              "dataset",
              "dissertation",
              "editorial",
              "erratum",
              "letter",
              "other",
              "paratext",
              "peer-review",
              "preprint",
              "reference-entry",
              "report",
              "retraction",
              "review",
              "software",
              "software-paper",
              "standard",
              "study-registration",
              "supplementary-materials"
            ],
            "default": "any",
            "prefill": "any"
          },
          "sortBy": {
            "title": "Sort by",
            "type": "string",
            "description": "Ordering for works. Relevance requires a search query; filter-only modes fall back to most cited.",
            "editor": "select",
            "enum": [
              "relevance_score:desc",
              "cited_by_count:desc",
              "cited_by_count:asc",
              "publication_date:desc",
              "publication_date:asc",
              "publication_year:desc",
              "publication_year:asc",
              "fwci:desc"
            ],
            "enumTitles": [
              "Relevance (default for keyword searches)",
              "Most cited first",
              "Least cited first",
              "Newest publication date first",
              "Oldest publication date first",
              "Newest publication year first",
              "Oldest publication year first",
              "Highest field-weighted citation impact"
            ],
            "default": "relevance_score:desc",
            "prefill": "relevance_score:desc"
          },
          "perPage": {
            "title": "Results per API page",
            "type": "integer",
            "description": "How many records to request per page (1-100). Smaller pages keep the daily test cheap.",
            "minimum": 1,
            "maximum": 100,
            "default": 50,
            "prefill": 3
          },
          "startPage": {
            "title": "Start page",
            "type": "integer",
            "description": "Resume page-based paging from this page (1-10000 combined with perPage must stay within 10,000 results).",
            "minimum": 1,
            "maximum": 10000,
            "default": 1,
            "prefill": 1
          },
          "useCursor": {
            "title": "Use cursor paging",
            "type": "boolean",
            "description": "Follow OpenAlex next_cursor pages instead of page numbers. Needs the optional free API key; without it the actor uses page paging.",
            "default": false,
            "prefill": false
          },
          "startCursor": {
            "title": "Start cursor",
            "type": "string",
            "description": "Optional saved OpenAlex cursor for a resumable cursor-paged run. Leave empty to start from the beginning.",
            "editor": "textfield",
            "default": "",
            "prefill": ""
          },
          "customFilter": {
            "title": "Raw OpenAlex filter",
            "type": "string",
            "description": "Advanced: an extra OpenAlex filter expression, e.g. language:en,is_retracted:false or topics.id:T10102. Combined with the filters above.",
            "editor": "textfield",
            "default": "",
            "prefill": ""
          },
          "includeAbstract": {
            "title": "Include abstract",
            "type": "boolean",
            "description": "Reconstruct readable abstract text from OpenAlex's inverted index. No extra API calls.",
            "default": true,
            "prefill": true
          },
          "includeAuthorships": {
            "title": "Include full authorships",
            "type": "boolean",
            "description": "Include every author, their affiliations and corresponding-author flag.",
            "default": true,
            "prefill": true
          },
          "includeConcepts": {
            "title": "Include legacy concepts",
            "type": "boolean",
            "description": "Include OpenAlex's deprecated concept tags (kept for backward compatibility). Prefer topics.",
            "default": true,
            "prefill": true
          },
          "includeTopics": {
            "title": "Include topics, keywords and SDGs",
            "type": "boolean",
            "description": "Include the current OpenAlex topic hierarchy, keyword tags and UN Sustainable Development Goals.",
            "default": true,
            "prefill": true
          },
          "includeOpenAccessLocations": {
            "title": "Include every open-access copy",
            "type": "boolean",
            "description": "Include all OA landing pages / PDFs, licenses and the OpenAlex full-text PDF and TEI links when available.",
            "default": true,
            "prefill": true
          },
          "includeCitationIds": {
            "title": "Include citation ID lists",
            "type": "boolean",
            "description": "Include referencedWorks / relatedWorks ID arrays and the citedBy API URL. Off by default because long reference lists make records large.",
            "default": false,
            "prefill": false
          },
          "userAgentEmail": {
            "title": "Contact email (polite pool)",
            "type": "string",
            "description": "Email sent in the User-Agent so OpenAlex can contact you about API usage. The default works; supply your own for high-volume runs.",
            "editor": "textfield",
            "default": "apify-actor@noreply.apify.com",
            "prefill": "apify-actor@noreply.apify.com"
          },
          "apiKey": {
            "title": "OpenAlex API key (optional)",
            "type": "string",
            "description": "Optional free key from openalex.org/settings/api. Only needed for cursor paging past 10,000 results or a larger daily request budget. Never required.",
            "editor": "textfield",
            "default": "",
            "prefill": ""
          },
          "maxItems": {
            "title": "Max records",
            "type": "integer",
            "description": "Hard cap on emitted records.",
            "minimum": 1,
            "maximum": 10000,
            "default": 50,
            "prefill": 1
          }
        },
        "required": [
          "mode"
        ]
      },
      "output": {
        "actorOutputSchemaVersion": 1,
        "title": "OpenAlex Citation & Open-Access Works Explorer Output",
        "description": "Works and author profiles from OpenAlex, including citation counts and direction, every open-access copy with PDF/license, reconstructed abstracts, authorships, venues, topics, keywords and universal identifiers.",
        "properties": {
          "works": {
            "type": "string",
            "title": "OpenAlex records",
            "description": "Dataset containing scraped works (search, lookup, author/venue/institution and citation modes) and author profiles (searchAuthors).",
            "template": "{{links.apiDefaultDatasetUrl}}/items"
          }
        }
      },
      "storages": {
        "dataset": {
          "actorSpecification": 1,
          "views": {
            "overview": {
              "title": "Scholarly works",
              "transformation": {
                "fields": [
                  "title",
                  "publicationYear",
                  "citedByCount",
                  "doi",
                  "openAccessStatus",
                  "openAccessOaUrl",
                  "bestOaUrl",
                  "primaryAuthor",
                  "venue",
                  "primaryTopic"
                ]
              },
              "display": {
                "component": "table",
                "properties": {}
              }
            }
          }
        }
      },
      "environmentVariables": {}
    },
    "buildNumber": "2.0.1",
    "imageDigest": "aee1d2b8434d1153a87150eb6009499203721be1f46513a59d7271ca34969e32",
    "actVersion": {
      "sourceType": "SOURCE_FILES",
      "buildTag": "latest",
      "versionNumber": "2.0"
    },
    "usage": {
      "ACTOR_COMPUTE_UNITS": 0.0051155555555555555
    }
  }
}