{
  "openapi": "3.0.1",
  "info": {
    "title": "Crossref Scraper: DOI Metadata and Citations | $1/1K",
    "description": "$1 per 1,000 results, platform usage included. Scholarly works from the official Crossref API: DOI, title, authors, journal, publisher, citation count, funders, licence and retraction notices. Search by text, DOI, author or ISSN. No key.",
    "version": "0.1",
    "x-build-id": "Fv4Sh2d5z7gdBhL9y"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/one_dollar_store~crossref-doi-metadata/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-one_dollar_store-crossref-doi-metadata",
        "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/one_dollar_store~crossref-doi-metadata/runs": {
      "post": {
        "operationId": "runs-sync-one_dollar_store-crossref-doi-metadata",
        "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/one_dollar_store~crossref-doi-metadata/run-sync": {
      "post": {
        "operationId": "run-sync-one_dollar_store-crossref-doi-metadata",
        "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": {
          "searchTexts": {
            "title": "Search texts",
            "type": "array",
            "description": "Words to look for in titles, authors, journals and other metadata, one search per line, for example machine learning. Leave empty if you give DOIs, an author or ISSNs.",
            "items": {
              "type": "string"
            }
          },
          "searchIn": {
            "title": "Search in",
            "enum": [
              "title",
              "bibliographic",
              "journal",
              "everything"
            ],
            "type": "string",
            "description": "Where the search texts are looked for. Title searches the work title. Title, authors and year uses Crossref's bibliographic search, which suits citation look ups. Everything searches all metadata and is the loosest.",
            "default": "title"
          },
          "requireAllWords": {
            "title": "Every word must match",
            "type": "boolean",
            "description": "Crossref also returns works that contain only some of your words, and ranks them high. Leave this on to keep only works where every word of the search text (or author name) appears in the field you chose. The actor reads more pages to find them.",
            "default": true
          },
          "dois": {
            "title": "DOIs",
            "maxItems": 5000,
            "type": "array",
            "description": "Look up exact DOIs, for example 10.1038/nature14539. A link such as https://doi.org/10.1038/nature14539 also works. DOIs that Crossref does not hold are left out.",
            "items": {
              "type": "string"
            }
          },
          "author": {
            "title": "Author name",
            "type": "string",
            "description": "Only works with a matching author, for example Geoffrey Hinton. Combines with the search texts and filters below."
          },
          "issns": {
            "title": "Journal ISSNs",
            "maxItems": 100,
            "type": "array",
            "description": "Only works from these journals or series, for example 0028-0836. Either the print or the online ISSN works.",
            "items": {
              "type": "string"
            }
          },
          "workType": {
            "title": "Type of work",
            "enum": [
              "any",
              "journal-article",
              "proceedings-article",
              "book-chapter",
              "book",
              "monograph",
              "posted-content",
              "dissertation",
              "dataset",
              "report",
              "peer-review",
              "reference-entry",
              "standard"
            ],
            "type": "string",
            "description": "Only this kind of work.",
            "default": "any"
          },
          "publishedFrom": {
            "title": "Published from",
            "pattern": "^(\\d{4}(-\\d{2}(-\\d{2})?)?)?$",
            "maxLength": 10,
            "type": "string",
            "description": "Earliest publication date. Use a year (2020), a month (2020-06) or a day (2020-06-15)."
          },
          "publishedUntil": {
            "title": "Published until",
            "pattern": "^(\\d{4}(-\\d{2}(-\\d{2})?)?)?$",
            "maxLength": 10,
            "type": "string",
            "description": "Latest publication date, in the same formats. A year includes that whole year."
          },
          "sortBy": {
            "title": "Order of results",
            "enum": [
              "relevance",
              "newest",
              "oldest",
              "mostCited"
            ],
            "type": "string",
            "description": "Best match is Crossref's relevance order. The other choices sort all matches before the first rows are returned.",
            "default": "relevance"
          },
          "includeReferences": {
            "title": "Add cited DOIs",
            "type": "boolean",
            "description": "Adds the DOIs of the works each work cites, where the publisher deposited its reference list. Rows get longer.",
            "default": false
          },
          "maxItems": {
            "title": "Maximum results",
            "minimum": 10,
            "maximum": 10000,
            "type": "integer",
            "description": "The run stops after this many works in total. Minimum 10.",
            "default": 100
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}