{
  "openapi": "3.0.1",
  "info": {
    "title": "Google Scholar | Research Papers, Citations & Author Profiles",
    "description": "Scrape Google Scholar at scale. Search research papers, get citation formats (MLA, APA, Chicago, BibTeX), author profiles with h-index and i10-index, list an author's publications, view per-article citation history, & map co-author networks. Six modes in one for lit reviews, bibliometrics, & agents.",
    "version": "0.0",
    "x-build-id": "auNg9Oc28a2Q14wIU"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/johnvc~google-scholar-api/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-johnvc-google-scholar-api",
        "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/johnvc~google-scholar-api/runs": {
      "post": {
        "operationId": "runs-sync-johnvc-google-scholar-api",
        "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/johnvc~google-scholar-api/run-sync": {
      "post": {
        "operationId": "run-sync-johnvc-google-scholar-api",
        "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",
        "required": [
          "mode"
        ],
        "properties": {
          "mode": {
            "title": "Mode",
            "enum": [
              "search",
              "cite",
              "author_profile",
              "author_articles",
              "author_citation",
              "author_co_authors"
            ],
            "type": "string",
            "description": "Which Google Scholar operation to run. Each mode uses different required fields. Defaults to 'search'.",
            "default": "search"
          },
          "q": {
            "title": "Search Query",
            "minLength": 1,
            "type": "string",
            "description": "Free-text query for mode=search. Supports advanced operators like author:smith or source:nature. Required for mode=search unless 'cites' or 'cluster' is provided."
          },
          "cites": {
            "title": "Cites (article ID)",
            "type": "string",
            "description": "For mode=search only. Article identifier used to look up papers that cite this article. Combine with 'q' to search within citing papers. Mutually exclusive with 'cluster'."
          },
          "cluster": {
            "title": "Cluster (article ID)",
            "type": "string",
            "description": "For mode=search only. Article cluster identifier used to fetch all versions of a paper. Mutually exclusive with 'q' and 'cites'."
          },
          "result_id": {
            "title": "Result ID",
            "type": "string",
            "description": "For mode=cite only. The result_id (cluster id) of the Google Scholar paper to fetch citation formats for. Obtain from an organic_results entry of mode=search."
          },
          "author_id": {
            "title": "Author ID",
            "type": "string",
            "description": "For mode=author_profile, author_articles, author_citation, and author_co_authors. The Google Scholar author identifier (e.g., 'LSsXyncAAAAJ'). Obtain from a publication_info.authors entry of mode=search or from a Google Scholar profile URL."
          },
          "citation_id": {
            "title": "Citation ID",
            "type": "string",
            "description": "For mode=author_citation only. The citation_id of the specific article in the author's profile (obtain from articles[].citation_id of mode=author_articles)."
          },
          "hl": {
            "title": "UI Language",
            "enum": [
              "en",
              "es",
              "fr",
              "de",
              "it",
              "pt",
              "ja",
              "ko",
              "zh-CN",
              "zh-TW",
              "ru",
              "ar",
              "hi",
              "tr",
              "pl",
              "nl",
              "sv",
              "fi",
              "da",
              "no",
              "cs",
              "el",
              "he",
              "id",
              "ms",
              "ro",
              "th",
              "uk",
              "vi"
            ],
            "type": "string",
            "description": "Language for the user interface and result display. Applies to all modes. Optional.",
            "default": "en"
          },
          "lr": {
            "title": "Language Restriction",
            "type": "string",
            "description": "For mode=search only. Restrict results to specific languages. Use 'lang_xx' codes separated by '|', e.g. 'lang_en' or 'lang_en|lang_fr'."
          },
          "as_ylo": {
            "title": "Min Publication Year",
            "minimum": 1900,
            "maximum": 2100,
            "type": "integer",
            "description": "For mode=search only. Earliest publication year to include (e.g., 2010)."
          },
          "as_yhi": {
            "title": "Max Publication Year",
            "minimum": 1900,
            "maximum": 2100,
            "type": "integer",
            "description": "For mode=search only. Latest publication year to include (e.g., 2024)."
          },
          "scisbd": {
            "title": "Sort By Date",
            "enum": [
              "0",
              "1",
              "2"
            ],
            "type": "string",
            "description": "For mode=search only. Recency sort: 0 = relevance (default), 1 = abstracts only from the last year sorted by date, 2 = everything from the last year sorted by date.",
            "default": "0"
          },
          "as_sdt": {
            "title": "Search Filter (as_sdt)",
            "enum": [
              "0",
              "7",
              "4"
            ],
            "type": "string",
            "description": "For mode=search only. Controls what types of results to include. Common values: '0' exclude patents (default), '7' include patents, '4' case law (US courts).",
            "default": "0"
          },
          "safe": {
            "title": "Safe Search",
            "enum": [
              "active",
              "off"
            ],
            "type": "string",
            "description": "For mode=search only. Safe search filter. Use 'active' to enable or 'off' to disable."
          },
          "filter": {
            "title": "Filter Similar/Omitted Results",
            "enum": [
              "0",
              "1"
            ],
            "type": "string",
            "description": "For mode=search only. 1 = enable the similar/omitted-results filter (default), 0 = disable it.",
            "default": "1"
          },
          "as_vis": {
            "title": "Include Citations",
            "enum": [
              "0",
              "1"
            ],
            "type": "string",
            "description": "For mode=search only. 0 = include citations in results (default), 1 = exclude citations.",
            "default": "0"
          },
          "as_rr": {
            "title": "Review Articles Only",
            "enum": [
              "0",
              "1"
            ],
            "type": "string",
            "description": "For mode=search only. 1 = restrict to review articles, 0 = all article types (default).",
            "default": "0"
          },
          "sort": {
            "title": "Sort Order (Author Modes)",
            "enum": [
              "title",
              "pubdate"
            ],
            "type": "string",
            "description": "For mode=author_profile and author_articles. 'title' sorts alphabetically, 'pubdate' sorts by publication date (newest first). Omit for the default citation-count sort."
          },
          "max_pages": {
            "title": "Maximum Pages",
            "minimum": 0,
            "maximum": 100,
            "type": "integer",
            "description": "For mode=search and author_articles only. Maximum number of result pages to fetch. Use 0 for no limit. Defaults to 1.",
            "default": 1
          },
          "num": {
            "title": "Results Per Page",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "For mode=search (1-20) and mode=author_articles (1-100). Page size for paginated modes. Defaults to 10 for search, 20 for author_articles."
          }
        }
      },
      "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
                  }
                }
              },
              "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}