v1

latestOpenAPI 3.0.02026-07-2663155142.2 KB
Offers

Get Offers

Returns offers for the current user in one of two modes: Full catalog (default) — Omit offer_ids. Behavior matches the historical user-based offers list (upstream AdGate user-based offers API). Optional query parameters such as limit, is_game, ipad, devices, client_ip, client_user_agent, ios_id, android_advertiser_id, idfv, device_name, os_version, and in_app apply to this mode. When provided, client_ip, client_user_agent, and the device/tracking parameters are appended to each offer's click_url. By offer IDs — Include offer_ids as a comma-separated list of AdGate offer IDs (non-empty, duplicate IDs deduplicated). There is no BitLabs-enforced maximum ID count (subject to upstream AdGate limits). The response uses the same OffersV2 schema; upstream calls use AdGate’s user-based “offers by IDs” API. Optional tags use the same encoding and merge semantics as catalog mode. List-scoping parameters (limit, is_game, devices, etc.) are ignored in this mode. Response order matches AdGate only; BitLabs does not reorder results. Malformed offer_ids, empty offer_ids, or invalid tags yield 400 Bad Request. The upstream rank_method parameter is not supported.

get/v2/client/offers

Query parameters

devicesstring[]

An array that any combination of iphone, ipad, or android. Provide an empty array to clear existing devices.

in_appboolean nullable

If true, only offers that follow App Store and Play Store guidelines are returned. If not set, it falls back to the app setting.

client_user_agentstring

Optional user agent of the user's device. When provided, appended to each offer's click_url as ua. Also used for upstream offer targeting.

client_ipstring

Optional IPv4 address of the user's device. When provided, appended to each offer's click_url as u_ip. Also used for upstream offer targeting.

ios_idstring

Optional Apple Identifier for Advertisers (IDFA), expected for iOS requests. When provided, appended to each offer's click_url.

android_advertiser_idstring

Optional Google Advertising ID (GAID), expected for Android requests. When provided, appended to each offer's click_url.

idfvstring

Optional Apple Identifier for Vendors (IDFV), expected for iOS requests. When provided, appended to each offer's click_url.

device_namestring

Optional device model name (e.g. iPhone17,2). When provided, appended to each offer's click_url.

os_versionstring

Optional operating system version (e.g. 18.3.1). When provided, appended to each offer's click_url.

is_gameboolean nullable

If true, only game offers are returned. If false, only non game offers are returned. If not set, all offers are returned.

ipadboolean nullable

If set, forwarded upstream as ipad=true or ipad=false. If unset, iPad User-Agents may forward ipad=true. Ignored when offer_ids is present.

limitinteger

Optional maximum number of offers to return from the upstream AdGate user-based offers API (limit={int}). This is not page-based pagination; omit the parameter for default upstream behavior. Ignored when offer_ids is present.

offer_idsstring

Comma-separated AdGate offer IDs. When present, selects by-ID mode (see operation description). Duplicate IDs are deduplicated. No fixed maximum count at the BitLabs API layer.

tagsstring URL-encoded query
Example:key1=value1&key2=value2

Optional set of key-value pairs to be passed back in callbacks. Max 10 pairs with both key and value up to 50 characters long. Keys and values are trimmed and lower-cased. Keys can only contain alphanumeric characters and underscores. Values can contain any characters. If you need to pass sensitive information, note that users can potentially manipulate this data.

bb_trackstring
Example:amp:01HXJKP9VQCMZKZ

Optional cross-provider tracking token for analytics correlation (e.g. comma-separated amp:session_id,other:token). Max 512 characters.

Headers

User-Agentstring required

The user agent string of the user's device.

Response

OK

Example response

{
  "data": {
    "offers": [
      {
        "anchor": "Playstation 5",
        "description": "Playstation 5",
        "requirements": "Sign up with valid information and complete the full survey.",
        "confirmation_time": "Confirms Instantly",
        "support_url": "https://wall.adgaterewards.com/offer/contact/nQ/100677?s1=",
        "icon_url": "https://main-p.agmcdn.com/offers/1639000851514.jpg",
        "impression_url": "https://seek:gg/v1/user-based-api/impression?funnel_id=01JKBMPR5QYT91EGGV1R62DB2W&wall_code=nqqYp2g&user_id=testuser&offer_id=1666524",
        "categories": [
          "Free",
          "Android"
        ],
        "events": [
          {
            "uuid": "0dc43f54-135a-46a4-a51c-a2c5f3cfdac0",
            "hash": "a1b2c3d4e5f6g7h8",
            "name": "Completed",
            "payout": "1.30",
            "multiple_conversions_rules": {
              "rule_type": "unlimited",
              "x_conversions": 1,
              "every_y_seconds": 60
            },
            "timestamp": 1741370829
          }
        ],
        "app_metadata": {
          "app_id": "com.google.android.youtube",
          "categories": [
            "Entertainment",
            "Video Players & Editors"
          ],
          "screenshot_urls": [
            "https://lh3.googleusercontent.com/...",
            "https://lh3.googleusercontent.com/..."
          ],
          "video_urls": [
            "https://www.youtube.com/watch?v=...",
            "https://www.youtube.com/watch?v=..."
          ]
        },
        "pending_time": 60,
        "web_to_mobile_devices": [
          "iphone",
          "ipad"
        ],
        "session_hours": 24,
        "offer_expires_at": "2021-12-31T23:59:59Z",
        "creatives": {
          "icon": "https://main-p.agmcdn.com/offers/1564507470875.gif",
          "images": {
            "120x60": "https://main-p.agmcdn.com/cdn-cgi/image/width=120,height=60/https://main-p.agmcdn.com/offers/26500-CON9Efq8.jpg",
            "275x275": "https://main-p.agmcdn.com/cdn-cgi/image/width=275,height=275/https://main-p.agmcdn.com/offers/26500-GwW1MNhL.jpg",
            "400x400": "https://main-p.agmcdn.com/cdn-cgi/image/width=400,height=400/https://main-p.agmcdn.com/offers/26500-GwW1MNhL.jpg"
          }
        },
        "lowest_cap_left": 150,
        "arpu_goals": [
          {
            "day": 1,
            "goal": "2.40"
          },
          {
            "day": 7,
            "goal": "8.49"
          }
        ]
      }
    ],
    "started_offers": [
      {
        "anchor": "Playstation 5",
        "description": "Playstation 5",
        "requirements": "Sign up with valid information and complete the full survey.",
        "confirmation_time": "Confirms Instantly",
        "support_url": "https://wall.adgaterewards.com/offer/contact/nQ/100677?s1=",
        "icon_url": "https://main-p.agmcdn.com/offers/1639000851514.jpg",
        "categories": [
          "Free",
          "Android"
        ],
        "events": [
          {
            "uuid": "0dc43f54-135a-46a4-a51c-a2c5f3cfdac0",
            "hash": "a1b2c3d4e5f6g7h8",
            "name": "Completed",
            "payout": "1.30",
            "multiple_conversions_rules": {
              "rule_type": "unlimited",
              "x_conversions": 1,
              "every_y_seconds": 60
            },
            "timestamp": 1741370829
          }
        ],
        "latest_date": "2022-01-01T00:00:00Z",
        "app_metadata": {
          "app_id": "com.google.android.youtube",
          "categories": [
            "Entertainment",
            "Video Players & Editors"
          ],
          "screenshot_urls": [
            "https://lh3.googleusercontent.com/...",
            "https://lh3.googleusercontent.com/..."
          ],
          "video_urls": [
            "https://www.youtube.com/watch?v=...",
            "https://www.youtube.com/watch?v=..."
          ]
        },
        "hours_left": 24,
        "continue_url": "https://seek.gg/vc/nQ/users/testing-prodege/offers/360819?source_type=live_offer_api"
      }
    ]
  }
}