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 des offres API des conversions API des annulations

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 des offres

Renvoie une liste JSON des offres disponibles. Les offres en vedette peuvent apparaître en premier. Ensuite, les valeurs offer_rank les plus basses apparaissent en premier.

Classement & Paiements par pays

Chaque offre inclut un offer_rank où 1 est l'offre la mieux classée. Les offres en vedette peuvent apparaître en premier. Ensuite, les résultats restent dans l'ordre offer_rank du plus bas au plus élevé.
Certaines offres paient des montants différents selon le pays. Si une offre inclut une liste "payouts_per_country", utilisez le paiement qui correspond au code pays à deux lettres de l'utilisateur (par ex. US, CA, GB). Si leur pays ne se trouve pas dans la liste, utilisez le paiement par défaut indiqué dans "amount".

Notes sur l'API des offres

Les offres CPC ne sont pas renvoyées par cette API.
Si une offre dispose de boost clicks, elle conserve quand même son rang normal. Elle n'est pas placée en tête simplement parce qu'elle a des boost clicks.
L'utilisation du lien exact renvoyé par l'API garantit la meilleure attribution. Si vous enregistrez ou reconstruisez les liens dans votre propre système, les clics fonctionnent toujours.

Point d'accès

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

Paramètres de requête HTTP disponibles

Paramètre HTTP	Description
id	Required. Your publisher ID.
country	Afficher uniquement les offres du pays, fournissez le code pays ISO à deux lettres Utilisez `country=user` pour obtenir automatiquement les offres du pays de l'utilisateur
limit	Limitez le nombre d'offres renvoyées. Cela peut accélérer vos appels API. La valeur par défaut est 2500 et le maximum est 5000.
type	Cette API ne renvoie pas les offres CPC. Par défaut, elle renvoie les offres CPA, CPI et CPE. Vous pouvez aussi demander CPR avec une liste séparée par des virgules, par exemple `&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	Booléen (vrai\|faux). Utilisez vrai si vous voulez aussi des offres marquées pour les offerwalls. Les offres CPC restent exclues, et les offres boost-click conservent leur rang normal.
device	Utilisez-cela uniquement si vous n'utilisez pas la ciblage automatique des appareils. Par défaut, l'API peut renvoyer tous les types d'appareils. Utilisez ce champ pour ne renvoyer que certains types d'appareils. Valeurs disponibles : ios, android, mobile et desktop. L'appareil peut aussi être une liste séparée par des virgules, par exemple: `&device=ios,android,mobile,desktop` Pour obtenir uniquement les offres CPI / CPE (qui nécessitent uniquement l'installation pour la conversion - utilisez device=ios,android Utilisez `device=user` pour obtenir automatiquement les offres de l'appareil de l'utilisateur
subid / subid2 / subid3	Le suivi SubID vous permet d'envoyer des données supplémentaires lorsqu'un utilisateur clique sur vos liens d'affiliation en ajoutant une balise à la fin de vos liens d'affiliation, ce paramètre remplira automatiquement le subid dans votre lien de suivi. Vous pouvez utiliser les SubID pour segmenter les prospects, optimiser les campagnes et améliorer les conversions, voici quelques exemples : IDs sub-affiliés, sources (organique, PPC, e-mail, etc.), mots-clés, emplacements, etc... Une deuxième variable subid pour des données supplémentaires Une troisième variable subid pour des données supplémentaires
gaid / idfa	Si vous avez un Google Advertising ID (GAID) pour mobile, utilisez cette variable pour remplir automatiquement le gaid sur votre lien de suivi Si vous avez un Apple Identifier For Advertisers (IDFA) pour mobile, utilisez cette variable pour remplir automatiquement l'idfa sur votre lien de suivi
format / callback	Format JSON ou JSONP. JSON est la valeur par défaut Nom de la fonction de rappel JSONP. Utilisé uniquement pour le format JSONP. Si vous utilisez jQuery getJSON, utilisez callback=? et jQuery remplira automatiquement le nom de la fonction pour vous. Voir l'exemple JSONP

Exemple de réponse

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

Exemple de 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 des conversions

Limite : 1 requête par minute
L'API de conversion vous permet de ping CPAlead pour tester les conversions, utile pour créer des applications personnalisées. Passez subid en tant que subid ou adresse IP, ou "user" pour que notre système utilise l'adresse IP du client appelant ce script (utile pour les appels JSONP)
Pour le service de conversion de type push (Postback serveur à serveur), voir notre documentation Postback

Point d'accès

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

Paramètres de requête HTTP disponibles

Paramètre HTTP	Description
id	Required. Your publisher ID.
api_key	Required. Your API key.
subid	Obligatoire. Recherche de conversion basée sur subid, passez subid ou l'adresse IP des utilisateurs, passez "user" pour utiliser l'adresse IP du client appelant ce script (utile pour les appels JSONP)
offer_id	Facultatif. Vérifiera la conversion uniquement pour cet ID d'offre (campagne)
format / callback	Format JSON ou JSONP. JSON est la valeur par défaut Nom de la fonction de rappel JSONP. Utilisé uniquement pour le format JSONP. Si vous utilisez jQuery getJSON, utilisez callback=? et jQuery remplira automatiquement le nom de la fonction pour vous. Voir l'exemple JSONP

Exemple de réponse

API des annulations

Limite : 1 requête par minute
Utilisez cette API pour télécharger votre liste de mauvais prospects entre deux dates. Utile pour trier le mauvais trafic

Point d'accès

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

Paramètres de requête HTTP disponibles

Paramètre HTTP	Description
id	Required. Your publisher ID.
api_key	Required. Your API key.
start_date	Date de début à utiliser lors de la récupération des mauvais prospects. Format : yyyy-mm-dd
end_date	Date de fin à utiliser lors de la récupération des mauvais prospects. Un maximum d'un mois peut être récupéré à la fois
format / callback	Format JSON ou JSONP. JSON est la valeur par défaut Nom de la fonction de rappel JSONP. Utilisé uniquement pour le format JSONP. Si vous utilisez jQuery getJSON, utilisez callback=? et jQuery remplira automatiquement le nom de la fonction pour vous. Voir l'exemple JSONP

Exemple de réponse