openapi-directory/api/whapi.com/sportsdata.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"contact":{"name":"William Hill Labs","url":"http://developer.williamhill.com","x-twitter":"WilliamHill"},"description":"The William Hill SportsData REST API is a collection of GET methods to provide William Hill product data such as sport, competition, event, market and selection data (including prices).","title":"SportsData API","version":"2","x-apisguru-categories":["entertainment"],"x-logo":{"url":"https://twitter.com/WillHillHelp/profile_image?size=original"},"x-origin":[{"format":"swagger","url":"https://developer.williamhill.com/wh-docs/docs-sdks/sportsdata/swagger/docs","version":"2.0"}],"x-providerName":"whapi.com","x-serviceName":"sportsdata"},"paths":{"/classes/{classId}/competitions/":{"get":{"description":"Retrieves a list of competitions for a given class id.","operationId":"getCompetitionsForClass","parameters":[{"$ref":"#/components/parameters/param_apiKey"},{"$ref":"#/components/parameters/param_classId"},{"$ref":"#/components/parameters/param_active"},{"$ref":"#/components/parameters/param_fields"},{"$ref":"#/components/parameters/param_include"},{"$ref":"#/components/parameters/param_exclude"},{"$ref":"#/components/parameters/param_displayed"},{"$ref":"#/components/parameters/param_channel"},{"$ref":"#/components/parameters/param_status"},{"$ref":"#/components/parameters/param_sort"},{"$ref":"#/components/parameters/param_offset"},{"$ref":"#/components/parameters/param_limit"},{"$ref":"#/components/parameters/param_culture"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/competitionsWrapper"},"examples":{"response":{"value":"{\n \"competitions\": [\n {\n \"id\": \"OB_TY1733\",\n \"name\": \"Manchester Senior Cup\",\n \"status\": \"A\"\n }\n ]\n}\n"}}}}},"400":{"description":"Incorrect or Missing Parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorsWrapper"},"examples":{"response":{"value":"{\n \"errors\" : [\n {\n \"code\":\"10070\",\n \"message\":\"Missing Parameter\",\n \"field\":\"apiKey\"\n }\n ]\n}\n"}}}}},"404":{"description":"No data found for request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorsWrapper"},"examples":{"response":{"value":"{\n \"errors\" : [\n {\n \"code\":\"10003\",\n \"message\":\"Resource Not Found\"\n }\n ]\n}\n"}}}}}},"summary":"Retrieves a list of competitions for a given class id.","tags":["sportsdata"],"x-canReturnErrors":[0]}},"/classes/{classId}/events/":{"get":{"description":"Retrieves a list of events for a given class id. 'includeAllDescendants' parameter should be accompanied with 'date' filter or one of 'dateFrom' and 'dateTo' filters.","operationId":"getEventsForClass","parameters":[{"$ref":"#/components/parameters/param_apiKey"},{"$ref":"#/components/parameters/param_classId"},{"$ref":"#/components/parameters/param_active"},{"$ref":"#/components/parameters/param_fields"},{"$ref":"#/components/parameters/param_include"},{"$ref":"#/components/parameters/param_exclude"},{"$ref":"#/components/parameters/param_displayed"},{"$ref":"#/components/parameters/param_channel"},{"$ref":"#/components/parameters/param_settled"},{"$ref":"#/components/parameters/param_includeEmpty"},{"$ref":"#/components/parameters/param_status"},{"$ref":"#/components/parameters/param_sort"},{"$ref":"#/components/parameters/param_offset"},{"$ref":"#/components/parameters/param_limit"},{"$ref":"#/components/parameters/param_headlinesummary"},{"$ref":"#/components/parameters/param_includeAllDescendants"},{"$ref":"#/components/parameters/param_isInPlay"},{"$ref":"#/components/parameters/param_marketCount"},{"$ref":"#/components/parameters/param_date"},{"$ref":"#/components/parameters/param_dateFrom"},{"$ref":"#/components/parameters/param_dateTo"},{"$ref":"#/components/parameters/param_eventSort"},{"$ref":"#/components/parameters/param_culture"},{"$ref":"#/components/parameters/param_marketPublished"},{"$ref":"#/components/parameters/param_marketStatus"},{"$ref":"#/components/parameters/param_marketDisplayed"},{"$ref":"#/components/parameters/param_marketChannel"},{"$ref":"#/components/parameters/param_marketSort"},{"$ref":"#/components/parameters/param_marketEW"},{"$ref":"#/components/parameters/param_selectionStatus"},{"$ref":"#/components/parameters/param_selectionChannel"},{"$ref":"#/components/parameters/param_selectionPublished"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eventsWrapper"},"examples":{"response":{"value":"{\n\"events\": [\n {\n \"id\": \"OB_EV2828\",\n \"name\": \"Forest Green Vs Liverpool\",\n \"status\": \"A\",\n \"startDateTime\": \"2016-01-29T20:00:00\"\n },\n {\n \"id\": \"OB_EV2829\",\n \"name\": \"XXXMan Utd Vs Man City\",\n \"status\": \"A\",\n \"startDateTime\": \"2016-01-07T11:00:00\"\n },\n {\n \"id\": \"OB_EV2849\",\n \"name\": \"Manchester Senior Cup - Winners 2015-16\",\n \"status\": \"A\",\n \"startDateTime\": \"2016-01-01T00:00:00\"\n }\n]\n}\n"}}}}},"400":{"description":"Incorrect or Missing Parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorsWrapper"},"examples":{"response":{"value":"{\n \"errors\" : [\n {\n \"code\":\"10070\",\n \"message\":\"Missing Parameter\",\n \"field\":\"apiKey\"\n }\n ]\n}\n"}}}}},"404":{"description":"No data found for request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorsWrapper"},"examples":{"response":{"value":"{\n \"errors\" : [\n {\n \"code\":\"10003\",\n \"message\":\"Resource Not Found\"\n }\n ]\n}\n"}}}}}},"summary":"Retrieves a list of events for a given class id.","tags":["sportsdata"],"x-canReturnErrors":[0]}},"/competitions/{competitionId}":{"get":{"description":"Retrieves a specific competition","operationId":"getCompetition","parameters":[{"$ref":"#/components/parameters/param_apiKey"},{"$ref":"#/components/parameters/param_competitionId"},{"$ref":"#/components/parameters/param_fields"},{"$ref":"#/components/parameters/param_include"},{"$ref":"#/components/parameters/param_exclude"},{"$ref":"#/components/parameters/param_culture"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/competition"},"examples":{"response":{"value":"{\n \"id\": \"OB_TY1733\",\n \"name\": \"Manchester Senior Cup\",\n \"status\": \"A\"\n}\n"}}}}},"400":{"description":"Incorrect or Missing Parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorsWrapper"},"examples":{"response":{"value":"{\n \"errors\" : [\n {\n \"code\":\"10070\",\n \"message\":\"Missing Parameter\",\n \"field\":\"apiKey\"\n }\n ]\n}\n"}}}}},"404":{"description":"No data found for request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorsWrapper"},"examples":{"response":{"value":"{\n \"errors\" : [\n {\n \"code\":\"10003\",\n \"message\":\"Resource Not Found\"\n }\n ]\n}\n"}}}}}},"summary":"Retrieves a specific competition","tags":["sportsdata"],"x-canReturnErrors":[0]}},"/competitions/{competitionId}/events/":{"get":{"description":"Retrieves a list of events for a given competition id. 'headlineSummary' and includeAllDescendants parameters should be accompanied with 'date' filter or one of 'dateFrom' and 'dateTo' filters.","operationId":"getEventsForCompetition","parameters":[{"$ref":"#/components/parameters/param_apiKey"},{"$ref":"#/components/parameters/param_competitionId"},{"$ref":"#/components/parameters/param_active"},{"$ref":"#/components/parameters/param_fields"},{"$ref":"#/components/parameters/param_include"},{"$ref":"#/components/parameters/param_exclude"},{"$ref":"#/components/parameters/param_displayed"},{"$ref":"#/components/parameters/param_channel"},{"$ref":"#/components/parameters/param_settled"},{"$ref":"#/components/parameters/param_includeEmpty"},{"$ref":"#/components/parameters/param_status"},{"$ref":"#/components/parameters/param_sort"},{"$ref":"#/components/parameters/param_offset"},{"$ref":"#/components/parameters/param_limit"},{"$ref":"#/components/parameters/param_headlinesummary"},{"$ref":"#/components/parameters/param_includeAllDescendants"},{"$ref":"#/components/parameters/param_isInPlay"},{"$ref":"#/components/parameters/param_marketCount"},{"$ref":"#/components/parameters/param_date"},{"$ref":"#/components/parameters/param_dateFrom"},{"$ref":"#/components/parameters/param_dateTo"},{"$ref":"#/components/parameters/param_marketGroupId"},{"$ref":"#/components/parameters/param_eventSort"},{"$ref":"#/components/parameters/param_culture"},{"$ref":"#/components/parameters/param_marketPublished"},{"$ref":"#/components/parameters/param_marketStatus"},{"$ref":"#/components/parameters/param_marketDisplayed"},{"$ref":"#/components/parameters/param_marketChannel"},{"$ref":"#/components/parameters/param_marketSort"},{"$ref":"#/components/parameters/param_marketEW"},{"$ref":"#/components/parameters/param_selectionStatus"},{"$ref":"#/components/parameters/param_selectionChannel"},{"$ref":"#/components/parameters/param_selectionPublished"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eventsWrapper"},"examples":{"response":{"value":"{\n\"events\": [\n {\n \"id\": \"OB_EV2828\",\n \"name\": \"Forest Green Vs Liverpool\",\n \"status\": \"A\",\n \"startDateTime\": \"2016-01-29T20:00:00\"\n },\n {\n \"id\": \"OB_EV2829\",\n \"name\": \"XXXMan Utd Vs Man City\",\n \"status\": \"A\",\n \"startDateTime\": \"2016-01-07T11:00:00\"\n },\n {\n \"id\": \"OB_EV2849\",\n \"name\": \"Manchester Senior Cup - Winners 2015-16\",\n \"status\": \"A\",\n \"startDateTime\": \"2016-01-01T00:00:00\"\n }\n]\n}\n"}}}}},"400":{"description":"Incorrect or Missing Parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorsWrapper"},"examples":{"response":{"value":"{\n \"errors\" : [\n {\n \"code\":\"10070\",\n \"message\":\"Missing Parameter\",\n \"field\":\"apiKey\"\n }\n ]\n}\n"}}}}},"404":{"description":"No data found for request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorsWrapper"},"examples":{"response":{"value":"{\n \"errors\" : [\n {\n \"code\":\"10003\",\n \"message\":\"Resource Not Found\"\n }\n ]\n}\n"}}}}}},"summary":"Retrieves a list of events for a given competition id.","tags":["sportsdata"],"x-canReturnErrors":[0]}},"/competitions/{competitionId}/marketgroups/":{"get":{"description":"Retrieves a list of market groups for a given competition id","operationId":"getMarketGroupsForCompetition","parameters":[{"$ref":"#/components/parameters/param_apiKey"},{"$ref":"#/components/parameters/param_competitionId"},{"$ref":"#/components/parameters/param_fields"},{"$ref":"#/components/parameters/param_include"},{"$ref":"#/components/parameters/param_exclude"},{"$ref":"#/components/parameters/param_sort"},{"$ref":"#/components/parameters/param_offset"},{"$ref":"#/components/parameters/param_limit"},{"$ref":"#/components/parameters/param_culture"},{"description":"Filter by market group name","in":"query","name":"name","required":false,"x-eg":"MARKETGROUP1","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/marketGroupsWrapper"},"examples":{"response":{"value":"{\n \"marketgroups\": [\n {\n \"id\": \"OB_MG36963\",\n \"name\": \"90 Minutes\"\n },\n {\n \"id\": \"OB_MG36964\",\n \"name\": \"Correct Score\"\n },\n {\n \"id\": \"OB_MG36966\",\n \"name\": \"First Goalscorer\"\n },\n {\n \"id\": \"OB_MG37004\",\n \"name\": \"Match Betting Live\"\n },\n {\n \"id\": \"OB_MG37043\",\n \"name\": \"Outright\"\n }\n ]\n}\n"}}}}},"400":{"description":"Incorrect or Missing Parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorsWrapper"},"examples":{"response":{"value":"{\n \"errors\" : [\n {\n \"code\":\"10070\",\n \"message\":\"Missing Parameter\",\n \"field\":\"apiKey\"\n }\n ]\n}\n"}}}}},"404":{"description":"No data found for request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorsWrapper"},"examples":{"response":{"value":"{\n \"errors\" : [\n {\n \"code\":\"10003\",\n \"message\":\"Resource Not Found\"\n }\n ]\n}\n"}}}}}},"summary":"Retrieves a list of market groups for a given competition id","tags":["sportsdata"],"x-canReturnErrors":[0]}},"/competitions/{competitionId}/marketsByGroupid":{"get":{"description":"Retrieves a list of events/markets/selections where markets within said event match selected sort/groupId","operationId":"getMarketsByGroupId","parameters":[{"$ref":"#/components/parameters/param_apiKey"},{"$ref":"#/components/parameters/param_competitionId"},{"$ref":"#/components/parameters/param_fields"},{"$ref":"#/components/parameters/param_include"},{"$ref":"#/components/parameters/param_exclude"},{"$ref":"#/components/parameters/param_marketSort2"},{"$ref":"#/components/parameters/param_marketGroupId2"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/marketGroupsWrapper"},"examples":{"response":{"value":"{\n \"events\": [\n\n {\n \"id\": \"OB_EV123\",\n \"name\": \"ManU v City\",\n \"markets\": {\n \"id\": \"OB_MA1234\",\n \"name\": \"90 Minutes\"\n \"selections\": {\n \"id\": \"OB_OU12345\",\n \"fractionalOdds\": \"2/1\"\n \n }\n }\n }\n ]\n}\n"}}}}},"400":{"description":"Incorrect or Missing Parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorsWrapper"},"examples":{"response":{"value":"{\n \"errors\" : [\n {\n \"code\":\"10070\",\n \"message\":\"Missing Parameter\",\n \"field\":\"apiKey\"\n }\n ]\n}\n"}}}}},"404":{"description":"No data found for request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorsWrapper"},"examples":{"response":{"value":"{\n \"errors\" : [\n {\n \"code\":\"10003\",\n \"message\":\"Resource Not Found\"\n }\n ]\n}\n"}}}}}},"summary":"Retrieves a list of events/markets/selections where markets within said event match selected sort/groupId","tags":["sportsdata"],"x-canReturnErrors":[0]}},"/events/":{"get":{"description":"Retrieves a list of events for the provided IDs.","operationId":"getEvents","parameters":[{"$ref":"#/components/parameters/param_apiKey"},{"$ref":"#/components/parameters/param_ids"},{"$ref":"#/components/parameters/param_active"},{"$ref":"#/components/parameters/param_includeAllDescendants"},{"$ref":"#/components/parameters/param_fields"},{"$ref":"#/components/parameters/param_include"},{"$ref":"#/components/parameters/param_exclude"},{"$ref":"#/components/parameters/param_channel"},{"$ref":"#/components/parameters/param_settled"},{"$ref":"#/components/parameters/param_includeEmpty"},{"$ref":"#/components/parameters/param_headlinesummary"},{"$ref":"#/components/parameters/param_marketCount"},{"$ref":"#/components/parameters/param_sort"},{"$ref":"#/components/parameters/param_offset"},{"$ref":"#/components/parameters/param_limit"},{"$ref":"#/components/parameters/param_marketIds"},{"$ref":"#/components/parameters/param_culture"},{"$ref":"#/components/parameters/param_marketPublished"},{"$ref":"#/components/parameters/param_marketStatus"},{"$ref":"#/components/parameters/param_marketDisplayed"},{"$ref":"#/components/parameters/param_marketChannel"},{"$ref":"#/components/parameters/param_marketSort"},{"$ref":"#/components/parameters/param_marketEW"},{"$ref":"#/components/parameters/param_selectionStatus"},{"$ref":"#/components/parameters/param_selectionChannel"},{"$ref":"#/components/parameters/param_selectionPublished"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eventsWrapper"},"examples":{"response":{"value":"{\n \"events\": [\n {\n \"id\": \"OB_EV2828\",\n \"name\": \"Forest Green Vs Liverpool\",\n \"status\": \"A\",\n \"startDateTime\": \"2016-01-29T20:00:00\",\n \"markets\": [\n {\n \"id\": \"OB_MA2559\",\n \"name\": \"Correct Score\",\n \"status\": \"A\",\n \"selections\": [\n {\n \"id\": \"OB_OU3863\",\n \"currentPriceNum\": 14,\n \"currentPriceDen\": 1,\n \"name\": \"Liverpool 2-1\",\n \"status\": \"A\"\n }\n ]\n }\n ]\n }\n ]\n}\n"}}}}},"400":{"description":"Incorrect or Missing Parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorsWrapper"},"examples":{"response":{"value":"{\n \"errors\" : [\n {\n \"code\":\"10070\",\n \"message\":\"Missing Parameter\",\n \"field\":\"apiKey\"\n }\n ]\n}\n"}}}}},"404":{"description":"No data found for request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorsWrapper"},"examples":{"response":{"value":"{\n \"errors\" : [\n {\n \"code\":\"10003\",\n \"message\":\"Resource Not Found\"\n }\n ]\n}\n"}}}}}},"summary":"Retrieves a list of events for the provided IDs.","tags":["sportsdata"],"x-canReturnErrors":[0]}},"/events/{eventId}":{"get":{"description":"Retrieves a single event by ID.","operationId":"getEvent","parameters":[{"$ref":"#/components/parameters/param_apiKey"},{"$ref":"#/components/parameters/param_eventId"},{"$ref":"#/components/parameters/param_includeAllDescendants"},{"$ref":"#/components/parameters/param_fields"},{"$ref":"#/components/parameters/param_include"},{"$ref":"#/components/parameters/param_exclude"},{"$ref":"#/components/parameters/param_headlinesummary"},{"$ref":"#/components/parameters/param_marketCount"},{"$ref":"#/components/parameters/param_marketIds"},{"$ref":"#/components/parameters/param_includeEmpty"},{"$ref":"#/components/parameters/param_culture"},{"$ref":"#/components/parameters/param_marketPublished"},{"$ref":"#/components/parameters/param_marketStatus"},{"$ref":"#/components/parameters/param_marketDisplayed"},{"$ref":"#/components/parameters/param_marketChannel"},{"$ref":"#/components/parameters/param_marketSort"},{"$ref":"#/components/parameters/param_marketEW"},{"$ref":"#/components/parameters/param_selectionStatus"},{"$ref":"#/components/parameters/param_selectionChannel"},{"$ref":"#/components/parameters/param_selectionPublished"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eventsWrapper"},"examples":{"response":{"value":"{\n \"events\": [\n {\n \"id\": \"OB_EV2828\",\n \"name\": \"Forest Green Vs Liverpool\",\n \"status\": \"A\",\n \"startDateTime\": \"2016-01-29T20:00:00\",\n \"markets\": [\n {\n \"id\": \"OB_MA2559\",\n \"name\": \"Correct Score\",\n \"status\": \"A\",\n \"selections\": [\n {\n \"id\": \"OB_OU3863\",\n \"currentPriceNum\": 14,\n \"currentPriceDen\": 1,\n \"name\": \"Liverpool 2-1\",\n \"status\": \"A\"\n }\n ]\n }\n ]\n }\n ]\n}\n"}}}}},"400":{"description":"Incorrect or Missing Parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorsWrapper"},"examples":{"response":{"value":"{\n \"errors\" : [\n {\n \"code\":\"10070\",\n \"message\":\"Missing Parameter\",\n \"field\":\"apiKey\"\n }\n ]\n}\n"}}}}},"404":{"description":"No data found for request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorsWrapper"},"examples":{"response":{"value":"{\n \"errors\" : [\n {\n \"code\":\"10003\",\n \"message\":\"Resource Not Found\"\n }\n ]\n}\n"}}}}}},"summary":"Retrieves a single event by ID.","tags":["sportsdata"],"x-canReturnErrors":[0]}},"/events/{eventId}/competitors":{"get":{"description":"Retrieves competitors for a single event by ID.","operationId":"getEventCompetitors","parameters":[{"$ref":"#/components/parameters/param_apiKey"},{"$ref":"#/components/parameters/param_eventId"},{"$ref":"#/components/parameters/param_fields"},{"$ref":"#/components/parameters/param_include"},{"$ref":"#/components/parameters/param_exclude"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eventCompetitorsWrapper"},"examples":{"response":{"value":"{\n \"competitors\": \n [\n {\n \"id\": \"1\",\n \"name\": \"Springer Dinger\",\n \"age\": \"3\",\n \"drawNumber\": \"4\",\n \"jockeyName\": \"Atzeni, A\",\n \"weightPounds\": \"134\",\n \"silkImageUrl\": \"http://whdn.williamhill.com/content/sportsbook/silks/55336.gif\",\n \"trainerName\": \"Varian, R\",\n \"ownerName\": \"Sheikh Mohammed Obaid Al Maktoum\"\n \"colour\": \"grey\",\n \"sex\": \"Male\",\n \"formGuide\": \"4-2711\",\n \"rating\": \"27\",\n \"overview\":\n {\n \"runner\":\"Good pedigree; took him five times to click but won his Lingfield novice nicely in the end and duly confirmed himself progressive by following up at Newmarket, again over 7f (good ground); pace was true there so form looks okay and rates a danger to all off 6lb higher.\"\n \"sire\":\"top-class 2yo over 6-7f inc Phoenix S. Lagardere; sire of Group winners; good record with fillies\",\n }\n ]\n}\n"}}}}},"400":{"description":"Incorrect or Missing Parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorsWrapper"},"examples":{"response":{"value":"{\n \"errors\" : [\n {\n \"code\":\"10070\",\n \"message\":\"Missing Parameter\",\n \"field\":\"apiKey\"\n }\n ]\n}\n"}}}}},"404":{"description":"No data found for request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorsWrapper"},"examples":{"response":{"value":"{\n \"errors\" : [\n {\n \"code\":\"10003\",\n \"message\":\"Resource Not Found\"\n }\n ]\n}\n"}}}}}},"summary":"Retrieves competitors for a single event by ID.","tags":["competitors"],"x-canReturnErrors":[0]}},"/events/{eventId}/markets/":{"get":{"description":"Retrieves one or more specific markets. Markets with Live at the end are always In-Play markets. However, not ALL In-Play markets have Live at the end of the market name.","operationId":"getMarkets","parameters":[{"$ref":"#/components/parameters/param_apiKey"},{"$ref":"#/components/parameters/param_eventId"},{"$ref":"#/components/parameters/param_ids"},{"$ref":"#/components/parameters/param_includeAllDescendants"},{"$ref":"#/components/parameters/param_fields"},{"$ref":"#/components/parameters/param_include"},{"$ref":"#/components/parameters/param_exclude"},{"$ref":"#/components/parameters/param_includeEmpty"},{"$ref":"#/components/parameters/param_culture"},{"$ref":"#/components/parameters/param_marketPublished"},{"$ref":"#/components/parameters/param_marketStatus"},{"$ref":"#/components/parameters/param_marketDisplayed"},{"$ref":"#/components/parameters/param_marketChannel"},{"$ref":"#/components/parameters/param_marketSort"},{"$ref":"#/components/parameters/param_marketEW"},{"$ref":"#/components/parameters/param_selectionStatus"},{"$ref":"#/components/parameters/param_selectionChannel"},{"$ref":"#/components/parameters/param_selectionPublished"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/marketsWrapper"},"examples":{"response":{"value":"{\n \"markets\": [\n {\n \"id\": \"OB_MA2493\",\n \"name\": \"90 Minutes\",\n \"status\": \"A\"\n },\n {\n \"id\": \"OB_MA2559\",\n \"name\": \"Correct Score\",\n \"status\": \"A\"\n }\n ]\n}\n"}}}}},"400":{"description":"Incorrect or Missing Parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorsWrapper"},"examples":{"response":{"value":"{\n \"errors\" : [\n {\n \"code\":\"10070\",\n \"message\":\"Missing Parameter\",\n \"field\":\"apiKey\"\n }\n ]\n}\n"}}}}},"404":{"description":"No data found for request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorsWrapper"},"examples":{"response":{"value":"{\n \"errors\" : [\n {\n \"code\":\"10003\",\n \"message\":\"Resource Not Found\"\n }\n ]\n}\n"}}}}}},"summary":"Gets one or more specific markets","tags":["sportsdata"],"x-canReturnErrors":[0]}},"/events/{eventId}/markets/{marketId}/selections/":{"get":{"description":"Retrieves one or more selections for a market","operationId":"getSelections","parameters":[{"$ref":"#/components/parameters/param_apiKey"},{"$ref":"#/components/parameters/param_eventId"},{"$ref":"#/components/parameters/param_marketId"},{"$ref":"#/components/parameters/param_ids"},{"$ref":"#/components/parameters/param_fields"},{"$ref":"#/components/parameters/param_include"},{"$ref":"#/components/parameters/param_exclude"},{"$ref":"#/components/parameters/param_culture"},{"$ref":"#/components/parameters/param_selectionStatus"},{"$ref":"#/components/parameters/param_selectionChannel"},{"$ref":"#/components/parameters/param_selectionPublished"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/selectionsWrapper"},"examples":{"response":{"value":"{\n \"selections\": [\n {\n \"id\": \"OB_OU3863\",\n \"currentPriceNum\": 14,\n \"currentPriceDen\": 1,\n \"name\": \"Liverpool 2-1\",\n \"status\": \"A\"\n },\n {\n \"id\": \"OB_OU3846\",\n \"currentPriceNum\": 11,\n \"currentPriceDen\": 2,\n \"name\": \"Forest Green 1-0\",\n \"status\": \"A\"\n }\n}\n"}}}}},"400":{"description":"Incorrect or Missing Parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorsWrapper"},"examples":{"response":{"value":"{\n \"errors\" : [\n {\n \"code\":\"10070\",\n \"message\":\"Missing Parameter\",\n \"field\":\"apiKey\"\n }\n ]\n}\n"}}}}},"404":{"description":"No data found for request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorsWrapper"},"examples":{"response":{"value":"{\n \"errors\" : [\n {\n \"code\":\"10003\",\n \"message\":\"Resource Not Found\"\n }\n ]\n}\n"}}}}}},"summary":"Gets one or more selections for a market","tags":["sportsdata"],"x-canReturnErrors":[0]}},"/sports/":{"get":{"description":"Gets a list of all sports","operationId":"getSports","parameters":[{"$ref":"#/components/parameters/param_apiKey"},{"$ref":"#/components/parameters/param_sort"},{"$ref":"#/components/parameters/param_offset"},{"$ref":"#/components/parameters/param_active"},{"$ref":"#/components/parameters/param_limit"},{"$ref":"#/components/parameters/param_fields"},{"$ref":"#/components/parameters/param_include"},{"$ref":"#/components/parameters/param_exclude"},{"$ref":"#/components/parameters/param_culture"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sportsWrapper"},"examples":{"response":{"value":"{\n \"sports\": [\n {\n \"id\": \"OB_SP43\",\n \"name\": \"Horse Racing\"\n },\n {\n \"id\": \"OB_SP9\",\n \"name\": \"Football\"\n }\n ]\n}\n"}}}}},"400":{"description":"Incorrect or Missing Parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorsWrapper"},"examples":{"response":{"value":"{\n \"errors\" : [\n {\n \"code\":\"000000\",\n \"message\":\"Error Message Text\",\n \"field\":\"aparam\"\n }\n ]\n}\n"}}}}},"404":{"description":"No data found for request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorsWrapper"},"examples":{"response":{"value":"{\n \"errors\" : [\n {\n \"code\":\"10003\",\n \"message\":\"Resource Not Found\"\n }\n ]\n}\n"}}}}}},"summary":"Gets a list of all sports","tags":["sportsdata"],"x-canReturnErrors":[0]}},"/sports/{sportId}/classes/":{"get":{"description":"Retrieves a list of classes for a given sport id.","operationId":"getClassesForSport","parameters":[{"$ref":"#/components/parameters/param_apiKey"},{"$ref":"#/components/parameters/param_sportId"},{"$ref":"#/components/parameters/param_active"},{"$ref":"#/components/parameters/param_fields"},{"$ref":"#/components/parameters/param_include"},{"$ref":"#/components/parameters/param_exclude"},{"$ref":"#/components/parameters/param_displayed"},{"$ref":"#/components/parameters/param_channel"},{"$ref":"#/components/parameters/param_status"},{"$ref":"#/components/parameters/param_sort"},{"$ref":"#/components/parameters/param_offset"},{"$ref":"#/components/parameters/param_limit"},{"$ref":"#/components/parameters/param_culture"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classesWrapper"},"examples":{"response":{"value":"{\n \"classes\": [\n {\n \"id\": \"OB_CL1\",\n \"name\": \"UK Football\",\n \"status\": \"A\"\n }\n ]\n}\n"}}}}},"400":{"description":"Incorrect or Missing Parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorsWrapper"},"examples":{"response":{"value":"{\n \"errors\" : [\n {\n \"code\":\"10070\",\n \"message\":\"Missing Parameter\",\n \"field\":\"apiKey\"\n }\n ]\n}\n"}}}}},"404":{"description":"No data found for request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorsWrapper"},"examples":{"response":{"value":"{\n \"errors\" : [\n {\n \"code\":\"10003\",\n \"message\":\"Resource Not Found\"\n }\n ]\n}\n"}}}}}},"summary":"Retrieves a list of classes for a given sport id.","tags":["sportsdata"],"x-canReturnErrors":[0]}},"/sports/{sportId}/competitions/":{"get":{"description":"Retrieves a list of competitions for a given sport id.","operationId":"getCompetitionsForSport","parameters":[{"$ref":"#/components/parameters/param_apiKey"},{"$ref":"#/components/parameters/param_sportId"},{"$ref":"#/components/parameters/param_active"},{"$ref":"#/components/parameters/param_fields"},{"$ref":"#/components/parameters/param_include"},{"$ref":"#/components/parameters/param_exclude"},{"$ref":"#/components/parameters/param_displayed"},{"$ref":"#/components/parameters/param_channel"},{"$ref":"#/components/parameters/param_status"},{"$ref":"#/components/parameters/param_sort"},{"$ref":"#/components/parameters/param_offset"},{"$ref":"#/components/parameters/param_limit"},{"$ref":"#/components/parameters/param_culture"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/competitionsWrapper"},"examples":{"response":{"value":"{\n \"competitions\": [\n {\n \"id\": \"OB_TY1733\",\n \"name\": \"Manchester Senior Cup\",\n \"status\": \"A\"\n }\n ]\n}\n"}}}}},"400":{"description":"Incorrect or Missing Parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorsWrapper"},"examples":{"response":{"value":"{\n \"errors\" : [\n {\n \"code\":\"10070\",\n \"message\":\"Missing Parameter\",\n \"field\":\"apiKey\"\n }\n ]\n}\n"}}}}},"404":{"description":"No data found for request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorsWrapper"},"examples":{"response":{"value":"{\n \"errors\" : [\n {\n \"code\":\"10003\",\n \"message\":\"Resource Not Found\"\n }\n ]\n}\n"}}}}}},"summary":"Retrieves a list of competitions for a given sport id.","tags":["sportsdata"],"x-canReturnErrors":[0]}},"/topbets/":{"get":{"description":"Retrieves a weighted list of Selections.","operationId":"getTopBets","parameters":[{"$ref":"#/components/parameters/param_apiKey"},{"$ref":"#/components/parameters/param_sportIds"},{"$ref":"#/components/parameters/param_competitionIds"},{"$ref":"#/components/parameters/param_limit"},{"$ref":"#/components/parameters/param_fields"},{"$ref":"#/components/parameters/param_include"},{"$ref":"#/components/parameters/param_exclude"},{"$ref":"#/components/parameters/param_topBetEventId"},{"$ref":"#/components/parameters/param_sortName"},{"$ref":"#/components/parameters/param_culture"},{"$ref":"#/components/parameters/param_locale"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/topBetsWrapper"},"examples":{"response":{"value":"{\n bets:\n {\n weight: \"\",\n sports:\n {\n isPublished:true,\n id: \"\",\n name: \"\"\n },\n competitions:\n {\n isPublished: true,\n parentIds: [\"\",\"\"],\n betInRunningDelay:9\n description:\"The description of the competition\"\n cashinAvailable:true,\n channels:[\"\",\"\"],\n displayed:true,\n flags:[\"\",\"\"],\n id:\"\",\n name:\"\",\n order: 1,\n status:\"A\"\n },\n events:\n {\n isPublished: true,\n parentIds:[\"\",\"\"],\n bettingStatus:\"\",\n betInRunningDelay:5,\n description:\"The description of the event\",\n cashinAvailable: true,\n channels:[\"\",\"\"],\n country: \"\",\n displayed: true, \n flags: [\"\",\"\"], \n hasInPlayMarkets:true,\n hasLivePrices:true,\n id: \"\",\n isInPlay:true,\n marketCountActiveInPlay:2, \n marketCountActivePreMatch: 3,\n marketCountActiveTotal:9,\n marketCountInPlay:6,\n marketCountPreMatch:2,\n name:\"6:10 Windsor\",\n order:4, \n raceNum:\"\", \n settled: true,\n eventSort:\"\",\n startDateTime:\"\",\n status:\"A\",\n markets:\n [ \n {\n isPublished:true,\n parentIds:[\"\",\"\"],\n antepostMarket:true,\n betInRunningDelay:4,\n description:\"Additional market information\",\n channels:\"\",\n displayed:true,\n eachWay: true,\n eachWayFactorDen:5, \n eachWayFactorNum:1,\n eachWayPlaces:3,\n earlyPriceAvailable:true,\n firstFourAvailable:true,\n firstPriceAvailable:true,\n flags:\"\",\n bestOddsGuaranteed:true,\n isInPlayMarket: true,\n hcapMakeup:5,\n hcapValue: 5,\n id:\"OB_MA1\",\n livePriceAvailable:true,\n marketGroupCollectionId:\"\",\n marketGroupId:\"\",\n marketGroupName:\"\",\n name:\"\",\n order:\"5\",\n quinellaAvailable:true,\n settled:true,\n marketSort:\"\",\n startingPriceAvailable:true,\n status:\"A\",\n selections:\n [\n {\n parentIds:[\"\",\"\"],\n isPublished:true,\n description:\"\",\n cashinPriceNum:5,\n cashinPriceDen:4,\n channels:[\"\",\"\"],\n csAway:5,\n csHome:5,\n currentPriceNum:5,\n currentPriceDen:5,\n displayed:true,\n resultType:\"\",\n id:\"\",\n name:\"\",\n order:5,\n result:\"\",\n runnerNum:5,\n settled:true,\n status:\"A\",\n oddsDecimal:1.1,\n resultType:\"\",\n priceFormatted:\n {\n fractional:\"EVS\",\n decimal:2,\n american:\"+100\"\n } \n }\n ]\n }\n ],\n markets:\n {\n isPublished:true,\n parentIds:[\"\",\"\"],\n antepostMarket:true,\n betInRunningDelay:4,\n description:\"Additional market information\",\n channels:\"\",\n displayed:true,\n eachWay: true,\n eachWayFactorDen:5, \n eachWayFactorNum:1,\n eachWayPlaces:3,\n earlyPriceAvailable:true,\n firstFourAvailable:true,\n firstPriceAvailable:true,\n flags:\"\",\n bestOddsGuaranteed:true,\n isInPlayMarket: true,\n hcapMakeup:5,\n hcapValue: 5,\n id:\"OB_MA1\",\n livePriceAvailable:true,\n marketGroupCollectionId:\"\",\n marketGroupId:\"\",\n marketGroupName:\"\",\n name:\"\",\n order:\"5\",\n quinellaAvailable:true,\n settled:true,\n marketSort:\"\",\n startingPriceAvailable:true,\n status:\"A\",\n selections:\n [\n {\n parentIds:[\"\",\"\"],\n isPublished:true,\n description:\"\",\n cashinPriceNum:5,\n cashinPriceDen:4,\n channels:[\"\",\"\"],\n csAway:5,\n csHome:5,\n currentPriceNum:5,\n currentPriceDen:5,\n displayed:true,\n resultType:\"\",\n id:\"\",\n name:\"\",\n order:5,\n result:\"\",\n runnerNum:5,\n settled:true,\n status:\"A\",\n oddsDecimal:1.1,\n priceFormatted:\n {\n fractional:\"EVS\",\n decimal:2,\n american:\"+100\"\n } \n }\n ]\n },\n selections:\n {\n parentIds:[\"\",\"\"],\n isPublished:true,\n description:\"\",\n cashinPriceNum:5,\n cashinPriceDen:4,\n channels:[\"\",\"\"],\n csAway:5,\n csHome:5,\n currentPriceNum:5,\n currentPriceDen:5,\n displayed:true,\n resultType:\"\",\n id:\"\",\n name:\"\",\n order:5,\n result:\"\",\n runnerNum:5,\n settled:true,\n status:\"A\",\n oddsDecimal:1.1,\n resultType:\"\",\n priceFormatted:\n {\n fractional:\"EVS\",\n decimal:2,\n american:\"+100\"\n } \n }\n }\n}\n"}}}}},"500":{"description":"Server Error: Something went wrong","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorsWrapper"},"examples":{"response":{"value":"{\n \"errors\" : \n [\n {\n \"code\":\"10000\",\n \"message\":\"Server Error\", \n }\n ]\n}\n"}}}}}},"summary":"Retrieves a weighted list of Selections.","tags":["sportsdata"],"x-canReturnErrors":[0]}}},"x-customerrors":[{"code":20101,"message":"Cannot have includeAllDescendants active without the headlineSummary parameter. Too much data to be returned.","status":400},{"code":20102,"message":"headlineSummary parameter must be accompanied with 'date' filter or one of 'dateFrom' and 'dateTo' filters.","status":400}],"x-docchapters":["fieldSelection","apiSummary","headAndOptions","docsAndSdks","errorHandling","statusCodes"],"servers":[{"url":"https://sandbox.whapi.com/v2/sportsdata"}],"components":{"parameters":{"param_active":{"description":"Specify whether only active entities should be returned, according to the William Hill definition of active","in":"query","name":"isPublished","required":false,"x-eg":"yes","schema":{"type":"string","pattern":"(yes|no|all|YES|NO|ALL)","default":"yes"}},"param_apiKey":{"description":"Your API Key available from your developer portal","in":"header","name":"apiKey","required":true,"x-eg":"l7xxa54460c573b5497c9b24b505xxxxxxxx","schema":{"type":"string","pattern":"^[a-zA-Z0-9]{19,50}$"}},"param_channel":{"description":"Specify a channel filter and only results from that channel will be returned","in":"query","name":"channel","required":false,"x-eg":"I","schema":{"type":"string","pattern":"^[A-Z]{1}$"}},"param_classId":{"description":"The class id to retrieve information for.","in":"path","name":"classId","required":true,"x-eg":"OB_CL1","schema":{"type":"string","pattern":"^(OB_CL\\d{1,7})$"}},"param_competitionId":{"description":"The competition id to retrieve information for.","in":"path","name":"competitionId","required":true,"x-eg":"OB_TY1","schema":{"type":"string","pattern":"^(OB_TY\\d{1,7})$"}},"param_competitionIds":{"description":"A comma-separated list of competitionIds for which to retrieve topBets for","in":"query","name":"competitionIds","required":false,"x-eg":"OB_TY1, OB_TY2","style":"form","explode":false,"schema":{"type":"array","items":{"pattern":"^(OB_TY\\d+)$","type":"string"},"minItems":1,"maxItems":10}},"param_culture":{"description":"Code used to return responses in language other than English, acceptable values are en-GB|de-DE|es-ES|fr-FR|nn-NO|fi-FI|ru-RU|pt-PT|hu-HU|sl-SL|ga-IE|en-CA|sr-Latn|sv-SE|el=GR|zh-CHS|it-IT|zh-CHT|cs-CZ|de-AT|ja-JP|pl-PL|da-DK|ro-RO|nl-NL|tr-TR","in":"query","name":"culture","required":false,"x-eg":"de-DE","schema":{"type":"string"}},"param_date":{"description":"Return only events for the specified date (yyyy-MM-dd).","in":"query","name":"date","required":false,"x-eg":"2025-04-15T13:50:42.917Z","schema":{"type":"string","pattern":"^(\\\\d{4})-(\\\\d{2})-(\\\\d{2})$"}},"param_dateFrom":{"description":"The UTC datetime from the events to be returned. (yyyy-MM-ddTHH:mm:ss)","in":"query","name":"dateFrom","required":false,"x-eg":"2025-04-15T13:50:42.917Z","schema":{"type":"string","pattern":"^(\\\\d{4})-(\\\\d{2})-(\\\\d{2})T(\\\\d{2}):(\\\\d{2}):(\\\\d{2})$"}},"param_dateTo":{"description":"The UTC datetime TO the events to be returned. (yyyy-MM-ddTHH:mm:ss)","in":"query","name":"dateTo","required":false,"x-eg":"2025-04-15T13:50:42.917Z","schema":{"type":"string","pattern":"^(\\\\d{4})-(\\\\d{2})-(\\\\d{2})T(\\\\d{2}):(\\\\d{2}):(\\\\d{2})$"}},"param_displayed":{"description":"Specify whether to return displayed entities or not","in":"query","name":"displayed","required":false,"x-eg":"yes","schema":{"type":"string","pattern":"(yes|no|all|YES|NO|ALL)","default":"yes"}},"param_eventId":{"description":"The event ID to retrieve information for.","in":"path","name":"eventId","required":true,"x-eg":"OB_EV1","schema":{"type":"string","pattern":"^(OB_EV\\d{1,7})$"}},"param_eventSort":{"description":"Filter event by event sort","in":"query","name":"eventSort","required":false,"x-eg":"MTCH","schema":{"type":"string"}},"param_exclude":{"description":"Specify fields from the default to exclude (Comma-Separated List)","in":"query","name":"exclude","required":false,"x-eg":"order","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},"param_fields":{"description":"Specify an absolute field list to return (Comma-Separated List)","in":"query","name":"fields","required":false,"x-eg":"id,name,status","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},"param_headlinesummary":{"description":"Return only headline markets (Markets with the lowest display order) Either 1 InPlay and 1 Pre-Match, or the amount specified in marketCount, if available. Markets and Outcomes will be returned.","in":"query","name":"headlineSummary","required":false,"x-eg":"true","schema":{"type":"boolean","default":false}},"param_ids":{"description":"A comma-separated list of selectionIds","in":"query","name":"ids","required":false,"x-eg":"OB_OU1,OB_OU2","style":"form","explode":false,"schema":{"type":"array","items":{"pattern":"^(OB_OU\\d{1,7})$","type":"string"},"minItems":1,"maxItems":200}},"param_include":{"description":"Specify fields in addition to the default to return (Comma-Separated List)","in":"query","name":"include","required":false,"x-eg":"channels","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},"param_includeAllDescendants":{"description":"Include every descendant in the below heirarchy","in":"query","name":"includeAllDescendants","required":false,"x-eg":"true","schema":{"type":"boolean","default":false}},"param_includeEmpty":{"description":"When declared as false it should exclude markets and events that have no selections / markets","in":"query","name":"includeEmpty","required":false,"x-eg":"true","schema":{"type":"boolean","default":true}},"param_isInPlay":{"description":"Show only events that are in-play","in":"query","name":"isInPlay","required":false,"x-eg":"true","schema":{"type":"boolean"}},"param_limit":{"description":"Specify the number of results to return","in":"query","name":"limit","required":false,"x-eg":"20","schema":{"type":"integer","default":100}},"param_locale":{"description":"Code used to select a set of top bets settings, default is \"whapi\" which allows events set in far future to be included, setting the value to \"en-GB\" will activate english sportsbook settings, mirroring top bets on the website, which restricts events returned to those taking place in next 36 hours. Acceptable values (not all heve their own settings - if none currently available for that locale - en-GB will be used) are de-DE|whapi|en-GB|es-ES|fr-FR|nn-NO|fi-FI|ru-RU|pt-PT|hu-HU|sl-SL|ga-IE|en-CA|sr-Latn|sv-SE|el=GR|zh-CHS|it-IT|zh-CHT|cs-CZ|de-AT|ja-JP|pl-PL|da-DK|ro-RO|nl-NL|tr-TR","in":"query","name":"Locale","required":false,"x-eg":"de-DE","schema":{"type":"string"}},"param_marketChannel":{"description":"Specify a channel filter and only results from that channel will be returned","in":"query","name":"marketChannel","required":false,"x-eg":"I","schema":{"type":"string","pattern":"^[A-Z]{1}$"}},"param_marketCount":{"description":"Specify the number of markets to return when requesting headlineSummary. This count of InPlay and Pre-Match markets will be returned.For example, when specifying 1, 1 In Play and 1 Pre Match market will be returned.","in":"query","name":"marketCount","required":false,"x-eg":"10","schema":{"type":"integer","minimum":1,"maximum":3,"default":1}},"param_marketDisplayed":{"description":"Specify whether to return displayed entities or not","in":"query","name":"marketDisplayed","required":false,"x-eg":"yes","schema":{"type":"string","pattern":"(yes|no|all|YES|NO|ALL)","default":"yes"}},"param_marketEW":{"description":"Specify whether to return markets with each way betting or those without","in":"query","name":"marketEW","required":false,"x-eg":"yes","schema":{"type":"string","pattern":"(yes|no|Yes|No)"}},"param_marketGroupId":{"description":"Filter by marketGroupId (e.g. OB_MG1276585).","in":"query","name":"marketGroupId","required":false,"x-eg":"OB_MG123","schema":{"type":"string"}},"param_marketGroupId2":{"description":"Filter by marketGroupId (e.g. OB_MG1276585).","in":"query","name":"marketGroupId","required":true,"x-eg":"OB_MG123","schema":{"type":"string"}},"param_marketId":{"description":"The market id to retrieve information for","in":"path","name":"marketId","required":true,"x-eg":"OB_MA1","schema":{"type":"string","pattern":"^(OB_MA\\d{1,7})$"}},"param_marketIds":{"description":"Comma-seaerated list of market IDs to filter by","in":"query","name":"marketIds","required":false,"x-eg":"OB_MA1, OB_MA2","style":"form","explode":false,"schema":{"type":"array","items":{"pattern":"^(OB_MA\\d{1,7})$","type":"string"}}},"param_marketPublished":{"description":"Specify whether only active entities should be returned, according to the William Hill definition of active","in":"query","name":"marketPublished","required":false,"x-eg":"yes","schema":{"type":"string","pattern":"(yes|no|all|YES|NO|ALL)","default":"yes"}},"param_marketSort":{"description":"Filter by market sort (e.g. MR (match result) -- (Outright)).","in":"query","name":"marketSort","required":false,"x-eg":"MR","schema":{"type":"string"}},"param_marketSort2":{"description":"Filter by market sort (e.g. MR (match result) -- (Outright)).","in":"query","name":"marketSort","required":true,"x-eg":"MR","schema":{"type":"string"}},"param_marketStatus":{"description":"Specify a status to filter results by. This is currently A (active) or S (suspended)","in":"query","name":"marketStatus","required":false,"x-eg":"A","schema":{"type":"string","pattern":"(A|S)"}},"param_offset":{"description":"Skip over a number of elements by specifying a start value for the query","in":"query","name":"offset","required":false,"x-eg":"10","schema":{"type":"integer","default":0}},"param_selectionChannel":{"description":"Specify a channel filter and only results from that channel will be returned","in":"query","name":"selectionChannel","required":false,"x-eg":"I","schema":{"type":"string","pattern":"^[A-Z]{1}$"}},"param_selectionPublished":{"description":"Specify whether only active entities should be returned, according to the William Hill definition of active","in":"query","name":"selectionPublished","required":false,"x-eg":"yes","schema":{"type":"string","pattern":"(yes|no|all)","default":"yes"}},"param_selectionStatus":{"description":"Specify a status to filter results by. This is currently A (active) or S (suspended)","in":"query","name":"selectionStatus","required":false,"x-eg":"A","schema":{"type":"string","pattern":"(A|S)"}},"param_settled":{"description":"Specify wether only settled entities should be returned","in":"query","name":"settled","required":false,"x-eg":"true","schema":{"type":"boolean"}},"param_sort":{"description":"The field to order the response by, followed by the order. For example: name,desc","in":"query","name":"sort","required":false,"x-eg":"name,desc","schema":{"type":"string","default":"id,asc"}},"param_sortName":{"description":"The market sort code used to further filter event results. Please note this can only be used with event id(s).","in":"query","name":"sortName","required":false,"x-eg":"MR","schema":{"type":"string"}},"param_sportId":{"description":"The sport id to retrieve information for.","in":"path","name":"sportId","required":true,"x-eg":"OB_SP9","schema":{"type":"string","pattern":"^(OB_SP\\d{1,7})$"}},"param_sportIds":{"description":"A comma-separated list of sportsIds for which to retrieve topBets for","in":"query","name":"sportIds","required":false,"x-eg":"OB_SP1, OB_SP2","style":"form","explode":false,"schema":{"type":"array","items":{"pattern":"^(OB_SP\\d+)(,OB_SP\\d+)*$","type":"string"},"minItems":1,"maxItems":10}},"param_status":{"description":"Specify a status to filter results by. This is currently A (active) or S (suspended)","in":"query","name":"status","required":false,"x-eg":"A","schema":{"type":"string","pattern":"(A|S)"}},"param_topBetEventId":{"description":"The event ID to retrieve top bet information for. Multiple events up to 5 may be used","in":"query","name":"param_topBetEventId","required":false,"x-eg":"OB_EV1, OB_EV1,OB_EV2","schema":{"type":"string","pattern":"^(OB_EV\\d{1,7})$"}}},"schemas":{"class":{"properties":{"id":{"description":"The Id of the Class","type":"string"},"isPublished":{"description":"Indicates if the item is published","type":"boolean"},"name":{"description":"The description of the Class","type":"string"},"status":{"description":"Indicates if the class is (A)ctive or (S)uspended","type":"string"}},"required":["id","name"]},"classesWrapper":{"properties":{"classes":{"items":{"$ref":"#/components/schemas/class"},"type":"array"}},"type":"object"},"competition":{"properties":{"betInRunningDelay":{"description":"Delay in seconds between bet being sent and bet being placed","format":"integer","type":"number"},"cashinAvailable":{"description":"Indicates whether cashin is available on the events of this competition","type":"boolean"},"channels":{"description":"A list of channels that apply to this competition","items":{"type":"string"},"type":"array"},"description":{"description":"The description of the competition","type":"string"},"displayed":{"description":"Whether the competition should be displayed or not","type":"boolean"},"flags":{"description":"A list of flags that apply to this competition","items":{"type":"string"},"type":"array"},"id":{"description":"The Id of the Competition","type":"string"},"isPublished":{"description":"Indicates if the item is published or not","type":"boolean"},"name":{"description":"The name of the competition","type":"string"},"order":{"description":"The display order of the competition","format":"integer","type":"integer"},"parentIds":{"description":"A list of IDs of parent entities","items":{"type":"string"},"type":"array"},"status":{"description":"The status of the competition (A for Active, S for Suspended)","type":"string"}},"required":["id","name","status"]},"competitionsWrapper":{"properties":{"competitions":{"items":{"$ref":"#/components/schemas/competition"},"type":"array"}},"type":"object"},"competitor":{"properties":{"age":{"description":"The age of the horse","type":"number","x-eg":"3"},"colour":{"description":"The colour of the horse (There are 5 colours. b = Bay. bl = Black. br = Brown. ch = Chestnut. gr = Grey)","type":"string","x-eg":"bl"},"drawNumber":{"description":"The stall number that the horse is allocated and will start from","t