Incentive programs¶
Time-boxed reward campaigns (maker rebates, volume bonuses) on specific markets or series. List them to discover what's currently rewarded and on what terms.
Public — no auth required.
Quick reference¶
| Method | Endpoint |
|---|---|
list(...) / list_all(...) |
GET /incentive_programs |
list_schedules() |
GET /incentive_schedules |
List active programs¶
page = client.incentive_programs.list(
status="active", # IncentiveProgramStatusLiteral
incentive_type="liquidity", # IncentiveProgramTypeLiteral — spec "type"
incentive_description="Q2 maker", # new in v2.1.0 — exact-match filter
series_ticker="KXHIGHNY", # optional — one series' incentives
event_ticker="KXHIGHNY-24", # optional — one event; omit for a perpetual
limit=100,
)
for p in page:
print(p.program_id, p.title, p.start_ts, p.end_ts)
incentive_description (added in v2.1.0) is an exact-string filter on the
program's description — useful when multiple programs share a status/type.
series_ticker and event_ticker (added in v22.13.0) restrict the list to
one series or one event. A perpetual's incentives belong to no event.
Use list_all to walk every program:
Uses next_cursor on the wire
The Kalshi endpoint returns the next page cursor under the key
next_cursor rather than the SDK-wide cursor. The SDK normalizes both
directions — you pass cursor= and read .cursor just like any other
list call.
incentive_type is the SDK's name for spec type
Same renaming logic as milestones and
structured targets. The wire still sends type=.
Available statuses and types¶
IncentiveProgramStatusLiteral:"all","active","upcoming","closed", and additional server-side categories.IncentiveProgramTypeLiteral:"all","liquidity","volume".
Incentive schedules¶
Recurring terms for what each market of a series — or of one event — can
expect to earn window after window. Public, no pagination. A schedule is
anticipated unless all_markets is true.
schedules = client.incentive_programs.list_schedules()
for s in schedules:
print(s.series_ticker, s.incentive_type, s.reward, s.window_days)
event_ticker / event_title are empty (or None if the server omits
them) when the schedule covers the whole series. ends is None when the schedule has
no end. reward is centi-cents, the same convention as
IncentiveProgram.period_reward.
Reference¶
kalshi.resources.incentive_programs.IncentiveProgramsResource ¶
Bases: SyncResource
Sync incentive programs API.
incentive_type renames the spec's type query param to avoid
shadowing the Python built-in. Wire still sends ?type=....
list_schedules ¶
list_schedules(
*, extra_headers: dict[str, str] | None = None
) -> builtins.list[IncentiveSchedule]
GET /incentive_schedules. Public. No pagination.
kalshi.resources.incentive_programs.AsyncIncentiveProgramsResource ¶
Bases: AsyncResource
Async incentive programs API.
list_all ¶
list_all(
*,
status: IncentiveProgramStatusLiteral | None = None,
incentive_type: (
IncentiveProgramTypeLiteral | None
) = None,
incentive_description: str | None = None,
series_ticker: str | None = None,
event_ticker: str | None = None,
limit: int | None = None,
max_pages: int | None = None,
extra_headers: dict[str, str] | None = None
) -> AsyncIterator[IncentiveProgram]
Returns an async iterator — use async for.
list_schedules
async
¶
list_schedules(
*, extra_headers: dict[str, str] | None = None
) -> builtins.list[IncentiveSchedule]
Async :meth:IncentiveProgramsResource.list_schedules.