{"openapi":"3.1.0","info":{"title":"Match Hype API","version":"1.0.0","description":"A read-only content API for developers building custom video experiences. Match Hype API returns videos, thumbnails and content metadata; presentation, playback UX, analytics and betting behavior remain with the integrating application."},"servers":[{"url":"https://api.matchhype.com"}],"tags":[{"name":"Videos"}],"paths":{"/v1/videos":{"get":{"tags":["Videos"],"summary":"List videos in a content catalog","operationId":"listVideos","parameters":[{"$ref":"#/components/parameters/ClientId"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Cursor"},{"$ref":"#/components/parameters/Language"},{"$ref":"#/components/parameters/Sport"},{"$ref":"#/components/parameters/SportId"},{"$ref":"#/components/parameters/CompetitionId"},{"$ref":"#/components/parameters/EventId"},{"$ref":"#/components/parameters/ContentType"},{"$ref":"#/components/parameters/UpdatedAfter"},{"$ref":"#/components/parameters/StartsAfter"},{"$ref":"#/components/parameters/StartsBefore"}],"responses":{"200":{"$ref":"#/components/responses/VideoList"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}}}},"/v1/videos/{videoId}":{"get":{"tags":["Videos"],"summary":"Get one video","operationId":"getVideo","parameters":[{"$ref":"#/components/parameters/VideoId"},{"$ref":"#/components/parameters/ClientId"}],"responses":{"200":{"$ref":"#/components/responses/VideoDetail"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}}}},"/v1/events/{eventId}/videos":{"get":{"tags":["Videos"],"summary":"List videos for an event","operationId":"listEventVideos","parameters":[{"$ref":"#/components/parameters/EventIdPath"},{"$ref":"#/components/parameters/ClientId"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Cursor"},{"$ref":"#/components/parameters/Language"}],"responses":{"200":{"$ref":"#/components/responses/VideoList"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}}}},"/v1/catalogs/{catalogId}/videos":{"get":{"tags":["Videos"],"summary":"List videos using the catalog-style URL","operationId":"listCatalogVideos","parameters":[{"$ref":"#/components/parameters/CatalogId"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Cursor"},{"$ref":"#/components/parameters/Language"},{"$ref":"#/components/parameters/Sport"},{"$ref":"#/components/parameters/SportId"},{"$ref":"#/components/parameters/CompetitionId"},{"$ref":"#/components/parameters/EventId"},{"$ref":"#/components/parameters/ContentType"},{"$ref":"#/components/parameters/UpdatedAfter"},{"$ref":"#/components/parameters/StartsAfter"},{"$ref":"#/components/parameters/StartsBefore"}],"responses":{"200":{"$ref":"#/components/responses/VideoList"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}}}}},"components":{"parameters":{"ClientId":{"name":"clientId","in":"query","required":true,"schema":{"type":"string"},"description":"Public Match Hype content catalog identifier."},"CatalogId":{"name":"catalogId","in":"path","required":true,"schema":{"type":"string"}},"VideoId":{"name":"videoId","in":"path","required":true,"schema":{"type":"string"}},"EventIdPath":{"name":"eventId","in":"path","required":true,"schema":{"type":"string"}},"Limit":{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},"Cursor":{"name":"cursor","in":"query","schema":{"type":"string"},"description":"Opaque cursor returned in paging.nextCursor."},"Language":{"name":"language","in":"query","schema":{"type":"string"},"description":"ISO 639-1 language code."},"Sport":{"name":"sport","in":"query","schema":{"type":"string"}},"SportId":{"name":"sportId","in":"query","schema":{"type":"string"}},"CompetitionId":{"name":"competitionId","in":"query","schema":{"type":"string"}},"EventId":{"name":"eventId","in":"query","schema":{"type":"string"},"description":"Match Hype event id, source id, or configured external event id."},"ContentType":{"name":"contentType","in":"query","schema":{"type":"string"}},"UpdatedAfter":{"name":"updatedAfter","in":"query","schema":{"type":"string","format":"date-time"}},"StartsAfter":{"name":"startsAfter","in":"query","schema":{"type":"string","format":"date-time"}},"StartsBefore":{"name":"startsBefore","in":"query","schema":{"type":"string","format":"date-time"}}},"responses":{"VideoList":{"description":"A page of videos ordered by publishedAt descending.","headers":{"ETag":{"schema":{"type":"string"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VideoListResponse"}}}},"VideoDetail":{"description":"One video.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VideoDetailResponse"}}}},"Error":{"description":"Stable error envelope.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"schemas":{"Thumbnail":{"type":"object","required":["role","url"],"properties":{"role":{"type":"string"},"url":{"type":"string","format":"uri"},"width":{"type":"number"},"height":{"type":"number"},"mediaType":{"type":"string"}}},"Video":{"type":"object","required":["id","version","type","contentType","publishedAt","media","event"],"properties":{"id":{"type":"string"},"version":{"type":"string"},"type":{"const":"video"},"contentType":{"type":["string","null"]},"language":{"type":["string","null"]},"title":{"type":["string","null"]},"description":{"type":["string","null"]},"publishedAt":{"type":"string","format":"date-time"},"media":{"type":"object","required":["mp4Url","thumbnails"],"properties":{"mp4Url":{"type":["string","null"],"format":"uri"},"hlsUrl":{"type":"string","format":"uri"},"durationSeconds":{"type":"number"},"aspectRatio":{"type":"string"},"width":{"type":"number"},"height":{"type":"number"},"thumbnails":{"type":"array","items":{"$ref":"#/components/schemas/Thumbnail"}}}},"event":{"type":"object","required":["id","externalId","startsAt","participants","sport","competition"],"properties":{"id":{"type":"string"},"externalId":{"type":"string"},"startsAt":{"type":["string","null"],"format":"date-time"},"title":{"type":["string","null"]},"participants":{"type":"array","items":{"type":"string"}},"imageUrl":{"type":["string","null"],"format":"uri"},"sport":{"type":"object"},"competition":{"type":"object"}}},"format":{"type":"object"}}},"VideoListResponse":{"type":"object","required":["schemaVersion","data","paging"],"properties":{"schemaVersion":{"const":"1.0"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Video"}},"paging":{"type":"object","required":["limit","nextCursor"],"properties":{"limit":{"type":"integer"},"nextCursor":{"type":["string","null"]}}}}},"VideoDetailResponse":{"type":"object","required":["schemaVersion","data"],"properties":{"schemaVersion":{"const":"1.0"},"data":{"$ref":"#/components/schemas/Video"}}},"ErrorResponse":{"type":"object","required":["error","requestId"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}}},"requestId":{"type":"string"}}}}}}