Yotpo Python API Docs | dltHub

Yotpo is a user‑generated content platform that provides APIs for reviews, photos and other UGC. The REST API base URL is https://api.yotpo.com and All requests require a Bearer token (uToken) obtained via the authentication endpoint..

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 pip install "dlt[workspace]" and start loading Yotpo data in under 10 minutes.

---

What data can I load from Yotpo?

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

---

How do I authenticate with the Yotpo API?

Include the uToken in the request header as Authorization: Bearer <token>.

1. Get your credentials

1. Sign in to your Yotpo account.
2. Click the profile icon and select Account Settings → General Settings.
3. Copy the App Key (store_id) shown on the page.
4. Click Get secret key; a verification code will be emailed to the admin address.
5. Enter the verification code and submit to reveal the Secret Key.
6. Store both values for use in the authentication POST request.

2. Add them to .dlt/secrets.toml

Copy
[sources.yotpo_reviews_source]
store_id = "your_app_key"
secret_key = "your_secret_key"

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 venv && source .venv/bin/activate
uv pip install "dlt[workspace]"

1. Install the dlt AI Workbench:

Copy
dlt 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
dlt ai toolkit rest-api-pipeline install

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 Yotpo 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
python yotpo_reviews_pipeline.py

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

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

Inspect your pipeline and data:

Copy
dlt pipeline yotpo_reviews_pipeline 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 reviews and products from the Yotpo 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 yotpo_reviews_source(store_id=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://api.yotpo.com",
            "auth": {
                "type": "bearer",
                "token": store_id,
            },
        },
        "resources": [
            {"name": "reviews", "endpoint": {"path": "v1/apps/{app_key}/reviews", "data_selector": "response.reviews"}},
            {"name": "products", "endpoint": {"path": "core/v3/stores/{store_id}/products", "data_selector": "data"}}
        ],
    }
    yield from rest_api_resources(config)


def get_data() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="yotpo_reviews_pipeline",
        destination="duckdb",
        dataset_name="yotpo_reviews_data",
    )
    load_info = pipeline.run(yotpo_reviews_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("yotpo_reviews_pipeline").dataset()
sessions_df = data.reviews.df()
print(sessions_df.head())

SQL (DuckDB example):

Copy
SELECT * FROM yotpo_reviews_data.reviews LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("yotpo_reviews_pipeline").dataset()
data.reviews.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 Yotpo 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.

---

Troubleshooting

Authentication Errors

• 401 Unauthorized – The uToken is missing, expired, or invalid. Generate a new token via the authentication endpoint.

Rate Limits

• Yotpo limits the reviews endpoint to 5,000 requests per minute per app key. Exceeding this returns a 429 Too Many Requests response. Reduce request frequency or implement back‑off.

Pagination

• The reviews endpoint supports page and count query parameters. The response includes pagination metadata inside the top‑level response object (e.g., current_page, total_pages). Use these fields to iterate through pages.

Bad Requests

• 400 Bad Request is returned for malformed parameters or missing required fields. Verify required query parameters and request bodies against the API docs.

Ensure that the API key is valid to avoid 401 Unauthorized errors. Also, verify endpoint paths and parameters to avoid 404 Not Found errors.

---

Next steps

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

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

Copy
dlt ai toolkit data-exploration install
dlt ai toolkit dlthub-runtime install

• 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