New to Corsair? See API access, authentication, and error handling.
Events
get
events.get
Get an event by ticker
Risk: read
Output
event full type
event full type
markets full type
markets full type
list
events.list
List events with filters and cursor pagination
Risk: read
Output
events full type
events full type
Exchange
schedule
exchange.schedule
Get the exchange trading schedule and maintenance windows
Risk: read
schedule full type
schedule full type
status
exchange.status
Get whether the exchange and trading are currently active
Risk: read
Markets
candlesticks
markets.candlesticks
Get OHLC candlesticks for a market over a time range, by minute, hour or day
Risk: read
Output
candlesticks full type
candlesticks full type
get
markets.get
Get a market by ticker, including its price ranges
Risk: read
Output
market full type
market full type
list
markets.list
List markets with filters and cursor pagination
Risk: read
Output
markets full type
markets full type
orderbook
markets.orderbook
Get the order book for a market
Risk: read
Output
orderbook_fp full type
orderbook_fp full type
trades
markets.trades
List recent trades, optionally for one market
Risk: read
Output
trades full type
trades full type
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
Output
batchCreate
orders.batchCreate
Place several orders in one request. Spends real money when the environment is production
Risk: destructive
orders full type
orders full type
orders full type
orders full type
cancel
orders.cancel
Cancel a resting order’s remaining contracts; a cancelled order can’t be restored
Risk: destructive · Irreversible
Output
create
orders.create
Place an order. Spends real money when the environment is production
Risk: destructive
Output
get
orders.get
Get a single order by ID
Risk: read
Output
order full type
order full type
list
orders.list
List orders, optionally filtered by status or market
Risk: read
Output
orders full type
orders full type
Portfolio
balance
portfolio.balance
Get the account balance and portfolio value
Risk: read
Output
fills
portfolio.fills
List order fills for the account
Risk: read
Output
fills full type
fills full type
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
Output
market_positions full type
market_positions full type
event_positions full type
event_positions full type
settlements
portfolio.settlements
List settled positions for the account
Risk: read
Output
settlements full type
settlements full type
Series
get
series.get
Get a series by ticker
Risk: read
Output
series full type
series full type
list
series.list
List event series, optionally by category or tags
Risk: read
Output
series full type
series full type