Partner API / Live stream

Live stream

One open WebSocket that pushes your clicks, filtered clicks and sales the moment they happen. For live dashboards, bots and alerts, without polling.

Parameters

Both go in the address (?events=click,conversion.created&since=...) or in the auth message. Never put the key in the address: it is refused.

Connect

From a server, send the key as a header. A browser cannot set headers, so it sends {"type":"auth","key":"..."} as its first message, within 10 seconds. Keep the key on your server where you can: anyone who has it can read your figures.

const ws = new WebSocket("wss://api.affiliatepipe.com:2053/v1/stream");
ws.onopen = () => ws.send(JSON.stringify({ type: "auth", key: process.env.AP_KEY }));
ws.onmessage = (e) => {
  const ev = JSON.parse(e.data);
  if (ev.type === "conversion.created") console.log("Sale on", ev.data.domain, ev.data.commission / 100);
};
ws.onclose = (e) => setTimeout(connect, 3000);   // reconnect with since= to catch up

import asyncio, json, os, websockets   # pip install websockets

async def main():
    url = "wss://api.affiliatepipe.com:2053/v1/stream?events=click,conversion.created"
    async with websockets.connect(url, additional_headers={"Authorization": "Bearer " + os.environ["AP_KEY"]}) as ws:
        async for msg in ws:
            ev = json.loads(msg)
            print(ev["type"], ev.get("data", {}).get("domain"))

asyncio.run(main())

curl -i -N --http1.1 \
  -H "Connection: Upgrade" -H "Upgrade: websocket" \
  -H "Sec-WebSocket-Version: 13" -H "Sec-WebSocket-Key: $(openssl rand -base64 16)" \
  -H "Authorization: Bearer $AP_KEY" \
  https://api.affiliatepipe.com:2053/v1/stream

Messages

Every message is one JSON object with a type. After the key is accepted you get ready, then events as they happen. Replayed events carry "replay": true.

{"type": "ready", "events": ["click", "click.filtered", "conversion.created", "conversion.approved", "conversion.paid", "conversion.clawed_back"], "replayed": 0, "ping_seconds": 25}

Every event

conversion.created

{
    "type": "conversion.created",
    "data": {
        "id": 412,
        "domain": "greyhoundapi.com",
        "amount": 4900,
        "commission": 490,
        "currency": "usd",
        "status": "pending",
        "recurring": true,
        "created_at": "2026-10-20T09:21:11Z"
    }
}

conversion.approved

{
    "type": "conversion.approved",
    "data": {
        "id": 412,
        "domain": "greyhoundapi.com",
        "amount": 4900,
        "commission": 490,
        "currency": "usd",
        "status": "approved",
        "recurring": true,
        "created_at": "2026-10-20T09:21:11Z"
    }
}

conversion.paid

{
    "type": "conversion.paid",
    "data": {
        "id": 412,
        "domain": "greyhoundapi.com",
        "amount": 4900,
        "commission": 490,
        "currency": "usd",
        "status": "paid",
        "recurring": true,
        "created_at": "2026-10-20T09:21:11Z"
    }
}

conversion.clawed_back

{
    "type": "conversion.clawed_back",
    "data": {
        "id": 412,
        "domain": "greyhoundapi.com",
        "amount": 4900,
        "commission": 490,
        "currency": "usd",
        "status": "clawed_back",
        "recurring": true,
        "created_at": "2026-10-20T09:21:11Z"
    }
}

click

{
    "type": "click",
    "data": {
        "id": "clk_9f2a41c07be3d855e1a0",
        "domain": "greyhoundapi.com",
        "country": "GB",
        "device": "desktop",
        "referrer_host": "reddit.com",
        "utm_source": "reddit",
        "utm_medium": "social",
        "utm_campaign": "october",
        "created_at": "2026-10-20T09:14:02Z"
    }
}

click.filtered

{
    "type": "click.filtered",
    "data": {
        "id": "clk_4b70e2a19c38f6d02e5b",
        "domain": "greyhoundapi.com",
        "country": "US",
        "device": "bot",
        "referrer_host": null,
        "utm_source": null,
        "utm_medium": null,
        "utm_campaign": null,
        "created_at": "2026-10-20T09:14:40Z",
        "reason": "bot"
    }
}

conversion.* data is the same as the webhook events. Money is in cents.

Staying connected

• We send a WebSocket ping every 25 seconds; any client library answers it. You can also send {"type":"ping"} and get pong.
• The stream restarts about once an hour and closes with code 1012. Reconnect after a few seconds with since set to your last event's time, and nothing is missed.
• Close codes: 4001 wrong, missing or revoked key, or a paused account; 4029 more than 3 streams on one key.
• For sales you must never miss, use webhooks as well: they are retried for a day if you are offline.