{
"openapi": "3.0.1",
"info": {
"title": "Crossref Works: Scholarly Metadata, DOIs and Retractions",
"description": "Scholarly article metadata from Crossref: DOI, title, authors with ORCID and ROR, journal, ISSN, publisher, dates, citation counts, funders, licences, full-text links. Filter by query, ISSN, member, type, date; daily new-works and retraction feeds. $1 per 1,000 works.",
"version": "0.1",
"x-build-id": "8NqdsAPWzBFSVuXmj"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/cprussin~crossref-works/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-cprussin-crossref-works",
"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/cprussin~crossref-works/runs": {
"post": {
"operationId": "runs-sync-cprussin-crossref-works",
"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/cprussin~crossref-works/run-sync": {
"post": {
"operationId": "run-sync-cprussin-crossref-works",
"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": [
"search",
"newSince",
"retractions"
],
"type": "string",
"description": "Search: works matching the query and filters. New since last run: works registered (created) on each full UTC day since this actor's previous run with the same filters (yesterday on the first run). Retractions: retraction notices (update-type:retraction), tracked since the last run like New, or for a date range.",
"default": "search"
},
"query": {
"title": "Search text",
"type": "string",
"description": "Free text matched against titles, authors, journals and other metadata, e.g. large language models. Results are sorted by relevance unless you set Sort."
},
"queryAuthor": {
"title": "Author name",
"type": "string",
"description": "Author name to match, e.g. Jennifer Doudna."
},
"publisherName": {
"title": "Publisher name",
"type": "string",
"description": "Publisher name to match, e.g. Elsevier. For an exact publisher use Member IDs."
},
"issns": {
"title": "Journal ISSNs",
"type": "array",
"description": "Print or electronic ISSNs, e.g. 1476-4687 (Nature). Works in any listed journal match.",
"items": {
"type": "string"
}
},
"memberIds": {
"title": "Crossref member IDs",
"type": "array",
"description": "Publisher member IDs, e.g. 78 (Elsevier), 297 (Springer Nature), 311 (Wiley), 1968 (MDPI). Find one at api.crossref.org/members?query=name.",
"items": {
"type": "string"
}
},
"types": {
"title": "Work types",
"type": "array",
"description": "Crossref work types. Leave empty for all.",
"items": {
"type": "string",
"enum": [
"journal-article",
"book-chapter",
"proceedings-article",
"posted-content",
"dataset",
"book",
"monograph",
"edited-book",
"reference-entry",
"report",
"dissertation",
"peer-review",
"component",
"standard",
"journal-issue",
"other"
],
"enumTitles": [
"Journal article",
"Book chapter",
"Conference paper",
"Preprint / posted content",
"Dataset",
"Book",
"Monograph",
"Edited book",
"Reference entry",
"Report",
"Dissertation",
"Peer review",
"Component",
"Standard",
"Journal issue",
"Other"
]
}
},
"funderIds": {
"title": "Funder IDs",
"type": "array",
"description": "Open Funder Registry IDs, e.g. 100000001 (NSF) or 10.13039/501100000780 (European Commission).",
"items": {
"type": "string"
}
},
"fromDate": {
"title": "From date",
"pattern": "^(\\d{4}(-\\d{2}(-\\d{2})?)?)?$",
"type": "string",
"description": "First date (inclusive) of the Date field: YYYY-MM-DD, YYYY-MM or YYYY. In New and Retractions modes, setting it turns off since-last-run tracking."
},
"untilDate": {
"title": "Until date",
"pattern": "^(\\d{4}(-\\d{2}(-\\d{2})?)?)?$",
"type": "string",
"description": "Last date (inclusive) of the Date field. Same formats."
},
"dateField": {
"title": "Date field",
"enum": [
"published",
"created",
"deposited",
"indexed"
],
"type": "string",
"description": "Which date the range applies to. Default: published (Search) or created, i.e. DOI registered (New, Retractions). Deposited/indexed also catch re-deposited older works."
},
"sort": {
"title": "Sort",
"enum": [
"relevance",
"published",
"created",
"deposited",
"indexed",
"is-referenced-by-count",
"references-count"
],
"type": "string",
"description": "Sort order. Default: relevance with search text, otherwise Crossref's order."
},
"order": {
"title": "Order",
"enum": [
"desc",
"asc"
],
"type": "string",
"description": "Sort direction.",
"default": "desc"
},
"maxItems": {
"title": "Max works",
"minimum": 1,
"maximum": 100000,
"type": "integer",
"description": "Stop after this many works. Each work is billed once. In tracked modes the next run only moves on when every work was output.",
"default": 100
},
"contactEmail": {
"title": "Your contact email (optional)",
"type": "string",
"description": "Crossref asks API users to identify themselves; with an email the requests are sent with mailto= and use Crossref's faster polite pool. Sent only to Crossref."
}
}
},
"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
},
"PROXY_UNBLOCKER_UNITS": {
"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
},
"PROXY_UNBLOCKER_UNITS": {
"type": "integer",
"example": 0
}
}
}
}
}
}
}
}
}
}