JotUrl Python API Docs | dltHub
Build a JotUrl-to-database pipeline in Python using dlt with AI Workbench support for Claude Code, Cursor, and Codex.
Last updated:
JotUrl API documentation provides authentication via session tokens and examples for API calls. Jotform API allows access to forms and submissions, requiring an API key for usage. JotURL API Lab enables testing scripts for JotUrl API. The REST API base URL is https://joturl.com/a/i1/ and All requests require a session token or an API token; API tokens are provided as Bearer tokens..
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 JotUrl data in under 10 minutes.
What data can I load from JotUrl?
Here are some of the endpoints you can load from JotUrl:
| Resource | Endpoint | Method | Data selector | Description |
|---|---|---|---|---|
| urls_list | a/i1/urls/list | GET | result.data | List tracking links (data array in result.data) |
| urls_preview_info | a/i1/urls/preview/info | GET | result | Get preview metadata (title/description/image) in result |
| urls_timing_info | a/i1/urls/timing/info | GET | result | Get timing/validity of a short URL |
| urls_deeplinks_templates_list | a/i1/urls/deeplinks/templates/list | GET | result | List deep link templates (fields param selectable) |
| urls_deeplinks_templates_urls_get | a/i1/urls/deeplinks/templates/urls/get | GET | result | Get template associated with a tracking link |
| remarketings_urls_list | a/i1/remarketings/urls/list | GET | result.data | List tracking links linked to remarketing pixel |
| cdns_links_get | a/i1/cdns/links/get | GET | result.data | Get CDN resource associations (result.data is object) |
| stats_ctas_get | a/i1/stats/ctas/get | GET | result.summary_snapshot | Stats charts returned under result (e.g., summary_snapshot) |
| users_login | a/i1/users/login | GET/POST | result | Obtain session_id (write operation) |
| apis_tokens | a/i1/apis/tokens or users/tokens | GET/POST | result | Returns read_only_token, read_write_token in result |
How do I authenticate with the JotUrl API?
JotUrl supports two auth flows: (1) Session authentication: obtain a session_id by calling users/login with username and HMAC_SHA256(password) computed from PRIVATE_KEY and PUBLIC_KEY with current GMT datetime; use returned session_id to sign further requests. (2) API token authentication: create tokens via users/tokens (requires session login) and then send Authorization: Bearer {token} header for subsequent requests. Read-only and read-write tokens available.
1. Get your credentials
- Log into JotUrl dashboard. 2) Retrieve PUBLIC_KEY and PRIVATE_KEY from https://www.joturl.com/reserved/settings.html. 3) Generate HMAC_SHA256(PRIVATE_KEY, PUBLIC_KEY + ':' + GMT_DATETIME) and call https://joturl.com/a/i1/users/login?username={EMAIL}&password={PASSWORD} to get session_id. 4) (Optional) Call https://joturl.com/a/i1/users/tokens to obtain read_only_token or read_write_token; use Authorization: Bearer {token} for API calls.
2. Add them to .dlt/secrets.toml
[sources.joturl_source] api_token = "your_read_only_or_read_write_token" public_key = "your_public_key" private_key = "your_private_key" username = "your_joturl_email"
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 JotUrl 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 joturl_pipeline.py
If everything is configured correctly, you'll see output like this:
Pipeline joturl_pipeline load step completed in 0.26 seconds 1 load package(s) were loaded to destination duckdb and into dataset joturl_data The duckdb destination used duckdb:/joturl.duckdb location to store data Load package 1749667187.541553 is LOADED and contains no failed jobs
Inspect your pipeline and data:
dlt pipeline joturl_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 urls and users from the JotUrl 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 joturl_source(api_token=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://joturl.com/a/i1/", "auth": { "type": "bearer", "token": api_token, }, }, "resources": [ {"name": "urls", "endpoint": {"path": "a/i1/urls/list", "data_selector": "result.data"}}, {"name": "users", "endpoint": {"path": "a/i1/users/login", "data_selector": "result"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="joturl_pipeline", destination="duckdb", dataset_name="joturl_data", ) load_info = pipeline.run(joturl_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("joturl_pipeline").dataset() sessions_df = data.urls.df() print(sessions_df.head())
SQL (DuckDB example):
SELECT * FROM joturl_data.urls LIMIT 10;
In a marimo or Jupyter notebook:
import dlt data = dlt.pipeline("joturl_pipeline").dataset() data.urls.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 JotUrl 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 JotUrl?
Request dlt skills, commands, AGENT.md files, and AI-native context.