Proximi Python API Docs | dltHub

Proximi.io is a location-based services and proximity platform that provides a core REST API for managing geofences, places, and events. The REST API base URL is https://api.proximi.fi/v5/geo and all requests require a Bearer token in the Authorization header.

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

---

What data can I load from Proximi?

Here are some of the endpoints you can load from Proximi:

---

How do I authenticate with the Proximi API?

All requests must include an Authorization header with the value 'Bearer YOUR_TOKEN', where YOUR_TOKEN is your API key (Master or Mobile token). For requests that post JSON data, the 'Content-Type: application/json' header should also be included.

1. Get your credentials

To obtain your API credentials, log in to the Proximi.io web portal. Navigate to the 'Applications' section in the left-hand menu. Select the specific application for which you need the token; clicking the key will open a new window where you can copy the API token. Note that there are two types of tokens: 'Master' tokens (required for REST API calls involving create/delete/update operations) and 'Mobile' tokens (read-only for core objects).

2. Add them to .dlt/secrets.toml

Copy
[sources.proximi_source]
api_key = "your_proximi_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:

Copy
uv init
uv add "dlt[hub]"

1. Install the dlt AI harness:

Copy
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:

Copy
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 Proximi 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:

Copy
uv run python proximi_pipeline.py

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

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

Inspect your pipeline and data:

Copy
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 /core/applications and /core/events from the Proximi API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:

Copy
import dlt
from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources

@dlt.source
def proximi_source(token=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://api.proximi.fi/v5/geo",
            "auth": {"type": "bearer", "token": token},
        },
        "resources": [
            {"name": "applications", "endpoint": {"path": "core/applications"}},
            {"name": "events", "endpoint": {"path": "core/events"}}
        ],
    }
    yield from rest_api_resources(config)


def get_data() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="proximi_pipeline",
        destination="duckdb",
        dataset_name="proximi_data",
    )
    load_info = pipeline.run(proximi_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):

Copy
import dlt

data = dlt.pipeline("proximi_pipeline").dataset()
sessions_df = data.applications.df()
print(sessions_df.head())

SQL (DuckDB example):

Copy
SELECT * FROM proximi_data.applications LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("proximi_pipeline").dataset()
data.applications.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 Proximi data to?

dlt supports loading into any of these destinations — only the destination parameter changes:

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.

Copy
uv run dlthub ai toolkit install data-exploration
uv run dlthub ai toolkit install dlthub-platform

• How to deploy a pipeline
• How to explore your data in marimo Notebooks
• How to query your data in Python with dataset
• Join the dlt community on Slack