Skip to content

justserpapi/justserpapi-python

Repository files navigation

JustSerpAPI Logo

JustSerpAPI Python SDK

PyPI version Python Versions Documentation License

OpenAPI-driven Python SDK for JustSerpAPI with a stable high-level Client as the public entrypoint.

Platform Overview

The documentation center helps you browse endpoint health, versioned API paths, request parameters, and SERP-specific usage notes.

JustSerpAPI documentation overview

The console provides API key management, subscription status, credit visibility, request logs, usage trends, and credit consumption analytics.

JustSerpAPI console overview

Installation

pip install justserpapi

Quick Start

from justserpapi import Client

with Client(api_key="YOUR_API_KEY") as client:
    response = client.google.search(
        query="coffee shops in New York",
        location="New York, NY",
        language="en",
    )
    print(response)
    print(response["data"])

Generated High-Level API

The high-level surface is generated from OpenAPI and designed to be the default entrypoint:

from justserpapi import Client

client = Client(api_key="YOUR_API_KEY", timeout=20.0)

search = client.google.search(query="best espresso beans", language="en")
light = client.google.search.light(query="best espresso beans", language="en")
maps = client.google.maps.search(query="espresso bars", location="Shanghai")
news = client.google.news.search(query="OpenAI", language="en")
images = client.google.images.search(query="espresso machine")
shopping = client.google.shopping.search(query="espresso tamper")
finance = client.google.finance.search(query="NASDAQ:GOOGL")
scholar = client.google.scholar.search(query="machine learning", language="en")
overview = client.google.ai.overview(url="https://example.com/ai-overview")

print(search["data"])

client.close()

High-level responses are plain Python dictionaries that mirror the API's JSON response envelope. The SDK does not auto-unpack data.

Configuration

The public client exposes the common knobs directly:

from justserpapi import Client
from urllib3.util.retry import Retry

client = Client(
    api_key="YOUR_API_KEY",
    base_url="https://api.justserpapi.com",
    timeout=(5.0, 30.0),
    retries=Retry(total=5, backoff_factor=0.5),
)
client.close()
  • api_key: value sent in the X-API-Key header
  • base_url: API host, defaults to https://api.justserpapi.com
  • timeout: default request timeout injected into high-level methods
  • retries: urllib3 retry configuration; defaults to a conservative retry strategy for the high-level client

Service Overview

The API list below is generated from OpenAPI and shows the current public API categories and endpoint names. See the online API documentation for full request and response details.

Google Search API

Google AI Mode API

Google AI Overview API

Google Maps API

Google Images API

Google News API

Google Videos API

Google Shorts API

Google Finance API

Google Trends API

Google Shopping API

Google Immersive Product API

Google Autocomplete API

Google Scholar API

Google Lens API

Google Jobs API

Google Local API

Google Patents API

Google Hotels API

Web API

License

Distributed under the MIT License. See LICENSE for more information.