<!-- 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/visits-counter -->

# 访问量计数器

SVG/JSON访问量计数器，支持多套动效主题卡片（咒纹夜/术式蓝焰/五条悟风/无量空处/宿傩咒印等），可嵌入GitHub README或网站。按站点隔离计数。

## 平台约定

- 网关：`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. 基本信息

| 字段 | 值 |
| --- | --- |
| 接口标识 | `visits-counter` |
| 接口名称 | 访问量计数器 |
| 接口地址 | `https://v1.apizero.cn/api/visits-counter` |
| 请求方法 | `GET` |
| 分类 | 开发工具 |
| 提供方 | 极数本源 |
| 计费模式 | 完全免费 |
| QPS 限制 | QPS 3 |
| 登录免费额度 | 1,000 次 |
| 匿名每日额度 | 500 次 |

### 会员每日额度

| 会员档位 | 每日免费 | QPS |
| --- | --- | --- |
| 黄金会员 | 50,000 次/日 | QPS 10 |
| 钻石会员 | 100,000 次/日 | QPS 30 |
| 企业会员 | 1,000,000 次/日 | QPS 120 |

## 2. 认证

匿名调用 500 次/天，登录后 1000 次/天，API Key 按你的额度计算。

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

## 3. 请求参数

| 参数 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| `site` | `string` | 否 | 站点标识，用于区分不同来源（建议传你的域名）。不传时全局共享一个计数器。 | `apizero.cn` |
| `name` | `string` | 否 | 计数器名称，同一站点下可挂多个不同位置（首页/产品页/文章页等）。默认 demo。 | `home` |
| `mode` | `string` | 否 | 计数模式：daily=每日清零 / total=累计不清零。默认 daily。 | `total` |
| `theme` | `string` | 否 | 主题：默认 gojo_board（像素角色举牌+数字 GIF 动画）。可选 gojo_board/hoops_board/zero_board/jjk_infinity/rule34/moebooru/gelbooru/cursed_night/seal_blue/talisman_red/void_gold/gojo_satoru/infinity_void/sukuna_mark。前 7 个为像素牌主题（角色帧动画），后 7 个为 SVG 渐变主题。 | `gojo_board` |
| `format` | `string` | 否 | 输出格式：svg（默认，可直接 <img> 嵌入网页）/ png（静态图，scale=1~4）/ json（原始 JSON 数据，便于自集成）。 | `svg` |
| `length` | `int` | 否 | 数字位数 4~12，默认 7（前导补 0）。 | `7` |
| `no_increment` | `int` | 否 | 只读模式：1=只查询不递增（适合预览/调试）。默认 0。 | `0` |

## 6. 响应字段

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

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | `string` | 业务码：200 成功，4xxx/5xxx 错误 |
| `desc` | `string` | 业务描述（success / 错误原因） |
| `data` | `object` | 业务数据（仅 format=json 时返回；format=svg/png 时直接返回图片二进制） |
| `data.name` | `string` | 计数器名称（与请求参数 name 一致） |
| `data.mode` | `string` | 计数模式：daily / total |
| `data.theme` | `string` | 生效的主题键（不识别会回退 gojo_board） |
| `data.theme_name` | `string` | 主题中文名（前端可直接显示） |
| `data.value` | `int` | 当前计数值（按 mode 取 daily 或 total） |
| `data.display_value` | `string` | 前导补 0 的展示值，与 SVG 上数字一致 |
| `data.record` | `object` | 完整计数记录 |
| `data.record.total` | `int` | 历史累计计数 |
| `data.record.daily` | `int` | 今日计数 |
| `data.record.day` | `string` | 今日日期（YYYY-MM-DD） |
| `data.record.updated_at` | `string` | 记录最近更新时间（ISO8601） |
| `data.incremented` | `bool` | 本次调用是否已自增 |
| `data.step` | `int` | 本次自增步长 |
| `data.length` | `int` | 生效的数字位数 |
| `data.format` | `string` | 生效的输出格式 |
| `tips` | `string` | 品牌提示（所有接口统一返回）：极数本源 · https://apizero.cn |

## 7. 响应示例

```json
{
  "code": "200",
  "desc": "success",
  "data": {
    "name": "home",
    "mode": "daily",
    "theme": "gojo_board",
    "theme_name": "像素牌-苍空",
    "value": 42,
    "display_value": "0000042",
    "record": {
      "total": 1024,
      "daily": 42,
      "day": "2026-05-09",
      "updated_at": "2026-05-09T21:48:52+08:00"
    },
    "incremented": true,
    "step": 1,
    "length": 7,
    "format": "json"
  },
  "tips": "极数本源 · https://apizero.cn"
}
```


## 5. 请求示例

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

### cURL

```bash
curl -sS -H "Authorization: Bearer YOUR_API_KEY" "https://v1.apizero.cn/api/visits-counter?site=apizero.cn&name=home&mode=total&theme=gojo_board&format=svg&length=7&no_increment=0"
```

### Python

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

key = "YOUR_API_KEY"

url = "https://v1.apizero.cn/api/visits-counter"
params = {
    "site": "apizero.cn",
    "name": "home",
    "mode": "total",
    "theme": "gojo_board",
    "format": "svg",
    "length": 7,
    "no_increment": 0,
}
query = urllib.parse.urlencode({k: "" if v is None else str(v) for k, v in params.items()})
req = urllib.request.Request(
    url + ("?" + query if query else ""),
    headers={"Authorization": "Bearer " + key},
    method="GET",
)
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.visits_counter(
    site="apizero.cn",
    name="home",
    mode="total",
    theme="gojo_board",
    format="svg",
    length=7,
    no_increment=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/visits-counter?site=apizero.cn&name=home&mode=total&theme=gojo_board&format=svg&length=7&no_increment=0";
const res = await fetch(url, {
  headers: { Authorization: `Bearer ${key}` },
});
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.visits_counter({
  "site": "apizero.cn",
  "name": "home",
  "mode": "total",
  "theme": "gojo_board",
  "format": "svg",
  "length": 7,
  "no_increment": 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 (
	"fmt"
	"io"
	"net/http"
)

func main() {
	key := "YOUR_API_KEY"

	url := "https://v1.apizero.cn/api/visits-counter?site=apizero.cn&name=home&mode=total&theme=gojo_board&format=svg&length=7&no_increment=0"
	req, err := http.NewRequest(http.MethodGet, url, nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+key)
	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.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/visits-counter?site=apizero.cn&name=home&mode=total&theme=gojo_board&format=svg&length=7&no_increment=0";

        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))
                .GET()
                .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/visits-counter?site=apizero.cn&name=home&mode=total&theme=gojo_board&format=svg&length=7&no_increment=0");
$opts = [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 20,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer '.$key,
    ],
];
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/visits-counter?site=apizero.cn&name=home&mode=total&theme=gojo_board&format=svg&length=7&no_increment=0";
    let mut headers = HeaderMap::new();
    headers.insert(
        AUTHORIZATION,
        HeaderValue::from_str(&format!("Bearer {key}"))?,
    );
    let body: Value = Client::new()
        .get(url)
        .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 | 暂无可用节点 |

### 本接口补充

| 业务码 | HTTP | 说明 |
| --- | --- | --- |
| 200 | 200 | 成功 |
| 4044 | 503 | 接口已下线（v1 网关层） |


## 9. 变更日志

- **1.0.0** (2026-05-08): 首次上线
支持7套动效主题
按站点隔离计数