Skip to main content

Settlement API

Get the most recent settlement message for all live prediction markets​

For a match defined by its Bayes perid, get the latest settlement message pertaining to the markets in our Bayes live predictions messages stream. Returns a list of settlements in dictionaries with json format.

Please note that for live matches, this will return the latest settled state. Due to how data is coming in and how markets are settled, the settlement of a given market might lag a bit behind what a human observer might notice. Also, sometimes, a market is not settled live but after the match is over, if some live data necessary to settle did not come in. Please make sure to pull the latest settlement after the match has ended.

However, the settlements you can retrieve from this API are updated in near real-time, with no more than 100ms lag to the Bayes Live Settlements stream.

GET - /api/get_settlements/{match_id}
parametertypedescription
match_idstringThe Bayes perid for the match

Notes

  • The perids for both teams can be found in the Bayes Fixtures Services.
  • For an overview of how live predictions work, please see here.
  • For an example of the message format, see here.