# Get Event Live Data
Retrieves real-time live game/event data for a specified milestone, including scores, game clock, period, and winner information. Use this to display live match status alongside event contract prices.
# OpenAPI definition
```json
{
"info": {
"title": "Webull Open API Reference",
"description": "application.yml\\ncom\\ni18n\\nMETA-INF\\nstatic\\n\\r\\n",
"contact": {
"name": "",
"url": "",
"email": ""
},
"version": "2.0",
"x-logo": {
"url": "static/png/logo.png"
}
},
"servers": [
{
"url": "https://us-global-openapi.uat.webullbroker.com"
}
],
"path": "/market-data/event-contracts/live-data/get",
"method": "get",
"tags": [
"Event Contract Market Data"
],
"description": "Retrieves real-time live game/event data for a specified milestone, including scores, game clock, period, and winner information. Use this to display live match status alongside event contract prices.",
"operationId": "eventLiveDataUsingGET",
"parameters": [
{
"name": "milestone_id",
"in": "query",
"description": "Milestone ID. A milestone represents a specific game or real-world occurrence tied to events.",
"required": true,
"schema": {
"type": "string"
},
"example": "MS-NBA-20250514-LAL-BOS"
},
{
"name": "category",
"in": "query",
"description": "Category, default is US_EVENT, currently only US_EVENT is supported.",
"required": false,
"schema": {
"type": "string",
"enum": [
"US_EVENT"
],
"default": "US_EVENT"
},
"example": "US_EVENT"
},
{
"name": "access_token",
"in": "header",
"description": "User's authenticated token.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "reqid",
"in": "header",
"description": "The unique ID for this request. Suggest using UUID.",
"schema": {
"type": "string"
},
"example": "2e46d5a4-bef9-4507-8cda-98f85d2f770c"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"required": [
"milestone_id",
"status",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Sport type identifier, e.g. basketball_game, baseball_game, baseball_tournament, football_game, hockey_match, hockey_tournament, soccer_tournament_multi_leg, tennis_tournament_singles, golf_tournament, cricket_match.",
"example": "basketball_game"
},
"milestone_id": {
"type": "string",
"description": "Milestone ID.",
"example": "MS-NBA-20250514-LAL-BOS"
},
"status": {
"type": "string",
"description": "Game status. Values: NOT_STARTED (not begun), INPROGRESS (underway), CLOSED (concluded with result), CANCELLED (cancelled, contracts may be voided), POSTPONED (delayed to future date), DELAYED (temporarily paused, expected to resume), SUSPENDED (indefinitely paused, outcome pending).",
"example": "INPROGRESS"
},
"winner": {
"type": "string",
"description": "Winner identifier. Empty string or absent if not yet determined.",
"example": "LAL"
},
"last_play": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "Last play description.",
"example": "LeBron James makes 3-point jump shot"
},
"occurence_ts": {
"type": "integer",
"description": "Occurrence timestamp in seconds.",
"format": "int64",
"example": 1778640200
}
},
"description": "EventContractLiveLastPlayVo",
"title": "EventContractLiveLastPlayVo"
},
"last_updated_ts": {
"type": "integer",
"description": "Last updated timestamp in seconds.",
"format": "int64",
"example": 1778640200
},
"details": {
"type": "object",
"description": "Sport-specific details. Structure varies by type field.
Type mapping:
• basketball_game → EventContractLiveBasketballDetailsVo
• baseball_game → EventContractLiveBaseballDetailsVo
• baseball_tournament → EventContractLiveBaseballDetailsVo
• football_game → EventContractLiveFootballDetailsVo
• hockey_match → EventContractLiveHockeyDetailsVo
• hockey_tournament → EventContractLiveHockeyDetailsVo
• soccer_tournament_multi_leg → EventContractLiveSoccerDetailsVo
• tennis_tournament_singles → EventContractLiveTennisDetailsVo
• golf_tournament → EventContractLiveGolfDetailsVo
• cricket_match → EventContractLiveCricketDetailsVo",
"oneOf": [
{
"type": "object",
"properties": {
"away_points": {
"type": "integer",
"description": "Away team score.",
"format": "int32",
"example": 87
},
"home_points": {
"type": "integer",
"description": "Home team score.",
"format": "int32",
"example": 92
},
"last_event_created_ts": {
"type": "integer",
"description": "Last event created timestamp in seconds.",
"format": "int64",
"example": 1778640200
},
"last_event_is_timeout": {
"type": "boolean",
"description": "Whether last event is a timeout.",
"example": false
},
"period": {
"type": "integer",
"description": "Current period number.",
"format": "int32",
"example": 3
},
"period_remaining_time": {
"type": "string",
"description": "Remaining time in current period.",
"example": "04:32"
},
"period_type": {
"type": "string",
"description": "Period type, e.g. quarter, half, overtime. Varies by sport.",
"example": "quarter"
},
"possession": {
"type": "string",
"description": "Ball possession side, e.g. away, home.",
"example": "home"
},
"score_last_updated_ts": {
"type": "integer",
"description": "Score last updated timestamp in seconds.",
"format": "int64",
"example": 1778640200
}
},
"description": "Basketball game details (type=basketball_game)",
"title": "EventContractLiveBasketballDetailsVo"
},
{
"type": "object",
"properties": {
"away_points": {
"type": "integer",
"description": "Away team score.",
"format": "int32",
"example": 3
},
"home_points": {
"type": "integer",
"description": "Home team score.",
"format": "int32",
"example": 5
},
"balls": {
"type": "integer",
"description": "Current ball count.",
"format": "int32",
"example": 2
},
"bases": {
"type": "array",
"description": "Base occupancy. Array of 4 booleans: [home, 1st, 2nd, 3rd].",
"example": [
false,
true,
false,
true
],
"items": {
"type": "boolean",
"description": "Base occupancy. Array of 4 booleans: [home, 1st, 2nd, 3rd].",
"example": false
}
},
"inning": {
"type": "integer",
"description": "Current inning number.",
"format": "int32",
"example": 6
},
"inning_half": {
"type": "integer",
"description": "Current half inning. 0=top, 1=bottom.",
"format": "int32",
"example": 0
},
"outs": {
"type": "integer",
"description": "Out count.",
"format": "int32",
"example": 1
},
"strikes": {
"type": "integer",
"description": "Strike count.",
"format": "int32",
"example": 1
}
},
"description": "Baseball game details (type=baseball_game, baseball_tournament)",
"title": "EventContractLiveBaseballDetailsVo"
},
{
"type": "object",
"properties": {
"away_points": {
"type": "integer",
"description": "Away team score.",
"format": "int32",
"example": 14
},
"home_points": {
"type": "integer",
"description": "Home team score.",
"format": "int32",
"example": 21
},
"clock": {
"type": "string",
"description": "Game clock.",
"example": "07:23"
},
"quarter": {
"type": "integer",
"description": "Current quarter number.",
"format": "int32",
"example": 3
},
"situation": {
"type": "object",
"properties": {
"down": {
"type": "integer",
"description": "Current down number.",
"format": "int32",
"example": 2
},
"goal_to_go": {
"type": "boolean",
"description": "Whether it is goal to go.",
"example": false
},
"possession_team_id": {
"type": "string",
"description": "Possession team ID.",
"example": "PHI-001"
},
"side_team_id": {
"type": "string",
"description": "Ball side team ID.",
"example": "KC-001"
},
"yardline": {
"type": "integer",
"description": "Yard line position.",
"format": "int32",
"example": 35
},
"yfd": {
"type": "integer",
"description": "Yards to first down.",
"format": "int32",
"example": 7
}
},
"description": "EventContractLiveFootballSituationVo",
"title": "EventContractLiveFootballSituationVo"
}
},
"description": "Football game details (type=football_game)",
"title": "EventContractLiveFootballDetailsVo"
},
{
"type": "object",
"properties": {
"away_points": {
"type": "integer",
"description": "Away team score.",
"format": "int32",
"example": 2
},
"home_points": {
"type": "integer",
"description": "Home team score.",
"format": "int32",
"example": 3
},
"period": {
"type": "integer",
"description": "Current period number.",
"format": "int32",
"example": 2
},
"period_remaining_time": {
"type": "string",
"description": "Remaining time in current period.",
"example": "08:15"
}
},
"description": "Hockey match details (type=hockey_match, hockey_tournament)",
"title": "EventContractLiveHockeyDetailsVo"
},
{
"type": "object",
"properties": {
"aggregate_text": {
"type": "string",
"description": "Aggregate score text.",
"example": "Agg: 3-2"
},
"away_aggregate_score": {
"type": "integer",
"description": "Away team aggregate score (multi-leg).",
"format": "int32",
"example": 2
},
"away_penalties": {
"type": "array",
"description": "Away team penalty results list.",
"items": {
"type": "string",
"description": "Away team penalty results list."
}
},
"away_same_game_score": {
"type": "integer",
"description": "Away team current game score.",
"format": "int32",
"example": 1
},
"away_significant_events": {
"type": "array",
"description": "Away team significant events list.",
"items": {
"type": "object",
"properties": {
"event_type": {
"type": "string",
"description": "Event type, e.g. goal, yellow_card, red_card.",
"example": "goal"
},
"player": {
"type": "string",
"description": "Player name.",
"example": "Vinicius Jr"
},
"time": {
"type": "string",
"description": "Event time.",
"example": "22'"
}
},
"description": "EventContractLiveSoccerSignificantEventVo",
"title": "EventContractLiveSoccerSignificantEventVo"
}
},
"half": {
"type": "string",
"description": "Current half, e.g. 1H, 2H, FT.",
"example": "2H"
},
"home_aggregate_score": {
"type": "integer",
"description": "Home team aggregate score (multi-leg).",
"format": "int32",
"example": 3
},
"home_penalties": {
"type": "array",
"description": "Home team penalty results list.",
"items": {
"type": "string",
"description": "Home team penalty results list."
}
},
"home_same_game_score": {
"type": "integer",
"description": "Home team current game score.",
"format": "int32",
"example": 2
},
"home_significant_events": {
"type": "array",
"description": "Home team significant events list.",
"items": {
"type": "object",
"properties": {
"event_type": {
"type": "string",
"description": "Event type, e.g. goal, yellow_card, red_card.",
"example": "goal"
},
"player": {
"type": "string",
"description": "Player name.",
"example": "Vinicius Jr"
},
"time": {
"type": "string",
"description": "Event time.",
"example": "22'"
}
},
"description": "EventContractLiveSoccerSignificantEventVo",
"title": "EventContractLiveSoccerSignificantEventVo"
}
},
"penalties_text": {
"type": "string",
"description": "Penalty shootout text."
},
"show_penalties": {
"type": "boolean",
"description": "Whether to show penalty shootout.",
"example": false
},
"status_text": {
"type": "string",
"description": "Status text.",
"example": "2nd Half"
},
"time": {
"type": "string",
"description": "Match time.",
"example": "62"
}
},
"description": "Soccer match details (type=soccer_tournament_multi_leg)",
"title": "EventContractLiveSoccerDetailsVo"
},
{
"type": "object",
"properties": {
"advantage": {
"type": "string",
"description": "Advantage holder ID. Empty if deuce."
},
"away_overall_score": {
"type": "integer",
"description": "Away player overall score.",
"format": "int32",
"example": 1
},
"competitor1_current_round_score": {
"type": "integer",
"description": "Competitor 1 current round score.",
"format": "int32",
"example": 4
},
"competitor1_id": {
"type": "string",
"description": "Competitor 1 ID.",
"example": "SINNER-001"
},
"competitor1_is_home": {
"type": "boolean",
"description": "Whether competitor 1 is home.",
"example": true
},
"competitor1_overall_score": {
"type": "integer",
"description": "Competitor 1 overall score (sets won).",
"format": "int32",
"example": 2
},
"competitor1_round_scores": {
"type": "array",
"description": "Competitor 1 round scores.",
"items": {
"type": "object",
"properties": {
"outcome": {
"type": "string",
"description": "Round outcome. Values: won, lost, or empty (in progress).",
"example": "won"
},
"score": {
"type": "integer",
"description": "Games won in this set.",
"format": "int32",
"example": 6
},
"tiebreak_score": {
"type": "integer",
"description": "Tiebreak score. Null if no tiebreak.",
"format": "int32"
}
},
"description": "EventContractLiveTennisRoundScoreVo",
"title": "EventContractLiveTennisRoundScoreVo"
}
},
"competitor1_seed": {
"type": "integer",
"description": "Competitor 1 seed ranking.",
"format": "int32",
"example": 1
},
"competitor1_statistics": {
"type": "object",
"properties": {
"gamescore": {
"type": "string",
"description": "Current game score.",
"example": "30"
}
},
"description": "EventContractLiveTennisStatisticsVo",
"title": "EventContractLiveTennisStatisticsVo"
},
"competitor2_current_round_score": {
"type": "integer",
"description": "Competitor 2 current round score.",
"format": "int32",
"example": 3
},
"competitor2_id": {
"type": "string",
"description": "Competitor 2 ID.",
"example": "ALCARAZ-001"
},
"competitor2_overall_score": {
"type": "integer",
"description": "Competitor 2 overall score (sets won).",
"format": "int32",
"example": 1
},
"competitor2_round_scores": {
"type": "array",
"description": "Competitor 2 round scores.",
"items": {
"type": "object",
"properties": {
"outcome": {
"type": "string",
"description": "Round outcome. Values: won, lost, or empty (in progress).",
"example": "won"
},
"score": {
"type": "integer",
"description": "Games won in this set.",
"format": "int32",
"example": 6
},
"tiebreak_score": {
"type": "integer",
"description": "Tiebreak score. Null if no tiebreak.",
"format": "int32"
}
},
"description": "EventContractLiveTennisRoundScoreVo",
"title": "EventContractLiveTennisRoundScoreVo"
}
},
"competitor2_seed": {
"type": "integer",
"description": "Competitor 2 seed ranking.",
"format": "int32",
"example": 2
},
"competitor2_statistics": {
"type": "object",
"properties": {
"gamescore": {
"type": "string",
"description": "Current game score.",
"example": "30"
}
},
"description": "EventContractLiveTennisStatisticsVo",
"title": "EventContractLiveTennisStatisticsVo"
},
"completed_rounds": {
"type": "integer",
"description": "Number of completed rounds.",
"format": "int32",
"example": 2
},
"home_overall_score": {
"type": "integer",
"description": "Home player overall score.",
"format": "int32",
"example": 2
},
"round_winners": {
"type": "array",
"description": "Round winners ID list.",
"items": {
"type": "string",
"description": "Round winners ID list."
}
},
"server": {
"type": "string",
"description": "Current server ID.",
"example": "SINNER-001"
}
},
"description": "Tennis match details (type=tennis_tournament_singles)",
"title": "EventContractLiveTennisDetailsVo"
},
{
"type": "object",
"properties": {
"current_round": {
"type": "integer",
"description": "Current round number.",
"format": "int32",
"example": 3
},
"leaderboard": {
"type": "array",
"description": "Leaderboard entries.",
"items": {
"type": "object",
"properties": {
"competitor_id": {
"type": "string",
"description": "Competitor ID.",
"example": "SCHEFFLER-001"
},
"current_round_score": {
"type": "integer",
"description": "Current round score (strokes relative to par).",
"format": "int32",
"example": -4
},
"current_round_thru": {
"type": "integer",
"description": "Holes completed in current round.",
"format": "int32",
"example": 14
},
"finished_current_round": {
"type": "boolean",
"description": "Whether current round is finished.",
"example": false
},
"position": {
"type": "integer",
"description": "Current leaderboard position.",
"format": "int32",
"example": 1
},
"started_current_round": {
"type": "boolean",
"description": "Whether current round has started.",
"example": true
},
"total_score": {
"type": "integer",
"description": "Total score (strokes relative to par).",
"format": "int32",
"example": -12
}
},
"description": "EventContractLiveGolfLeaderboardEntryVo",
"title": "EventContractLiveGolfLeaderboardEntryVo"
}
},
"round_label": {
"type": "string",
"description": "Round label.",
"example": "Round 3"
}
},
"description": "Golf tournament details (type=golf_tournament)",
"title": "EventContractLiveGolfDetailsVo"
},
{
"type": "object",
"properties": {
"away_overs": {
"type": "integer",
"description": "Away team overs.",
"format": "int32",
"example": 18
},
"away_score": {
"type": "integer",
"description": "Away team score.",
"format": "int32",
"example": 156
},
"away_wickets": {
"type": "integer",
"description": "Away team wickets.",
"format": "int32",
"example": 6
},
"batting": {
"type": "string",
"description": "Current batting side. Values: home, away.",
"example": "home"
},
"home_overs": {
"type": "integer",
"description": "Home team overs.",
"format": "int32",
"example": 12
},
"home_score": {
"type": "integer",
"description": "Home team score.",
"format": "int32",
"example": 98
},
"home_wickets": {
"type": "integer",
"description": "Home team wickets.",
"format": "int32",
"example": 3
}
},
"description": "Cricket match details (type=cricket_match)",
"title": "EventContractLiveCricketDetailsVo"
}
]
}
},
"description": "EventContractLiveDataVo",
"title": "EventContractLiveDataVo"
}
}
}
},
"401": {
"description": "Unauthorized: Authentication required",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Internal logic error code"
},
"message": {
"type": "string",
"description": "Error message"
}
},
"description": "ErrorResponseVo",
"title": "ErrorResponseVo"
},
"example": {
"error_code": "UNAUTHORIZED",
"message": "Insufficient permission"
}
}
}
},
"417": {
"description": "A business logic error triggered when the request cannot be processed due to domain-specific constraints.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Internal logic error code"
},
"message": {
"type": "string",
"description": "Error message"
}
},
"description": "ErrorResponseVo",
"title": "ErrorResponseVo"
},
"example": {
"error_code": "UNSUPPORTED_CATEGORY",
"message": "Unsupported category:US_EVENTS"
}
}
}
}
},
"postman": {
"name": "Get Event Live Data",
"description": {
"content": "Retrieves real-time live game/event data for a specified milestone, including scores, game clock, period, and winner information. Use this to display live match status alongside event contract prices.",
"type": "text/plain"
},
"url": {
"path": [
"market-data",
"event-contracts",
"live-data",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "(Required) Milestone ID. A milestone represents a specific game or real-world occurrence tied to events.",
"type": "text/plain"
},
"key": "milestone_id",
"value": ""
},
{
"disabled": false,
"description": {
"content": "Category, default is US_EVENT, currently only US_EVENT is supported.",
"type": "text/plain"
},
"key": "category",
"value": ""
}
],
"variable": []
},
"header": [
{
"disabled": false,
"description": {
"content": "(Required) User's authenticated token.",
"type": "text/plain"
},
"key": "access_token",
"value": ""
},
{
"disabled": false,
"description": {
"content": "The unique ID for this request. Suggest using UUID.",
"type": "text/plain"
},
"key": "reqid",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET"
}
}
```