{ "openapi": "3.0.1", "info": { "title": "Crossref Works & DOI Metadata", "description": "Crossref works and DOI metadata scraper for bibliographic enrichment. Export publication metadata as JSON; search modes also provide journal and funder records.", "version": "1.0", "x-build-id": "vUWNgOHtfO9gHACXA" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/grit-77~crossref-works/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-grit-77-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/grit-77~crossref-works/runs": { "post": { "operationId": "runs-sync-grit-77-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/grit-77~crossref-works/run-sync": { "post": { "operationId": "run-sync-grit-77-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": "Operation", "enum": [ "works", "doi", "journals", "funders" ], "type": "string", "description": "Choose the record type. Works can be scoped by journal ISSN or funder ID.", "default": "works" }, "query": { "title": "Search query", "type": "string", "description": "Keywords for works, journals or funders. Required for journal/funder search. For works, provide a query, filter, ISSN or funder ID." }, "dois": { "title": "DOI list", "type": "array", "description": "Used in DOI mode. Bare DOI, doi: prefix and doi.org URLs are accepted. Duplicate DOI values are removed; invalid entries become uncharged error rows.", "items": { "type": "string" } }, "issn": { "title": "Journal ISSN", "type": "string", "description": "Optional works scope, for example 0028-0836. Cannot be combined with funderId." }, "funderId": { "title": "Funder identifier", "type": "string", "description": "Optional works scope: numeric Crossref funder ID, 10.13039/ DOI or its doi.org URL. Cannot be combined with issn." }, "filter": { "title": "Crossref works filters", "type": "string", "description": "Works mode only. Comma-separated official filters, for example from-pub-date:2024-01-01,type:journal-article,has-license:true. Unsupported filters produce a source error row." }, "sort": { "title": "Works sort", "enum": [ "published", "relevance", "is-referenced-by-count", "references-count", "indexed", "updated" ], "type": "string", "description": "Sorting for works search. Relevance requires a search query. Not applied in other modes.", "default": "published" }, "order": { "title": "Works order", "enum": [ "desc", "asc" ], "type": "string", "description": "Ordering for works search. Not applied in other modes.", "default": "desc" }, "mailto": { "title": "Crossref polite-pool email", "type": "string", "description": "Optional real contact email that you monitor. Sent to Crossref in the mailto parameter and User-Agent to request polite-pool access. Never saved to result rows." }, "maxItems": { "title": "Maximum output rows", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Hard cap on total output rows, including error rows. DOI duplicates do not consume this cap.", "default": 100 }, "concurrency": { "title": "Maximum concurrent DOI tasks", "minimum": 1, "maximum": 3, "type": "integer", "description": "Up to three DOI tasks are scheduled at once. HTTP requests remain serial in both pools to respect Crossref concurrency limits.", "default": 1 }, "pageSize": { "title": "Search page size", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Records requested per page, additionally limited by remaining maxItems.", "default": 100 }, "includeReferences": { "title": "Include deposited reference details", "type": "boolean", "description": "Include references array for work records. referenceCount is included regardless. Full reference lists can make records large.", "default": false }, "requestTimeoutSecs": { "title": "Request timeout (seconds)", "minimum": 5, "maximum": 120, "type": "integer", "description": "Timeout per HTTP attempt.", "default": 30 }, "maxRetries": { "title": "Retries per request", "minimum": 0, "maximum": 5, "type": "integer", "description": "Retries after timeouts, rate limits and transient server errors, with backoff.", "default": 3 } } }, "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 } } } } } } } } } }