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

Advertiser campaigns manage karna chahte hain?

Is page par Publisher API offers retrieve karne aur publisher reporting ke liye hai. Advertisers alag Campaign API se self-serve campaigns ko validate, create, edit, start aur pause kar sakte hain, AI agent ki madad ke saath bhi.

Advertiser Campaign API guide padhein

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
CPC API Access: केवल भुगतान कर चुके CPAlead Premium सदस्यों के लिए
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

CPC और बूस्ट क्लिक से कमाई के लिए भुगतान की गई CPAlead Premium सदस्यता और चालू CPC API एक्सेस ज़रूरी है। बूस्ट वाले ऑफ़र अपनी सामान्य रैंक पर ही रहते हैं।

OpenAPI File

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

Offers API

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

आपका CPC API एक्सेस

अपना एक्सेस देखने के लिए साइन इन करें

क्लिक रिवॉर्ड अस्थायी रूप से क्यों रुक सकते हैं

अगर आपके ट्रैफ़िक से बार-बार क्लिक आते हैं लेकिन पर्याप्त योग्य CPA या CPI कन्वर्ज़न नहीं होते, तो CPC ऑफ़र और बूस्ट क्लिक रिवॉर्ड अस्थायी रूप से सीमित हो सकते हैं। इससे विज्ञापनदाताओं को बॉट और अमान्य ट्रैफ़िक से बचाने में मदद मिलती है।

इस रोक के दौरान नेटिव CPC ऑफ़र और बूस्ट-क्लिक रिवॉर्ड फ़ील्ड आपकी API फ़ीड में छिपा दिए जाते हैं। योग्य CPA या CPI कन्वर्ज़न होने पर रोक अपने आप हट जाती है। योग्य कन्वर्ज़न ऑफ़र उपलब्ध रहते हैं। उपलब्धता अपडेट करने के लिए अपनी पूरी ऑफ़र फ़ीड रीफ़्रेश करें; क्लिक की पात्रता की अन्य जाँचें लागू रहती हैं।

CPC पात्रता की स्थिति

हर सफल ऑफ़र जवाब में cpc_eligibility होता है, भले ही कोई ऑफ़र न मिले या fields इस्तेमाल हो। access_enabled आपके खाते की अनुमति बताता है। status की वैल्यू not_enabled, eligible, conversion_limited या unavailable होती है। native_cpc_available और boost_click_rewards_available बताते हैं कि ये रिवॉर्ड आपके खाते के लिए अभी उपलब्ध हैं या नहीं।

हर सिंक पर इन वैल्यू की तुलना करें। इनके बदलने पर updated_since के बिना पूरी फ़ीड रीफ़्रेश करें और सेव की गई ऑफ़र सूची बदलें। यह स्थिति हर क्लिक के रिवॉर्ड की गारंटी नहीं देती; क्लिक की अन्य जाँचें लागू रहती हैं।

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.
CPA and CPI offers with conversion_mode=events pay each listed event once. The offer amount is the maximum total reward; events.amount is the reward for that event. Complete events within 30 days of the original click. The daily cap counts new acquisitions on the day of their first paid event.
CPT (Cost Per Task) offers use screenshot verification. Send visitors to the returned offer link for instructions and My Tasks. Each task pays after approval; the events list shows the publisher rewards. Lockers unlock only after every required task is confirmed.
इवेंट ऑफर पर लौटते समय वही subid या विज्ञापन ID इस्तेमाल करें। हम मूल क्लिक और उसकी 30 दिन की समय सीमा रखते हैं। ऑफर फिर खोलने से वह दोबारा शुरू नहीं होता। बिना ID वाले सीधे लिंक ब्राउज़र कुकी इस्तेमाल करते हैं; ब्राउज़र या ट्रैकिंग डोमेन बदलने या कुकी हटाने से पहचान खो सकती है।
Use lead_id to credit each reward once. Event callbacks and conversion or reversal records include event_key and event_name. A later event has a new lead_id even when it belongs to the same offer and user.

Offer API Notes

API के ज़रिए CPC ऑफ़र और बूस्ट क्लिक रिवॉर्ड केवल उन CPAlead Premium सदस्यों के लिए उपलब्ध हैं जिन्होंने $100 सदस्यता शुल्क का भुगतान किया है और जिनका CPC API एक्सेस चालू है।
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 से मिला लिंक बिल्कुल उसी रूप में इस्तेमाल करें। अपने सिस्टम में ऑफ़र ID से CPAlead ट्रैकिंग लिंक दोबारा न बनाएँ।
CPA, CPI या CPE ऑफ़र पर योग्य बूस्ट क्लिक के लिए अमेरिकी विज़िटर पर $0.10 और अन्य देशों के विज़िटर पर $0.07 मिलता है। रिवॉर्ड के लिए बूस्ट क्लिक बाकी होने चाहिए और क्लिक की पात्रता की सामान्य सीमाएँ लागू रहती हैं।
मूल CPC ऑफ़र के लिए cpc_reward_type का मान native होता है और amount प्रति क्लिक आपका भुगतान है। बूस्ट वाले ऑफ़र के लिए cpc_reward_type का मान boost_click होता है और amount कन्वर्ज़न का भुगतान ही रहता है। boost_click_balance बचे हुए बूस्ट क्लिक दिखाता है। ऑफ़र के लक्षित देशों के अनुसार API cpc_payout_us, cpc_payout_not_us या दोनों लौटाता है। ये क्लिक रिवॉर्ड केवल पब्लिशर को मिलते हैं। इनसे पब्लिशर पोस्टबैक नहीं भेजा जाता और पोस्टबैक के ज़रिए कॉन्टेंट अनलॉक नहीं होता।

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	डिफ़ॉल्ट रूप से यह API CPA, CPI, CPE और CPT ऑफ़र लौटाता है। मूल CPC ऑफ़र और बूस्ट क्लिक रिवॉर्ड के लिए भुगतान की गई CPAlead Premium सदस्यता और चालू CPC API एक्सेस ज़रूरी है। आप कॉमा से अलग की गई सूची में भुगतान के प्रकार माँग सकते हैं, उदाहरण के लिए `&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, review_period_hours, payment_terms_label, payment_terms_description, link, preview_link, amount, payout_currency, payout_type, countries, epc, creatives, offer_rank, payouts_per_country, events, conversion_mode, verification_method, 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,
    "cpc_eligibility": {
        "access_enabled": false,
        "status": "not_enabled",
        "native_cpc_available": false,
        "boost_click_rewards_available": false
    },
    "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",
            "conversion_mode": "single",
            "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",
            "conversion_mode": "single",
            "countries": [
                "US"
            ],
            "epc": 1.1,
            "creatives": {
                "url": "https://{assets_domain}/images/photomaster.png"
            },
            "offer_rank": 12,
            "events": []
        }
    ]
}

Pratikriya udaharan: HTTP 403

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>

बूस्ट क्लिक वाले रिस्पॉन्स का उदाहरण

भुगतान कर चुके और CPC API एक्सेस वाले Premium सदस्य के लिए उदाहरण रिस्पॉन्स। यह CPI ऑफ़र अमेरिका और कनाडा के लिए है, इसलिए दोनों बूस्ट भुगतान फ़ील्ड दिखते हैं। amount कन्वर्ज़न का भुगतान है; CPC फ़ील्ड संभावित क्लिक रिवॉर्ड दिखाते हैं।

{
    "status": "success",
    "number_offers": 1,
    "country": "US",
    "devices": null,
    "cpc_eligibility": {
        "access_enabled": true,
        "status": "eligible",
        "native_cpc_available": true,
        "boost_click_rewards_available": true
    },
    "offers": [
        {
            "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",
            "conversion_mode": "single",
            "countries": [
                "US",
                "CA"
            ],
            "epc": 1.1,
            "creatives": {
                "url": "https://{assets_domain}/images/photomaster.png"
            },
            "offer_rank": 12,
            "events": [],
            "cpc_reward_type": "boost_click",
            "boost_click_balance": 250,
            "cpc_payout_us": 0.1,
            "cpc_payout_not_us": 0.07
        }
    ]
}

Conversions API

Conversions और Reversals की अनुरोध सीमा साझा है।
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

यदि API अनुरोध HTTP 429 लौटाता है, तो दोबारा प्रयास करने से पहले Retry-After में दिए गए सेकंड तक प्रतीक्षा करें। X-RateLimit-Limit और X-RateLimit-Remaining देखें और लगातार विफलताओं पर प्रतीक्षा समय बढ़ाएँ।

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

Conversions और Reversals की अनुरोध सीमा साझा है।
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