Postaffiliatepro Python API Docs | dltHub

Post Affiliate Pro is an affiliate marketing platform that provides affiliate tracking, commission management, and reporting via a RESTful API v3. The REST API base URL is https://YOUR_ACCOUNT_DOMAIN.postaffiliatepro.com/api/v3 and all requests require an API key (Bearer token) or OAuth2 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 Postaffiliatepro data in under 10 minutes.

---

What data can I load from Postaffiliatepro?

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

---

How do I authenticate with the Postaffiliatepro API?

API v3 supports Bearer‑style API keys and OAuth2 access tokens. API keys are created in the merchant panel (Configuration > Tools > Integration > API v3) and must be sent in the Authorization header.

1. Get your credentials

1. Log into your Post Affiliate Pro merchant account as an administrator.
2. Navigate: Configuration (or Settings) > Tools > Integration > API v3 (REST API).
3. Open the API v3 management screen; note the displayed API URL for your instance (it will be https://YOUR_ACCOUNT_DOMAIN.postaffiliatepro.com/api/v3).
4. Click Add API key (or Manage API keys).
5. Enter a name, optional expiration, optional IP whitelist, and set Access scopes (read/write per resource).
6. Save and copy the generated API key (it is shown only once after creation). Use this key in the Authorization header when calling the API.

2. Add them to .dlt/secrets.toml

Copy
[sources.postaffiliatepro_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 Postaffiliatepro 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 postaffiliatepro_pipeline.py

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

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

Inspect your pipeline and data:

Copy
dlt pipeline postaffiliatepro_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 affiliates and transactions from the Postaffiliatepro 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 postaffiliatepro_source(api_key=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://YOUR_ACCOUNT_DOMAIN.postaffiliatepro.com/api/v3",
            "auth": {
                "type": "bearer",
                "token": api_key,
            },
        },
        "resources": [
            {"name": "affiliates", "endpoint": {"path": "affiliates"}},
            {"name": "transactions", "endpoint": {"path": "transactions"}}
        ],
    }
    yield from rest_api_resources(config)


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

SQL (DuckDB example):

Copy
SELECT * FROM postaffiliatepro_data.affiliates LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("postaffiliatepro_pipeline").dataset()
data.affiliates.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 Postaffiliatepro 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 failures

If requests return 401/403, verify you're using the instance‑specific API URL and that the API key or OAuth token is valid, has the required scopes, and (if configured) your client IP is whitelisted. Regenerate the API key from Configuration > Tools > Integration > API v3 if compromised.

Rate limits and Retry‑After header

API v3 is rate‑limited (default documented: 100 requests per minute). Responses include X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers. When you exceed the limit the API returns 429 Too Many Requests and a Retry-After header with the wait time. Implement backoff and respect the Retry-After value.

Finding exact response data selectors

API v3 publishes an interactive Swagger/OpenAPI UI inside your account (https://YOUR_ACCOUNT_DOMAIN.postaffiliatepro.com/api/v3 or /api/v3/docs). Use the "Try it out" feature on each GET endpoint to inspect the exact JSON response body and confirm the data selector that contains the records array (some responses use wrappers). Because the API base URL and docs are instance‑specific, always validate selectors in your account before wiring them into production pipelines.

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