枚举定义

API 参数与响应字段使用的预定义值集合。API 参考中蓝色的枚举类型会跳转到下方对应小节。

标准市场(Market)

Market

market / context.market 的标准市场码。输入 alias 会归一成标准值;响应只输出标准码(不用 ks_equity)。

取值说明
us_equity美国。来源 alias 示例:US, NASDAQ, NYSE。
hk_equity香港。来源 alias 示例:HK, HKEX。
kr_equity韩国。来源 alias 示例:KR, KS, KQ, KOSPI, KOSDAQ。
uk_equity英国。来源 alias 示例:UK, GB, LSE。
jp_equity日本。来源 alias 示例:JP, TSE。
crypto加密。来源 alias 示例:spot, perp, token, protocol (query context; not market aliases)。

市场类型(MarketType)

MarketType

行情类接口的合约市场类型;缺省为 spot。

取值说明
spot现货市场。
perp永续合约市场。
futures交割合约市场。

K 线周期(Timeframe)

Timeframe

/v1/markets/kline 的 K 线周期。

取值说明
1m1 分钟 K 线。
5m5 分钟 K 线;Equity live 亦接受 5m。
15m15 分钟 K 线。
1h1 小时 K 线。
4h4 小时 K 线。
1d日 K 线。
1w周 K;覆盖不足时可能 no_data。

历史聚合周期(HistoryTimeframe)

HistoryTimeframe

最近成交与流动性历史接口的聚合周期。

取值说明
5m5 分钟窗口。
1h1 小时窗口。
1d按日窗口。

快照类型(SnapshotType)

SnapshotType

GET /v1/markets/snapshot 的多所聚合方式。

取值说明
multi_venueCrypto 多所聚合;venue_quotes 通常多行。
single_venue单 listing 作用域(equity live 常见)。

交易时段(MarketSession)

MarketSession

Equity live 返回的交易时段阶段。

取值说明
pre_market盘前。
regular常规交易时段(RTH)。
post_market盘后。
closed休市。
unknown会话未知。

财报日期精度(EarningsDatePrecision)

EarningsDatePrecision

财报日历事件中 report_date 的日期精度。

取值说明
day披露日期精确到日。

财报披露时段(EarningsReportTimeType)

EarningsReportTimeType

财报预计或实际披露所在的交易时段。

取值说明
pre_market常规交易时段前。
during_market常规交易时段内。
post_market常规交易时段后。
unknown无可靠的披露时段信息。

财报期间类型(EarningsPeriodType)

EarningsPeriodType

财报日历或一致预期记录所对应的财务统计期间。

取值说明
quarterly季度期间。
annual年度期间。
ttm滚动十二个月。

数据状态(DataStatus)

DataStatus

响应数据状态。各 endpoint 只输出其支持的子集;不会直接透出来源 raw 状态。

取值说明
ok数据完整且为最新。
ready完整就绪(GA live 表面)。
partial部分字段缺失;参见 metadata.missing_fields / limitations。
no_data对象存在但本域无数据;empty_reason 说明原因。
stale返回的是超过时效目标的旧快照(RTH 还可附带 quote_source_latency_high)。
not_readyendpoint 返回 200 但数据尚未就绪。
upstream_error上游数据源异常;请稍后重试。

对象解析状态(ResolutionStatus)

ResolutionStatus

对象解析结果。not_applicable 用于无需绑定资产的事件,不代表失败。

取值说明
resolved输入解析到唯一对象。
candidate返回多个候选,由调用方选择。
ambiguous输入歧义;不做静默绑定。
no_match没有匹配到对象。
not_applicable查询无需绑定资产(如宏观事件)。

Gate 映射状态(GateMappingStatus)

GateMappingStatus

Gate symbol 与覆盖范围内原市场 listing 的映射状态。

取值说明
mappedGate symbol 已映射到原市场 listing。
unknown映射关系尚未建立。
conflict映射证据冲突,需人工确认。

对象引用类型(ObjectRefType)

ObjectRefType

metadata.object_refs[] 中引用对象的类型。

取值说明
asset可投资或可分析的资产(如 BTC、AAPL 普通股)。
listingInstrument 在某场所的挂牌(行情、盘口、成交挂在这一层)。
instrument由资产派生的具体交易工具(spot、perp、ADR 等)。
venue交易所或交易平台(如 XNAS、Gate)。
event事件对象(新闻 / 信号 / 预测事件)。
market预测市场对象。

预测市场平台(PredictionVenue)

PredictionVenue

支持的预测市场平台。

取值说明
polymarketPolymarket(支持实时盘口)。
predict_funPredict.fun

榜单类型(RankingType)

RankingType

/v1/prediction/rankings 的排行维度。

取值说明
volume_24h按 24h 成交量排行。
liquidity按当前流动性排行。

盘口方向(OrderBookSide)

OrderBookSide

预测市场盘口查询的方向。

取值说明
yes仅 YES 方向盘口。
no仅 NO 方向盘口。
both两个方向盘口。

成交方向(TradeSide)

TradeSide

listing 级近期成交的主动方向。方向不明时返回 unknown,不猜测 buy/sell。

取值说明
buy买方主动(taker)。
sell卖方主动(taker)。
unknown方向不可用或不一致;不要推断。