Offers API

This page will guide you through the integration of Revlum API

The Offers API is designed for backend or server-side use, giving you access to our available inventory. You can use this feed to enhance your current offer inventory or to create a new offer system from scratch.

API

Method: GET
Base URL: https://revlum.com/api/offers

ParameterDescriptionType
apikeyYour API key. Can be found here.String

Optional Parameters:

ParameterDescriptionTypeExample
countriesFilter by specific countries. Accepts a list of comma-separated country codes.Stringus,ca,de
offerFilter by specific offer name.StringKraken
deviceFilter by specific devices. Accepts a list of comma-separated devices from this list: desktop, android, ios, all.Stringios,android
featuredFilter by featured offers. Accepts 'yes' or 'no'.Stringyes
idFilter by specific offer ID.Integer2416
sortOrder results by either payout (high to low) or epc (low to high).Stringhigh
limitLimit the number of results to X. Maximum value is 100.Integer100
pageSpecify the page of results to return. Requires limit to be set.Integer1

Example Request: GET https://revlum.com/api/offers?apikey=YOUR_API_KEY&limit=100&page=1&device=ios,android

Response

{
    "status": "success",
    "data": [
        {
            "added": "2023-01-01",
            "status": "active",
            "id": "672488",
            "name": "Dream Gym",
            "description": "Complete Level 21 within 14 days. You must click “Allow” if tracking permission is requested within the app.",
            "featured": yes,
            "daily_cap": "10",
            "payout": {
                "usd": "5.25",
                "reward": "525.0",
                "currency": "Coins"
            },
            "reporting": {
                "epc": "0.50",
                "conversion_rate": "1.2"
            },
            "devices": [
                {
                    "name": "android"
                },
                {
                    "name": "ios"
                }
            ],
            "geo_targeting": {
                "countries": [
                    {
                        "country_code": "US"
                    },
                    {
                        "country_code": "CA"
                    }
                ],
                "states": []
            },
            "creatives": {
                "icon": "https://link_to_icon_image"
            },
            "events": [
                {
                    "name": "Install",
                    "payout": "0.50"
                },
                {
                    "name": "Reach Level 21",
                    "payout": "1.00"
                }
            ],
            "url": "https://revlum.com/click?apiKey=wpvnaqodiv6lc9nsm6mw16ds8yo5x1&offerId=672488&userId=",
            "preview_url": "https://link_to_preview"
        }
    ]
}

📘

The API should be called periodically from your backend (e.g., every 10 minutes) to get a fresh list of offers. Avoid using live traffic to request offers.