> For the complete documentation index, see [llms.txt](https://knowledgebase.offer18.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://knowledgebase.offer18.com/zh/lian-meng-huo-ban/lian-meng-huo-ban-api/offers-api.md).

# Offer API

```
GET https://api.offer18.com/api/af/offers
```

:link: [<mark style="color:蓝色;">**点击测试 Offers API**</mark>](https://offer18.readme.io/reference/offers-api-1)

### **常用参数**

<table data-header-hidden><thead><tr><th width="150">路径</th><th width="150"> </th><th> </th></tr></thead><tbody><tr><td><strong>参数</strong></td><td><strong>类型</strong></td><td><strong>描述</strong></td></tr><tr><td>key</td><td>字符串</td><td>API 密钥</td></tr><tr><td>aid</td><td>整数</td><td>联盟客 ID</td></tr><tr><td>mid</td><td>整数</td><td>您的广告主 MID</td></tr></tbody></table>

***

### 过滤条件

<table data-header-hidden><thead><tr><th width="150">查询</th><th width="150"> </th><th width="376.2"> </th></tr></thead><tbody><tr><td><strong>查询</strong></td><td><strong>类型</strong></td><td><strong>描述</strong></td></tr><tr><td>offer_id</td><td>整数</td><td>OfferID（&#x26;offer_id=000,001,002）</td></tr><tr><td>page</td><td>整数</td><td>页码（&#x26;page=1）</td></tr><tr><td>category</td><td>字符串</td><td>Offer 的分类（&#x26;category=000,000,000）</td></tr><tr><td>model</td><td>字符串</td><td><p>Offer 模型（&#x26;model=CPA,CPC） </p><p><span data-gb-custom-inline data-tag="emoji" data-code="1f517">🔗</span> <a href="/pages/d9d4155c600d0d3d7c6df1cd9f8ebac54fafa4a3#models"><mark style="color:蓝色;">查看模型</mark></a></p></td></tr><tr><td>country</td><td>字符串</td><td><p>按国家的 Offer（&#x26;country=US, IN, AU） </p><p><span data-gb-custom-inline data-tag="emoji" data-code="1f517">🔗</span> <a href="/pages/d9d4155c600d0d3d7c6df1cd9f8ebac54fafa4a3#countries"><mark style="color:蓝色;">查看国家</mark></a></p></td></tr><tr><td><strong>offer_status</strong></td><td>整数</td><td>允许的值：<br><strong>1:</strong> 活动 offers（&#x26;offer_status=1）</td></tr><tr><td><strong>authorized</strong></td><td>整数</td><td>允许的值：<br><strong>1:</strong> 已分配的 Offers（&#x26;authorized=1）</td></tr></tbody></table>

{% code overflow="wrap" %}

```
https://api.offer18.com/api/af/offers?key=000000000&aid=0000&mid=0000&offer_id=0000000&model=000
```

{% endcode %}

***

### API 请求示例

![](/files/a9e502a78c71c94acd33841711a2f1ded2cfc990)

***

### **API 响应**

```json
{
  "response": "200",
  "data": {
    "00011": {
      "offerid": "00011",
      "name": "XXXXX",
      "logo": "https://example.com/sample.jpeg/",
      "status": "active",
      "category": "download campaigns, gaming, subscription offers, Ecommerece Campaign",
      "currency": "USD",
      "price": 100,
      "model": "CPA",
      "date_start": "2019-05-09 02:19:00",
      "date_end": "2021-08-31 02:19:00",
      "preview_url": "https://www.example.com/?offerid=00011",
      "offer_terms": "These are the offer terms",
      "offer_kpi": "",
      "country_allow": "IN,US",  
      "country_block": "GB", 
      "city_allow": "", 
      "city_block": "", 
      "os_allow": "", 
      "os_block": "", 
      "device_allow": "", 
      "device_block": "", 
      "isp_allow": "", 
      "isp_block": "", 
      "browser_allow": "", 
      "browser_block": "", 
      "capping": [
        {
          "rule_type": "shared_capping",
          "event": "",
          "type": "gross_conversions",
          "period": "daily",
          "value": 100,
          "timezone": null,
          "rule_id": "00000"
        },
        {
          "rule_type": "affiliate_capping",
          "event": "",
          "type": "approved_conversions",
          "period": "daily",
          "value": 100,
          "timezone": null,
          "rule_id": "00000"
        }
      ],
      "events": [
        {
          "event_name": "registration",
          "event_token": "registration"
        }
      ],
      "payout": [
        {
          "payout": "515.0000",
          "currency": "USD",
          "model": "CPA",
          "condition": [
            [
              {
                "field": "event",
                "operator_type": "is_equal",
                "value": "reagistration"
              },
              {
                "field": "country",
                "operator_type": "is_equal",
                "value": "US"
              },
              {
                "field": "device_type",
                "operator_type": "is_equal",
                "value": "smartphone"
              },
              {
                "field": "browser",
                "operator_type": "is_equal",
                "value": "ch"
              },
              {
                "field": "os",
                "operator_type": "is_equal",
                "value": "android"
              }
            ]
          ],
          "rule_id": "00000"
        }
      ],
      "suppression_list": [
        {
          "name": "Sample Suppression list",
          "file_url": "https:\/\/storage.googleapis.com\/offer18-user-data\/suppression\/0000\/3dd0e00000f9202c8602b84feaf7_file.zip?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=service-account%40offer18.iam.gserviceaccount.com%2F20250324%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20250324T122057Z&X-Goog-Expires=172800&X-Goog-SignedHeaders=host&X-Goog-Signature=5ce353be3a209f62098d934b32b40d3af66b52a203ca821158c642a7c80c939af5bbad6435c2ce441b24e52df7f7bed4d4c54af8c4a8b54510c1dd7a55922ea49e52e1d1d4b6060000000653252a5d09c272f4748acf990c6eee95e166a87515fe984224fd587cf2c33d",
          "unsubscribe_url": "https:\/\/example.com",
          "subject_lines": "sample subject lines",
          "from_lines": "sample from lines"
        }
      ],
      "impression_url": "https://mynet.o18.click/i?o=00011&m=000&a=00000",
      "click_url": "https://mynet.o18.click/c?o=00011&m=000&a=00000",
      "landing_page_urls": {
                "random": "https://mynet.o18.click/c?o=00011&m=000&a=00000&mo=r",
                "LP1": "https://mynet.o18.click/c?o=00011&m=000&a=00000&mo=LP1",
                "LP2": "https://mynet.o18.click/c?o=00011&m=000&a=00000&mo=LP2"
            },
      "authorized": "true",
      "creatives": [
        {
          "type": "image",
          "url": "https://example.com/creative_00001.png"
        },
        {
          "type": "image",
          "url": "https://example.com/creative_00002.png"
        },
        {
          "type": "html",
          "url": "https:example.com/creative00002.zip"
        }
      ],
      "targeting": [
        {
          "action_on_clicks": "allow",
          "condition": [
            [
              {
                "field": "country",
                "operator_type": "is_equal",
                "value": "IN,US"
              },
              {
                "field": "device_type",
                "operator_type": "not_equal",
                "value": "smartphone"
              }
            ]
          ],
          "rule_id": "101"
        },
        {
          "action_on_clicks": "reject",
          "condition": [
            [
              {
                "field": "os",
                "operator_type": "not_equal",
                "value": "android"
              }
            ]
          ],
          "rule_id": "102"
        },
        {
          "action_on_impressions": "allow",
          "condition": [
            [
              {
                "field": "country",
                "operator_type": "is_equal",
                "value": "IN,US"
              },
              {
                "field": "os",
                "operator_type": "is_equal",
                "value": "windows"
              }
            ]
          ],
          "rule_id": "103"
        }
      ]
    }
  }
}
```

{% hint style="info" %}

1. **共享封顶 -** 一条封顶规则可由多个联盟客共享。
2. Suppression File URL 仅在 2 小时内有效。我们建议尽快下载并使用该文件，以确保持续访问和功能正常。
   {% endhint %}

#### 应用 Offer

<table data-header-hidden><thead><tr><th width="163.8046846634862">查询</th><th width="150"> </th><th width="407.6775081031496"> </th></tr></thead><tbody><tr><td><strong>查询</strong></td><td><strong>类型</strong></td><td><strong>描述</strong></td></tr><tr><td>offer_access</td><td>整数</td><td>允许的值<br><strong>1:</strong> 批准公开 Offers（&#x26;offer_access=1）</td></tr></tbody></table>

{% code overflow="wrap" %}

```
https://api.offer18.com/api/af/offers?key=000000000&aid=0000&mid=0000&offer_access=1
```

{% endcode %}


---

# 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://knowledgebase.offer18.com/zh/lian-meng-huo-ban/lian-meng-huo-ban-api/offers-api.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.