# 入门

本文档提供了有关API端点，支持的环境以及Netnut SERP API的可用参数的信息。 API允许您检索搜索引擎结果页面（SERP）。

### 身份验证[​](https://serp-api.netnut.io/docs/SERP/Getting%20Started#authentication) <a href="#authentication" id="authentication"></a>

要访问Netnut API，您必须使用Netnut提供的用户名和密码，提供基本的身份验证。在HTTP请求标头中包括这些信息：

授权：Basic base64（用户名：密码）

其中base64（用户名：密码）是您的用户名和密码的base64编码字符串，并加入了冒号（:)分隔。

#### 环境 <a href="#environments" id="environments"></a>

* 基础 URL: `https://serp-api.netnut.io`
* 端点: /search

### API 参数和规格 <a href="#api-parameters--specifications" id="api-parameters--specifications"></a>

#### 搜索请求 <a href="#search-query" id="search-query"></a>

<table data-header-hidden data-full-width="true"><thead><tr><th></th><th></th><th></th></tr></thead><tbody><tr><td>名称</td><td>状态</td><td>描述</td></tr><tr><td>q</td><td>必需</td><td>“q”参数定义您要搜索的查询。 您可以使用常规 Google 搜索中使用的任何字符串（例如 inurl:、site:、intitle:）。</td></tr></tbody></table>

#### 分页 <a href="#pagination" id="pagination"></a>

| 名称    | 状态 | 描述                                                                                    |
| ----- | -- | ------------------------------------------------------------------------------------- |
| num   | 可选 | “num”参数定义查询返回的最大结果数。 例如，10（默认）返回 10 个结果，20 返回 20 个结果，60 返回 60 个结果。 我们支持每个查询最多 100 个结果 |
| start | 可选 | “start”参数定义结果偏移量。 它允许跳过给定数量的结果。 它用于分页。 （例如，0（默认）是结果的第一页，10 是结果的第二页，20 是结果的第三页，等等）。    |

#### 地理位置 <a href="#geographic-location" id="geographic-location"></a>

| 名称   | 状态 | 描述                                                                                                  |
| ---- | -- | --------------------------------------------------------------------------------------------------- |
| uule | 可选 | “uule”参数是您要用于执行 Google 搜索的 Google 位置编码。 [单击此处](https://site-analyzer.pro/services-seo/uule/)生成 UULE |

#### &#x20;本地化[​](https://serp-api.netnut.io/docs/SERP/Getting%20Started#--localization--) <a href="#localization" id="localization"></a>

| 名称           | 状态 | 描述                                                                                                       |
| ------------ | -- | -------------------------------------------------------------------------------------------------------- |
| googleDomain | 可选 | “googleDomain”参数定义用于 Google 搜索的 Google 域名。 默认为 [www.google.com。](http://www.google.com。) 请确保在域名前添加“www”。 |
| gl           | 可选 | “gl”参数定义用于 Google 搜索的国家/地区。它是两个字母的国家/地区代码。例如 - 使用 us 表示美国，使用 uk 表示英国，等等。                                 |
| hl           | 可选 | “hl”参数定义用于 Google 搜索的语言。 它是两个字母的语言代码。 例如 - 使用 en 表示英语，使用 de 表示德语等。访问 Google 语言页面以获取受支持的 Google 语言的完整列表。  |

#### &#x20;高级过滤器 <a href="#advanced-filters" id="advanced-filters"></a>

| 名称      | 状态 | 描述                                                                                                             |
| ------- | -- | -------------------------------------------------------------------------------------------------------------- |
| rawHtml | 可选 | “rawHtml”参数定义您想要的最终输出。可以将其设置为 true 或 false 以获取原始 html 响应。                                                      |
| safe    | 可选 | “safe”参数定义对成人内容的过滤。 它可以设置为active或off，默认情况下 Google 会模糊显示内容。                                                     |
| filter  | 可选 | “filter”参数允许定义是否启用或禁用“省略结果”和“相似结果”过滤器。将参数设置为 1（默认）会启用这些过滤器，将参数设置为 0 将禁用这些过滤器。                                  |
| nfpr    | 可选 | 该参数定义排除从拼写错误的自动更正中查询的结果。可以将其设置为 1 以排除这些结果，或设置为 0 以包含它们（默认）。                                                    |
| device  | 可选 | “device”参数定义用于获取 Google 搜索结果的设备。该参数可以设置为desktop（默认）使用常规浏览器，tablet使用平板浏览器（当前使用iPad），或mobile使用移动浏览器（当前使用iPhone）。 |

#### API 结果 HTTP 响应​

我们目前仅支持 JSON。 以下是 API 响应架构的示例：

```
{
    "url": "string",
    "general": {
        "searchEngine": "string",
        "resultsCount": 0,
        "searchTime": 0.0,
        "mobile": false,
        "searchType": "string",
        "pageTitle": "string",
        "timestamp": "string"
    },
    "input": {
        "originalUrl": "string",
        "userAgent": "string",
        "jobId": "string"
    },
    "organic": [
        {
            "title": "string",
            "description": "string",
            "link": "string",
            "extensions": [
                {
                    "type": "string",
                    "text": "string",
                    "extended": false,
                    "link": "string",
                    "rank": 0
                }
            ],
            "displayLink": "string",
            "rank": 0,
            "globalRank": 0
        }
    ],
    "pagination": {
        "currentPage": 0,
        "nextPage": 0,
        "nextPageLink": "string",
        "nextPageStart": 0
    },
    "related": [
        {
            "listGroup": false,
            "link": "string",
            "text": "string",
            "rank": 0,
            "globalRank": 0
        }
    ],
    "peopleAlsoAsk": [
        {
            "question": "string",
            "questionLink": "string",
            "answerSource": "string",
            "answerLink": "string",
            "answerDisplayLink": "string",
            "answerHtml": "string",
            "answers": [
                {
                    "type": "answer",
                    "text": "string",
                    "rank": 0
                }
            ],
            "rank": 0,
            "globalRank": 0
        }
    ]
}
```