API documentation

API requests go over HTTPS. The function base URL is https://cpaw.cat/api/cpaw/<func>.json. The format extension is mandatory (.json).

Parameters may be passed in GET or POST. The response is always JSON in UTF-8, and the HTTP response status is always 200.

Placeholder parameters are shown in curly braces throughout: {id} — the auth string, {offer} — an offer ID, {network} — a network ID. In real requests do not use the curly braces — only the values themselves.

Authentication

The key is passed in the id parameter as <userid>-<key>:

• <userid> — your numeric user ID;
• <key> — your personal API key.

A successful response has status: ok and the payload in data:

{
    "status": "ok",
    "data": { "...": "..." }
}

The offers function additionally returns a navigation block nav alongside it — its fields are described in that section. The others return everything at once, with no pagination.

On error the response has status: error and an error field with the error code:

{
    "status": "error",
    "error": "auth"
}

Common error codes:

• auth — the API key is invalid;
• ban — the user is banned;
• access — access to the requested resource is denied;
• request — malformed request (e.g. the format extension is missing);
• not-found — the requested object was not found.

Each function may also return its own error codes, described in its section.

Event type IDs are used in the requests and responses of the feed and offer functions:

Returns feed events for the given period. Up to 1000 events per response, sorted newest first (by descending id).

Parameters

Response

The data field is an array of events (the feed is time-ordered). Fields of each event:

{
    "status": "ok",
    "data": [
        {
            "id": 35400, "time": 1573291851, "tid": 4,
            "nid": 16, "oid": 6113, "gid": 19304,
            "date": "2019-11-09 09:30:51", "type": "New goal",
            "network": "Admitad", "offer": "Edadeal [CPI, Android] RU",
            "goal": "Install on Android",
            "value": false, "old": false,
            "url": "https://cpaw.cat/offer/6113", "my": false
        }
    ]
}

Lists the networks available to work with. No input parameters. data is an object keyed by network ID; each value has:

{
    "status": "ok",
    "data": {
        "2": {
            "id": 2, "name": "Admitad", "domain": "www.admitad.com",
            "offer": true, "fav": true, "prio": 100,
            "geo": { "ru": "Russia", "de": "Germany" },
            "auths": [ "user", "key" ],
            "subscribed": true, "level": 2
        }
    }
}

Lists offers: the global catalog, private offers, subscriptions. Search by URL, name, or similar offers.

Parameters

Response

The data field is an object of offers (keyed by offer ID), with a navigation block nav alongside it for pagination:

Offer fields:

{
    "status": "ok",
    "data": {
        "2861": {
            "id": 2861, "active": true, "name": "AB Gymnic belt",
            "info": "https://cpaw.cat/offer/2861", "nid": 6, "network": "M1 Shop",
            "url": "http://m1-shop.ru/myoffers/add/453", "add": true,
            "time": 1571411245, "date": "2019-10-18 15:07:25", "first": 1571411245,
            "sub": true, "now": false, "goal": 3, "goals": 5,
            "geo": { "ru": "Russia", "ua": "Ukraine" },
            "private": false
        }
    },
    "nav": { "total": 100, "page": 1, "pages": 1, "show": 500, "offset": 0 }
}

Shows everything about a single offer. Locate the offer three ways:

• by offer — the offer ID on the WatchCat side (the only way for a private offer);
• by url — the offer URL in the affiliate network (public only);
• by network + uid — the network ID and the offer ID on its side (public only).

Parameters

If the offer isn't found — error not-found. On success data holds the offer fields (the same as in offers), plus:

Goal fields (goal):

Change fields (change): id, time, tid, gid, date, type, goal, value, old (see feed).

{
    "status": "ok",
    "data": {
        "id": 2874, "active": true, "name": "Detoxic - anti-parasite remedy",
        "info": "https://cpaw.cat/offer/2874", "nid": 6, "network": "M1 Shop",
        "url": "http://m1-shop.ru/myoffers/add/897", "add": true,
        "time": 1571432786, "date": "2019-10-18 21:06:26", "first": 1571429261,
        "sub": true, "now": false,
        "private": false, "goals": 1, "goalactive": 1,
        "geo": { "tj": "Tajikistan" },
        "goal": {
            "11419": {
                "id": 11419, "active": true, "name": "Tajikistan", "type": "CPS",
                "code": "tj", "geo": "tj", "price": 200, "cash": 350,
                "up": 0, "cross": 0, "percent": 0, "currency": "rub"
            }
        },
        "change": [
            { "id": 24201, "time": 1571432786, "tid": 4, "gid": 11419,
              "date": "2019-10-18 21:06:26", "type": "New goal",
              "goal": "Tajikistan", "value": false, "old": false }
        ]
    }
}

Aggregates for each public network. No input parameters. data holds:

• nets — an array of networks with fields id, name, url (catalog filtered by this network), nomy (the network does not support adding your own offers), domain, offer (offers), goal (goals), change (changes);
• total — grand totals: networks, offers, goals, changes.

{
    "status": "ok",
    "data": {
        "nets": [
            {
                "id": 2, "name": "Admitad",
                "url": "https://cpaw.cat/offers?n=2", "nomy": true,
                "domain": "www.admitad.com", "offer": 5820, "goal": 14310, "change": 92034
            }
        ],
        "total": { "networks": 48, "offers": 99358, "goals": 229257, "changes": 3293186 }
    }
}

Global counters. No input parameters. data:

{
    "status": "ok",
    "data": {
        "net": 48, "nets": 47,
        "offer": 99358, "offers": 42,
        "goal": 229257, "goals": 118,
        "change": 3293186, "changes": 1204
    }
}

Creates a private offer and enables its once-a-day check. The source offer is given one of three ways.

Parameters

On success data holds the id of the added offer (needed for edit / del).

Error codes: not-found — offer/network not found; no-private — the network doesn't support own offers; bad-auth — the network rejected the credentials; error — save failed.

{ "status": "ok", "data": { "id": 1234 } }

Changes the credentials and check frequency. Send only the fields you want to change; only offer is required.

Parameters

On success data holds id and changed — the fields actually changed (empty if a field already had the desired value).

Error codes: bad-id — offer not given; access — the offer isn't yours; edit — save failed.

{ "status": "ok", "data": { "id": 1234, "changed": [ "api" ] } }

Deletes a previously added private offer and its entire check history.

Parameters

Error codes: bad-id — offer not given; access — the offer isn't yours.

{ "status": "ok", "data": { "id": 1234 } }

Adds a subscription to a public offer. Idempotent: a repeat call doesn't create a duplicate, but lets you toggle the instant-notification flag.

Parameters

On success data holds id and the current value of the now flag.

Error codes: bad-id — offer not given; access — the offer is private or the network is unavailable.

{ "status": "ok", "data": { "id": 1234, "now": 1 } }

Removes a subscription to a public offer.

Parameters

Error codes: bad-id — offer not given; access — the offer is private or the network is unavailable.

{ "status": "ok", "data": { "id": 1234 } }

Adds a subscription to a whole affiliate network. Idempotent: a repeat call doesn't create a duplicate, but lets you change the subscription level.

Parameters

On success data holds the network id and the current level.

Error codes: bad-id — network not given; access — the network is unavailable (a private network for a non-VIP user).

{ "status": "ok", "data": { "id": 2, "level": 2 } }

Removes a network subscription. Always allowed (including when the network has become private).

Parameters

Error codes: bad-id — network not given.

{ "status": "ok", "data": { "id": 2 } }