@mostlyrightmd/markets/trades

Interfaces

KalshiCandleRow

Properties

close

readonly close: null | number

end_time_utc

readonly end_time_utc: null | string

Bucket-end timestamp as ISO 8601 UTC string.

high

readonly high: null | number

low

readonly low: null | number

open

readonly open: null | number

open_interest

readonly open_interest: null | number

source

readonly source: "kalshi"

ticker

readonly ticker: string

The query identity — a leading column (DX-H4 / CUT-06), consistent with settlement rows.

volume

readonly volume: null | number

KalshiCandlesArgs

Properties

fromTime

readonly fromTime: Date

interval

readonly interval: "1m" | "1h" | "1d"

toTime

readonly toTime: Date

KalshiClientOptions

Properties

fetchFn()?

readonly optional fetchFn: (input, init?) => Promise<Response>(input, init?) => Promise<Response>

Override fetch for tests. Defaults to global fetch.

MDN Reference

Parameters

input

URL | RequestInfo

init?

RequestInit

Returns

Promise<Response>

MDN Reference

Parameters

input

string | URL | Request

init?

RequestInit

Returns

Promise<Response>

signal?

readonly optional signal: AbortSignal

AbortSignal for the whole call.

sleepBetweenMs?

readonly optional sleepBetweenMs: number

Politeness sleep between requests in ms. Default 100 (0.1 s). 0 to skip.

timeoutMs?

readonly optional timeoutMs: number

Per-attempt timeout. Default 30 000 ms.

KalshiFillRow

Properties

count

readonly count: null | number

no_price

readonly no_price: null | number

source

readonly source: "kalshi"

taker_side

readonly taker_side: null | "yes" | "no"

trade_id

readonly trade_id: null | string

ts

readonly ts: null | string

yes_price

readonly yes_price: null | number

KalshiFillsArgs

Properties

maxPages?

readonly optional maxPages: number

since?

readonly optional since: Date

until?

readonly optional until: Date

KalshiOrderbookArgs

Properties

depth?

readonly optional depth: number

KalshiOrderbookRow

Properties

price

readonly price: null | number

side

readonly side: "yes" | "no"

size

readonly size: null | number

source

readonly source: "kalshi"

PolymarketClientOptions

Properties

fetchFn()?

readonly optional fetchFn: (input, init?) => Promise<Response>(input, init?) => Promise<Response>

Override fetch for tests.

MDN Reference

Parameters

input

URL | RequestInfo

init?

RequestInit

Returns

Promise<Response>

MDN Reference

Parameters

input

string | URL | Request

init?

RequestInit

Returns

Promise<Response>

signal?

readonly optional signal: AbortSignal

AbortSignal for the whole call.

sleepBetweenMs?

readonly optional sleepBetweenMs: number

Politeness sleep between requests in ms. Default 200. 0 to skip.

timeoutMs?

readonly optional timeoutMs: number

Per-attempt timeout. Default 30_000 ms.

PolymarketHistoryArgs

Properties

fidelityMinutes?

readonly optional fidelityMinutes: number

Bucket size in minutes (default 60).

from

readonly from: Date

to

readonly to: Date

PolymarketHistoryRow

Properties

price

readonly price: null | number

Last-traded price in [0, 1] for the requested CLOB token.

source

readonly source: "polymarket.clob"

History rows live on the CLOB host (architect iter-1 CRITICAL fix).

ts

readonly ts: null | string

volume

readonly volume: null | number

PolymarketSnapshotRow

Properties

last_price

readonly last_price: null | number

liquidity

readonly liquidity: null | number

market_id

readonly market_id: null | string

outcome

readonly outcome: string

source

readonly source: "polymarket.gamma"

volume

readonly volume: null | number

RawKalshiCandle

Properties

end_period_ts?

readonly optional end_period_ts: number

open_interest?

readonly optional open_interest: string | number

open_interest_fp?

readonly optional open_interest_fp: string

price?

readonly optional price: object

close?

readonly optional close: string | number

close_dollars?

readonly optional close_dollars: string

high?

readonly optional high: string | number

high_dollars?

readonly optional high_dollars: string

low?

readonly optional low: string | number

low_dollars?

readonly optional low_dollars: string

open?

readonly optional open: string | number

open_dollars?

readonly optional open_dollars: string

volume?

readonly optional volume: string | number

volume_fp?

readonly optional volume_fp: string

RawKalshiOrderbook

Properties

orderbook?

readonly optional orderbook: object

no?

readonly optional no: readonly KalshiOrderLevel[]

yes?

readonly optional yes: readonly KalshiOrderLevel[]

orderbook_fp?

readonly optional orderbook_fp: object

no_dollars?

readonly optional no_dollars: readonly KalshiOrderLevel[]

yes_dollars?

readonly optional yes_dollars: readonly KalshiOrderLevel[]

RawKalshiTrade

Properties

count?

readonly optional count: string | number

count_fp?

readonly optional count_fp: string

created_time?

readonly optional created_time: string | number

no_price?

readonly optional no_price: string | number

no_price_dollars?

readonly optional no_price_dollars: string

taker_outcome_side?

readonly optional taker_outcome_side: "yes" | "no"

taker_side?

readonly optional taker_side: "yes" | "no"

trade_id?

readonly optional trade_id: string

yes_price?

readonly optional yes_price: string | number

yes_price_dollars?

readonly optional yes_price_dollars: string

TradesCacheKey

Properties

issuer

readonly issuer: string

month

readonly month: number

ticker

readonly ticker: string

year

readonly year: number

TradesCacheReadOpts

Properties

now?

readonly optional now: Date

TradesCacheWriteOpts

Properties

now?

readonly optional now: Date

Type Aliases

KalshiInterval

KalshiInterval: typeof KALSHI_INTERVALS[number]

TradesSource

TradesSource: "kalshi" | "polymarket.gamma" | "polymarket.clob"

Source string carried per row — load-bearing invariant for cross-frame joins.

polymarket.gamma covers /events + /events/{id} (snapshot endpoint); polymarket.clob covers /prices-history (history endpoint, on the CLOB host — distinct from Gamma per architect iter-1 CRITICAL).

Variables

KALSHI_API_BASE

const KALSHI_API_BASE: "https://api.elections.kalshi.com/trade-api/v2" = "https://api.elections.kalshi.com/trade-api/v2"

KALSHI_INTERVALS

const KALSHI_INTERVALS: readonly ["1m", "1h", "1d"]

Supported candle intervals — exact union mirrors Python INTERVALS.

Functions

fetchCandlesticks()

fetchCandlesticks(ticker, args, opts): Promise<readonly RawKalshiCandle[]>

Parameters

ticker

string

args

endTs

number

periodIntervalMinutes

number

startTs

number

opts

KalshiClientOptions = {}

Returns

Promise<readonly RawKalshiCandle[]>

fetchOrderbook()

fetchOrderbook(ticker, args, opts): Promise<RawKalshiOrderbook>

Parameters

ticker

string

args

depth?

number

opts

KalshiClientOptions = {}

Returns

Promise<RawKalshiOrderbook>

fetchTrades()

fetchTrades(ticker, args, opts): Promise<readonly RawKalshiTrade[]>

Parameters

ticker

string

args

FetchTradesArgs = {}

opts

KalshiClientOptions = {}

Returns

Promise<readonly RawKalshiTrade[]>

invalidateTradesCache()

invalidateTradesCache(cache, args): Promise<boolean>

Delete cached entry; returns true when a value existed before.

Parameters

cache

CacheStore

args

TradesCacheKey

Returns

Promise<boolean>

isCurrentUtcMonth()

isCurrentUtcMonth(year, month, now): boolean

Parameters

year

number

month

number

now

Date = ...

Returns

boolean

isFutureUtcMonth()

isFutureUtcMonth(year, month, now): boolean

Parameters

year

number

month

number

now

Date = ...

Returns

boolean

kalshiCandles()

kalshiCandles(ticker, args, opts): Promise<DataResult<KalshiCandleRow>>

Parameters

ticker

string

args

KalshiCandlesArgs

opts

KalshiClientOptions = {}

Returns

Promise<DataResult<KalshiCandleRow>>

kalshiFills()

kalshiFills(ticker, args, opts): Promise<DataResult<KalshiFillRow>>

Parameters

ticker

string

args

KalshiFillsArgs = {}

opts

KalshiClientOptions = {}

Returns

Promise<DataResult<KalshiFillRow>>

kalshiOrderbook()

kalshiOrderbook(ticker, args, opts): Promise<DataResult<KalshiOrderbookRow>>

Parameters

ticker

string

args

KalshiOrderbookArgs = {}

opts

KalshiClientOptions = {}

Returns

Promise<DataResult<KalshiOrderbookRow>>

polymarketHistory()

polymarketHistory(tokenId, args, opts): Promise<DataResult<PolymarketHistoryRow>>

Parameters

tokenId

string

CLOB token id (ERC-1155 asset id, one per outcome — YES or NO). NOT a Gamma market/condition/event id. Architect iter-1 CRITICAL fix.

args

PolymarketHistoryArgs

opts

PolymarketClientOptions = {}

Returns

Promise<DataResult<PolymarketHistoryRow>>

polymarketSnapshot()

polymarketSnapshot(eventId, opts): Promise<DataResult<PolymarketSnapshotRow>>

Parameters

eventId

string

opts

PolymarketClientOptions = {}

Returns

Promise<DataResult<PolymarketSnapshotRow>>

readTradesCache()

readTradesCache<Row>(cache, args, opts): Promise<null | readonly Row[]>

Read cached trades rows. Returns null on miss / current-or-future month.

Type Parameters

• Row

Parameters

cache

CacheStore

args

TradesCacheKey

opts

TradesCacheReadOpts = {}

Returns

Promise<null | readonly Row[]>

tradesCacheKey()

tradesCacheKey(args): string

Build the canonical key string for a (issuer, ticker, year, month).

Parameters

args

TradesCacheKey

Returns

string

writeTradesCache()

writeTradesCache<Row>(cache, args, rows, opts): Promise<boolean>

Write rows to the cache. Returns false (no-op) when:

the (year, month) is the current UTC month (still mutable),
the (year, month) is in the future, OR
rows is empty.

Type Parameters

• Row

Parameters

cache

CacheStore

args

TradesCacheKey

rows

readonly Row[]

opts

TradesCacheWriteOpts = {}

Returns

Promise<boolean>