Skip to content
Inflection API

Market summary

GET
/api/market-data/summary
curl --request GET \
  --url https://example.com/api/market-data/summary

The best bid and ask and the last trade of each market named, for a page’s first paint. Name markets, series or both, up to 100 together. A series gives its open windows, and those that ended recently and have not settled.

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
markets
Markets
Array<integer>
default:

A market id. Repeat for more.

series
Series
Array<string>
default:

A series. Repeat for more.

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
Summaries
object
markets
required
Markets
Array<object>
MarketSummary
object
market_id
required
Market Id
integer
series
required
Any of:
string
status
required
Status
string
Allowed values: open closed settled
outcome
required
Any of:
string
Allowed values: up down void
seq
required
Any of:
integer
bid
required
Any of:
array
>= 2 items <= 2 items
ask
required
Any of:
array
>= 2 items <= 2 items
last_trade
required
Any of:
Trade
object
trade_id
required
Trade Id

Counts 1, 2, 3 within the market.

integer
up_price_bps
required
Up Price Bps

The Up price. The Down price is 10,000 minus it.

integer
quantity
required
Quantity

Lots.

integer
taker_outcome
required
Taker Outcome

The outcome of the order that took liquidity.

string
Allowed values: up down
taker_side
required
Taker Side

Whether that order bought or sold its outcome.

string
Allowed values: buy sell
time_ms
required
Time Ms
integer
reversed
required
Reversed

True once the vault skipped the trade and the exchange took it back from both sides, which can be some time after it traded. It stays on the tape.

boolean
reversed_reason
required
Any of:
string
volume
required
Any of:
integer
traded_units
required
Any of:
integer
Example
{
  "markets": [
    {
      "status": "open",
      "outcome": "up",
      "last_trade": {
        "taker_outcome": "up",
        "taker_side": "buy"
      }
    }
  ]
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}