Bukalapak Python API Docs | dltHub
Build a Bukalapak-to-database pipeline in Python using dlt with AI Workbench support for Claude Code, Cursor, and Codex.
Last updated:
Bukalapak API documentation is available at https://chez14.gitlab.io/buka-api. It provides access to product and transaction information. Authentication requires Bukalapak account credentials. The REST API base URL is https://api.bukalapak.com/v2 and HTTP Basic auth (username:token) used for authenticated endpoints; tokens are obtained via authenticate 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 Bukalapak data in under 10 minutes.
What data can I load from Bukalapak?
Here are some of the endpoints you can load from Bukalapak:
| Resource | Endpoint | Method | Data selector | Description |
|---|---|---|---|---|
| products | /products.json | GET | products | Search/list products |
| products_popular | /products/populars.json | GET | (likely products) | Get popular products |
| banks | /banks.json | GET | banks | Get supported banks list |
| address_provinces | /address/provinces.json | GET | provinces | Get provinces list |
| address_cities | /address/cities.json | GET | cities | Get cities list (query province) |
| address_districts | /address/districts.json | GET | districts | Get districts list (province & city) |
| labels | /labels/index.json | GET | labels | Get label list for logged in user (requires auth) |
| notifications_list | /notifications/list.json | GET | (response contains notifications list) | Get notifications (requires auth) |
| transactions | /transactions.json | GET | transactions | Get transactions list for current user (requires auth) |
| products_shipping_list | /products/:id/shipping_list.json | GET | fee_list | Get shipping fee options for a product |
How do I authenticate with the Bukalapak API?
Obtain an API token by POSTing username:password to https://api.bukalapak.com/v2/authenticate.json (HTTP Basic). Subsequent authenticated requests use HTTP Basic with username:token (or user_id:token) in the Authorization header.
1. Get your credentials
- Register a Bukalapak account at https://www.bukalapak.com/register (or use existing account). 2) Call POST https://api.bukalapak.com/v2/authenticate.json using HTTP Basic with username:password to receive a JSON response containing token and user_id. 3) Use username:user_token (or user_id:token) as HTTP Basic credentials for protected endpoints.
2. Add them to .dlt/secrets.toml
[sources.bukalapak_source] username = "your_username_here" password = "your_api_token_here"
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 Bukalapak 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 bukalapak_pipeline.py
If everything is configured correctly, you'll see output like this:
Pipeline bukalapak_pipeline load step completed in 0.26 seconds 1 load package(s) were loaded to destination duckdb and into dataset bukalapak_data The duckdb destination used duckdb:/bukalapak.duckdb location to store data Load package 1749667187.541553 is LOADED and contains no failed jobs
Inspect your pipeline and data:
dlt pipeline bukalapak_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 products and transactions from the Bukalapak 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 bukalapak_source(credentials=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://api.bukalapak.com/v2", "auth": { "type": "http_basic", "password": credentials, }, }, "resources": [ {"name": "products", "endpoint": {"path": "products.json", "data_selector": "products"}}, {"name": "transactions", "endpoint": {"path": "transactions.json", "data_selector": "transactions"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="bukalapak_pipeline", destination="duckdb", dataset_name="bukalapak_data", ) load_info = pipeline.run(bukalapak_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("bukalapak_pipeline").dataset() sessions_df = data.products.df() print(sessions_df.head())
SQL (DuckDB example):
SELECT * FROM bukalapak_data.products LIMIT 10;
In a marimo or Jupyter notebook:
import dlt data = dlt.pipeline("bukalapak_pipeline").dataset() data.products.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 Bukalapak 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 Bukalapak?
Request dlt skills, commands, AGENT.md files, and AI-native context.