API reference · Sim
List replayable events
GET/v1/sim/events
The events with a recorded feed and recorded order books, newest first, that the simulator can replay.
On this page
Auth. None. Without a token the call is served as Free (the Free delay and request budget, shared per IP); send Authorization: Bearer lb_… for your plan's.
Limits. Counts against your plan's API requests (60, 600 or 3,000 a minute on Free, Builder and Standard). Does not count as a Sim run.
Parameters
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
limit | integer | no | Page size. 1 to 500. Default 50. |
cursor | string | no | next_cursor from the previous page. |
sample | boolean | no | true for the suggested first events only. |
Request
curl "https://api.langbot.ai/v1/sim/events?limit=1"from langbot import LangbotClient
async with LangbotClient() as lb:
page = await lb.sim_events()
for e in page["events"]:
print(e["event_id"], e["coverage"]["books"], e["title"])const res = await fetch("https://api.langbot.ai/v1/sim/events?limit=1");
console.log(await res.json());Response
200 OK
{
"ts": 1793685884697,
"count": 20,
"next_cursor": "1",
"partial": false,
"events": [
{
"title": "What nicknames will Trump say before 2027?",
"sample": false,
"window": {"to": 1798816200000, "from": 1790861400000},
"ends_at": 1798815600000,
"tickers": ["KXTRUMPSAY-26NOV02-ANTI", "KXTRUMPSAY-26NOV02-AUTO"],
"coverage": {
"books": 96483,
"events": 81061,
"candles": 2,
"last_ts": 1793614367134,
"markets": 286,
"settled": false,
"first_ts": 1793489241009,
"phrase_hits": 1919,
"markets_settled": 75,
"tickers_with_books": 243,
"tickers_with_candles": 1
},
"event_id": "ev_kxtrumpsaynickname_27jan01",
"starts_at": 1790863200000,
"speaker_keys": []
}
]
}A real response from the API; long lists are cut to their first items.
coverage counts what was recorded: feed events, phrase_hits, order-book snapshots (books) and markets with books.
Errors
| Status | code | When |
|---|---|---|
| 401 | token_invalid | A token was sent and not recognised. Send a valid one, or none to call anonymously. |
| 422 | validation_error | A parameter failed validation; detail[].loc names it. |
| 429 | rate_limited | Over your request budget; wait Retry-After seconds. |
Every error body is {"detail": …, "code": "…"}; branch on code. All codes: Errors.