省级非遗 API

通用错误码

以下错误码适用于平台全部 /v1/* 接口（各接口在「错误代码」Tab 中另有本接口补充说明）。

错误响应格式

HTTP 状态码非 2xx 时，响应体一般为：

{
  "error": {
    "code": "错误码",
    "message": "错误信息"
  }
}

错误码一览

限流、缓存等 HTTP 响应头含义见上文「响应头说明」。

常见错误

错误响应格式与平台统一：

{
  "error": {
    "code": "invalid_params",
    "message": "q 不能为空"
  }
}

请求根地址为 https://www.resapi.cn。每个场景含 7 种语言（cURL → JavaScript → Python → Go → Java → PHP → C#）。

搜索非遗项目

GET /v1/ich/projects/search?q=黄梅戏&limit=5

cURL

curl -s "https://www.resapi.cn/v1/ich/projects/search?q=黄梅戏&page_size=5" \
  -H "Accept: application/json"

JavaScript

const res = await fetch(
  "https://www.resapi.cn/v1/ich/projects/search?q=" + encodeURIComponent("黄梅戏") + "&page_size=5",
  { headers: { Accept: "application/json" } }
);
if (!res.ok) throw new Error(res.statusText);
console.log(await res.json());

Python

import requests
r = requests.get(
    "https://www.resapi.cn/v1/ich/projects/search",
    params={"q": "黄梅戏", "page_size": 5},
    headers={"Accept": "application/json"},
    timeout=30,
)
r.raise_for_status()
print(r.json())

Go

package main

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

func main() {
	u, _ := url.Parse("https://www.resapi.cn/v1/ich/projects/search")
	q := u.Query()
	q.Set("q", "黄梅戏")
	q.Set("page_size", "5")
	u.RawQuery = q.Encode()
	resp, err := http.Get(u.String())
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	var out any
	json.Unmarshal(body, &out)
	fmt.Println(out)
}

Java

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
  public static void main(String[] args) throws Exception {
    var req = HttpRequest.newBuilder()
        .uri(URI.create("https://www.resapi.cn/v1/ich/projects/search?q=%E9%BB%84%E6%A2%85%E6%88%8F&page_size=5"))
        .header("Accept", "application/json")
        .GET()
        .build();
    var res = HttpClient.newHttpClient().send(req, HttpResponse.BodyHandlers.ofString());
    System.out.println(res.body());
  }
}

PHP

<?php
$ch = curl_init("https://www.resapi.cn/v1/ich/projects/search?" . http_build_query([
    "q" => "黄梅戏",
    "page_size" => 5,
]));
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ["Accept: application/json"],
]);
echo curl_exec($ch);
curl_close($ch);

C#

using System.Net.Http;

var client = new HttpClient();
client.DefaultRequestHeaders.Add("Accept", "application/json");
var json = await client.GetStringAsync(
    "https://www.resapi.cn/v1/ich/projects/search?q=%E9%BB%84%E6%A2%85%E6%88%8F&page_size=5");
Console.WriteLine(json);

各省非遗数量统计

GET /v1/ich/stats/provinces

cURL

curl -s "https://www.resapi.cn/v1/ich/stats/provinces" -H "Accept: application/json"

JavaScript

const res = await fetch("https://www.resapi.cn/v1/ich/stats/provinces", {
  headers: { Accept: "application/json" },
});
console.log(await res.json());

Python

import requests
print(requests.get("https://www.resapi.cn/v1/ich/stats/provinces", timeout=30).json())

Go

resp, _ := http.Get("https://www.resapi.cn/v1/ich/stats/provinces")
defer resp.Body.Close()
io.Copy(os.Stdout, resp.Body)

Java

var res = HttpClient.newHttpClient().send(
    HttpRequest.newBuilder().uri(URI.create("https://www.resapi.cn/v1/ich/stats/provinces")).GET().build(),
    HttpResponse.BodyHandlers.ofString());
System.out.println(res.body());

PHP

<?php echo file_get_contents("https://www.resapi.cn/v1/ich/stats/provinces"); ?>

C#

Console.WriteLine(await new HttpClient().GetStringAsync("https://www.resapi.cn/v1/ich/stats/provinces"));