Google scholar API

Search Google Scholar for papers, books and case law, with citations

curl --request POST \
  --url https://api.stophy.dev/v1/google/scholar \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "malaria vaccine efficacy"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({query: 'malaria vaccine efficacy'})
};

fetch('https://api.stophy.dev/v1/google/scholar', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.stophy.dev/v1/google/scholar"

payload = { "query": "malaria vaccine efficacy" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "success": true,
  "data": {
    "results": [
      {
        "title": "<string>",
        "position": 123,
        "url": "<string>",
        "format": "pdf",
        "authors": [
          "<string>"
        ],
        "publication": "<string>",
        "year": 0,
        "publisher": "<string>",
        "snippet": "<string>",
        "citations": 4503599627370495,
        "citesId": "<string>",
        "versions": 4503599627370495,
        "pdfUrl": "<string>"
      }
    ],
    "page": 4503599627370496
  },
  "creditsUsed": 123,
  "requestId": "<string>"
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

POST

google

scholar

Search Google Scholar for papers, books and case law, with citations

curl --request POST \
  --url https://api.stophy.dev/v1/google/scholar \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "malaria vaccine efficacy"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({query: 'malaria vaccine efficacy'})
};

fetch('https://api.stophy.dev/v1/google/scholar', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.stophy.dev/v1/google/scholar"

payload = { "query": "malaria vaccine efficacy" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "success": true,
  "data": {
    "results": [
      {
        "title": "<string>",
        "position": 123,
        "url": "<string>",
        "format": "pdf",
        "authors": [
          "<string>"
        ],
        "publication": "<string>",
        "year": 0,
        "publisher": "<string>",
        "snippet": "<string>",
        "citations": 4503599627370495,
        "citesId": "<string>",
        "versions": 4503599627370495,
        "pdfUrl": "<string>"
      }
    ],
    "page": 4503599627370496
  },
  "creditsUsed": 123,
  "requestId": "<string>"
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

Searches Google Scholar for papers, books and case law, with citations.

Request

At least one of query or citesId is required. Set citesId to list the works that cite a result.

import { Stophy } from "stophy";

const stophy = new Stophy({ apiKey: process.env.STOPHY_API_KEY });
const result = await stophy.google.scholar({ query: "malaria vaccine efficacy" });
console.log(result.data.results);

from stophy import Stophy

stophy = Stophy()  # reads STOPHY_API_KEY
result = stophy.google.scholar(query="malaria vaccine efficacy")
print(result["data"]["results"])

curl -X POST https://api.stophy.dev/v1/google/scholar \
  -H "Authorization: Bearer $STOPHY_API_KEY" \
  -H "content-type: application/json" \
  -d '{"query":"malaria vaccine efficacy"}'

stophy google scholar "malaria vaccine efficacy"

Response

If successful, the response body contains the standard envelope. data.results[] contains the papers, books and cases, each with its authors, year and the number of works that cite it. The following example is a real response, truncated: each list shows one item and long strings are cut.

{
  "success": true,
  "data": {
    "results": [
      {
        "title": "Seven-year efficacy of RTS, S/AS01 malaria vaccine among young African children",
        "url": "https://www.nejm.org/doi/abs/10.1056/NEJMoa1515257",
        "format": "pdf",
        "authors": ["A Olotu", "G Fegan"],
        "publication": "England Journal of …",
        "year": 2016,
        "publisher": "Mass Medical Soc",
        "snippet": "… In an analysis that was not prespecified, the malaria exposure of each child was estimated … of malaria among…",
        "citations": 618,
        "citesId": "15871362944033457094",
        "versions": 14,
        "pdfUrl": "https://www.nejm.org/doi/pdf/10.1056/NEJMoa1515257",
        "position": 1
      }
    ],
    "page": 1
  },
  "creditsUsed": 1,
  "requestId": "2fe9dbad-fc48-4890-9751-0b24b596035b"
}

Field	Type	Description
`citesId`	string	Pass it as `citesId` to list the works that cite this one.
`citations`	integer	The number of works cite this one.
`format`	string	Scholar’s tag, such as [PDF] or [BOOK].
`publication`	string	Journal or venue; the case citation for case law.
`page`	integer	The page number of this response.
`position`	integer	The 1-based position of the result in the list.

For every field, see the response schema on this page.

Optional parameters

Parameter	Type	Description
`query`	string	Words to search for.
`citesId`	string	A result’s `citesId`. Lists the works that cite it.
`yearFrom`	integer	Restricts results to works from this year on. Must be between 1700 and 2027.
`yearTo`	integer	Restricts results to works up to this year. Must be between 1700 and 2027.
`sort`	string	Specifies the order of the results. `newest` lists recent additions first. Acceptable values are `relevance` and `newest`. If unset, defaults to `relevance`.
`type`	string	Any type, review articles or case law. Acceptable values are `any`, `reviewArticles` and `caseLaw`. If unset, defaults to `any`.
`includePatents`	boolean	Include patents in the results. If unset, defaults to `false`.
`includeCitations`	boolean	Include works that Scholar knows only from citations. If unset, defaults to `true`.
`page`	integer	The page to return. Pages are numbered from 1. Must be between 1 and 20. If unset, defaults to `1`.

Billing

Each successful request consumes 1 credit, regardless of the number of items returned. Requests that fail, or that return no items, are not billed.

Pagination

Results are paginated. To retrieve the next page, increment page. An empty data.results indicates the last page. The maximum value of page is 20.

Google Scholar: Accepts a result’s citesId as citesId. Searches Google Scholar for papers, books and case law, with citations.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

query

string

Required string length: 1 - 256

citesId

string

A result's citesId: lists the works that cite it, like Scholar's Cited by.

Pattern: ^\d{5,25}$

yearFrom

integer

Scholar's own Custom range: from this year.

Required range: 1700 <= x <= 2027

yearTo

integer

Scholar's own Custom range: up to this year.

Required range: 1700 <= x <= 2027

sort

enum<string>

default:relevance

Scholar's own sort. Newest lists recent additions first.

Available options:

relevance,

newest

type

enum<string>

default:any

Scholar's own Any type, Review articles, or Case law.

Available options:

any,

reviewArticles,

caseLaw

includePatents

boolean

default:false

includeCitations

boolean

default:true

Scholar's own include citations: works known only from citations.

page

integer

default:1

Page number, starting at 1.

Required range: 1 <= x <= 20

Response

The data, and the credits this call used.

success

any

required

data

object

required

Show child attributes

creditsUsed

integer

required

requestId

string

required

Using the API

Catalog

Account

Search and AI answers

Video

Social

Places and travel

Jobs

Shopping

Apps

Real estate

Ads

Google scholar API

Request

Response

Optional parameters

Billing

Authorizations

Body

Response

​Request

​Response

​Optional parameters

​Billing

​Pagination

​Related methods

Authorizations

Body

Response

Request

Response

Optional parameters

Billing

Pagination

Related methods