> For the complete documentation index, see [llms.txt](https://hugoffers-1.gitbook.io/hugoffers/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://hugoffers-1.gitbook.io/hugoffers/master.md).

# HugOffers  API Documents

## 1.       Introduction

This document will introduce HugOffers  API (hereinafter referred to as API). Advanced partners can get campaign information by calling API  .

HugOffers API is built on HTTP protocol, using GET / POST way to obtain the response content. Notably, to call our API, please contact with your account manager to get your API Key for authentication. Since anyone can conduct API request on your account’s behalf with the API Key, please keep your API Key confidential.

## 2.      Get Campaign List

This interface will provide a list of promoted campaigns and all related information. The return value is a json.

**Note:**

This interface is case sensitive and you must distinguish campaigns by yourself.

### **2.1   Query** **Params:**

## Get

<mark style="color:green;">GET</mark> `http://{cid}.hoapi0.com/v1?cid={Customer_id}&token={Token}`

Please contact your account manager to get your unique request URL.

#### Path Parameters

| Name     | Type   | Description                                                        |
| -------- | ------ | ------------------------------------------------------------------ |
| token    | string | Unique key                                                         |
| cid      | string | Customer id                                                        |
| page     | string | Pagesize,current page .eg:page=10,1                                |
| return   | string | Default json                                                       |
| geo      | string | Filter by geo value, muti-geo should be implode by",",eg:geo=es,vn |
| platform | string | Default:all devices                                                |

{% tabs %}
{% tab title="200  successfully retrieved." %}

```javascript
total_offers_num	1221
max_page	1
page	1
offers_num_this_page	1221
success	true
offers	[…]
```

{% endtab %}
{% endtabs %}

### 2.2     Response

| Parameters              | Description          |
| ----------------------- | -------------------- |
| total\_offers\_num      | Total offers counts  |
| max\_page               | Maximum page         |
| page                    | Current page         |
| offers\_num\_this\_page | Rows of current page |
| success                 | true or false        |
| offers                  | refer to offer data  |

### **2.3** **Offer Data**

| Parameter              | Description                                                                                                         | Possible Value                                           | Allow Multiple Value                                                          | Sample                                                                                                                                                 |   |
| ---------------------- | ------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | - |
| campid                 | Campaign ID                                                                                                         | int number                                               | No                                                                            | 10                                                                                                                                                     |   |
| offer\_name            | Campaign Name                                                                                                       | string                                                   | No                                                                            | PMobo Market - TH                                                                                                                                      |   |
| status                 | The status of the campaign                                                                                          | running                                                  | No                                                                            | running                                                                                                                                                |   |
| platform               | Allowed OS                                                                                                          | Android, iOS, PC Others                                  | No                                                                            | Android                                                                                                                                                |   |
| tracking\_link         | Tracking link                                                                                                       | url                                                      | No                                                                            | https\://{cid}. hotrk0.com/offer?offer\_id=354634\&aff\_id=91\&aff\_sub={click\_id}\&aff\_pub={source}\&advertising\_id={advertising\_id}\&idfa={idfa} |   |
| geo                    | Allowed countries                                                                                                   | refer to appendix                                        | Yes, multiple values separated by comma without space                         | DE,NO,FI                                                                                                                                               |   |
| preview\_link          | Preview link                                                                                                        | url                                                      | No                                                                            | <https://play.google.com/> store/apps/details?id=com.zpy.android.mm                                                                                    |   |
| price                  | Payout for channel Default currency is dollar ($)                                                                   | <p>Floating number with two</p><p>significant figure</p> | No                                                                            | 1.85                                                                                                                                                   |   |
| price\_model           | Pricing mode                                                                                                        | cpc,cpi,cpa                                              | No                                                                            | cpi                                                                                                                                                    |   |
| app\_category          | Campaign categories                                                                                                 | Refer to appendix                                        | Yes,multiple values separated by comma without space                          | Game,Subscr iption                                                                                                                                     |   |
| start\_time            | Unix time stamp                                                                                                     | 1550743682                                               | No                                                                            | 1550743682                                                                                                                                             |   |
| start\_date            | Time of campaign beginning to run                                                                                   | xxxx-xx-xx xx:xx                                         | No                                                                            | 2019-02-21T10:08:02+0000                                                                                                                               |   |
| end\_time              | Unix time stamp                                                                                                     | 1582279682                                               | No                                                                            | 1582279682                                                                                                                                             |   |
| end\_date              | <p>Time of campaign being paused; null means long</p><p>term;</p>                                                   | xxxx-xx-xx xx:xx                                         | No                                                                            | 2020-02-21T10:08:02+0000                                                                                                                               |   |
| update\_time           | <p>The last time when the information associated with  this  Campaign ID</p><p>being Modified,unix timestamp</p>    | 1553499459                                               | No                                                                            | 1553499459                                                                                                                                             |   |
| update\_date           | <p>The last time when the information associated with this Campaign ID</p><p>being modified.</p>                    | xxxx-xx-xx xx:xx                                         | No                                                                            | 2019-03-25T07:37:39+0000                                                                                                                               |   |
| effective\_time        | <p>Time of enabling campaign modification</p><p>Unix timestamp</p>                                                  | 1419782400                                               | No                                                                            | 1419782400                                                                                                                                             |   |
| effective\_date        | Time of enabling campaign modification                                                                              | xxxx-xx-xx xx:xx                                         | No                                                                            | 2019-02-21T10:08:02+0000                                                                                                                               |   |
| exclude\_device        | Device models NOT allowed to show this campaign.                                                                    | string                                                   | Yes, multiple values separated by comma without space                         | samsung,son y                                                                                                                                          |   |
| exclude\_site          | Sites NOT allowed to run the campaign                                                                               | string                                                   | Yes, multiple values separated by comma without space                         | songs.pk                                                                                                                                               |   |
| carriers               | Target carriers                                                                                                     | string                                                   | Yes, multiple values separated by comma without space                         | Digi,Maxis, Celcom                                                                                                                                     |   |
| daily\_cap             | daily max conversion                                                                                                | null or int number                                       | No                                                                            | 12000                                                                                                                                                  |   |
| icon\_link             | <p>Usually is the the</p><p>link where</p><p>we can get the icon url</p>                                            | string                                                   | No                                                                            | <p>http\:// testHugoffers.com</p><p>/yandexicon96</p><p>.png</p>                                                                                       |   |
| creative\_link         | <p>Usually is the list of the</p><p>data where</p><p>we can get the image url, and the width and height</p>         | json                                                     | Yes, multiple values with json format                                         | <p>\[{"url":"http\:// testHugoffers.com</p><p>/123456.jpg",</p><p>"width":1200,"height":627}]</p>                                                      |   |
| video\_link            | <p>Usually is the list of the</p><p>data where</p><p>we can get the video url, video duration, width and height</p> | json                                                     | Yes, multiple values with json format, duration is the video length in second | <p>\[{"url":"http\:// testHugoffers.com</p><p>/65432.mp4",</p><p>"duration":30, "width":800,"height":600}]</p>                                         |   |
| app\_name              | App Name                                                                                                            | string                                                   | No                                                                            | Poker Texas Polski                                                                                                                                     |   |
| app\_desc              | App Description                                                                                                     | string                                                   | No                                                                            | Poker Texas online                                                                                                                                     |   |
| app\_size              | App size. Default unit is MB                                                                                        | floating number with one significant figure              | No                                                                            | 3.7                                                                                                                                                    |   |
| app\_rate              | App rate in google play                                                                                             | floating number with one significant figure              | No                                                                            | 4.3                                                                                                                                                    |   |
| app\_id                | bundle id in appstore or package name in google play                                                                | string                                                   | No                                                                            | 944846798                                                                                                                                              |   |
| min\_android\_ version | <p>Allowed min Android</p><p>version if the platform is Android.</p>                                                | refer to appendix                                        | No                                                                            | 1.1                                                                                                                                                    |   |
| max\_android\_ version | <p>Allowed max Android</p><p>version if the platform is Android.</p>                                                | refer to appendix                                        | No                                                                            | 5.0                                                                                                                                                    |   |
| min\_ios\_version      | <p>Allowed max iOS</p><p>version if the platform is iOS.</p>                                                        | refer to appendix                                        | No                                                                            | 2.0                                                                                                                                                    |   |
| max\_ios\_version      | <p>Allowed max iOS</p><p>version if the platform is iOS.</p>                                                        | refer to appendix                                        | No                                                                            | 8.0                                                                                                                                                    |   |
| requirement\_traffic   | <p>Traffic reqirement.</p><p>“null” means all kinds of traffic allowed</p>                                          | refer to appendix                                        | Yes, multiple values separated by comma without space                         | Incent no allowe Adult no Allowed,                                                                                                                     |   |
| performance\_criteria  | kpi                                                                                                                 | kpi                                                      | Yes                                                                           | Second day retention rate above 35%                                                                                                                    |   |
| white\_source          | whitelist,format: “mid\_publisher\_pubid\_subid”                                                                    | string                                                   | Yes, multiple values separated by comma without space                         | 2425\_10323,2425\_10215                                                                                                                                |   |
| black\_source          | blacklist,format: “mid\_publisher\_pubid\_subid”                                                                    | string                                                   | Yes, multiple values separated by comma without space                         | 2500\_4781,2500\_4588                                                                                                                                  |   |
| impression\_link       | Impression\_link                                                                                                    | url                                                      | No                                                                            | https\://{cid}. hoimp0.com/imp?offer\_id=354634\&aff\_id=91\&aff\_sub={click\_id}\&aff\_pub={source}\&advertising\_id={advertising\_id}\&idfa={idfa}   |   |

**Note1:**

You may not receive the following four parameters, “min\_android\_version”,

“max\_android\_version”, “min\_ios\_version” and “max\_ios\_version”, at the same time. If “platform” is Android, you will only receive “min\_android\_version” and “max\_android\_version”. Otherwise, you will only receive “min\_ios\_version” and “max\_ios\_version”.

**Note2:**

“campid” is our campaign’s unique index. Our “tracking\_link” may be changed, due to the server migration. So if you use “tracking\_link” to match campaign information requested by API to which you’ve received from us before, please refer to the below string, part of “tracking\_link”, which does not change during campaign’s life time.

354634 remains the same during campaign’s flight time.

e.g.:

https\://{cid}.hotrk0.com/offer?offer\_id=354634\&aff\_id=91\&aff\_sub=\[click\_id]\&aff\_pub=\[source]\&advertising\_id=\[advertising\_id]\&idfa=\[idfa]

### 2.3 example &#xD;

`{`

`total_offers_num: 1,`

`max_page: 1,`

`page: 1,`

`offers_num_this_page: 1,`

`success: true,`

`offers: [`

`{`

`campid: "354634",`

`offer_name: "tap4fun_Spartanwars_ru",`

&#x20;`status: "running",`

`platform: "Android",`

`tracking_link:"https://{cid}.hotrk0.com/offer?offer_id=354634&aff_id=91&aff_sub=[click_id]&aff_pub=[source]&advertising_id=[advertising_id]",`

`geo: "MY",`

`preview_link:"https://play.google.com/store/apps/details?id=com.tap4fun.spartanwar", price: 1,`

`price_model: "cpi",`

`app_category: "Game",`

`start_time: "1553498486",`

`start_date: "2019-03-25T07:21:26+0000",`

`end_time: "1585034486",`

`end_date: "2020-03-24T07:21:26+0000",`

`update_time: "1553502101",`

`update_date: "2019-03-25T08:21:41+0000",`

`effective_time: "1553498486",`

`effective_date: "2019-03-25T07:21:26+0000",`

`exclude_device: "",`

`exclude_site: "0",`

`carriers: "",`

`daily_cap: 100,`

`icon_link: "https://lh3.googleusercontent.com/rZkpGk1TcmElfKXLC_NZldKGW8rPPngTuTfmJ 9Z7SfF_Qy6vN1u4Ymy3JzNIQ9e9ZqN3=w300",`

`creatives_link: [{"url":"http://hugoffers.com/1.jpg","width":1200,"height":627},`

`{"url":"http://test.hugoffers.com/2.jpg","width":640,"height":100}]`

`video_link:[ {"url":"http://testhugoffers.com/4.mp4","duration":30,"width":1200,"height":627},{"url":"http://testhugoffers.com/5.jpg","duration":15,"width":640,"height":100}]`

`app_name: "",`

`app_desc: "",`

`app_size: "0",`

`app_rate: "0",`

`app_id: "com.tap4fun.spartanwar",`

`min_android_version: "",`

`max_android_version: "",`

`min_ios_version:"5.0",`

`max_ios_version:"",`

`requirement_traffic:"non-incent",`

`performance_criteria:"kpi details",`

`white_source:"",`

`black_source:"",`

`Impression_link:""`

`}`

`]`

`}`

## 3.Tracking Parameters

| aff\_sub        | String | affiliate/publisher click id                  |
| --------------- | ------ | --------------------------------------------- |
| offer\_id       | String | ID of offer.                                  |
| aff\_id         | String | ID of unique affiliate/publisher              |
| aff\_pub        | String | Sub source id/sub id                          |
| idfa            | String | Apple's advertiser identifier with iOS 6+.    |
| advertising\_id | String | Google's advertising identifier,gaid          |
| ip              | String | IP address that made the click request.       |
| event\_name     | String | Event Name                                    |
| android\_id     | String | Android Device ID.                            |
| user\_agent     | String | User Agent In Header.                         |
| site\_id        | String | app id,package name,website url (App/Website) |
| aff\_lang       | String | Device two-character language code.           |

## 4.Postback format

| Tracking Parameters | Type   | Description                                   |
| ------------------- | ------ | --------------------------------------------- |
| offer\_id           | String | ID of offer.                                  |
| aff\_id             | String | ID of publisher.                              |
| aff\_pub            | String | Sub source id/sub id                          |
| aff\_sub            | String | affiliate/publisher click id                  |
| aff\_sub2           | String | affiliate/publisher sub 2 Custom parameter    |
| aff\_sub3           | String | affiliate/publisher sub 3 Custom parameter    |
| aff\_sub4           | String | affiliate/publisher sub 4 Custom parameter    |
| aff\_sub5           | String | affiliate/publisher sub 5 Custom parameter    |
| aff\_sub6           | String | affiliate/publisher sub 6 Custom parameter    |
| payout              | String | Amount paid to publisher for conversion.      |
| idfa                | String | Apple's advertiser identifier with iOS 6+.    |
| advertising\_id     | String | Google's advertising identifier,gaid          |
| ip                  | String | IP address that made the click request.       |
| event\_name         | String | Event Name                                    |
| android\_id         | String | Android Device ID.                            |
| user\_agent         | String | User Agent In Header.                         |
| site\_id            | String | app id,package name,website url (App/Website) |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://hugoffers-1.gitbook.io/hugoffers/master.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.