Meta Box Python API Docs | dltHub
Build a Meta Box-to-database pipeline in Python using dlt with AI Workbench support for Claude Code, Cursor, and Codex.
Last updated:
The MB REST API extension allows custom fields to be accessed via WordPress REST API. It retrieves and updates custom fields in REST API responses. Install Meta Box and MB REST API plugins to use it. The REST API base URL is https://{your_site}/wp-json/ and Uses WordPress REST API authentication; GETs for public content usually require no auth; modifying endpoints require WordPress authentication (HTTP Basic, cookie, OAuth/JWT depending on WP setup)..
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 Meta Box data in under 10 minutes.
What data can I load from Meta Box?
Here are some of the endpoints you can load from Meta Box:
| Resource | Endpoint | Method | Data selector | Description |
|---|---|---|---|---|
| posts | wp/v2/posts | GET | (top-level array) | List of posts; each post includes a meta_box object with Meta Box fields. |
| post | wp/v2/{post_type}/{id} | GET | meta_box | Single post or custom post type; Meta Box fields appear under meta_box. |
| terms | wp/v2/{taxonomy} | GET | (top-level array) | List of taxonomy terms; Meta Box term meta injected under meta_box. |
| users | wp/v2/users | GET | (top-level array) | List of users; Meta Box user meta appears in meta_box. |
| comments | wp/v2/comments | GET | (top-level array) | List of comments; Meta Box fields included under meta_box. |
| settings_page | meta-box/v1/settings-page?id={id} | GET | (top-level object) | Custom settings page provided by Meta Box; returns a JSON object with settings data. |
How do I authenticate with the Meta Box API?
MB REST API leverages WordPress authentication. For POST (update) requests you must authenticate with a WordPress account using HTTP Basic (username:password), cookie‑based login, or any WordPress‑supported REST auth plugin (e.g., JWT, OAuth). Include the appropriate Authorization header or cookies.
1. Get your credentials
- Log into the WordPress admin dashboard.
- Navigate to Users → All Users and ensure you have an account with the appropriate role (e.g., Administrator or Editor).
- For basic auth, note the username and password of that account.
- (Optional) If using a JWT plugin, install the plugin, then follow its instructions to generate a token (usually via a POST to
/wp-json/jwt-auth/v1/tokenwith the same username/password). - For cookie‑based auth, authenticate via a browser session and pass the WP‑nonce and cookies with each request.
2. Add them to .dlt/secrets.toml
[sources.meta_box_rest_api_source] username = "your_wp_username" password = "your_wp_password" # or for JWT jwt_token = "your_jwt_token"
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 Meta Box 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 meta_box_rest_api_pipeline.py
If everything is configured correctly, you'll see output like this:
Pipeline meta_box_rest_api_pipeline load step completed in 0.26 seconds 1 load package(s) were loaded to destination duckdb and into dataset meta_box_rest_api_data The duckdb destination used duckdb:/meta_box_rest_api.duckdb location to store data Load package 1749667187.541553 is LOADED and contains no failed jobs
Inspect your pipeline and data:
dlt pipeline meta_box_rest_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 post and posts from the Meta Box 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 meta_box_rest_api_source(username=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://{your_site}/wp-json/", "auth": { "type": "http_basic", "password": username, }, }, "resources": [ {"name": "posts", "endpoint": {"path": "wp/v2/posts"}}, {"name": "post", "endpoint": {"path": "wp/v2/{post_type}/{id}", "data_selector": "meta_box"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="meta_box_rest_api_pipeline", destination="duckdb", dataset_name="meta_box_rest_api_data", ) load_info = pipeline.run(meta_box_rest_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("meta_box_rest_api_pipeline").dataset() sessions_df = data.posts.df() print(sessions_df.head())
SQL (DuckDB example):
SELECT * FROM meta_box_rest_api_data.posts LIMIT 10;
In a marimo or Jupyter notebook:
import dlt data = dlt.pipeline("meta_box_rest_api_pipeline").dataset() data.posts.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 Meta Box data to?
dlt supports loading into any of these destinations — only the destination parameter changes:
| Destination | Example 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 Meta Box?
Request dlt skills, commands, AGENT.md files, and AI-native context.