No logo available for AROYA to DuckDB connector icon

Load AROYA data to DuckDB

Build a AROYA to DuckDB pipeline with your coding agent. One prompt scaffolds it with the dltHub AI harness, plus the AROYA API base URL, auth, endpoints, and incremental loading.

SourceAROYAAROYA API DocumentationDestinationDuckDBIn-process analytical database. The default local destination for dlt pipelines.

AROYA is a platform that provides a public REST API for retrieving device, facility, and room data for third-party integrations and data analysis. Everything needed to build a working AROYA → DuckDB pipeline is on this page: the API's base URL, authentication, endpoints, pagination and incremental field — plus a prompt that hands the whole job to your coding agent.


Build your AROYA to DuckDB pipeline

Paste this prompt into Claude, Codex, or Cursor. The agent does the rest.

Prompt
Run uvx dlthub-init@latest to build a pipeline from AROYA to DuckDB and run it on dltHub

That scaffolds a dltHub workspace and installs the dltHub AI harness — the project rules, the secrets-management skill, and the dlt MCP server your agent needs to work safely. From there it reads the AROYA API, proposes the endpoints to load, then writes, runs and validates the pipeline while you review rather than type. Credentials are inspected through MCP tools, so your agent never reads secrets.toml itself. How the LLM-native workflow works →

Prefer to write it yourself? Every fact the agent uses is below.


AROYA API at a glance

Base URLhttps://api.aroya.io/public_api/
Example endpointGET public_api/devices/
AuthenticationAll requests require a Bearer token in the Authorization header — sent in the Authorization header, prefixed Bearer
PaginationNot paginated
API referencehttps://aroya.helpdocs.io/article/z2xm3fxcp2-aroya-public-api-overview

These values come from the AROYA API reference — the authoritative source if anything here looks out of date.


How do I authenticate with the AROYA API?

All requests must use an Authorization: Bearer <api_key> header to authenticate.

1. Get your credentials

To obtain an API key for the AROYA REST API, you must contact AROYA customer support directly. It is recommended that you create a dedicated 'API User' account within your AROYA system with restricted permissions limited to the specific data or facilities the integration requires, rather than using a personal administrative account.

2. Add them to .dlt/secrets.toml

[sources.aroya_source] api_key = "your_aroya_api_key_here"

dlt reads this file automatically at runtime. With the harness, the setup-secrets skill prompts you for the values and never handles the raw credential in chat. For production, see setting up credentials with dlt.


What AROYA data can I load into DuckDB?

These are the AROYA endpoints dlt can load into DuckDB:

ResourceEndpointMethodData selectorDescription
devicespublic_api/devices/GETRetrieve list of devices
device_detailpublic_api/devices/{id}/GETRetrieve details for a specific device
facilitiespublic_api/facilities/GETRetrieve list of facilities
facility_detailpublic_api/facilities/{id}/GETRetrieve details for a specific facility
roomspublic_api/rooms/GETRetrieve list of rooms

How do I load only new AROYA records?

The AROYA API reference does not document a timestamp or sequence field for these endpoints, so there is nothing to advertise here as verified. Pick a field from the endpoints table above that increases with every write, then set it as the cursor_path.

{"name": "devices", "endpoint": { "path": "public_api/devices/", # Replace with a field that increases on every write. "incremental": {"cursor_path": "REPLACE_ME", "initial_value": "2024-01-01T00:00:00Z"}, }}

On the first run dlt loads everything from initial_value; on every run after that it requests only what changed and appends with write_disposition="merge" if you set a primary key. See incremental loading.


What does the generated AROYA pipeline look like?

A standard dlt REST API pipeline — the same code you would write by hand, loading /facilities and /devices from the AROYA API into DuckDB:

import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def aroya_source(access_token=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://api.aroya.io/public_api/", "auth": {"type": "bearer", "token": access_token}, }, "resources": [ {"name": "devices", "endpoint": {"path": "public_api/devices/"}}, {"name": "facilities", "endpoint": {"path": "public_api/facilities/"}} ], } yield from rest_api_resources(config) def load_aroya_to_duckdb() -> None: pipeline = dlt.pipeline( pipeline_name="aroya_pipeline", destination="duckdb", dataset_name="aroya_data", ) load_info = pipeline.run(aroya_source()) print(load_info) if __name__ == "__main__": load_aroya_to_duckdb()

Run it with python aroya_pipeline.py. The agent iterates on this until it loads cleanly — you review and approve, rather than write it from scratch.


How do I query AROYA data in DuckDB?

dlt creates one table per resource. Query the loaded data with Python or SQL — or ask your agent to, through the MCP server's execute_sql_query tool.

Python (pandas DataFrame):

import dlt data = dlt.pipeline("aroya_pipeline").dataset() df = data.devices.df() print(df.head())

SQL:

SELECT * FROM aroya_data.devices LIMIT 10;

See querying your data with dataset and exploring it in marimo notebooks.


How do I deploy the AROYA to DuckDB pipeline in production?

The pipeline runs locally, which is ideal for prototyping and one-off analysis. When you need it on a schedule, monitored on every load, and shared with your team, deploy the same dlt code on the dltHub platform — no infrastructure to maintain. The prompt above already ends with "run it on dltHub", so your agent can take it there directly.

  • Deploy & schedule — run the pipeline as a managed job with automatic retries.
  • Monitor — observable job queues, alerting, and load metrics for every run.
  • Transform — promote raw AROYA loads into governed, documented models.
  • Visualize & share — explore data in notebooks and publish live dashboards instead of static screenshots.

Book a demo →


What other destinations can I load AROYA data to?

dlt loads into any of these — only the destination argument changes:

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

Set dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. On the dltHub platform the same pipeline runs against a managed Iceberg lakehouse. See the full destinations list.


Next steps

Was this page helpful?

Community Hub

Need more dlt context for AROYA to DuckDB?

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