markets/src/trades

Mostlyright TypeScript SDK

---

Mostlyright TypeScript SDK / markets/src/trades

markets/src/trades

Interfaces

KalshiCandleRow

Defined in: packages-ts/markets/src/trades/types.ts:16

Properties

close

readonly close: null | number

Defined in: packages-ts/markets/src/trades/types.ts:22

high

readonly high: null | number

Defined in: packages-ts/markets/src/trades/types.ts:20

low

readonly low: null | number

Defined in: packages-ts/markets/src/trades/types.ts:21

open

readonly open: null | number

Defined in: packages-ts/markets/src/trades/types.ts:19

openInterest

readonly openInterest: null | number

Defined in: packages-ts/markets/src/trades/types.ts:24

source

readonly source: "kalshi"

Defined in: packages-ts/markets/src/trades/types.ts:25

ts

readonly ts: null | string

Defined in: packages-ts/markets/src/trades/types.ts:18

Bucket-end timestamp as ISO 8601 UTC string.

volume

readonly volume: null | number

Defined in: packages-ts/markets/src/trades/types.ts:23

---

KalshiCandlesArgs

Defined in: packages-ts/markets/src/trades/kalshi.ts:34

Properties

from

readonly from: Date

Defined in: packages-ts/markets/src/trades/kalshi.ts:36

interval

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

Defined in: packages-ts/markets/src/trades/kalshi.ts:35

to

readonly to: Date

Defined in: packages-ts/markets/src/trades/kalshi.ts:37

---

KalshiClientOptions

Defined in: packages-ts/markets/src/trades/kalshi-client.ts:19

Properties

fetchFn()?

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

Defined in: packages-ts/markets/src/trades/kalshi-client.ts:25

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

Defined in: packages-ts/markets/src/trades/kalshi-client.ts:23

AbortSignal for the whole call.

sleepBetweenMs?

readonly optional sleepBetweenMs: number

Defined in: packages-ts/markets/src/trades/kalshi-client.ts:21

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

timeoutMs?

readonly optional timeoutMs: number

Defined in: packages-ts/markets/src/trades/kalshi-client.ts:27

Per-attempt timeout. Default 30 000 ms.

---

KalshiFillRow

Defined in: packages-ts/markets/src/trades/types.ts:28

Properties

count

readonly count: null | number

Defined in: packages-ts/markets/src/trades/types.ts:33

noPrice

readonly noPrice: null | number

Defined in: packages-ts/markets/src/trades/types.ts:32

source

readonly source: "kalshi"

Defined in: packages-ts/markets/src/trades/types.ts:35

takerSide

readonly takerSide: null | "yes" | "no"

Defined in: packages-ts/markets/src/trades/types.ts:34

tradeId

readonly tradeId: null | string

Defined in: packages-ts/markets/src/trades/types.ts:29

ts

readonly ts: null | string

Defined in: packages-ts/markets/src/trades/types.ts:30

yesPrice

readonly yesPrice: null | number

Defined in: packages-ts/markets/src/trades/types.ts:31

---

KalshiFillsArgs

Defined in: packages-ts/markets/src/trades/kalshi.ts:40

Properties

maxPages?

readonly optional maxPages: number

Defined in: packages-ts/markets/src/trades/kalshi.ts:43

since?

readonly optional since: Date

Defined in: packages-ts/markets/src/trades/kalshi.ts:41

until?

readonly optional until: Date

Defined in: packages-ts/markets/src/trades/kalshi.ts:42

---

KalshiOrderbookArgs

Defined in: packages-ts/markets/src/trades/kalshi.ts:46

Properties

depth?

readonly optional depth: number

Defined in: packages-ts/markets/src/trades/kalshi.ts:47

---

KalshiOrderbookRow

Defined in: packages-ts/markets/src/trades/types.ts:38

Properties

price

readonly price: null | number

Defined in: packages-ts/markets/src/trades/types.ts:40

side

readonly side: "yes" | "no"

Defined in: packages-ts/markets/src/trades/types.ts:39

size

readonly size: null | number

Defined in: packages-ts/markets/src/trades/types.ts:41

source

readonly source: "kalshi"

Defined in: packages-ts/markets/src/trades/types.ts:42

---

PolymarketClientOptions

Defined in: packages-ts/markets/src/trades/polymarket.ts:23

Properties

fetchFn()?

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

Defined in: packages-ts/markets/src/trades/polymarket.ts:29

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

Defined in: packages-ts/markets/src/trades/polymarket.ts:27

AbortSignal for the whole call.

sleepBetweenMs?

readonly optional sleepBetweenMs: number

Defined in: packages-ts/markets/src/trades/polymarket.ts:25

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

timeoutMs?

readonly optional timeoutMs: number

Defined in: packages-ts/markets/src/trades/polymarket.ts:31

Per-attempt timeout. Default 30_000 ms.

---

PolymarketHistoryArgs

Defined in: packages-ts/markets/src/trades/polymarket.ts:34

Properties

fidelityMinutes?

readonly optional fidelityMinutes: number

Defined in: packages-ts/markets/src/trades/polymarket.ts:38

Bucket size in minutes (default 60).

from

readonly from: Date

Defined in: packages-ts/markets/src/trades/polymarket.ts:35

to

readonly to: Date

Defined in: packages-ts/markets/src/trades/polymarket.ts:36

---

PolymarketHistoryRow

Defined in: packages-ts/markets/src/trades/types.ts:45

Properties

price

readonly price: null | number

Defined in: packages-ts/markets/src/trades/types.ts:48

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

source

readonly source: "polymarket.clob"

Defined in: packages-ts/markets/src/trades/types.ts:51

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

ts

readonly ts: null | string

Defined in: packages-ts/markets/src/trades/types.ts:46

volume

readonly volume: null | number

Defined in: packages-ts/markets/src/trades/types.ts:49

---

PolymarketSnapshotRow

Defined in: packages-ts/markets/src/trades/types.ts:54

Properties

lastPrice

readonly lastPrice: null | number

Defined in: packages-ts/markets/src/trades/types.ts:57

liquidity

readonly liquidity: null | number

Defined in: packages-ts/markets/src/trades/types.ts:59

marketId

readonly marketId: null | string

Defined in: packages-ts/markets/src/trades/types.ts:55

outcome

readonly outcome: string

Defined in: packages-ts/markets/src/trades/types.ts:56

source

readonly source: "polymarket.gamma"

Defined in: packages-ts/markets/src/trades/types.ts:60

volume

readonly volume: null | number

Defined in: packages-ts/markets/src/trades/types.ts:58

---

RawKalshiCandle

Defined in: packages-ts/markets/src/trades/kalshi-client.ts:114

Properties

end_period_ts?

readonly optional end_period_ts: number

Defined in: packages-ts/markets/src/trades/kalshi-client.ts:115

open_interest?

readonly optional open_interest: string | number

Defined in: packages-ts/markets/src/trades/kalshi-client.ts:133

open_interest_fp?

readonly optional open_interest_fp: string

Defined in: packages-ts/markets/src/trades/kalshi-client.ts:130

price?

readonly optional price: object

Defined in: packages-ts/markets/src/trades/kalshi-client.ts:116

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

Defined in: packages-ts/markets/src/trades/kalshi-client.ts:132

volume_fp?

readonly optional volume_fp: string

Defined in: packages-ts/markets/src/trades/kalshi-client.ts:129

---

RawKalshiOrderbook

Defined in: packages-ts/markets/src/trades/kalshi-client.ts:162

Properties

orderbook?

readonly optional orderbook: object

Defined in: packages-ts/markets/src/trades/kalshi-client.ts:169

no?

readonly optional no: readonly KalshiOrderLevel[]

yes?

readonly optional yes: readonly KalshiOrderLevel[]

orderbook_fp?

readonly optional orderbook_fp: object

Defined in: packages-ts/markets/src/trades/kalshi-client.ts:164

no_dollars?

readonly optional no_dollars: readonly KalshiOrderLevel[]

yes_dollars?

readonly optional yes_dollars: readonly KalshiOrderLevel[]

---

RawKalshiTrade

Defined in: packages-ts/markets/src/trades/kalshi-client.ts:136

Properties

count?

readonly optional count: string | number

Defined in: packages-ts/markets/src/trades/kalshi-client.ts:147

count_fp?

readonly optional count_fp: string

Defined in: packages-ts/markets/src/trades/kalshi-client.ts:142

created_time?

readonly optional created_time: string | number

Defined in: packages-ts/markets/src/trades/kalshi-client.ts:138

no_price?

readonly optional no_price: string | number

Defined in: packages-ts/markets/src/trades/kalshi-client.ts:146

no_price_dollars?

readonly optional no_price_dollars: string

Defined in: packages-ts/markets/src/trades/kalshi-client.ts:141

taker_outcome_side?

readonly optional taker_outcome_side: "yes" | "no"

Defined in: packages-ts/markets/src/trades/kalshi-client.ts:143

taker_side?

readonly optional taker_side: "yes" | "no"

Defined in: packages-ts/markets/src/trades/kalshi-client.ts:148

trade_id?

readonly optional trade_id: string

Defined in: packages-ts/markets/src/trades/kalshi-client.ts:137

yes_price?

readonly optional yes_price: string | number

Defined in: packages-ts/markets/src/trades/kalshi-client.ts:145

yes_price_dollars?

readonly optional yes_price_dollars: string

Defined in: packages-ts/markets/src/trades/kalshi-client.ts:140

---

TradesCacheKey

Defined in: packages-ts/markets/src/trades/cache.ts:22

Properties

issuer

readonly issuer: string

Defined in: packages-ts/markets/src/trades/cache.ts:23

month

readonly month: number

Defined in: packages-ts/markets/src/trades/cache.ts:26

ticker

readonly ticker: string

Defined in: packages-ts/markets/src/trades/cache.ts:24

year

readonly year: number

Defined in: packages-ts/markets/src/trades/cache.ts:25

---

TradesCacheReadOpts

Defined in: packages-ts/markets/src/trades/cache.ts:61

Properties

now?

readonly optional now: Date

Defined in: packages-ts/markets/src/trades/cache.ts:62

---

TradesCacheWriteOpts

Defined in: packages-ts/markets/src/trades/cache.ts:65

Properties

now?

readonly optional now: Date

Defined in: packages-ts/markets/src/trades/cache.ts:66

---

TradesResult<Row>

Defined in: packages-ts/markets/src/trades/types.ts:64

Envelope returned by every trades function — rows + metadata.

Type Parameters

• Row

Properties

eventId?

readonly optional eventId: string

Defined in: packages-ts/markets/src/trades/types.ts:73

fidelityMinutes?

readonly optional fidelityMinutes: number

Defined in: packages-ts/markets/src/trades/types.ts:75

interval?

readonly optional interval: string

Defined in: packages-ts/markets/src/trades/types.ts:74

marketId?

readonly optional marketId: string

Defined in: packages-ts/markets/src/trades/types.ts:72

retrievedAt

readonly retrievedAt: string

Defined in: packages-ts/markets/src/trades/types.ts:67

rows

readonly rows: readonly Row[]

Defined in: packages-ts/markets/src/trades/types.ts:65

snapshotAt?

readonly optional snapshotAt: string

Defined in: packages-ts/markets/src/trades/types.ts:69

Snapshot-style results may carry a snapshotAt distinct from retrievedAt.

source

readonly source: TradesSource

Defined in: packages-ts/markets/src/trades/types.ts:66

ticker?

readonly optional ticker: string

Defined in: packages-ts/markets/src/trades/types.ts:71

Echo of the input ticker / market-id for downstream attribution.

tokenId?

readonly optional tokenId: string

Defined in: packages-ts/markets/src/trades/types.ts:77

CLOB token id for polymarketHistory results (architect iter-1 fix).

Type Aliases

KalshiInterval

KalshiInterval: typeof KALSHI_INTERVALS[number]

Defined in: packages-ts/markets/src/trades/types.ts:82

---

TradesSource

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

Defined in: packages-ts/markets/src/trades/types.ts:14

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"

Defined in: packages-ts/markets/src/trades/kalshi-client.ts:11

---

KALSHI_INTERVALS

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

Defined in: packages-ts/markets/src/trades/types.ts:81

Supported candle intervals — exact union mirrors Python INTERVALS.

Functions

fetchCandlesticks()

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

Defined in: packages-ts/markets/src/trades/kalshi-client.ts:175

Parameters

ticker

string

args

endTs

number

periodIntervalMinutes

number

startTs

number

opts

KalshiClientOptions = {}

Returns

Promise<readonly RawKalshiCandle[]>

---

fetchOrderbook()

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

Defined in: packages-ts/markets/src/trades/kalshi-client.ts:246

Parameters

ticker

string

args

depth?

number

opts

KalshiClientOptions = {}

Returns

Promise<RawKalshiOrderbook>

---

fetchTrades()

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

Defined in: packages-ts/markets/src/trades/kalshi-client.ts:210

Parameters

ticker

string

args

FetchTradesArgs = {}

opts

KalshiClientOptions = {}

Returns

Promise<readonly RawKalshiTrade[]>

---

invalidateTradesCache()

invalidateTradesCache(cache, args): Promise<boolean>

Defined in: packages-ts/markets/src/trades/cache.ts:111

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

Parameters

cache

CacheStore

args

TradesCacheKey

Returns

Promise<boolean>

---

isCurrentUtcMonth()

isCurrentUtcMonth(year, month, now): boolean

Defined in: packages-ts/markets/src/trades/cache.ts:51

Parameters

year

number

month

number

now

Date = ...

Returns

boolean

---

isFutureUtcMonth()

isFutureUtcMonth(year, month, now): boolean

Defined in: packages-ts/markets/src/trades/cache.ts:55

Parameters

year

number

month

number

now

Date = ...

Returns

boolean

---

kalshiCandles()

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

Defined in: packages-ts/markets/src/trades/kalshi.ts:137

Parameters

ticker

string

args

KalshiCandlesArgs

opts

KalshiClientOptions = {}

Returns

Promise<TradesResult<KalshiCandleRow>>

---

kalshiFills()

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

Defined in: packages-ts/markets/src/trades/kalshi.ts:190

Parameters

ticker

string

args

KalshiFillsArgs = {}

opts

KalshiClientOptions = {}

Returns

Promise<TradesResult<KalshiFillRow>>

---

kalshiOrderbook()

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

Defined in: packages-ts/markets/src/trades/kalshi.ts:237

Parameters

ticker

string

args

KalshiOrderbookArgs = {}

opts

KalshiClientOptions = {}

Returns

Promise<TradesResult<KalshiOrderbookRow>>

---

polymarketHistory()

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

Defined in: packages-ts/markets/src/trades/polymarket.ts:166

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<TradesResult<PolymarketHistoryRow>>

---

polymarketSnapshot()

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

Defined in: packages-ts/markets/src/trades/polymarket.ts:230

Parameters

eventId

string

opts

PolymarketClientOptions = {}

Returns

Promise<TradesResult<PolymarketSnapshotRow>>

---

readTradesCache()

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

Defined in: packages-ts/markets/src/trades/cache.ts:70

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

Defined in: packages-ts/markets/src/trades/cache.ts:30

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>

Defined in: packages-ts/markets/src/trades/cache.ts:92

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>