Home
Home pin surfaces
All CMS-defined pin surfaces in admin order, each with its active pinned events serialized exactly like the events listing (EventListItem). event_count is the pre-cap total per surface.
GET
/
api/v1/home/surfacesQuery Parameters
limitinteger
Per-surface event cap. Default 25, max 50.
Default:
25Minimum: 1Maximum: 50include_marketsstring
Ship lean listing_markets on non-GAME items. Default true; pass false for the lighter payload.
Default:
"true"Value in: "true" | "false"curl -X GET "https://app.agara.xyz/api/v1/home/surfaces?limit=25&include_markets=true"Success
{
"surfaces": [
{
"slug": "string",
"label": "string",
"position": 0,
"event_count": 0,
"events": [
{
"event_type": "GAME",
"market_count": 0,
"display": {
"image_url": "string",
"icon_url": "string",
"description": "string",
"subtext": "string",
"display_date": "string",
"liquidity": 0,
"has_three_way_markets": true,
"has_prop_markets": true,
"has_legacy_prop_markets": true,
"market_categories": [
"string"
],
"tags": [
"string"
],
"resolution_source": "string",
"layout": "regular",
"game_unit_label": "Game",
"spreads_main_market_id": "string",
"totals_main_market_id": "string",
"agara_cms": {
"property1": null,
"property2": null
},
"team_a": {
"name": "string",
"abbreviation": "string",
"logo_url": "string",
"color": "string",
"record": "string",
"sport_slug": "string",
"league_slug": "string",
"provider_id": "string",
"source_team_id": "string"
},
"team_b": {
"name": "string",
"abbreviation": "string",
"logo_url": "string",
"color": "string",
"record": "string",
"sport_slug": "string",
"league_slug": "string",
"provider_id": "string",
"source_team_id": "string"
},
"sport_slug": "string",
"league_slug": "string",
"format_label": "string",
"spreads_main_line": 0,
"totals_main_line": 0
},
"game_state": {
"id": 0,
"score": {
"sport": "tennis",
"match": {
"a": 0,
"b": 0
},
"sets": [
{
"a": 0,
"b": 0,
"tiebreak": {
"a": 0,
"b": 0
}
}
]
},
"match": {
"lifecycle": "scheduled",
"live_label": "string"
}
},
"id": "string",
"slug": "string",
"title": "string",
"is_accepting_orders": true,
"is_live": true,
"is_group_root": true,
"start_time": "string",
"end_time": "string",
"volume_micro": "string",
"primary_category": {
"slug": "string",
"label": "string"
},
"main_market_id": "string",
"resolution_status": "ACTIVE",
"state": "DRAFT",
"main_market_group": {
"neg_risk_id": "string",
"markets": [
{
"id": "string",
"state": "DRAFT",
"exchange": "AGARA",
"slug": "string",
"question": "string",
"display_type": "BINARY",
"source_market_type": "string",
"outcomes": [
{
"id": "string",
"index": 0,
"label": "string",
"price_micro": "string",
"token_id": "string",
"best_bid_micro": "string",
"best_ask_micro": "string",
"spread_micro": "string",
"kind": "team_home",
"short_label": "string",
"team_side": "home",
"side": "left",
"threshold": 0,
"resolution_price_micro": "string",
"bet_slip_title": "string",
"resolution_label": "string",
"display": {
"label": "string",
"kind": "team_home",
"short_label": "string",
"team_side": "home",
"side": "left",
"threshold": 0,
"bet_slip_title": "string",
"resolution_label": "string",
"agara_cms": {
"property1": null,
"property2": null
}
}
}
],
"is_accepting_orders": true,
"halted_at": "string",
"halted_reason": "string",
"volume_micro": "string",
"liquidity": "string",
"volume_24h_micro": "string",
"tick_size_micro": "string",
"engine_config": {
"tick_size": 0,
"price_scale": 0,
"size_scale": 0,
"min_price": 0,
"max_price": 0
},
"min_order_size_micro": "string",
"line": "string",
"resolution_status": "DISPUTED",
"resolution_outcome": "string",
"resolved_at": "string",
"resolution": {
"source": "string",
"reference_value": "string",
"observed_value": "string",
"observed_at": "string"
},
"archived_at": "string",
"condition_id": "string",
"neg_risk_id": "string",
"three_way_role": "home",
"is_three_way": true,
"game_number": 0,
"display_label": "string",
"display": {
"image_url": "string",
"portfolio_title": "string",
"description": "string",
"resolution_source": "string",
"resolution_criteria": "string",
"resolution_sources": [
{
"title": "string",
"url": "string"
}
],
"player_name": "string",
"stat_type": "string",
"liquidity": 0,
"cadence_seconds": 0,
"reference_price": "string",
"currency": "string",
"reference_at": "string",
"observe_at": "string",
"band_index": 0,
"band_lower": "string",
"band_upper": "string",
"band_label": "string",
"pyth_feed_id": "string",
"pyth_benchmark_symbol": "string",
"tradingview_symbol": "string",
"pyth_pro_symbol": "string",
"security_symbol": "string",
"security_provider": "string",
"game_number": 0,
"is_three_way": true,
"three_way_role": "home",
"display_label": "string",
"agara_cms": {
"property1": null,
"property2": null
}
}
}
]
}
}
]
}
]
}