SuperAPI AI 工具集

polymarket

数据与分析

查看项目

更新于 10-15 08:56

技能介绍

用途

本技能用于协助 Polymarket 平台相关的开发工作,覆盖完整平台能力(API、交易、市场数据)以及实时数据流客户端(通过 WebSocket 订阅实时市场活动)。当需要处理 Polymarket 预测市场、使用其 API 获取市场数据、实现交易策略、构建基于 Polymarket 服务的应用,或学习 Polymarket 最佳实践时,可触发本技能。

主要能力

平台能力包括:预测市场的创建与结算、交易 API(REST 与 WebSocket)、市场数据查询、用户投资组合管理、事件与市场发现。

实时流能力包括:基于 WebSocket 的持久连接、基于主题的订阅、动态订阅管理、面向目标数据的过滤器支持、私有数据的用户认证、带完整类型安全的 TypeScript,以及连接时的初始数据转储。

使用方式

实时数据客户端安装命令:

npm install @polymarket/real-time-data-client

基础用法示例:

import { RealTimeDataClient } from "@polymarket/real-time-data-client";

const onMessage = (message: Message): void => { console.log(message.topic, message.type, message.payload); };

const onConnect = (client: RealTimeDataClient): void => { client.subscribe({ subscriptions: [{ topic: "activity", type: "trades" }] }); };

new RealTimeDataClient({ onMessage, onConnect }).connect();

支持的 WebSocket 主题:

  1. Activity(activity):trades(已完成交易)、orders_matched(订单匹配事件)。过滤器:{"event_slug":"string"} 或 {"market_slug":"string"}。

  2. Comments(comments):comment_created、comment_removed、reaction_created、reaction_removed。过滤器:{"parentEntityID":number,"parentEntityType":"Event"}。

  3. RFQ(rfq):请求/报价生命周期事件。无过滤器,无需认证。

  4. Crypto Prices(crypto_prices、crypto_prices_chainlink):update(实时价格源)。过滤器:{"symbol":"BTC"}(可选)。

  5. CLOB User(clob_user)⚠️ 需要认证:order(用户订单更新)、trade(用户交易执行)。

  6. CLOB Market(clob_market):price_change(价格变动)、agg_orderbook(聚合订单簿)、last_trade_price(最新价格)、market_created、market_resolved。

用户数据认证示例:

client.subscribe({ subscriptions: [{ topic: "clob_user", type: "*", clob_auth: { key: "your-api-key", secret: "your-api-secret", passphrase: "your-passphrase" } }] });

常见用例:

监控特定市场:

client.subscribe({ subscriptions: [{ topic: "activity", type: "trades", filters: {"market_slug":"btc-above-100k-2024"} }] });

跟踪多个市场:

client.subscribe({ subscriptions: [{ topic: "clob_market", type: "price_change", filters: ["100","101","102"] }] });

监控事件评论:

client.subscribe({ subscriptions: [{ topic: "comments", type: "*", filters: {"parentEntityID":12345,"parentEntityType":"Event"} }] });

参考文件:本技能在 references/ 中包含完整文档。平台文档:api.md(Polymarket API 文档)、getting_started.md(入门指南)、guides.md(开发指南)、learn.md(学习资源)、trading.md(交易文档)、other.md(其他资源)。实时客户端:README.md(WebSocket 客户端 API 与示例)、llms.md(LLM 集成指南)、llms-full.md(完整 LLM 文档)。可使用 view 读取具体参考文件获取详细信息。

适用场景

适合构建预测市场监控工具、处理实时交易/订单/市场更新、监控市场评论与社交反应、跟踪 RFQ(请求报价)活动、集成加密价格源,以及进行 API 集成、交易策略实现和 LLM 集成等场景。

限制与注意事项

实时客户端为 TypeScript/JavaScript(非 Python)。部分 WebSocket 主题需要认证。建议使用过滤器有效管理消息量。所有时间戳为 Unix 时间戳。市场 ID 为字符串(例如 "100"、"101")。平台文档同时覆盖 REST API 与 WebSocket 用法。

最佳实践:WebSocket 连接管理方面,使用 onConnect 回调进行订阅,生产环境实现重连逻辑,完成后用 disconnect() 清理,优雅处理认证错误。订阅策略方面,谨慎使用通配符("*"),应用过滤器减少数据量,取消未使用的流,异步处理消息。性能方面,考虑对高频数据进行批处理,使用过滤器最小化客户端处理,使用前验证消息负载。

环境要求:Node.js 14+(推荐),TypeScript(可选但推荐),包管理器 npm 或 yarn。

官方链接:Polymarket 平台 https://polymarket.com ,实时客户端仓库 https://github.com/Polymarket/real-time-data-client ,API 文档见 references/api.md 。

入门建议:初学者从 getting_started.md 开始了解基础概念;API 集成使用 api.md 和 trading.md 了解 REST API 细节;实时数据使用 README.md 实现 WebSocket 客户端;LLM 集成使用 llms.md 和 llms-full.md 用于 AI/ML 用例。