Query parameters

• limit integer

  Limit the number of results to X.

  Default value is 2000.

• skip integer

  Skips the first X number of results.

  Default value is 0.

Responses

• 200 application/json

  OK

  Hide response attribute Show response attribute object

  • data object
    Hide data attribute Show data attribute object

    • offers array[object] Required
      Hide offers attributes Show offers attributes object

      • id integer(int64) Required
      • name string Required

        Internal offer name, not to be displayed to end-users.

      • anchor string Required

        Offer title as shown to the end-user.

      • country_stats array[object] Required

        Mobile and desktop ranks that indicate how well the offer performs compared to other offers within the same country. If API options are provided that filter the results, such as categories or platform, the ranks are calculated within the filtered result set. Note: the ranking algorithm is subject to change in the future. Please allow for gaps in the numeric ranks.

        Only present if "multiple_conversions_allowed" is true. It is an object with the following values:

        rule_type: "UNLIMITED" means that the offer event can be completed an indefinite amount of times without time limit. "INTERVAL" means the offer event 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.

        Hide country_stats attributes Show country_stats attributes object

        • country_code string Required
        • mobile_rank integer Required
        • desktop_rank integer Required
      • description string Required

        Offer description.

      • requirements string Required

        Offer requirements. The user must complete these requirements in order to convert.

      • things_to_know array[string] Required

        List of key points the user should be aware of regarding the offer such as prerequisites or limitations.

      • disclaimer string Required

        Detailed disclaimer outlining additional conditions, sponsor affiliations, and terms for eligibility. It may include placeholders for dynamic content such as currency name or site name..

      • pending_time integer(int32) Required

        Time in minutes that a reward will be held from the user following completion.

      • translations object Required

        Available translations for the offer anchor, description and requirements.

        Hide translations attribute Show translations attribute object

        • * object Additional properties
          Hide * attributes Show * attributes object

          • anchor string Required
          • description string Required
          • requirements string Required
      • device_targeting object Required
        Hide device_targeting attributes Show device_targeting attributes object

        • browsers array[object] Required

          If present, the offer requires one of the specified browsers. Possible values are: chrome, firefox, safari, edge, internet explorer, chrome mobile, mobile safari (More values may be added in the future)

          Hide browsers attributes Show browsers attributes object

          • name string Required
          • min_version string

            Minimum version number of the operating system above. If there is no minimum version requirement, this value will be null.

          • max_version string

            Maximum version number of the operating system above. If there is no minimum version requirement, this value will be null.

        • operating_systems array[object] Required

          If present, the offer requires one of the specified operating systems. Possible values are: windows, mac os, ios, android (More values may be added in the future)

          Hide operating_systems attributes Show operating_systems attributes object

          • name string Required
          • min_version string

            Minimum version number of the operating system above. If there is no minimum version requirement, this value will be null.

          • max_version string

            Maximum version number of the operating system above. If there is no minimum version requirement, this value will be null.

        • devices array[object] Required

          If present, the offer requires one of the specified devices. Possible values are: iphone, ipad (More values may be added in the future)

          Hide devices attributes Show devices attributes object

          • name string Required
          • min_version string

            Minimum version number of the operating system above. If there is no minimum version requirement, this value will be null.

          • max_version string

            Maximum version number of the operating system above. If there is no minimum version requirement, this value will be null.

        • platforms array[object] Required

          If present, the offer requires one of the specified platforms. Possible values are: smartphone, tablet, desktop (More values may be added in the future)

          Hide platforms attributes Show platforms attributes object

          • name string Required
          • min_version string

            Minimum version number of the operating system above. If there is no minimum version requirement, this value will be null.

          • max_version string

            Maximum version number of the operating system above. If there is no minimum version requirement, this value will be null.

      • geo_targeting object Required
        Hide geo_targeting attributes Show geo_targeting attributes object

        • countries array[object] Required

          uses country_code

          Hide countries attributes Show countries attributes object

          • country_code string

            The two-letter country codes this offer is available to. If no countries are provided, all countries are permitted. Use GB for the UK.

          • geoname_id integer(int64)

            The states/regions/city that the offer is limited to, provided by the geoname ID. You may find a searchable and downloadable database of geoname IDs from https://www.geonames.org/

          • name string

            The name of the state/region/city as provided by Geonames.

          • code string

            The postal code the offer is limited to.

        • states array[object] Required

          uses geoname_id & name

          Hide states attributes Show states attributes object

          • country_code string

            The two-letter country codes this offer is available to. If no countries are provided, all countries are permitted. Use GB for the UK.

          • geoname_id integer(int64)

            The states/regions/city that the offer is limited to, provided by the geoname ID. You may find a searchable and downloadable database of geoname IDs from https://www.geonames.org/

          • name string

            The name of the state/region/city as provided by Geonames.

          • code string

            The postal code the offer is limited to.

        • cities array[object] Required

          uses geoname_id & name

          Hide cities attributes Show cities attributes object

          • country_code string

            The two-letter country codes this offer is available to. If no countries are provided, all countries are permitted. Use GB for the UK.

          • geoname_id integer(int64)

            The states/regions/city that the offer is limited to, provided by the geoname ID. You may find a searchable and downloadable database of geoname IDs from https://www.geonames.org/

          • name string

            The name of the state/region/city as provided by Geonames.

          • code string

            The postal code the offer is limited to.

        • postal_codes array[object] Required

          uses code

          Hide postal_codes attributes Show postal_codes attributes object

          • country_code string

            The two-letter country codes this offer is available to. If no countries are provided, all countries are permitted. Use GB for the UK.

          • geoname_id integer(int64)

            The states/regions/city that the offer is limited to, provided by the geoname ID. You may find a searchable and downloadable database of geoname IDs from https://www.geonames.org/

          • name string

            The name of the state/region/city as provided by Geonames.

          • code string

            The postal code the offer is limited to.

      • icon string Required
      • epc string Required

        Network-wide EPCs

      • categories array[string] Required

        An array of offer categories

      • events array[object] Required

        An array of offer events.

        Hide events attributes Show events attributes object

        • id string Required

          UUID of the event

        • name string Required

          Event title

        • payout_type string Required

          One of "flat" or "dynamic". Flat payouts don't change. Dynamic payouts vary. Only 'flat' events are served at the moment.

          Values are flat or dynamic.

        • payout string Required

          The dollar amount.

        • is_cpc boolean Required

          Boolean. Indicates if the offer event is CPC (cost-per-click).

        • multiple_conversions_allowed boolean Required

          Boolean. Indicates if the offer event allows multiple conversions for a single user (IP), according to the rules specified in "multiple_conversions_rules".

        • points string Required

          It is 0 if the event is not payable.

        • promotional_points string

          Points if there is an ongoing promotion

        • multiple_conversions_rules object
          Hide multiple_conversions_rules attributes Show multiple_conversions_rules attributes object

          • rule_type string Required

            Values are unlimited or interval.

          • x_conversions integer Required
          • every_y_seconds integer Required
        • type_id integer(int64) Required

          ID used to identify the event type. The following values are possible: 0: Not specified 1: Install 2: Event 3: In-app purchase 4: Time played event

        • translations object Required

          Available translations for the event name.

          Hide translations attribute Show translations attribute object

          • * object Additional properties
            Hide * attribute Show * attribute object

            • name string Required
      • click_url string Required

        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,s3,s4 and s5 subids are available.

      • support_url string Required

        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 string Required

        Preview of the offer's landing page.

      • app_metadata object Required
        Hide app_metadata attributes Show app_metadata attributes object

        • app_id string

          The app ID

        • categories array[string] Required

          The categories the app belongs to

        • screenshot_urls array[string] Required

          URLs to screenshots of the app

        • video_urls array[string] Required

          URLs to videos of the app

      • is_game boolean Required

        Boolean. Indicates if the offer is a game.

      • product_id string Required

        A unique string shared between offers which belong to same product, e.g. same mobile app.

      • product_name string Required

        The offer's product name.