CPAlead Publisher API Documentation

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

Most accounts do not receive 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 .

01

Offers API

Returns a JSON list of available offers. Lower offer_rank values show first.

Ranking & Country Payouts

Each offer includes an offer_rank where 1 is the highest ranked offer. Results stay in offer_rank order from low to high.
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.
Some offers pay by event. If an offer includes an "events" list, use each event name, description, and amount for the completed event. Event amounts are already adjusted to your publisher payout split.

Offer API Notes

Most accounts do not receive native CPC offers. If CPAlead enables CPC API access for your account, native CPC offers can appear and the amount field is your publisher payout.
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.
If CPAlead enables CPC API access for your publisher account, native CPC offers can appear in the Offers API. Boosted CPA, CPI, or CPE offers can also include publisher-only CPC rewards.
For native CPC offers, use the amount field. For boosted offers, boost_click_balance shows the remaining boost clicks. The API shows cpc_reward_type, cpc_payout_us, cpc_payout_not_us, or both payout fields based on the offer target countries. CPC API rewards do not fire publisher postbacks.

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	By default this API returns CPA, CPI, and CPE offers. Publishers with CPC API access can also receive native CPC offers and boosted offers with CPC rewards. You can request payout types with a comma-separated list, for example `&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	Sirf wo offer fields return karo jo aapko chahiye. Comma-separated list ka upyog karo, jaise `&fields=id,title,link,amount,offer_rank` Available fields: `id, title, description, long_description, conversion, device, daily_cap, is_fast_pay, link, preview_link, amount, payout_currency, payout_type, countries, epc, creatives, offer_rank, payouts_per_country, events, cpc_reward_type, cpc_payout_us, cpc_payout_not_us, boost_click_balance` Use "description" for the short offer description. Use "long_description" when you want the longer marketplace description.
include_long_description	Set this to 0 or false to leave long_description out of the default Offers API response. If your fields list includes long_description, it will still be returned. `&include_long_description=0`
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 lets you pass extra data into CPAlead tracking links. CPAlead stores the value with clicks and conversions and returns it in publisher postbacks when available. If you do not pass subid, CPAlead will not add one automatically. Use a user ID, wallet ID, or click reference when you need to credit a specific visitor. You can also use a shared value for a page, site, sub-affiliate, keyword, or traffic source, but shared values are for reporting and segmentation and cannot identify one visitor for rewards. 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!",
            "long_description": "Play QuizBlitz Pro, answer trivia questions, and complete the required level to earn your reward.",
            "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
            },
            "events": [
                {
                    "key": "event_1",
                    "name": "Event 1",
                    "description": "Install and open the app.",
                    "amount": 0.7,
                    "payout_currency": "USD"
                },
                {
                    "key": "event_2",
                    "name": "Event 2",
                    "description": "Reach level 5.",
                    "amount": 1.2,
                    "payout_currency": "USD"
                }
            ]
        },
        {
            "id": 999002,
            "title": "PhotoMaster Lite",
            "description": "Edit photos with one tap.",
            "long_description": "Install PhotoMaster Lite, try the editing tools, and keep the app installed for the required period.",
            "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,
            "events": []
        }
    ]
}

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>

02

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

03

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