Foreca Python API Docs | dltHub

Foreca Weather API provides global weather data including current conditions, hourly and daily forecasts, and maps for commercial applications. The REST API base URL is https://pfa.foreca.com/api/v1 and 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 Foreca data in under 10 minutes.

---

What data can I load from Foreca?

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

---

How do I authenticate with the Foreca API?

Authentication is performed by obtaining a bearer token from the authorization endpoint and including it in the 'Authorization' header as 'Bearer ' for subsequent requests.

1. Get your credentials

To obtain Foreca API credentials, first sign up for an account at the official Foreca Business Weather API website. Once registered, you will receive access details for your API account via email. Use these credentials to log in to the 'My API' customer portal at developer.foreca.com/manage. Inside the 'My API' portal, you can generate tokens or permanent API keys for authentication.

2. Add them to .dlt/secrets.toml

Copy
[sources.foreca_source]
api_token = "your_generated_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 Foreca 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 foreca_pipeline.py

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

Copy
Pipeline foreca_pipeline load step completed in 0.26 seconds
1 load package(s) were loaded to destination duckdb and into dataset foreca_data
The duckdb destination used duckdb:/foreca.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 location/search and capabilities from the Foreca 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 foreca_source(api_key=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://pfa.foreca.com/api/v1",
            "auth": {"type": "bearer", "token": api_key},
        },
        "resources": [
            {"name": "point_forecast", "endpoint": {"path": "api/v1/forecast/{location_id}"}},
            {"name": "location_search", "endpoint": {"path": "api/v1/location/search/{query}"}}
        ],
    }
    yield from rest_api_resources(config)


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

SQL (DuckDB example):

Copy
SELECT * FROM foreca_data.point_forecast LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("foreca_pipeline").dataset()
data.point_forecast.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 Foreca 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