Skip to main content
New to Corsair? See API access, authentication, and error handling.

Events

get

events.get Get an event by ticker Risk: read
Input Output

list

events.list List events with filters and cursor pagination Risk: read
Input Output

Exchange

schedule

exchange.schedule Get the exchange trading schedule and maintenance windows Risk: read
Input: empty object Output

status

exchange.status Get whether the exchange and trading are currently active Risk: read
Input: empty object Output

Markets

candlesticks

markets.candlesticks Get OHLC candlesticks for a market over a time range, by minute, hour or day Risk: read
Input Output

get

markets.get Get a market by ticker, including its price ranges Risk: read
Input Output

list

markets.list List markets with filters and cursor pagination Risk: read
Input Output

orderbook

markets.orderbook Get the order book for a market Risk: read
Input Output

trades

markets.trades List recent trades, optionally for one market Risk: read
Input Output

Orders

amend

orders.amend Change an existing order’s price or size; a new price can fill at once and spend real money in production Risk: destructive
Input Output

batchCreate

orders.batchCreate Place several orders in one request. Spends real money when the environment is production Risk: destructive
Input
Output

cancel

orders.cancel Cancel a resting order’s remaining contracts; a cancelled order can’t be restored Risk: destructive · Irreversible
Input Output

create

orders.create Place an order. Spends real money when the environment is production Risk: destructive
Input Output

get

orders.get Get a single order by ID Risk: read
Input Output

list

orders.list List orders, optionally filtered by status or market Risk: read
Input Output

Portfolio

balance

portfolio.balance Get the account balance and portfolio value Risk: read
Input Output

fills

portfolio.fills List order fills for the account Risk: read
Input Output

positions

portfolio.positions List market and event positions. Includes closed markets awaiting settlement and fully exited positions, so not every row is open exposure Risk: read
Input Output

settlements

portfolio.settlements List settled positions for the account Risk: read
Input Output

Series

get

series.get Get a series by ticker Risk: read
Input Output

list

series.list List event series, optionally by category or tags Risk: read
Input Output