Skip to content

Google Scholar

Overview

Method Endpoint Version Description
POST /api/v1/open/search v1 Google Search API endpoint for retrieving search results

Request Headers

Header Type Required Description
Content-Type string Yes Must be set to application/json
Accept string No Response format (defaults to application/json)

Authentication

API Key Authentication - Pass the API key as a request parameter: api_key=your_api_key - Example: "api_key": "your_api_key_here"

Request Example

curl -X POST "https://domain/api/v1/open/search" \
  -H "Content-Type: application/json" \
  -d '{
    "api_key": "your_api_key_here",
    // ...
  }'

Response Format

All responses follow a standardized JSON structure:

{
  "code": 200,
  "msg": "Success",
  "reqId": "req_1234567890",
  "timestamp": "2025-01-08T10:30:00Z",
  "data": {
    // Response data object
  }
}

HTTP Status Codes

Code Status Description Retry
200 OK Request successful No

Request Parameters

Parameter Type Required Description Default
api_key string Yes API key for authentication
engine string Yes Search engine type, currently engine value is google_scholar google
q string Yes Search query, supports regular Google search syntax (like inurl:, site:, intitle:) and advanced search parameters
google_domain string No Google domain, defaults to google.com google.com
gl string No Search country code (e.g., us-United States, uk-United Kingdom, fr-France). Head to the Google countries page for a full list of supported Google countries.
hl string No Search language code (e.g., en-English, es-Spanish, fr-French). Head to the Google languages page for a full list of supported Google languages.
lr string No Parameter defines one or multiple languages to limit the search to. It uses lang_{two-letter language code} to specify languages and | as a delimiter. (e.g., lang_fr|lang_de will only search French and German pages). Head to the Google lr languages page for a full list of supported languages.
device string No Device type, currently only supports desktop version desktop
date string No Time range filter: h-last hour, d-last day, w-last week, m-last month, y-last year
start number No Parameter defines the result offset. It skips the given number of results. It's used for pagination. (e.g., 0 (default) is the first page of results, 10 is the 2nd page of results, 20 is the 3rd page of results, etc.).
num number No Parameter defines the maximum number of results to return. (e.g., 10 (default) returns 10 results, 40 returns 40 results, and 100 returns 100 results).
as_sdt string No Parameter can be used either as a search type or a filter. As a Filter (only works when searching articles): 0 - exclude patents (default). 7 - include patents. As a Search Type: 4 - Select case law (US courts only). This will select all the State and Federal courts. e.g. as_sdt=4 - Selects case law (all courts) To select specific courts, see the full list of supported Google Scholar courts. e.g. as_sdt=4,33,192 - 4 is the required value and should always be in the first position, 33 selects all New York courts and 192 selects Tax Court. Values have to be separated by comma (,)
cites string No Parameter defines unique ID for an article to trigger Cited By searches. Usage of cites will bring up a list of citing documents in Google Scholar. Example value: cites=1275980731835430123. Usage of cites and q parameters triggers search within citing articles
as_ylo string No Parameter defines the year from which you want the results to be included. (e.g. if you set as_ylo parameter to the year 2018, the results before that year will be omitted.). This parameter can be combined with the as_yhi parameter
as_yhi string No Parameter defines the year until which you want the results to be included. (e.g. if you set as_yhi parameter to the year 2018, the results after that year will be omitted.). This parameter can be combined with the as_ylo parameter
scisbd string No Parameter defines articles added in the last year, sorted by date. It can be set to 1 to include only abstracts, or 2 to include everything. The default value is 0 which means that the articles are sorted by relevance 0
cluster string No Parameter defines unique ID for an article to trigger All Versions searches. Example value: cluster=1275980731835430123. Usage of cluster together with q and cites parameters is prohibited. Use cluster parameter only
safe string No Parameter defines the level of filtering for adult content. It can be set to active or off, by default Google will blur explicit content. off or active
filter string No Parameter defines the exclusion of results from an auto-corrected query when the original query is spelled wrong. It can be set to 1 to exclude these results, or 0 to include them (default). Note that this parameter may not prevent Google from returning results for an auto-corrected query if no other results are available. 1 or 0 1
as_vis string No Parameter defines whether you would like to include citations or not. It can be set to 1 to exclude these results, or 0 (default) to include them 0
as_rr string No Parameter defines whether you would like to show only review articles or not (these articles consist of topic reviews, or discuss the works or authors you have searched for). It can be set to 1 to enable this filter, or 0 (default) to show all results 0
html string No Whether to return HTML format, 1-yes, 0-no 0

Response Example

{
    "code": 200,
    "data": {
        "search_metadata": {
            "raw_html_file": "oss_html",
            "total_time_taken": 2.032416469,
            "id": "1985902431212408832",
            "json_endpoint": "oss_json",
            "created_at": "2025-10-29 08:53:31",
            "processed_at": "2025-10-29 08:53:33",
            "google_url": "https://scholar.google.com/scholar?q=coffee",
            "status": "Success"
        },
        "search_information": {
          "organic_results_state": "Showing results for exact spelling despite spelling suggestion",
          "time_taken_displayed": 0.042,
          "total_results": "753000"
        },
        "search_parameters": {
            "engine": "google_scholar",
            "html": "0",
            "google_domain": "scholar.google.com",
            "q": "coffee"
        },
        "organic_results": [
            {
                "position": 1,
                "title": "The impact of coffee on health",
                "link": [
                    "https://www.sciencedirect.com/science/article/pii/S0378512213000479"
                ],
                "snippet": "OBJECTIVE: Coffee is a beverage used worldwide. It includes a wide array of components \\nthat can have potential implication on he ve reviewed publications on the impact of ...",
                "result_id": "sWzmct-yYzgJ",
                "publication_info": {
                    "summary": "A Cano-Marquina, JJ Tarín, A Cano - Maturitas, 2013 - Elsevier",
                    "authors": [
                        {
                            "name": "A Cano-Marquina",
                            "link": "https://scholar.google.com/citations?user=nMS5yswAAAAJ&hl=en&oi=sra",
                            "author_id": "nMS5yswAAAAJ"
                        }
                    ]
                },
                "resources": {
                    "title": "sci-hub.box",
                    "link": "https://2024.sci-hub.box/2123/6b434e554b91bca5615f905bff214b52/cano-marquina2013.pdf",
                    "file_format": "PDF"
                },
                "inline_links": {
                    "cited_by": {
                        "total": 544,
                        "link": "https://scholar.google.com/scholar?cites=4063287961593474225&as_sdt=2005&sciodt=0,5&hl=en",
                        "cites_id": "4063287961593474225"
                    },
                    "related_pages_link": "/scholar?q=related:sWzmct-yYzgJ:scholar.google.com/&scioq=coffee&hl=en&lr=lang_en&as_sdt=0,5",
                    "versions": {
                        "link": "https://scholar.google.com/scholar?cluster=4063287961593474225&hl=en&lr=lang_en&as_sdt=0,5",
                        "cluster_id": "4063287961593474225",
                        "total": 10
                    }
                }
            }
        ],
        "pagination": {
          "current": 1,
          "next": "https://www.google.com/search?q=coffee&lr=lang_en&sca_esv=4b752b0057153c0c&gl=us&hl=en&tbs=lr:lang_1en&ei=yaXxaLu2FpKNseMPh9Pu2QI&start=10&sa=N&sstk=Af77f_e5ATQiBR2g6i0PioPRhVCJRwe-Uvg3QfRx8PbRJCfhhwu1aHhL5hYp9LpnSHWs0YchGN0UJXWAj7kHwSz1pB75iAOYOpi4Pg&ved=2ahUKEwj7vs__k6qQAxWSRmwGHYepOysQ8NMDegQIGRAW",
          "other_pages": {
            "2": "https://www.google.com/search?q=coffee&lr=lang_en&sca_esv=4b752b0057153c0c&gl=us&hl=en&tbs=lr:lang_1en&ei=yaXxaLu2FpKNseMPh9Pu2QI&start=10&sa=N&sstk=Af77f_e5ATQiBR2g6i0PioPRhVCJRwe-Uvg3QfRx8PbRJCfhhwu1aHhL5hYp9LpnSHWs0YchGN0UJXWAj7kHwSz1pB75iAOYOpi4Pg&ved=2ahUKEwj7vs__k6qQAxWSRmwGHYepOysQ8tMDegQIGRAE",
            "3": "https://www.google.com/search?q=coffee&lr=lang_en&sca_esv=4b752b0057153c0c&gl=us&hl=en&tbs=lr:lang_1en&ei=yaXxaLu2FpKNseMPh9Pu2QI&start=20&sa=N&sstk=Af77f_e5ATQiBR2g6i0PioPRhVCJRwe-Uvg3QfRx8PbRJCfhhwu1aHhL5hYp9LpnSHWs0YchGN0UJXWAj7kHwSz1pB75iAOYOpi4Pg&ved=2ahUKEwj7vs__k6qQAxWSRmwGHYepOysQ8tMDegQIGRAG",
            "4": "https://www.google.com/search?q=coffee&lr=lang_en&sca_esv=4b752b0057153c0c&gl=us&hl=en&tbs=lr:lang_1en&ei=yaXxaLu2FpKNseMPh9Pu2QI&start=30&sa=N&sstk=Af77f_e5ATQiBR2g6i0PioPRhVCJRwe-Uvg3QfRx8PbRJCfhhwu1aHhL5hYp9LpnSHWs0YchGN0UJXWAj7kHwSz1pB75iAOYOpi4Pg&ved=2ahUKEwj7vs__k6qQAxWSRmwGHYepOysQ8tMDegQIGRAI",
            "5": "https://www.google.com/search?q=coffee&lr=lang_en&sca_esv=4b752b0057153c0c&gl=us&hl=en&tbs=lr:lang_1en&ei=yaXxaLu2FpKNseMPh9Pu2QI&start=40&sa=N&sstk=Af77f_e5ATQiBR2g6i0PioPRhVCJRwe-Uvg3QfRx8PbRJCfhhwu1aHhL5hYp9LpnSHWs0YchGN0UJXWAj7kHwSz1pB75iAOYOpi4Pg&ved=2ahUKEwj7vs__k6qQAxWSRmwGHYepOysQ8tMDegQIGRAK",
            "6": "https://www.google.com/search?q=coffee&lr=lang_en&sca_esv=4b752b0057153c0c&gl=us&hl=en&tbs=lr:lang_1en&ei=yaXxaLu2FpKNseMPh9Pu2QI&start=50&sa=N&sstk=Af77f_e5ATQiBR2g6i0PioPRhVCJRwe-Uvg3QfRx8PbRJCfhhwu1aHhL5hYp9LpnSHWs0YchGN0UJXWAj7kHwSz1pB75iAOYOpi4Pg&ved=2ahUKEwj7vs__k6qQAxWSRmwGHYepOysQ8tMDegQIGRAM",
            "7": "https://www.google.com/search?q=coffee&lr=lang_en&sca_esv=4b752b0057153c0c&gl=us&hl=en&tbs=lr:lang_1en&ei=yaXxaLu2FpKNseMPh9Pu2QI&start=60&sa=N&sstk=Af77f_e5ATQiBR2g6i0PioPRhVCJRwe-Uvg3QfRx8PbRJCfhhwu1aHhL5hYp9LpnSHWs0YchGN0UJXWAj7kHwSz1pB75iAOYOpi4Pg&ved=2ahUKEwj7vs__k6qQAxWSRmwGHYepOysQ8tMDegQIGRAO",
            "8": "https://www.google.com/search?q=coffee&lr=lang_en&sca_esv=4b752b0057153c0c&gl=us&hl=en&tbs=lr:lang_1en&ei=yaXxaLu2FpKNseMPh9Pu2QI&start=70&sa=N&sstk=Af77f_e5ATQiBR2g6i0PioPRhVCJRwe-Uvg3QfRx8PbRJCfhhwu1aHhL5hYp9LpnSHWs0YchGN0UJXWAj7kHwSz1pB75iAOYOpi4Pg&ved=2ahUKEwj7vs__k6qQAxWSRmwGHYepOysQ8tMDegQIGRAQ",
            "9": "https://www.google.com/search?q=coffee&lr=lang_en&sca_esv=4b752b0057153c0c&gl=us&hl=en&tbs=lr:lang_1en&ei=yaXxaLu2FpKNseMPh9Pu2QI&start=80&sa=N&sstk=Af77f_e5ATQiBR2g6i0PioPRhVCJRwe-Uvg3QfRx8PbRJCfhhwu1aHhL5hYp9LpnSHWs0YchGN0UJXWAj7kHwSz1pB75iAOYOpi4Pg&ved=2ahUKEwj7vs__k6qQAxWSRmwGHYepOysQ8tMDegQIGRAS",
            "10": "https://www.google.com/search?q=coffee&lr=lang_en&sca_esv=4b752b0057153c0c&gl=us&hl=en&tbs=lr:lang_1en&ei=yaXxaLu2FpKNseMPh9Pu2QI&start=90&sa=N&sstk=Af77f_e5ATQiBR2g6i0PioPRhVCJRwe-Uvg3QfRx8PbRJCfhhwu1aHhL5hYp9LpnSHWs0YchGN0UJXWAj7kHwSz1pB75iAOYOpi4Pg&ved=2ahUKEwj7vs__k6qQAxWSRmwGHYepOysQ8tMDegQIGRAU"
          }
      }
    },
    "msg": "string",
    "reqId": "string"
}

Complete Response Parameters Overview

search_metadata

object Contains metadata about the search execution

Parameter Type Description Applicable Terminal
id string Unique identifier for the search request desktop
json_endpoint string Provide an interface endpoint for searching related JSON data, through which JSON-formatted search data can be obtained desktop
created_at string The timestamp when the search request was created, recording the time when the search was initiated desktop
processed_at string The timestamp when the search results were processed and became available for return, recording the time point from processing to completion of the search desktop
google_url string The Google search URL, which contains the search keyword "coffee" along with language parameters (hl=en for English), regional parameters (gl=us for the United States), and other search parameters, used to redirect to the corresponding Google search page desktop
status string Status of the search execution (e.g., Success) desktop
raw_html_file string Identifier for the original HTML file desktop
total_time_taken number The total time spent on the entire search process (including request sending, result parsing, and other stages) desktop

search_information

object Contains information about the search results

Parameter Type Description Applicable Terminal
organic_results_state string State of organic results desktop
time_taken_displayed number TDisplay time (i.e., the time spent on displaying the search results) desktop
total_results string Total results count (the total number of results returned by this search) desktop

search_parameters

object Contains the parameters used for the search

Parameter Type Description Applicable Terminal
q string Keywords used for this query desktop
engine string Search engine used for this query (e.g., google_web) desktop
html string When HTML=0, returns JSON; when HTML=1, returns HTML; when HTML=2, returns both JSON and HTML desktop
device string Device type used during search (e.g., desktop) desktop
google_domain string Specifies the corresponding Google domain (e.g., google.com, etc., used to distinguish Google services in different regions/locales) desktop

organic_results

object[] Google's scholarly literature search engine, your one-stop solution from daily information retrieval to professional academic research.

Parameter Type Description Applicable Terminal
position number The ranking position of this literature in Google Scholar search results desktop
title string Title of the literature desktop
link string[] List of full-text access links for the literature desktop
snippet string Abstract excerpt of the literature desktop
result_id string Unique identifier of the search result desktop
publication_info object Publication and author information set of the literature desktop
publication_info.summary string Publication and author information set of the literature desktop
publication_info.authors object[] Author list of the literature, where each element represents detailed information of an author desktop
publication_info.authors[].name string Author name desktop
publication_info.authors[].link string Google Scholar profile URL of the author (for accessing their other research works) desktop
publication_info.authors[].author_id string Author's unique identifier ID (Google Scholar's code for distinguishing authors) desktop
resources object Resource access information set for the literature desktop
resources.title string Name of the resource source desktop
resources.link string Direct PDF download link for the document (click to access full text) desktop
resources.file_format string File format of the resource (e.g., PDF, specifies resource type) desktop
inline_links object Collection of action links for literature desktop
inline_links.cited_by object Citation information for literature desktop
inline_links.cited_by.total number Total citation count of literature desktop
inline_links.cited_by.link string "View citing literature" link desktop
inline_links.cited_by.cites_id string Unique identifier for citation record desktop
inline_links.related_pages_link string View related pages or literature desktop
inline_links.versions object Literature version information desktop
inline_links.versions.link string View all versions of this literature desktop
inline_links.versions.cluster_id string Unique identifier of the literature version family desktop
inline_links.versions.total string Total number of versions in literature desktop

pagination

object (Pagination) related fields used to describe pagination navigation information for search results

Parameter Type Description Applicable Terminal
current number Current page number desktop
next string Next page navigation link (can directly jump to the next page of search results) desktop
other_pages object An object containing navigation links to other pages (such as page 2, page 3, etc.) desktop