Google

Google Scholar

Retrieve Google Scholar using its native source data.

post/v1/google/scholar/search

Request

  • Base URL: https://api.prismcrawl.com
  • URL: https://api.prismcrawl.com/v1/google/scholar/search
  • Auth: API key in header x-api-key

Request body

querystring

Text to search for on the selected service. At most 8,192 UTF-8 bytes.

languagestring

Provider-supported language code, such as en.

pageinteger

One-based page number.

device'desktop' | 'mobile' | 'tablet'

Device presentation for the source request.

htmlboolean

Return the encoded original response rather than parsed JSON.

zero_traceboolean

Do not archive source or parsed response artifacts.

citesstring

Comma-separated native article IDs; query optionally searches within citing articles.

clusterstring

Native article cluster ID. Cannot be combined with query or cites.

as_ylointeger

Inclusive publication year bound.

as_yhiinteger

Inclusive publication year bound.

scisbdinteger

Date sorting: 0 relevance, 1 recent abstracts, 2 recent articles.

filterinteger

Enable similar and omitted results filtering.

as_visinteger

Exclude citation-only records when 1.

as_rrinteger

Only review articles when 1.

startinteger

Native result offset. Cannot be combined with page.

numinteger

Native page size, default 10.

lrstring

Language restrictions, such as lang_fr|lang_de.

as_sdtstring

Article/patent filter or comma-separated native court selection, such as 4,33,192.

safe'active' | 'off'

Provider safe-search filtering.

output'json' | 'html' | 'md' | 'null' nullable

Response content format. md returns Markdown in data.content with data.format=md; the JSON success/request envelope remains. Accept: text/markdown also selects Markdown unless output or html=true is explicit. html is an alias for html=true and retains the existing Brotli/Base64 source format.

json_restrictorstring nullable

Select fields within data.content for JSON or Markdown. Supports comma-separated paths, non-negative array indices, half-open slices [0:3] (either bound may be omitted), [] and .{nested,subqueries}. Up to128 selections and16 levels. Missing fields are omitted; selected declared fields retain their zero defaults. The request envelope and credit headers remain. Include next_page_token when pagination is needed. Incompatible with HTML output. This changes response presentation only; tracing-enabled history retains the complete JSON result.

no_cacheboolean nullable

Accepted for compatibility. Searches are always fetched without a result cache for either value; normal successful-request billing applies.

Example request

{
  "json_restrictor": "results[].{title,url},has_next_page,next_page_token"
}

Response

Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.

successtrue required
request_idstring uuid required

Changes

No recorded changes to this operation across all 1 revision of this API.