PAR Technology Python API Docs | dltHub

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

Last updated:

PAR Technology provides a suite of POS and restaurant management cloud APIs including Order, Data, Settings, and Pay services for building restaurant integrations. The REST API base URL is The base URL varies significantly based on the specific service (e.g., POS, Ordering, Pay) and production environment stack (e.g., https://api{stack}.parpos.net/). Because PAR Technology provides multiple distinct services, there is no single global base URL. and Most modern REST APIs use Bearer JWT tokens, often alongside application-specific identification headers..

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 PAR Technology data in under 10 minutes.


What data can I load from PAR Technology?

Here are some of the endpoints you can load from PAR Technology:

ResourceEndpointMethodData selectorDescription
transactions/transactions/v1GETRetrieves a paginated list of transactions
orders/register/v1/Order/getOrdersGETRetrieves a page of orders
menu_categories/venues/{venue_uuid}/menus/{menu_uuid}/categoriesGETFetches categories for a menu
receipts/customer-accounts/{customer_id}/receiptsGETreceiptsReturns all receipts for a customer
venues/venues/{venue_id}GETvenueFetches a venue by ID

How do I authenticate with the PAR Technology API?

API requests typically require an Authorization header using a Bearer JWT token (e.g., Authorization: Bearer {jwt_token}). Some services may require additional headers such as 'Application' for identification or 'X-LocationId' for merchant identification.

1. Get your credentials

PAR Technology (Brink POS) does not provide a self-service dashboard for generating API credentials. Credentials are obtained through the integration onboarding process. You must contact your PAR Technology/Brink POS representative or the API support team (api.support@partech.com) to request an API Access Token (often called an 'Access Key' or 'AccessToken') and a Location Token (Location ID). For certain integrations, you may also be provided with an API URL specific to your environment. Provide your company details and the specific locations you need to access when requesting these credentials.

2. Add them to .dlt/secrets.toml

[sources.par_technology_source] api_access_token = "your_access_token_here" location_token = "your_location_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 init uv add "dlt[hub]"

1. Install the dlt AI harness:

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:

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 PAR Technology 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:

uv run python par_technology_pipeline.py

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

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

Inspect your pipeline and data:

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 AccessToken and LocationToken from the PAR Technology 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 par_technology_source(application_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "The base URL varies significantly based on the specific service (e.g., POS, Ordering, Pay) and production environment stack (e.g., https://api{stack}.parpos.net/). Because PAR Technology provides multiple distinct services, there is no single global base URL.", "auth": {"type": "bearer", "token": application_key}, }, "resources": [ {"name": "transactions", "endpoint": {"path": "transactions/v1"}}, {"name": "orders", "endpoint": {"path": "register/v1/Order/getOrders"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="par_technology_pipeline", destination="duckdb", dataset_name="par_technology_data", ) load_info = pipeline.run(par_technology_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("par_technology_pipeline").dataset() sessions_df = data.transactions.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM par_technology_data.transactions LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("par_technology_pipeline").dataset() data.transactions.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 PAR Technology 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 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.
uv run dlthub ai toolkit install data-exploration uv run dlthub ai toolkit install dlthub-platform

Was this page helpful?

Community Hub

Need more dlt context for PAR Technology?

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