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 API sa mga Alayon API sa mga Konbersiyon API sa mga Pagbalik

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 .

API sa mga Alayon

Mopabalik og lista sa JSON sa mga magamit nga mga alayon. Ang itinatampok nga mga alayon puwedeng una nga mohayag. Human ana, ang mas ubos nga mga balor sa offer_rank maoy una nga mohayag.

Ranggo & Mga Bayad sa Nasod

Ang matag alayon apil ang usa ka offer_rank nga ang 1 mao ang pinakataas nga nanguna nga alayon. Ang itinatampok nga mga alayon puwedeng una nga mohayag. Human ana, ang mga resulta magpabilin sa han-ay sa offer_rank gikan sa ubos paingon sa taas.
Ang uban nga mga alayon lain-lain ang bayad depende sa nasod. Kung ang usa ka alayon naglakip og lista sa "payouts_per_country", gamita ang bayad nga mohaom sa duha ka-titik nga code sa nasod sa gamiton (pananglitan, US, CA, GB). Kung ang ilang nasod wala sa lista, gamita ang default nga bayad nga ipakita sa "amount".

Mga Pahimangno sa API sa Alayon

Ang mga alayon nga CPC dili mabawi niining API.
Kung ang usa ka alayon adunay boost clicks, magpabilin kini sa iyang normal nga ranggo. Dili kini ibutang sa taas lang kay naa kini boost clicks.
Ang paggamit sa eksaktong link nga gibalik sa API nagpabilin sa pinakamaayong attribution. Kung imong i-save o usbon pag-usab ang mga link sa imong kaugalingong system, ang mga pag-klik maglihok pa gihapon.

Dulnganan

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

Magamit nga mga parameter sa pangutana sa HTTP

Parameter sa HTTP	Pagpasabot
id	Required. Your publisher ID.
country	Ipakita lang ang mga alayon gikan sa nasod, isulod ang duha ka-titik nga ISO nga code sa nasod Gamita `country=user` aron makuha ang mga alayon para sa nasod sa gamiton nga tiggamit awtomatiko
limit	Limitahi ang gidaghanon sa mga alayon nga mabalik. Makatabang kini nga paspason ang imong mga tawag sa API. Ang default mao ang 2500 ug ang pinakataas mao ang 5000.
type	Kining API dili mopabalik og mga alayon nga CPC. Sa default, mopabalik kini og CPA, CPI, ug CPE nga mga alayon. Pwede ka usab mangayo og CPR uban sa lista nga gipagkamao sa komo, pananglitan `&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 (tinuod\|sayop). Gamita ang tinuod kung gusto mo usab ang mga alayon nga gi-markahan para sa offerwall. Ang mga alayon nga CPC magpabilin nga wala ug ang mga alayon nga boost-click magpadayon sa ilang normal nga ranggo.
device	Gamita kini kung dili ka gamita og awtomatikong pag-target sa device. Sa default, ang API makapabalik sa tanan nga klase sa device. Gamita kini nga field aron sa piho lang nga mga klase sa device ang mabalik. Magamit nga mga balor: ios, android, mobile, ug desktop. Ang Device pwede usab nga lista nga gipagkamao sa komo, pananglitan: `&device=ios,android,mobile,desktop` Para makakuha lang og mga alayon nga CPI / CPE (nga nanginahanglan lang og pag-instalar alang sa konbersiyon - gamita device=ios,android Gamita `device=user` aron makuha ang mga alayon para sa device sa gamiton nga tiggamit awtomatiko
subid / subid2 / subid3	Ang pagsubaybay sa SubID naghatag kanimo og kapabilidad nga magsend og dugang nga datos kung ang usa ka gamiton mug-klik sa imong mga affiliate link pinaagi sa pagpasa og tag sa tapos sa imong mga affiliate link, kini nga parameter awtomatikong mobuno sa subid sa imong tracking link. Pwede ka magamit og SubID aron bahinan ang mga lead, paandaron ang mga kampanya, ug paayoha ang mga konbersiyon, anhi ang pipila ka mga pananglitan: Mga ID sa Sub-Affiliate, Mga Tinubdan (Organiko, PPC, Email ug uban pa), Mga Pulong hinungdan, Mga Lokasyon, ug uban pa... Ikaduhang variable sa subid alang sa dugang nga datos Ikatulong variable sa subid alang sa dugang nga datos
gaid / idfa	Kung naa kay Google Advertising ID (GAID) para sa mobile, gamita kini nga variable aron awtomatikong mapuno ang gaid sa imong tracking link Kung naa kay Apple Identifier For Advertisers (IDFA) para sa mobile, gamita kini nga variable aron awtomatikong mapuno ang idfa sa imong tracking link
format / callback	Porma nga JSON o JSONP. Ang JSON mao ang default Pangalan sa callback function sa JSONP. Gigamit lang para sa pormat sa JSONP. Kung mogamit og jQuery getJSON, gamita ang callback=? ug ang jQuery awtomatikong magpuno sa ngalan sa function para kanimo. Tan-awa ang pananglitan sa JSONP

Pananglitan sa tubag

{
    "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
        }
    ]
}

Pananglitan sa code

<!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>

API sa mga Konbersiyon

Limitasyon: 1 hangyo kada minuto
Ang API sa Konbersiyon naghatag kanimo og kapabilidad nga iping ang CPAlead aron mosusi sa mga konbersiyon, mapuslanon sa paghimo og mga custom nga aplikasyon. Ihatag ang subid isip subid o IP address, o "user" aron ang atong system magamit ang IP address sa kliyente nga mitawag niining script (mapuslanon para sa mga tawag sa JSONP)
Para sa serbisyo sa konbersiyon nga tipo push (Server-to-Server Postback), tan-awa ang among Dokumentasyon sa Postback

Dulnganan

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

Magamit nga mga parameter sa pangutana sa HTTP

Parameter sa HTTP	Pagpasabot
id	Required. Your publisher ID.
api_key	Required. Your API key.
subid	Gikinahanglan. Tan-awa ang konbersiyon pinaagi sa subid, ihatag ang subid o IP address sa gamiton, ihatag ang "user" aron magamit ang IP address sa kliyente nga mitawag niining script (mapuslanon para sa mga tawag sa JSONP)
offer_id	Opsyonal. Susiha lang ang konbersiyon para niining ID sa alayon (kampanya)
format / callback	Porma nga JSON o JSONP. Ang JSON mao ang default Pangalan sa callback function sa JSONP. Gigamit lang para sa pormat sa JSONP. Kung mogamit og jQuery getJSON, gamita ang callback=? ug ang jQuery awtomatikong magpuno sa ngalan sa function para kanimo. Tan-awa ang pananglitan sa JSONP

Pananglitan sa tubag

API sa mga Pagbalik

Limitasyon: 1 hangyo kada minuto
Gamita kini nga API aron ma-download ang imong lista sa daotang mga lead taliwala sa duha ka mga petsa. Mapuslanon ni sa paghan-ay sa daotang trapiko

Dulnganan

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

Magamit nga mga parameter sa pangutana sa HTTP

Parameter sa HTTP	Pagpasabot
id	Required. Your publisher ID.
api_key	Required. Your API key.
start_date	Petsa sa sinugdanan nga gamiton sa pagkuha sa daotang mga lead. Porma: yyyy-mm-dd
end_date	Petsa sa katapusan nga gamiton sa pagkuha sa daotang mga lead. Hangtod lang sa usa ka bulan ang pwede makuha sa usa ka panahon
format / callback	Porma nga JSON o JSONP. Ang JSON mao ang default Pangalan sa callback function sa JSONP. Gigamit lang para sa pormat sa JSONP. Kung mogamit og jQuery getJSON, gamita ang callback=? ug ang jQuery awtomatikong magpuno sa ngalan sa function para kanimo. Tan-awa ang pananglitan sa JSONP

Pananglitan sa tubag