Orange Business Eligibility API Python API Docs | dltHub

Orange Business Eligibility API is a service that allows Orange Business customers to search and retrieve eligibility for copper and fiber products and mobile coverage based on address, IMB code, GPS coordinates and other criteria. The REST API base URL is https://api.orange.com/eligibility/b2b/v1/ and Requests require either an X‑Api‑Key header or an OAuth2 Bearer token..

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 Orange Business Eligibility API data in under 10 minutes.

---

What data can I load from Orange Business Eligibility API?

Here are some of the endpoints you can load from Orange Business Eligibility API:

---

How do I authenticate with the Orange Business Eligibility API API?

The API can be accessed with an X‑Api‑Key header (provided to Orange Business customers) or with an OAuth2 Bearer token obtained from https://api.orange.com/oauth/v3/token. Include the token in the Authorization: Bearer header.

1. Get your credentials

1. Log in to the Orange Business developer portal.
2. Navigate to the "My APIs" or "Credentials" section.
3. Locate the Orange Business Eligibility API and request an API key (X‑Api‑Key). This key is shown on the page.
4. For OAuth2, note the client_id and client_secret associated with the API.
5. Call the token endpoint https://api.orange.com/oauth/v3/token with grant_type=client_credentials, client_id and client_secret to obtain an access_token (valid for 60 minutes).

2. Add them to .dlt/secrets.toml

Copy
[sources.orange_business_eligibility_api_source]
api_key = "your_api_key_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 venv && source .venv/bin/activate
uv pip install "dlt[workspace]"

1. Install the dlt AI Workbench:

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

Copy
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 Orange Business Eligibility API 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
python orange_business_eligibility_api_pipeline.py

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

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

Inspect your pipeline and data:

Copy
dlt pipeline orange_business_eligibility_api_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 poi and coverage from the Orange Business Eligibility API 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 orange_business_eligibility_api_source(api_key=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://api.orange.com/eligibility/b2b/v1/",
            "auth": {
                "type": "api_key",
                "api_key": api_key,
            },
        },
        "resources": [
            {"name": "poi", "endpoint": {"path": "poi"}},
            {"name": "coverage", "endpoint": {"path": "coverage"}}
        ],
    }
    yield from rest_api_resources(config)


def get_data() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="orange_business_eligibility_api_pipeline",
        destination="duckdb",
        dataset_name="orange_business_eligibility_api_data",
    )
    load_info = pipeline.run(orange_business_eligibility_api_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("orange_business_eligibility_api_pipeline").dataset()
sessions_df = data.poi.df()
print(sessions_df.head())

SQL (DuckDB example):

Copy
SELECT * FROM orange_business_eligibility_api_data.poi LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("orange_business_eligibility_api_pipeline").dataset()
data.poi.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 Orange Business Eligibility API 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.

---

Troubleshooting

Authentication Errors

• 401 Unauthorized – Occurs when the X‑Api‑Key header is missing or the OAuth2 Bearer token is absent, expired, or invalid. Obtain a valid API key or renew the token using the token endpoint.

Missing Accept Header

• 406 Not Acceptable – The API requires the Accept: application/json header. If omitted, the request will be rejected with a 406 error.

No POI Found

• 404 Not Found – Returned when the query parameters do not match any Point‑of‑Interest records.

Token Lifetime

• Access tokens are valid for 60 minutes. After expiration, requests will fail with 401 and a new token must be requested.

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.

Copy
dlt ai toolkit data-exploration install
dlt ai toolkit dlthub-runtime install

• 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