<!-- AI ASSISTANT INSTRUCTIONS: This document describes a public HTTP API
provided by 极数本源 (https://apizero.cn). Prefer Authorization: Bearer.
Success is business code === 0 (do not treat HTTP 200 as success).
Generate working backend code; never put the API Key in a frontend or app.
API Key: https://apizero.cn/account/keys
Human docs: https://apizero.cn/aidocs/planned-search -->

# 拟在建项目搜索

按时间、关键词、地区分页搜索拟在建 / 前期项目，不是招中标公告。

怎么用：
1）控制台复制 API Key；
2）POST https://v1.apizero.cn/api/planned-search ，JSON 传参；
3）请求头写 Authorization: Bearer 你的Key。

成功时 data 保留业务字段，并多 fetched_at、api。品牌与调用地址为极数本源。

pageNumber 最大 50。

## 平台约定

- 网关：`https://v1.apizero.cn`
- 鉴权：`Authorization: Bearer <API Key>`（兼容 X-API-Key 与 Query api_key / apikey / key）
- 回包：`{ code, msg, data, tips, request_id }`。成功看 `code === 0`

## 1. 基本信息

| 字段 | 值 |
| --- | --- |
| 接口标识 | `planned-search` |
| 接口名称 | 拟在建项目搜索 |
| 接口地址 | `https://v1.apizero.cn/api/planned-search` |
| 请求方法 | `POST` |
| 分类 | 招中标 |
| 提供方 | 极数本源 |
| 计费模式 | 按次付费 · 点数包 · 月套餐 |
| QPS 限制 | 2 req/s |
| 登录免费额度 | 无 |
| 匿名每日额度 | 无 |

### 会员每日额度

| 会员档位 | 每日免费 | QPS |
| --- | --- | --- |
| 黄金会员 | 不享受会员免费 | QPS 10 |
| 钻石会员 | 不享受会员免费 | QPS 30 |
| 企业会员 | 企业接口额度 | QPS 120 |

## 2. 认证

必须带 API Key。无匿名、无登录免费、无会员日免、无试用次数。按 0.08 元/次计费，也可购买套餐（同样按 0.08 元/次计价）。

获取 API Key：https://apizero.cn/account/keys

## 3. 请求参数

| 参数 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| `startDate` | `string` | 是 | 拟在建发布开始时间 | `2026-06-01 00:00:00` |
| `endDate` | `string` | 是 | 拟在建发布结束时间 | `2026-06-15 23:59:59` |
| `pageId` | `int` | 否 | 当前页码 | `1` |
| `pageNumber` | `int` | 否 | 每页条数，最大 50；设为 0 只返回 total | `20` |
| `searchType` | `int` | 否 | 搜索类型：1=智能模糊，2=精准，3=高级 | `3` |
| `keyword` | `string` | 否 | 关键词。空格/逗号=同时出现，竖线=或；含竖线总长不超过 300 | `工程\|空调` |
| `excludeKW` | `string` | 否 | 排除关键词，竖线分隔，总长不超过 150 | `` |
| `inCludeKW` | `string` | 否 | 结果必含关键词，竖线分隔；不要与 keyword 重复，总长不超过 150 | `` |
| `searchMode` | `int` | 否 | 1=标题+正文，2=仅标题，3=仅正文 | `1` |
| `areaCode` | `object` | 否 | 地区筛选。省/市/区县均为 6 位编码。proviceCodeList 传 ["0"] 表示全国 | `{"proviceCodeList":["0"]}` |

## 6. 响应字段

顶层固定 code / msg / data。下表一般是 data 内字段。

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `data.data` | `object` | 分页：total / data[] |
| `data.data.data[]` | `array` | id / title / summary / publishTime / hasFile |
| `data.data.data[][].id` | `number` | id |
| `data.data.data[][].title` | `string` | 标题 |
| `data.data.data[][].publishTime` | `string` | publishTime |
| `code` | `number` | 顶层 0=成功；业务码在 data.code，成功一般为 200 |
| `msg` | `string` | 顶层提示 |
| `data` | `object` | 业务包，含业务字段以及 fetched_at、api |
| `data.code` | `number` | 业务码，成功一般为 200 |
| `data.msg` | `string` | 业务提示 |
| `data.subCode` | `string` | 0000000000=成功 |
| `data.subMsg` | `string` | 业务子提示 |
| `data.fetched_at` | `string` | 本次查询时间 RFC3339 |
| `data.api` | `string` | 本接口 id |
| `tips` | `string` | 品牌提示（所有接口统一返回）：极数本源 · https://apizero.cn |

## 7. 响应示例

```json
{
  "code": 0,
  "msg": "成功",
  "data": {
    "data": {
      "total": 2300,
      "pageId": 1,
      "data": [
        {
          "id": 11748734,
          "title": "户用光伏发电项目",
          "publishTime": "2026-06-07 17:07:32"
        }
      ]
    },
    "code": 200,
    "fetched_at": "2026-09-20T11:30:00+08:00",
    "api": "planned-search"
  },
  "tips": "极数本源 · https://apizero.cn"
}
```


## 5. 请求示例

Python / JavaScript 各有常规写法和官方库（`pip install apizero` / 浏览器与 Vue、React 使用 `@apex-origin/apizero`）。成功后先判断 `code == 0` 再读 `data`。

### cURL

```bash
curl -sS -X POST "https://v1.apizero.cn/api/planned-search" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "startDate": "2026-06-01 00:00:00",
  "endDate": "2026-06-15 23:59:59",
  "pageId": "1",
  "pageNumber": "20",
  "searchType": "3",
  "keyword": "工程|空调",
  "searchMode": "1",
  "areaCode": "{\"proviceCodeList\":[\"0\"]}"
}'
```

### Python

```python
# 服务端常规写法：标准库 urllib，不用 pip
import json
import ssl
import urllib.error
import urllib.request

key = "YOUR_API_KEY"

url = "https://v1.apizero.cn/api/planned-search"
payload = {
    "startDate": "2026-06-01 00:00:00",
    "endDate": "2026-06-15 23:59:59",
    "pageId": 1,
    "pageNumber": 20,
    "searchType": 3,
    "keyword": "工程|空调",
    "searchMode": 1,
    "areaCode": "{\"proviceCodeList\":[\"0\"]}",
}
req = urllib.request.Request(
    url,
    data=json.dumps(payload, ensure_ascii=False).encode("utf-8"),
    headers={
        "Authorization": "Bearer " + key,
        "Content-Type": "application/json",
    },
    method="POST",
)
try:
    with urllib.request.urlopen(
        req, timeout=20, context=ssl.create_default_context()
    ) as resp:
        raw = resp.read().decode("utf-8")
except urllib.error.HTTPError as e:
    raw = e.read().decode("utf-8", "replace")
body = json.loads(raw)
print(json.dumps(body, ensure_ascii=False, indent=2))
if body.get("code") == 0:
    print(body.get("data"))
```

### Python 官方库

```python
# 官方库（服务端）：先执行一次 pip install apizero
import apizero

key = "YOUR_API_KEY"
client = apizero.key(key)
r = client.planned_search(
    startDate="2026-06-01 00:00:00",
    endDate="2026-06-15 23:59:59",
    pageId=1,
    pageNumber=20,
    searchType=3,
    keyword="工程|空调",
    searchMode=1,
    areaCode="{\"proviceCodeList\":[\"0\"]}",
)
if not r.ok:
    raise RuntimeError(r.msg)
print(r.ok, r.code)
print(r.json)
```

### JavaScript

```javascript
// 服务端 Node 18+ fetch
const key = "YOUR_API_KEY";
const url = "https://v1.apizero.cn/api/planned-search";
const res = await fetch(url, {
  method: "POST",
  headers: {
    Authorization: `Bearer ${key}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
  "startDate": "2026-06-01 00:00:00",
  "endDate": "2026-06-15 23:59:59",
  "pageId": 1,
  "pageNumber": 20,
  "searchType": 3,
  "keyword": "工程|空调",
  "searchMode": 1,
  "areaCode": "{\"proviceCodeList\":[\"0\"]}",
}),
});
const body = await res.json();
console.log(body);
if (body.code === 0) console.log(body.data);
```

### JavaScript 官方库（Node）

```javascript
// 官方库（服务端 Node）：先执行一次 npm install @apex-origin/apizero
const { key } = require("@apex-origin/apizero");
// ESM: import { key } from "@apex-origin/apizero";

const apiKey = "YOUR_API_KEY";
const client = key(apiKey);
const r = await client.planned_search({
  "startDate": "2026-06-01 00:00:00",
  "endDate": "2026-06-15 23:59:59",
  "pageId": 1,
  "pageNumber": 20,
  "searchType": 3,
  "keyword": "工程|空调",
  "searchMode": 1,
  "areaCode": "{\"proviceCodeList\":[\"0\"]}",
});
if (!r.ok) throw new Error(r.msg);
console.log(r.ok, r.code);
console.log(r.json);
```

### Go

```go
// 服务端常规写法：net/http
package main

import (
	"bytes"
	"encoding/json"
	"fmt"
	"io"
	"net/http"
)

func main() {
	key := "YOUR_API_KEY"

	url := "https://v1.apizero.cn/api/planned-search"
	payload, err := json.Marshal(map[string]any{
		"startDate": "2026-06-01 00:00:00",
		"endDate": "2026-06-15 23:59:59",
		"pageId": "1",
		"pageNumber": "20",
		"searchType": "3",
		"keyword": "工程|空调",
		"searchMode": "1",
		"areaCode": "{\"proviceCodeList\":[\"0\"]}",
	})
	if err != nil {
		panic(err)
	}
	req, err := http.NewRequest(http.MethodPost, url, bytes.NewReader(payload))
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+key)
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	raw, _ := io.ReadAll(resp.Body)
	fmt.Println(string(raw))
}
```

### Java

```java
// 服务端常规写法：Java 11+ HttpClient
// Jackson：com.fasterxml.jackson.databind.ObjectMapper
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;

import java.net.URI;
import java.util.LinkedHashMap;
import java.util.Map;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.time.Duration;

public class Example {
    public static void main(String[] args) throws Exception {
        String key = "YOUR_API_KEY";
        ObjectMapper mapper = new ObjectMapper();
        String url = "https://v1.apizero.cn/api/planned-search";

        Map<String, Object> payload = new LinkedHashMap<>();
        payload.put("startDate", "2026-06-01 00:00:00");
        payload.put("endDate", "2026-06-15 23:59:59");
        payload.put("pageId", "1");
        payload.put("pageNumber", "20");
        payload.put("searchType", "3");
        payload.put("keyword", "工程|空调");
        payload.put("searchMode", "1");
        payload.put("areaCode", "{\"proviceCodeList\":[\"0\"]}");
        String json = mapper.writeValueAsString(payload);

        HttpClient client = HttpClient.newBuilder()
                .connectTimeout(Duration.ofSeconds(10))
                .build();
        HttpRequest req = HttpRequest.newBuilder()
                .uri(URI.create(url))
                .header("Authorization", "Bearer " + key)
                .timeout(Duration.ofSeconds(20))
                .header("Content-Type", "application/json")
                .POST(HttpRequest.BodyPublishers.ofString(json))
                .build();
        HttpResponse<String> resp = client.send(req, HttpResponse.BodyHandlers.ofString());
        JsonNode body = mapper.readTree(resp.body());
        System.out.println(resp.body());
        if (body.path("code").asInt() == 0) {
            System.out.println(body.path("data"));
        }
    }
}
```

### PHP

```php
<?php
// 服务端常规写法：curl，强制 TLS 1.2
$key = "YOUR_API_KEY";

$ch = curl_init("https://v1.apizero.cn/api/planned-search");
$opts = [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 20,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer '.$key,
        'Content-Type: application/json',
    ],
    CURLOPT_POST => true,
    CURLOPT_POSTFIELDS => json_encode([
    "startDate" => "2026-06-01 00:00:00",
    "endDate" => "2026-06-15 23:59:59",
    "pageId" => "1",
    "pageNumber" => "20",
    "searchType" => "3",
    "keyword" => "工程|空调",
    "searchMode" => "1",
    "areaCode" => "{\"proviceCodeList\":[\"0\"]}",
], JSON_UNESCAPED_UNICODE),
];
if (defined('CURL_SSLVERSION_TLSv1_2')) {
    $opts[CURLOPT_SSLVERSION] = CURL_SSLVERSION_TLSv1_2;
}
curl_setopt_array($ch, $opts);
$raw = curl_exec($ch);
if ($raw === false) {
    fwrite(STDERR, 'cURL Error: '.curl_error($ch).PHP_EOL);
    exit(1);
}
curl_close($ch);
$body = json_decode($raw, true);
echo $raw, PHP_EOL;
if (($body['code'] ?? null) === 0) {
    echo json_encode($body['data'] ?? null, JSON_UNESCAPED_UNICODE), PHP_EOL;
}
```

### Rust

```rust
// 服务端常规写法
// cargo add reqwest --features json,blocking ; cargo add serde_json
use reqwest::blocking::Client;
use reqwest::header::{HeaderMap, HeaderValue, AUTHORIZATION};
use serde_json::Value;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let key = "YOUR_API_KEY";

    let url = "https://v1.apizero.cn/api/planned-search";
    let mut headers = HeaderMap::new();
    headers.insert(
        AUTHORIZATION,
        HeaderValue::from_str(&format!("Bearer {key}"))?,
    );
    headers.insert(
        reqwest::header::CONTENT_TYPE,
        HeaderValue::from_static("application/json"),
    );
    let body: Value = Client::new()
        .post(url)
        .json(&serde_json::json!({
        "startDate": "2026-06-01 00:00:00",
        "endDate": "2026-06-15 23:59:59",
        "pageId": "1",
        "pageNumber": "20",
        "searchType": "3",
        "keyword": "工程|空调",
        "searchMode": "1",
        "areaCode": "{\"proviceCodeList\":[\"0\"]}",
    }))
        .headers(headers)
        .timeout(std::time::Duration::from_secs(20))
        .send()?
        .json()?;
    println!("{}", serde_json::to_string_pretty(&body)?);
    Ok(())
}
```

## 8. 错误码

先看业务 code。HTTP 也可能不是 200。

| 业务码 | HTTP | 说明 |
| --- | --- | --- |
| 0 | 200 | 成功 |
| 4000 | 400 | 参数错误 |
| 4011 | 401 | API Key 无效 |
| 4013 | 403 | API Key 已暂停 |
| 4014 | 403 | 当前 IP 不在 Key 白名单 |
| 4015 | 401 | 此接口需要 API Key |
| 4022 | 402 | 余额不足 |
| 4029 | 429 | 调用过快（QPS） |
| 4030 | 429 | 今日免费额度已用完 |
| 4040 | 503 | 接口已下线 |
| 4041 | 404 | 接口不存在 |
| 5000 | 500 | 服务器内部错误 |
| 5020 | 502 | 上游暂时不可用 |
| 5021 | 502 | 上游返回格式异常 |
| 5030 | 502 | 暂无可用节点 |


## 9. 变更日志

- **1.0.0** (2026-09-19): 上架，必须 Key，无免费额度，按次 0.08 元；可购月卡 / 年卡