Introduction

The Offer API provides developers with an interface to obtain ad offer information via S2S.

Developers should note the following:

• Request method: GET
• Response format: JSON
• Access address: Server-side access only, client-side requests are not supported
• Suggestion: Request every 10-15 minutes to avoid frequent requests

Request Method

Request URL

https://offer-api.bonamobi.com/v1/offer-api/offers?app_id={APP_ID}&app_key={APP_KEY}&page_size={NUM}&page_no={NUM}

HTTP Method

GET

Request Parameters

Parameter	Description	Required
app_id	Channel ID, obtained from AM	Yes
app_key	Channel Key, obtained from AM	Yes
page_size	Number per page, default 500, should be ≤500	No
page_no	Page number, default 1	No

Example Request

https://offer-api.bonamobi.com/v1/offer-api/offers?app_id=10000&app_key=xxxxx-xxxx-xxxxx&page_size=2&page_no=1

API Response

Response Parameters

Name	Type	Description
code	int	Result: 0-success, non-0 means request failed (e.g., 10001-parameter error)
msg	string	Response: "OK" means success, non-"OK" means failure reason
data	json object	Data details, in json format

data object (Returned Data Details)

Name	Type	Description
total_count	int	Total number of offers
page_no	int	Current page number
offers	object[]	Offer details, as an array

Offer Object (Offer Details)

Name	Type	Description
status	int	Status code, 1-success
id	string	Offer id
name	string	Offer name
app_name	string	App name of the offer
pkg_name	string	Package name of the offer
description	string	Offer description
icon	string	Offer icon
payout_model	string	Payout type: CPI / CPA / CPE...
payout	string	Offer price, e.g., 0.90
currency	string	Currency type, e.g., USD
daily_cap	string	Daily cap, empty means unlimited
kpi	string	KPI information for the offer
expiration_date	string	Offer expiration time, UTC
preview_link	string	Preview link for the offer
tracking_link	string	Attribution link for the offer
geo	string[]	Target countries, [Global] means worldwide, [PH] means Philippines
geo_exclude	string[]	Excluded countries, empty means no restriction, [PH] means exclude PH
os	string	OS of the offer app, e.g., "android" / "ios"
os_vers	string	OS version targeting, empty means no restriction

Response Example

{
  "code": 0,
  "data": {
    "offers": [
      {
        "id": 1392411,
        "name": "com.igg.android.lordsmobile_US",
        "pkg_name": "com.igg.android.lordsmobile",
        "app_name": "Lords Mobile",
        "payout_model": "CPI",
        "payout": "2.67",
        "currency": "USD",
        "kpi": "cvr 0.2%",
        "tracking_link": "http://api.bonamobi.com/moonlight/v4?value=5146ea64xxx&click_id={click_id}"
      }
    ],
    "total_count": 1
  },
  "msg": "OK"
}