CarbonMeld API(v1)
30天高级版通行证包含 REST API v1:项目记录、筛选列表与市场统计。使用 Bearer 密钥,默认每个密钥每天 300 次请求。
API 返回哪些数据
读取 CarbonMeld 持有的项目数据:项目列表、市场统计,以及包含已有质量评分和文档分析的单个项目记录。若有高级版详情,项目接口会将其与公开数据合并。评分和分析取决于已发布的记录;通行证不会生成尚不存在的分析。
获取密钥
持有效的30天高级版通行证,在账户栏登录后生成 API 密钥。密钥只显示一次,请立即保存。重新生成会撤销旧密钥。通行证到期后密钥无法通过认证;购买新通行证后,未被撤销的密钥可再次使用。
打开账户栏身份认证
每次请求都需在 Authorization 请求头中发送密钥。密钥以 cmk_ 开头,后接64个小写十六进制字符。示例使用占位符;请在本地替换为您自己的密钥并妥善保管。
Authorization: Bearer cmk_YOUR_KEY_HERE 接口
| 请求 | 返回内容 |
|---|---|
GET /api/v1/stats | 当前导出数据中的市场统计,包括项目数、登记机构数和 updated_at。这是已收录项目数量,不是已完成评估的数量。 |
GET /api/v1/projects | 筛选后的项目列表:updated_at、total(筛选后的总数)、limit、offset 和 projects。 |
GET /api/v1/projects/<id_or_slug> | 通过登记编号、规范 slug 或别名获取单个项目。返回已有高级版详情时,会计入共享的每日项目额度。 |
项目列表参数
| 参数 | 允许值 |
|---|---|
registry | 数据中存在的标准代码,不区分大小写(例如 VCS)。未知值返回400,并列出可用值。 |
min_score | 0至10之间的数值。只要提供此参数,即使为0,也会排除没有数值评分的项目;省略该参数可包含未评分项目。 |
limit | 1至200之间的十进制整数,默认50。 |
offset | 非负十进制整数,默认0。 |
额度与合理使用
- 300 次请求/天/密钥,为默认上限,由 REST 与 MCP 共享。
- 30 个不同高级版项目/天,由网站、PDF 报告、REST 与 MCP 共享。同一天重复打开同一项目只计一次。投资组合中的项目及为您解锁的项目不占此额度;仅返回公开记录也不消耗项目额度。
每日计数在 UTC 00:00 重置。另外,每个 IP 每分钟最多120次请求。列表和统计请求计入请求次数,但不消耗高级版项目额度。
错误
| 状态码 | 含义与处理方法 |
|---|---|
400 | 项目标识符或列表参数无效。请检查错误消息和允许值。 |
401 | 密钥缺失、无效、已撤销,或没有有效通行证。请检查 Authorization 请求头及账户。 |
404 | 未找到项目。请核对登记编号或 slug。 |
429 | 已达请求、突发请求或项目额度。请按 Retry-After 响应头等待。 |
503 | 项目正在更新。请按 Retry-After 等待后重试。 |
请求示例
先获取筛选列表,再按登记编号请求单个记录。第二次请求可能消耗一次高级版项目额度。
curl 'https://carbonmeld.com/api/v1/projects?registry=VCS&min_score=7&limit=5&offset=0' \
-H 'Authorization: Bearer cmk_YOUR_KEY_HERE'
curl 'https://carbonmeld.com/api/v1/projects/VCS-1318' \
-H 'Authorization: Bearer cmk_YOUR_KEY_HERE'查看示例项目:VCS-1318 API 的功能边界
此接口提供 CarbonMeld 数据的只读访问,不接入登记机构的签发或 MRV 工作流,不签发或转移信用,也不验证单个序列号的所有权。登记标签和记录数量反映我们持有的数据,并不构成对报价的保证。
条款
将数据用于工作前,请阅读使用条件与评分方法说明。
使用条款在 AI 助手中使用
MCP 服务器使用相同的 API 密钥和额度。
MCP 指南