{
  "openapi": "3.0.1",
  "info": {
    "title": "Google Scholar Scraper - Papers, Citations, Authors API",
    "description": "Google Scholar papers by keyword with year range, language, sort by date and patents; cited-by lists, all versions, author profiles with h-index, citations per year, co-authors and publications, and citation formats (APA, MLA, BibTeX). $0.33 per 1,000 papers.",
    "version": "0.1",
    "x-build-id": "tVGELdBF5OoOr0d3U"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/topapi~google-scholar-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-topapi-google-scholar-scraper",
        "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/topapi~google-scholar-scraper/runs": {
      "post": {
        "operationId": "runs-sync-topapi-google-scholar-scraper",
        "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/topapi~google-scholar-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-topapi-google-scholar-scraper",
        "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": {
          "queries": {
            "title": "Search words",
            "type": "array",
            "description": "One Google Scholar search per line. Scholar's own operators work: author:\"hinton\", source:nature, \"exact phrase\", intitle:review.",
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "Google Scholar links",
            "type": "array",
            "description": "Scholar search links (scholar.google.com/scholar?...), \"Cited by\" or \"All versions\" links, or author profile links (scholar.google.com/citations?user=...). Every filter in the link is kept.",
            "items": {
              "type": "string"
            }
          },
          "citedByIds": {
            "title": "Cited by: paper IDs",
            "type": "array",
            "description": "The papers that cite a paper. Give the number from its \"Cited by\" link (cites=...), or the citesId field of a paper row.",
            "items": {
              "type": "string"
            }
          },
          "clusterIds": {
            "title": "All versions: paper IDs",
            "type": "array",
            "description": "Every version Scholar holds of a paper. Give the number from its \"All versions\" link (cluster=...), or the clusterId field of a paper row.",
            "items": {
              "type": "string"
            }
          },
          "relatedTo": {
            "title": "Related articles: result IDs",
            "type": "array",
            "description": "Scholar's \"Related articles\" for a paper. Give the 12-character resultId of a paper row.",
            "items": {
              "type": "string"
            }
          },
          "authorIds": {
            "title": "Author profiles: IDs or links",
            "type": "array",
            "description": "Google Scholar author IDs (the user= value of a profile link, e.g. JicYPdAAAAAJ) or full profile links. One row per author with metrics, citations per year, co-authors and publications.",
            "items": {
              "type": "string"
            }
          },
          "citationFormatsFor": {
            "title": "Citation formats: result IDs",
            "type": "array",
            "description": "Just the citation formats (MLA, APA, Chicago, Harvard, Vancouver and BibTeX/EndNote/RefMan/RefWorks links) for these 12-character resultIds. One row per ID.",
            "items": {
              "type": "string"
            }
          },
          "maxResults": {
            "title": "Maximum papers per search",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "Papers to deliver for each search, cited-by list or versions list. Scholar shows at most 1,000 per search (10 per page).",
            "default": 100
          },
          "yearFrom": {
            "title": "From year",
            "minimum": 1500,
            "maximum": 2100,
            "type": "integer",
            "description": "Only papers published in this year or later (Scholar's own as_ylo filter)."
          },
          "yearTo": {
            "title": "To year",
            "minimum": 1500,
            "maximum": 2100,
            "type": "integer",
            "description": "Only papers published in this year or earlier (as_yhi)."
          },
          "sortBy": {
            "title": "Sort by",
            "enum": [
              "relevance",
              "date",
              "dateAll"
            ],
            "type": "string",
            "description": "Relevance (Scholar's default), Date (Scholar's \"Sort by date\": articles added in the last year, newest first) or Date, everything (all results by date).",
            "default": "relevance"
          },
          "includePatents": {
            "title": "Include patents",
            "type": "boolean",
            "description": "Add patents to the results (Scholar's \"include patents\").",
            "default": false
          },
          "includeCitations": {
            "title": "Include citations",
            "type": "boolean",
            "description": "Keep Scholar's [CITATION] entries (works Scholar knows only from references). Off = as_vis=1.",
            "default": true
          },
          "language": {
            "title": "Interface language",
            "type": "string",
            "description": "Scholar's interface language code (hl), e.g. en, de, es, fr, pt-BR, zh-CN.",
            "default": "en"
          },
          "languageRestrict": {
            "title": "Only papers in these languages",
            "type": "string",
            "description": "Scholar's lr filter, e.g. lang_en, or lang_de|lang_fr for several."
          },
          "reviewArticlesOnly": {
            "title": "Review articles only",
            "type": "boolean",
            "description": "Scholar's \"Review articles\" filter (as_rr=1).",
            "default": false
          },
          "similarResultsFilter": {
            "title": "Hide similar results",
            "type": "boolean",
            "description": "Scholar's default filter that folds similar and omitted results. Off = filter=0.",
            "default": true
          },
          "minCitationCount": {
            "title": "Minimum citations",
            "minimum": 0,
            "type": "integer",
            "description": "Deliver and charge only papers cited at least this many times. Reads at most 3 extra pages per search to fill the count."
          },
          "includeCitationFormats": {
            "title": "Add citation formats (paid add-on)",
            "type": "boolean",
            "description": "Adds MLA, APA, Chicago, Harvard and Vancouver text plus BibTeX, EndNote, RefMan and RefWorks links to every paper row (one citation-formats event per row that gets them).",
            "default": false
          },
          "authorProfilesFromResults": {
            "title": "Add author profiles found in the results",
            "type": "boolean",
            "description": "For each search, also deliver the full profile (author-profile row) of authors linked in the results and of Scholar's \"User profiles for\" box, up to the maximum below.",
            "default": false
          },
          "maxAuthorProfiles": {
            "title": "Maximum author profiles per search",
            "minimum": 1,
            "maximum": 200,
            "type": "integer",
            "description": "Used with the option above.",
            "default": 10
          },
          "maxPublications": {
            "title": "Publications per author",
            "minimum": 0,
            "maximum": 2000,
            "type": "integer",
            "description": "Publications listed in each author row (0 = metrics only). Profiles hold up to thousands; 100 are read per page.",
            "default": 20
          },
          "publicationSort": {
            "title": "Publications order",
            "enum": [
              "citations",
              "pubdate",
              "title"
            ],
            "type": "string",
            "description": "The order the profile lists publications in, which decides which ones are collected.",
            "default": "citations"
          },
          "includeCoauthors": {
            "title": "Include co-authors",
            "type": "boolean",
            "description": "The co-authors shown on the profile (name, ID, affiliation, email domain). No extra request.",
            "default": true
          },
          "monitorMode": {
            "title": "Monitor: only new items",
            "type": "boolean",
            "description": "Deliver only papers not delivered by an earlier run with the same monitor name, and author rows whose citation count changed. Pair it with Sort by date for new-paper alerts.",
            "default": false
          },
          "monitorName": {
            "title": "Monitor name",
            "type": "string",
            "description": "Runs with the same name share one memory (kept in a dataset named google-scholar-scraper-monitor-<name> in your account)."
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Leave empty: the actor uses its own Apify datacenter connection. Set only to route requests through your own proxies."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}