Open Gateway by Telefonica Python API Docs | dltHub

Build a Open Gateway by Telefonica-to-database pipeline in Python using dlt with AI Workbench support for Claude Code, Cursor, and Codex.

Last updated:

Open Gateway by Telefonica is a GSMA-backed set of RESTful telecom network APIs exposed via aggregators and Telefonica's Developer Hub. The REST API base URL is https://sandbox.opengateway.telefonica.com/apigateway/token and All requests require an OAuth 2.0 access token for authentication..

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 Open Gateway by Telefonica data in under 10 minutes.


What data can I load from Open Gateway by Telefonica?

Here are some of the endpoints you can load from Open Gateway by Telefonica:

ResourceEndpointMethodData selectorDescription
number_verification/verifyPOSTVerifies if the received hashed/plain text phone number matches the phone number associated with the access token
device_phone_number/device-phone-numberGETReturns the phone number associated with the access token
device_location/location/v0/verifyPOSTExecute location verification for a user equipment
token/tokenPOSTRetrieve access tokens

How do I authenticate with the Open Gateway by Telefonica API?

Authentication uses OAuth 2.0. An access token is obtained from the /token endpoint using basic authentication with client_id and client_secret. This access_token must then be sent in the Authorization: Bearer <access_token> header for all subsequent API calls.

1. Get your credentials

To obtain API credentials, join the Developer Hub and create an application within the Sandbox environment. Navigate to 'My Apps' in the Sandbox to retrieve your client_id and client_secret.

2. Add them to .dlt/secrets.toml

[sources.open_gateway_telefonica_source] client_id = "your_client_id_here" client_secret = "your_client_secret_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 Open Gateway by Telefonica 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 open_gateway_telefonica_pipeline.py

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

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

Inspect your pipeline and data:

dlt pipeline open_gateway_telefonica_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 number_verification and device_location from the Open Gateway by Telefonica 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 open_gateway_telefonica_source(client_id, client_secret=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://sandbox.opengateway.telefonica.com/apigateway/token", "auth": { "type": "bearer", "access_token": client_id, client_secret, }, }, "resources": [ {"name": "number_verification", "endpoint": {"path": "verify"}}, {"name": "device_location", "endpoint": {"path": "location/v0/verify"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="open_gateway_telefonica_pipeline", destination="duckdb", dataset_name="open_gateway_telefonica_data", ) load_info = pipeline.run(open_gateway_telefonica_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("open_gateway_telefonica_pipeline").dataset() sessions_df = data.number_verification.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM open_gateway_telefonica_data.number_verification LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("open_gateway_telefonica_pipeline").dataset() data.number_verification.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 Open Gateway by Telefonica 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.


Troubleshooting

Authentication Failures

Authentication failures can occur if the client_id or client_secret used to obtain the access token are incorrect, or if the access_token itself is invalid or expired. Ensure that the Authorization: Bearer <access_token> header is correctly formatted and that the token is still valid.

Missing or Invalid Scope

When requesting credentials, specific scope/purpose strings are required. If the requested scope is missing or invalid, API calls may fail. Examples of required purpose strings include dpv:FraudPreventionAndDetection and dpv:GeneralQAPurpose. Verify that the correct purpose strings are used during credential setup.

Ensure that the API key is valid to avoid 401 Unauthorized errors. Also, verify endpoint paths and parameters to avoid 404 Not Found errors.


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 Open Gateway by Telefonica?

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