CPAlead Publisher API

Publisher API Documentation

Use these APIs to pull offers, check conversions, and download reversals. If you want, you can also use the OpenAPI file below with your own API tools.

OpenAPI JSON Offers API Conversions API Reversals API

This page is public. Replace placeholder values like {PUBLISHER_ID} and {API_KEY} with your own values after you sign in.

Quick Facts

Formats: JSON and JSONP
Offers Default Limit: 2500
Native CPC: Not returned by the Offers API
OpenAPI File: https://www.cpalead.com/api/openapi.json

On This Page

OpenAPI File

You can use this file if you want to import the API into your own tools.

Overview

What this API is designed for

Offer Sync

Pull available offers, filter by device or country, and use updated_since for incremental refreshes.

Tracking Safety

The Offers API never returns native CPC offers. Boost-click offers can appear, but they keep their normal rank.

OpenAPI File

The public OpenAPI file is available at /api/openapi.json .

Offers API

Available offers ki JSON list return karta hai. Featured offers pehle dikh sakate hain. Uske baad, kam offer_rank values pehle dikhengi.

Ranking & Country Payouts

Har offer mein ek offer_rank hotaa hai jahan 1 sabse upar rank wala offer hai. Featured offers pehle aa sakate hain. Uske baad, results kam se zyaada offer_rank order mein rahte hain.
Kuch offers desh ke hisab se alag raashi chukate hain. Agar ek offer mein "payouts_per_country" list hai, to user ke do letter country code (jaise, US, CA, GB) se match karne wali payout ka upyog karo. Agar unka country list mein nahi hai, to "amount" mein dikhai gayi default payout ka upyog karo.

Offer API Notes

CPC offers is API dwara return nahi kiye jaate.
Agar ek offer mein boost clicks hain, to ye phir bhi apni normal rank banaye rakhta hai. Sirf boost clicks hone ki wajah se isey top par nahi bheja jaata.
API dwara return ki gayi exact link ka upyog karne se best attribution banaye rakhta hai. Agar aap apne system mein links save ya rebuild karte ho, to clicks phir bhi kaam karte hain.

Endpoint

https://www.cpalead.com/api/offers?id={PUBLISHER_ID}

Available HTTP query parameters

HTTP Parameter	Description
id	Required. Your publisher ID.
country	Sirf is country ke offers dikhाओ, do letter ISO country code pass karo Use `country=user` taaki user ke country ke offers automatically milen
limit	Wapas aane wale offers ki sankhya limit karo. Isse aapke API calls tez ho sakate hain. Default 2500 hai aur maximum 5000 hai.
type	Ye API CPC offers return nahi karta. Default mein ye CPA, CPI, aur CPE offers return karta hai. Aap comma-separated list ke saath CPR ko bhi request kar sakate ho, jaise `&type=cpi,cpe,cpr`
updated_since	Only return offers updated on or after this date. You can use YYYY-MM-DD or a full ISO date and time, for example `&updated_since=2026-04-01T00:00:00Z`
fields	Only return the offer fields you need. Use a comma-separated list, for example `&fields=id,title,link,amount,offer_rank` Available fields: `id, title, description, conversion, device, daily_cap, is_fast_pay, link, preview_link, amount, payout_currency, payout_type, countries, epc, creatives, offer_rank, payouts_per_country`
offerwall_offers	Boolean (true\|false). Agar aap offerwalls ke liye mark kiye gaye offers bhi chahte ho to true ka upyog karo. CPC offers phir bhi bahar rahengi, aur boost-click offers apni normal rank banaye rakhenge.
device	Iska upyog sirf tab karo jab aap automatic device targeting use nahi kar rahe ho. Default mein, API saare device types return kar sakti hai. Sirf kuch device types return karne ke liye is field ka upyog karo. Upalabdh values: ios, android, mobile, aur desktop. Device comma-separated list bhi ho sakta hai, jaise: `&device=ios,android,mobile,desktop` Sirf CPI / CPE offers paane ke liye (jisme conversion ke liye sirf installation chahiye - upyog karo device=ios,android Use `device=user` taaki user ke device ke offers automatically milen
subid / subid2 / subid3	SubID tracking aapko extra data bhejne ki anumati deta hai jab ek user aapke affiliate links par click karta hai aur link ke end par tag pass karke ye parameter aapke tracking link mein subid ko automatically bharta hai. Aap SubIDs ka upyog leads ko segment karne, campaigns optimize karne, aur conversions behtar karne ke liye kar sakate ho, yahan kuch udaharans hain: Sub-Affiliate IDs, Sources (Organic, PPC, Email etc), Keywords, Locations, etc... Extra data ke liye ek doosra subid variable Extra data ke liye ek teesra subid variable
gaid / idfa	Agar aapke paas mobile ke liye Google Advertising ID (GAID) hai, to is variable ka upyog karke tracking link par gaid ko automatically bharo Agar aapke paas mobile ke liye Apple Identifier For Advertisers (IDFA) hai, to is variable ka upyog karke tracking link par idfa ko automatically bharo
format / callback	JSON ya JSONP format. JSON default hai JSONP callback function naam. Sirf JSONP format ke liye upyog hota hai. Agar jQuery getJSON use kar rahe ho, to callback=? ka upyog karo aur jQuery automatically function naam bharega. JSONP udaharan dekho

Pratikriya udaharan

{
    "status": "success",
    "number_offers": 2,
    "country": "US",
    "devices": null,
    "offers": [
        {
            "id": 999001,
            "title": "QuizBlitz Pro",
            "description": "Test your knowledge and win rewards!",
            "conversion": "Complete Level 5 (New Users Only)",
            "device": "android",
            "daily_cap": 50,
            "is_fast_pay": true,
            "link": "https://{tracking_domain}/view.php?id=999001&pub={PUBLISHER_ID}&_src=api&_src_sig={SIGNATURE}",
            "preview_link": "https://example.com/offerblast",
            "amount": 1.2,
            "payout_currency": "USD",
            "payout_type": "CPE",
            "countries": [
                "US",
                "CA",
                "GB",
                "AU",
                "NZ"
            ],
            "epc": 0.95,
            "creatives": {
                "url": "https://{assets_domain}/images/offerblast.png"
            },
            "offer_rank": 7,
            "payouts_per_country": {
                "US": 1.2,
                "CA": 1.1,
                "GB": 0.9
            }
        },
        {
            "id": 999002,
            "title": "PhotoMaster Lite",
            "description": "Edit photos with one tap.",
            "conversion": "Install, open & keep for 2 days (New Users Only)",
            "device": "ios",
            "daily_cap": 100,
            "is_fast_pay": false,
            "link": "https://{tracking_domain}/view.php?id=999002&pub={PUBLISHER_ID}&_src=api&_src_sig={SIGNATURE}",
            "preview_link": "https://example.com/photomaster",
            "amount": 0.85,
            "payout_currency": "USD",
            "payout_type": "CPI",
            "countries": [
                "US"
            ],
            "epc": 1.1,
            "creatives": {
                "url": "https://{assets_domain}/images/photomaster.png"
            },
            "offer_rank": 12
        }
    ]
}

Code udaharan

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>CPAlead Offers API Example</title>
</head>
<body>
    <div id="offer-list">Loading offers...</div>

document.getElementById("offer-list").innerHTML = html || "No offers found.";
            })
            .catch(() => {
                document.getElementById("offer-list").innerText = "Failed to load offers.";
            });
    </script>
</body>
</html>

Conversions API

Limit: 1 anurodh prati minute
Conversion API aapko CPAlead ko conversions test karne ke liye ping karne ki suvidha deta hai, jo custom apps banane ke liye upyogi hai. Subid ko subid ya ip address ke roop mein pass karo, ya "user" taaki hamaari system is script ko call karne wale client ke ip address ka upyog kare (JSONP calls ke liye upyogi)
Push-type conversion service (Server-to-Server Postback) ke liye, hamaari Postback Documentation dekho

Endpoint

https://www.cpalead.com/api/conversions?id={PUBLISHER_ID}&api_key={API_KEY}

Available HTTP query parameters

HTTP Parameter	Description
id	Required. Your publisher ID.
api_key	Required. Your API key.
subid	Required. Subid ke aadhaar par conversion lookup karo, subid ya users ke ip address ko pass karo, "user" pass karke is script ko call karne wale client ke ip address ka upyog karo (JSONP calls ke liye upyogi)
offer_id	Optional. Sirf is offer (campaign) id ke liye conversion check karega
format / callback	JSON ya JSONP format. JSON default hai JSONP callback function naam. Sirf JSONP format ke liye upyog hota hai. Agar jQuery getJSON use kar rahe ho, to callback=? ka upyog karo aur jQuery automatically function naam bharega. JSONP udaharan dekho

Pratikriya udaharan

Reversals API

Limit: 1 anurodh prati minute
Is API ka upyog karke do dates ke beech apni bad leads ki list download karo. Buri traffic ko alag karne ke liye upyogi

Endpoint

https://www.cpalead.com/api/reversals?id={PUBLISHER_ID}&api_key={API_KEY}

Available HTTP query parameters

HTTP Parameter	Description
id	Required. Your publisher ID.
api_key	Required. Your API key.
start_date	Bad leads pull karne ke samay upyog karne wali shuruati date. Format: yyyy-mm-dd
end_date	Bad leads pull karne ke samay upyog karne wali antim date. Ek samay mein adhiktam ek mahina pull kiya ja sakta hai
format / callback	JSON ya JSONP format. JSON default hai JSONP callback function naam. Sirf JSONP format ke liye upyog hota hai. Agar jQuery getJSON use kar rahe ho, to callback=? ka upyog karo aur jQuery automatically function naam bharega. JSONP udaharan dekho

Pratikriya udaharan