# Offers API (v2) ### **WARNING!** This is our old API. Please update to [API v3](/publisher-apis/offers-api.md) . ## Use Case Our offers API allow you to pull offers compatible with virtual currency applications and display them natively on your website or app. It is recommended to get a fresh list of offers every 10 minutes. Please do not use live traffic to request offers; the API should be called periodically from the backend. ## Limitations There are certain features that are available via the AdGate Rewards offer wall that are currently not accessible via the offers API. These include: * A page that displays user history * Access to offers that are hyper-targeted (state or postal code specific) * Access to thousands of market research surveys via the AdGate Rewards routing system Please keep this in mind prior to implementation. ## API **Method:** GET\ **Base URL:** ### Required Parameters | Parameter | Description | Type | Example | | ---------- | ---------------------------------------------------------------------------------------------------------------- | ----------- | ---------------------------------- | | aff | Your affiliate ID. Can be found on the [Offers API page](http://panel.adgatemedia.com/affiliate/api/keys). | Any Integer | `60000` | | api\_key | Your API key. Can be found on the [Offers API page](http://panel.adgatemedia.com/affiliate/api/keys). | Any String | `941bd1fecf7e6596823b895e04df3a0c` | | wall\_code | Wall code that can be found on the [AdGate Rewards page](https://panel.adgatemedia.com/affiliate/vc-walls/index) | String | `nQug` | ### Optional Parameters | Parameter | Description | Type | Example | | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------- | ---------------- | | countries | Filter by specific countries. Accepts a list of comma separated country codes. | String | `gb,us,ca` | | offer | Filter by specific offers. Accepts a list of comma separated offer IDs. | String | `4849,5201,4809` | | paymin | Filter by offers above a minimum payout. Values are in USD. | Decimal | `0.50` | | minepc | Filter by offers above a minimum EPC. Values are in USD. | Decimal | `0.05` | | mobile\_only | Filter by offers that can only be displayed on mobile devices. Accepted values are `1` or `0`. A value of `0` will display all offers (default). | Integer | `1` | | categories | Filter by offers in certain categories. Accepts a comma separated list of category IDs. Please see the table below for the category ID list. | String | `4,10,11` | | orderby | Order results by either `payout`,`epc` , or `id`(offer id) in descending order. Default is `epc`. | String | `payout` | | take | Limit the number of results to X. By default all results are returned. | Integer | `200` | | skip | Skips the first X number of results. Useful when combined with limiting (see above). By default, no offers are skipped. | Integer | | #### Category List | Category ID | Category Name | | ----------- | -------------------- | | 1 | Android | | 2 | Downloads | | 3 | Email Submits | | 4 | Free | | 10 | iPad | | 11 | iPhone | | 12 | Lead Gen | | 13 | Credit Card Required | | 14 | Mobile Subscription | | 16 | Surveys | | 17 | Videos | | 18 | CPC | | 19 | Pay Per Call | | 20 | Cash Back | | 21 | CPI | | 22 | CPE | | 23 | CPA | ### Response Note that country abbreviations use the ISO standard, e.g. GB instead of UK. #### Sample Response ``` [ { "status": "success", "data": [ { "id": 100677, "name": "Final Fantasy XV iPhone CPE (US) (Incentive)", "anchor": "Play Final Fantasy XV on your iPhone!", "requirements": "Install and Reach Citadel level 10.", "user_agent": [ "iphone" ], "mobile_only": true, "creatives": { "icon": "https://linkhere" }, "epc": "1.98", "categories": [ "iPhone" ], "tools": [ "content_locking", "virtual_currency" ], "adgate_rewards": { "cpm": "0.00", "anchor": "Final Fantasy XV", "requirements": "Install and Reach Citadel level 10. Eligibility: Must be installing the app for the first time. ***New Users Only*** Users must download and OPEN the app within 15 minutes of starting (clicking) the offer.", "description": "Be the hero of your own Final Fantasy XV adventure in the brand new mobile strategy game Final Fantasy XV: A New Empire! Build your own kingdom, discover powerful magic, and dominate the realm alongside all of your friends! " }, "lockers": { "epc":"0.07", "desktop_average_epc":"0.05", "mobile_average_epc":"0.08" }, "countries": [ "US" ], "type": "flat", "payout": "18.00", "click_url": "https://agm.mobi/vc/nQ/offers/100677?s1=", "support_url": "https://wall.adgaterewards.com/offer/contact/nQ/345862?s1=", "preview_url": "https://itunes.apple.com/app/final-fantasy-xv-a-new-empire/id1186994231?mt=8", "multiple_conversions_allowed": true, "multiple_conversions_rules": { "rule_type": "INTERVAL", "x_conversions": 1, "every_y_seconds": 10 } }, ...... ] } ] ``` #### Response Parameters | Key Name | Description | | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | id | AdGate offer id. | | name | AdGate's internal offer name, not to be displayed to end-users. | | anchor | Deprecated value. Do not use this. Use "title" from the "adgate\_rewards" section. | | requirements | Deprecated value. Do not use this. Use "requirements" from the "adgate\_rewards" section. | | user\_agent | An array of strings that must be present in the end-user's user agent. If an empty array, then any user agent is permitted. | | mobile\_only | Mobile and tablet traffic only. If false, allowed on any device. | | creatives | Object of key-values representing creatives. | | epc | Network-wide EPCs | | categories | Array offer categories (listed above) | | tools | The types of traffic and AdGate tools this offer can be displayed on. May include one or more of: super\_urls, content\_locking, incent\_mobile\_app\_walls, non\_incent\_mobile\_app\_walls, virtual\_currency, video | | adgate\_rewards |

If "virtual\_currency" is listed in "tools" above, the "adgate\_rewards" key will be present, which is an object that provides the following key-value pairs:

cpm: deprecated value, always returns 0.00
anchor: Offer title to display to end-users
requirements: Offer requirements to display to end users.
description: Offer description to display to end users

| | lockers |

If "content\_locking" is listed in the "tools" array, this "lockers" key will contains content locking EPCs as an object containing the following key-value pairs:

epc: Network-wide locker traffic EPC
desktop\_average\_epc: Network-wide desktop locker traffic EPC
mobile\_average\_epc: Network-wide mobile locker traffic EPC

| | countries | Array of two-letter country codes this offer is available to. If this array is empty, all countries are allowed. Use "GB" for the UK. | | type | One of "flat" or "dynamic". Flat payouts don't change. Dynamic payouts vary. | | payout | The dollar amount if "type" above is "flat". | | click\_url | Tracking link. The `s1` parameter should include the ID of the user accessing the offer. The ID can be any string up to 255 characters long. s2-5 subids are available. | | support\_url | The URL the user can access to get support in case they are not rewarded. The `s1` parameter is required (see `click_url` above for info.) Note that most offers require waiting at least one hour after clicking an offer to be able to contact support. | | preview\_url | Preview of the offer's landing page. | | multiple\_conversions\_allowed | Boolean. Indicates if the offer allows multiple conversions for a single user (IP), according to the rules specified in "multiple\_conversions\_rules". | | multiple\_conversions\_rules |

If "multiple\_conversions\_allowed" is false then this will be null. Otherwise, it will be an object with the following values:

rule\_type: Can be one of "UNLIMITED" or "INTERVAL". "UNLIMITED" means ths offer can be completed an indefinite amount of times without time limit. "INTERVAL" means the offer can be completed a certain amount of times in a given amount of time, in the format "allow X conversions every Y seconds".
x\_conversions: Integer when the rule type is "INTERVAL", "null" otherwise.
every\_y\_seconds: Integer when the rule type is "INTERVAL", "null" otherwise.

More attempts than the rule allows will not result in a conversion.

| --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.prodegeads.com/publisher-apis/offers-api-1.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.