Pinterest - Api Python API Docs | dltHub

Build a Pinterest-to-database pipeline in Python using dlt with AI Workbench support for Claude Code, Cursor, and Codex.

Last updated:

The Pinterest API (v5) enables developers to manage content, ads, and analytics; it requires OAuth for authentication. To use it, apply for access and follow the API documentation for implementation. The latest version is v5.3.0. The REST API base URL is https://api.pinterest.com/v5 and all requests require a Bearer access token in the Authorization header.

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 Pinterest - Api data in under 10 minutes.


What data can I load from Pinterest - Api?

Here are some of the endpoints you can load from Pinterest - Api:

ResourceEndpointMethodData selectorDescription
user_account/user_accountGETGet the calling user's account details.
boards_list_pins/boards/{board_id}/pinsGETitemsList pins on a board (paginated; response contains "items" and optional "bookmark").
ad_accounts/ad_accountsGETitemsList ad accounts accessible to the operation user (response contains "items" and optional "bookmark").
ads_get/ads/{ad_id}GETGet a single ad by id.
campaigns_list/ad_accounts/{ad_account_id}/campaignsGETitemsList campaigns for an ad account (paginated).
pins_get/pins/{pin_id}GETGet a single Pin by id.
boards_get/boards/{board_id}GETGet a single Board by id.
media_get/media/{media_id}GETGet media details.
reports_get/ad_accounts/{ad_account_id}/analyticsGETitemsGet analytics reports (response contains items/bookmark depending on endpoint).
oauth_token/oauth/tokenPOSTaccess_tokenExchange code or client credentials for access token.

How do I authenticate with the Pinterest - Api API?

Pinterest uses OAuth 2.0. Include the token in the request header as "Authorization: Bearer {access_token}".

1. Get your credentials

  1. Create an app in Pinterest Developer > My apps and note the client_id and client_secret.
  2. For user‑scoped access, direct the user to the authorization URL: https://www.pinterest.com/oauth/?client_id={client_id}&redirect_uri={redirect_uri}&response_type=code&scope=... to obtain an authorization code.
  3. Exchange the code for tokens with a POST to https://api.pinterest.com/v5/oauth/token, using the header 'Authorization: Basic {base64(client_id:client_secret)}' and body grant_type=authorization_code (or client_credentials for app‑only access).
  4. Receive an access_token (prefixed with "pina"), store it, and include it in subsequent API requests as "Authorization: Bearer {access_token}". Refresh with grant_type=refresh_token when needed.

2. Add them to .dlt/secrets.toml

[sources.pinterest_api_source] access_token = "pina_XXXXXXXXXXXXXXXXXXXXXXXX"

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:

uv venv && source .venv/bin/activate uv pip install "dlt[workspace]"

1. Install the dlt AI Workbench:

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:

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 Pinterest - Api 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:

python pinterest_api_pipeline.py

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

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

Inspect your pipeline and data:

dlt pipeline pinterest_api_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 ad_accounts and boards_list_pins from the Pinterest - Api API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:

import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def pinterest_api_source(access_token=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://api.pinterest.com/v5", "auth": { "type": "bearer", "token": access_token, }, }, "resources": [ {"name": "ad_accounts", "endpoint": {"path": "ad_accounts", "data_selector": "items"}}, {"name": "boards_list_pins", "endpoint": {"path": "boards/{board_id}/pins", "data_selector": "items"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="pinterest_api_pipeline", destination="duckdb", dataset_name="pinterest_api_data", ) load_info = pipeline.run(pinterest_api_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):

import dlt data = dlt.pipeline("pinterest_api_pipeline").dataset() sessions_df = data.boards_list_pins.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM pinterest_api_data.boards_list_pins LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("pinterest_api_pipeline").dataset() data.boards_list_pins.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 Pinterest - Api data to?

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

DestinationExample value
DuckDB (local, default)"duckdb"
PostgreSQL"postgres"
BigQuery"bigquery"
Snowflake"snowflake"
Redshift"redshift"
Databricks"databricks"
Filesystem (S3, GCS, Azure)"filesystem"

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 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.
dlt ai toolkit data-exploration install dlt ai toolkit dlthub-runtime install

Was this page helpful?

Community Hub

Need more dlt context for Pinterest - Api?

Request dlt skills, commands, AGENT.md files, and AI-native context.