gspread Python API Docs | dltHub

gspread is a Python library that provides a simple interface for interacting with the Google Sheets REST API v4. The REST API base URL is https://sheets.googleapis.com and authentication is performed using Google OAuth2 credentials or service account files which provide authorization to the Google Sheets API.

dlt is an open-source Python library that handles authentication, pagination, and schema evolution automatically. dlthub provides AI context files that enable code assistants to generate production-ready pipelines. Install with uv add "dlt[hub]" and start loading gspread data in under 10 minutes.

---

What data can I load from gspread?

Here are some of the endpoints you can load from gspread:

---

How do I authenticate with the gspread API?

gspread uses OAuth2 to access Google Sheets, typically managed via service account credentials or OAuth Client IDs, which handles the necessary Bearer token authentication under the hood when communicating with the Google Sheets API. Header injection is handled automatically by the library and its underlying HTTP client.

1. Get your credentials

1. Go to the Google Cloud Console (console.cloud.google.com) and create or select a project. 2. Navigate to 'APIs & Services' > 'Library' and enable the 'Google Sheets API'. 3. Navigate to 'APIs & Services' > 'Credentials'. 4. To use a Service Account (recommended for pipelines): Click 'Create credentials' > 'Service account'. Follow the prompts, then click on the created account, go to the 'Keys' tab, select 'Add key' > 'Create new key' (JSON format). Download the resulting file. If using User OAuth (for interactive sessions), select 'OAuth client ID' instead, choose 'Desktop app', and download the JSON credentials file. 5. Share your target spreadsheet with the service account email address provided in your JSON key file.

2. Add them to .dlt/secrets.toml

Copy
[sources.gspread_source]
project_id = "your_project_id"
private_key = "-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----\n"
client_email = "your_service_account_email@project.iam.gserviceaccount.com"

dlt reads this automatically at runtime — never hardcode tokens in your pipeline script. For production environments, see setting up credentials with dlt for environment variable and vault-based options.

---

How do I set up and run the pipeline?

Set up a virtual environment and install dlt:

Copy
uv init
uv add "dlt[hub]"

1. Install the dlt AI harness:

Copy
uv run dlthub ai init --agent <your-agent> # <agent>: claude | cursor | codex

This installs project rules, a secrets management skill, appropriate ignore files, and configures the dlt MCP server for your agent. Learn more →

2. Install the rest-api-pipeline toolkit:

Copy
uv run dlthub ai toolkit install rest-api-pipeline

This loads the skills and context about dlt the agent uses to build the pipeline iteratively, efficiently, and safely. The agent uses MCP tools to inspect credentials — it never needs to read your secrets.toml directly. Learn more →

3. Start LLM-assisted coding:

Use /find-source to load data from the gspread API into DuckDB.

The rest-api-pipeline toolkit takes over from here — it reads relevant API documentation, presents you with options for which endpoints to load, and follows a structured workflow to scaffold, debug, and validate the pipeline step by step.

4. Run the pipeline:

Copy
uv run python gspread_pipeline.py

If everything is configured correctly, you'll see output like this:

Copy
Pipeline gspread_pipeline load step completed in 0.26 seconds
1 load package(s) were loaded to destination duckdb and into dataset gspread_data
The duckdb destination used duckdb:/gspread.duckdb location to store data
Load package 1749667187.541553 is LOADED and contains no failed jobs

Inspect your pipeline and data:

Copy
uv run dlthub show

This opens the Pipeline Dashboard where you can verify pipeline state, load metrics, schema (tables, columns, types), and query the loaded data directly.

---

Python pipeline example

This example loads spreadsheets.values.get and spreadsheets.values.update from the gspread API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:

Copy
import dlt
from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources

@dlt.source
def gspread_source(credentials_filename=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://sheets.googleapis.com",
            "auth": {"type": "bearer", "token": credentials_filename},
        },
        "resources": [
            {"name": "values", "endpoint": {"path": "spreadsheets/{spreadsheetId}/values/{range}", "data_selector": "values"}},
            {"name": "spreadsheets", "endpoint": {"path": "spreadsheets/{spreadsheetId}", "data_selector": "sheets"}}
        ],
    }
    yield from rest_api_resources(config)


def get_data() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="gspread_pipeline",
        destination="duckdb",
        dataset_name="gspread_data",
    )
    load_info = pipeline.run(gspread_source())
    print(load_info)

To add more endpoints, append entries from the resource table to the "resources" list using the same name, path, and data_selector pattern.

---

How do I query the loaded data?

Once the pipeline runs, dlt creates one table per resource. You can query with Python or SQL.

Python (pandas DataFrame):

Copy
import dlt

data = dlt.pipeline("gspread_pipeline").dataset()
sessions_df = data.values.df()
print(sessions_df.head())

SQL (DuckDB example):

Copy
SELECT * FROM gspread_data.values LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("gspread_pipeline").dataset()
data.values.df().head()

See how to explore your data in marimo Notebooks and how to query your data in Python with dataset.

---

What destinations can I load gspread data to?

dlt supports loading into any of these destinations — only the destination parameter changes:

Change the destination in dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. See the full destinations list.

---

Next steps

Continue your data engineering journey with the other toolkits of the dltHub AI harness:

• data-exploration — Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.
• dlthub-platform — Deploy, schedule, and monitor your pipeline in production.

Copy
uv run dlthub ai toolkit install data-exploration
uv run dlthub ai toolkit install dlthub-platform

• How to deploy a pipeline
• How to explore your data in marimo Notebooks
• How to query your data in Python with dataset
• Join the dlt community on Slack