CSGOFloat 镜像文档

镜像概述和主要用途

CSGOFloat是一个免费开源的API服务，允许通过CSGO物品的检查链接获取其float值（磨损度）和涂装种子。该服务需搭配拥有CS:GO的Steam账户（机器人）运行，每个账户每秒可处理1次请求，支持多账户部署以提升并发能力。适用于CSGO物品交易平台、第三方工具开发者及个人玩家查询物品详细属性。

核心功能和特性

• 物品属性查询：通过检查链接获取float值、涂装种子、磨损等级、贴纸信息等完整属性
• 多接口支持：提供两种查询方式，支持直接使用检查链接或拆分参数（s、a、d、m）调用
• 多机器人扩展：支持配置多个Steam机器人账户，单实例建议部署300个以内以保证稳定性
• 缓存兼容：可集成MongoDB、Nginx或Varnish等缓存服务，优化重复查询性能
• 错误处理机制：完善的错误码体系，覆盖参数错误、服务器超时等常见异常场景

使用场景和适用范围

• CSGO物品交易平台：实时展示物品磨损度、涂装信息，辅助交易决策
• 第三方工具开发：集成物品属性查询功能，如库存管理、市场分析工具
• 个人玩家：查询自己或市场物品的详细属性，评估物品价值

详细使用方法和配置说明

Docker部署

拉取镜像

bash
docker pull step7750/csgofloat:latest

启动容器

bash
docker run -d --name csgofloat -v /host/config:/config -p 80:80 -p 443:443 step7750/csgofloat:latest

参数说明：

• -v /host/config:/config：挂载宿主机目录至容器，用于持久化配置文件
• -p 80:80/-p 443:443：映射HTTP/HTTPS端口（根据实际需求调整）
• --name csgofloat：指定容器名称，便于管理

首次启动配置

1. 首次启动后，容器会在/host/config目录生成config.js配置文件
2. 停止容器：docker stop csgofloat
3. 编辑config.js，添加Steam机器人账户信息（用户名、密码、2FA配置）
4. 重启容器：docker start csgofloat使配置生效

机器人账户配置与登录

每个机器人账户需拥有CS:GO，首次登录需配置两步验证（2FA）：

***2FA配置

1. 在config.js中仅填写机器人的user（用户名）和pass（密码），auth字段留空
2. 启动容器，查看日志获取***验证码提示
3. 将验证码填入config.js的auth字段
4. 重启容器，登录成功后生成sentry文件，后续可移除auth字段

手机2FA配置

1. 在config.js中填写user、pass及手机2FA的shared_secret（填入auth字段）
2. 启动容器，登录成功后生成sentry文件，后续需保留auth字段

API接口说明

基础信息

• 服务端点：http://<服务器IP> 或 https://<服务器IP>

接口1：使用拆分参数查询

请求格式

GET /?s=<s>&a=<a>&d=<d>&m=<m>

参数说明

示例

[***]
[***]

接口2：使用检查链接查询

请求格式

GET /?url=<完整检查链接>

参数说明

示例

[***]

响应说明

API返回基于CSGO protobuf定义的JSON数据，包含物品完整属性。

响应示例

json
{
  "iteminfo": {
    "itemid": "13874827217",
    "defindex": 7,
    "paintindex": 282,
    "rarity": 5,
    "quality": 4,
    "paintseed": 361,
    "floatvalue": 0.22740158438682556,
    "imageurl": "[***]",
    "min": 0.1,
    "max": 0.7,
    "weapon_type": "AK-47",
    "item_name": "Redline",
    "rarity_name": "Classified",
    "quality_name": "Unique",
    "origin_name": "Found in Crate",
    "wear_name": "Field-Tested",
    "full_item_name": "AK-47 | Redline (Field-Tested)"
  }
}

核心字段说明

错误处理

错误代码说明

错误响应示例

json
{
  "error": "Valve's servers didn't reply in time",
  "code": 4
}

高级配置与注意事项

• 缓存建议：部署MongoDB或在服务前添加Nginx缓存，减少对Valve服务器的重复请求
• 性能优化：单实例机器人账户控制在300个以内，多实例部署需配置负载均衡
• 版本变更：v3.0起使用node-steam-user，sentry文件路径变更（遵循系统默认路径），旧版本升级需重新验证账户
• 启动参数：支持-c <path>指定配置文件路径，-s <path>指定steam数据目录（默认使用node-steam-user系统路径）