Enum Definitions
Predefined value sets used by API parameters and response fields. Blue enum types across the API Reference link to the sections below.
Market
MarketStandard market codes for market / context.market. Input aliases normalize to the standard code; responses always emit the standard value (never ks_equity).
| Value | Description |
|---|---|
us_equity | United States. Input alias examples: US, NASDAQ, NYSE. |
hk_equity | Hong Kong. Input alias examples: HK, HKEX. |
kr_equity | Korea. Input alias examples: KR, KS, KQ, KOSPI, KOSDAQ. |
uk_equity | United Kingdom. Input alias examples: UK, GB, LSE. |
jp_equity | Japan. Input alias examples: JP, TSE. |
crypto | Crypto. Input alias examples: spot, perp, token, protocol (query context; not market aliases). |
Market type
MarketTypeInstrument market type for market-data endpoints. Defaults to spot when omitted.
| Value | Description |
|---|---|
spot | Spot market. |
perp | Perpetual futures market. |
futures | Dated futures market. |
K-line timeframe
TimeframeBar size for /v1/markets/kline.
| Value | Description |
|---|---|
1m | 1-minute bars. |
5m | 5-minute bars. Equity live also accepts 5m. |
15m | 15-minute bars. |
1h | 1-hour bars. |
4h | 4-hour bars. |
1d | Daily bars. |
1w | Weekly bars; may return no_data when coverage is thin. |
History timeframe
HistoryTimeframeAggregation window for recent trades and liquidity history endpoints.
| Value | Description |
|---|---|
5m | 5-minute window. |
1h | 1-hour window. |
1d | Daily window. |
Snapshot type
SnapshotTypeAggregation mode for GET /v1/markets/snapshot venue coverage.
| Value | Description |
|---|---|
multi_venue | Crypto multi-exchange aggregate; venue_quotes has 2+ rows. |
single_venue | Single listing scope (typical for equity live). |
Market session
MarketSessionEquity session phase from live overlay.
| Value | Description |
|---|---|
pre_market | Pre-market session. |
regular | Regular trading hours (RTH). |
post_market | After-hours / post-market. |
closed | Market closed. |
unknown | Session unknown. |
Earnings date precision
EarningsDatePrecisionPrecision of report_date in earnings calendar events.
| Value | Description |
|---|---|
day | The report date is precise to a calendar day. |
Earnings report time type
EarningsReportTimeTypeMarket session in which an earnings report is expected or was released.
| Value | Description |
|---|---|
pre_market | Before the regular market session. |
during_market | During the regular market session. |
post_market | After the regular market session. |
unknown | A reliable release session is unavailable. |
Earnings period type
EarningsPeriodTypeFinancial reporting period represented by a calendar or consensus record.
| Value | Description |
|---|---|
quarterly | Quarterly reporting period. |
annual | Annual reporting period. |
ttm | Trailing twelve months. |
Data status
DataStatusResponse readiness status. Endpoints emit the subset they support; raw upstream statuses are never exposed directly.
| Value | Description |
|---|---|
ok | Data is complete and current. |
ready | Full ready (GA live surfaces). |
partial | Some fields are missing; see metadata.missing_fields / limitations. |
no_data | Object resolved but this domain has no data; empty_reason explains why. |
stale | Serving snapshot is older than the freshness target (RTH may also add quote_source_latency_high). |
not_ready | Endpoint responds 200 but the payload is not populated yet. |
upstream_error | Upstream source failed; retry later. |
Resolution status
ResolutionStatusObject resolver outcome. not_applicable marks events that need no asset binding and is not a failure.
| Value | Description |
|---|---|
resolved | Input resolved to a single object. |
candidate | Multiple candidates returned for the caller to pick. |
ambiguous | Ambiguous input; no silent binding is performed. |
no_match | No object matched the input. |
not_applicable | Query does not require asset binding (e.g. macro events). |
Gate mapping status
GateMappingStatusGate symbol ↔ underlying listing mapping status for covered listings.
| Value | Description |
|---|---|
mapped | Gate symbol is mapped to an underlying listing. |
unknown | Mapping is not established yet. |
conflict | Conflicting mapping evidence; manual review required. |
Object ref type
ObjectRefTypeObject type carried by metadata.object_refs[] entries.
| Value | Description |
|---|---|
asset | Investable or analyzable asset (e.g. BTC, AAPL common equity). |
listing | Instrument listed on a venue (quotes / books / trades live here). |
instrument | Tradable contract derived from an asset (spot, perp, ADR, …). |
venue | Exchange or trading platform (e.g. XNAS, Gate). |
event | Event object (news / signal / prediction event). |
market | Prediction market object. |
Prediction venue
PredictionVenueSupported prediction-market venues.
| Value | Description |
|---|---|
polymarket | Polymarket (live order book supported). |
predict_fun | Predict.fun |
Ranking type
RankingTypeRanking dimension for /v1/prediction/rankings.
| Value | Description |
|---|---|
volume_24h | Rank by 24h traded volume. |
liquidity | Rank by current liquidity. |
Order book side
OrderBookSideOutcome side for prediction order-book queries.
| Value | Description |
|---|---|
yes | YES outcome book only. |
no | NO outcome book only. |
both | Both outcome books. |
Trade side
TradeSideAggressor side on listing-level recent trades. Use unknown when the venue does not provide a reliable direction — never invent buy/sell.
| Value | Description |
|---|---|
buy | Buyer was the aggressor (taker). |
sell | Seller was the aggressor (taker). |
unknown | Direction unavailable or inconsistent; do not infer. |