{ "openapi": "3.0.4", "info": { "title": "OpenLigaDB-API", "version": "v1" }, "paths": { "/getavailableleagues": { "get": { "tags": [ "Matchdata" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/League" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/League" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/League" } } } } } } } }, "/getavailableleagues/{season}": { "get": { "tags": [ "Matchdata" ], "parameters": [ { "name": "season", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/League" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/League" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/League" } } } } } } } }, "/getavailablesports": { "get": { "tags": [ "Matchdata" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Sport" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Sport" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Sport" } } } } } } } }, "/getmatchdata/{matchId}": { "get": { "tags": [ "Matchdata" ], "parameters": [ { "name": "matchId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Match" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Match" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Match" } } } } } } }, "/getmatchdata/{leagueShortcut}/{leagueSeason}/{groupOrderId}": { "get": { "tags": [ "Matchdata" ], "parameters": [ { "name": "leagueShortcut", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "leagueSeason", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "groupOrderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Match" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Match" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Match" } } } } } } } }, "/getmatchdata/{leagueShortcut}/{leagueSeason}": { "get": { "tags": [ "Matchdata" ], "summary": "Gibt eine Struktur von Spieldaten aller Spiele der übergebenen Liga (leagueShortcut) für die gesamte übergebene Saison (leagueSeason) zurueck.", "parameters": [ { "name": "leagueShortcut", "in": "path", "description": "der Shortcut der Liga, z.B. 'bl1' für die erste Bundesliga", "required": true, "schema": { "type": "string" } }, { "name": "leagueSeason", "in": "path", "description": "die Saison der Liga, z.B. 2019 für die Saison 2019/2020", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Match" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Match" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Match" } } } } } } } }, "/getmatchdata/{leagueShortcut}/{leagueSeason}/{teamFilterstring}": { "get": { "tags": [ "Matchdata" ], "summary": "Gibt eine Struktur von Spieldaten aller Spiele eines Teams der übergebenen Liga (leagueShortcut) für die gesamte übergebene Saison (leagueSeason) für das im \"teamFilterstring\" übergebene Team zurueck. \r\nHier reicht ein Teil des Vereinsnamen aus.", "parameters": [ { "name": "leagueShortcut", "in": "path", "description": "der Shortcut der Liga, z.B. 'bl1' für die erste Bundesliga", "required": true, "schema": { "type": "string" } }, { "name": "leagueSeason", "in": "path", "description": "die Saison der Liga, z.B. 2019 für die Saison 2019/2020", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "teamFilterstring", "in": "path", "description": "Name bzw. Teil des Namens eines Teams", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Match" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Match" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Match" } } } } } } } }, "/getmatchdata/{teamId1}/{teamId2}": { "get": { "tags": [ "Matchdata" ], "summary": "Gibt eine Struktur von Matches zurück, bei welchen die als Parameter übergebenen Teams gegeneinander spielen.", "parameters": [ { "name": "teamId1", "in": "path", "description": "die Id des ersten Teams", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "teamId2", "in": "path", "description": "die Id des anderen Teams", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Match" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Match" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Match" } } } } } } } }, "/getlastchangedate/{leagueShortcut}/{leagueSeason}/{groupOrderId}": { "get": { "tags": [ "Matchdata" ], "summary": "Gibt ein DateTime-Objekt der letzten Änderung der Daten der übergebenen Liga (leagueShortcut) für die übergebene Saison (leagueSeason) für den übergebenen Spieltag (groupOrderId) zurueck.", "parameters": [ { "name": "leagueShortcut", "in": "path", "description": "der Shortcut der Liga, z.B. 'bl1' für die erste Bundesliga", "required": true, "schema": { "type": "string" } }, { "name": "leagueSeason", "in": "path", "description": "die Saison der Liga, z.B. 2019 für die Saison 2019/2020", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "groupOrderId", "in": "path", "description": "beim Fußball der Spieltag, z.B. 1", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string", "format": "date-time" } }, "application/json": { "schema": { "type": "string", "format": "date-time" } }, "text/json": { "schema": { "type": "string", "format": "date-time" } } } } } } }, "/getnextmatchbyleagueteam/{leagueId}/{teamId}": { "get": { "tags": [ "Matchdata" ], "summary": "Gibt das nächste folgende Spiel der übergebenen Liga (leagueId) des übergebenen Teams (teamId) zurueck.", "parameters": [ { "name": "leagueId", "in": "path", "description": "die Id der Liga", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "teamId", "in": "path", "description": "die Id des Teams", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Match" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Match" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Match" } } } } } } }, "/getnextmatchbyleagueshortcut/{leagueShortcut}": { "get": { "tags": [ "Matchdata" ], "summary": "Gibt das nächste folgende Spiel des übergebenen LigaShortcuts zurueck.", "parameters": [ { "name": "leagueShortcut", "in": "path", "description": "Der Liga-Shortcut", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Match" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Match" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Match" } } } } } } }, "/getlastmatchbyleagueshortcut/{leagueShortcut}": { "get": { "tags": [ "Matchdata" ], "summary": "Gibt das letzte Spiel des übergebenen LigaShortcuts zurueck.", "parameters": [ { "name": "leagueShortcut", "in": "path", "description": "Der Liga-Shortcut", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Match" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Match" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Match" } } } } } } }, "/getlastmatchbyleagueteam/{leagueId}/{teamId}": { "get": { "tags": [ "Matchdata" ], "summary": "Gibt das letzte zurückliegende Spiel der übergebenen Liga (leagueId) des übergebenen Teams (teamId) zurueck.", "parameters": [ { "name": "leagueId", "in": "path", "description": "die Id der Liga", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "teamId", "in": "path", "description": "die Id des Teams", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Match" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Match" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Match" } } } } } } }, "/getcurrentgroup/{leagueShortcut}": { "get": { "tags": [ "Matchdata" ], "summary": "Gibt die aktuelle Group (entspricht z.B. bei der Fussball-Bundesliga dem 'Spieltag') des als Parameter zu übergebenden leagueShortcuts (z.B. 'bl1') aus. Der aktuelle Spieltag\r\nwird jeweils zur Hälfte der Zeit zwischen dem letzten Spiel des letzten Spieltages und dem ersten Spiel des nächsten Spieltages erhöht.", "parameters": [ { "name": "leagueShortcut", "in": "path", "description": "der Shortcut der Liga, z.B. 'bl1' für die erste Bundesliga", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Group" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Group" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Group" } } } } } } }, "/getresultinfos/{leagueId}": { "get": { "tags": [ "Matchdata" ], "summary": "Gibt die für diese Liga konfigurierten Ergebnistypen zurück!", "parameters": [ { "name": "leagueId", "in": "path", "description": "Id der Liga, z.B. '4500' für die erste Bundesliga 2021/2022", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ResultInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ResultInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResultInfo" } } } } } } }, "/getavailablegroups/{leagueShortcut}/{leagueSeason}": { "get": { "tags": [ "Matchdata" ], "summary": "Eine Liste der Spiel-Einteilungen (Spieltag, Vorrunde, Finale, ...) der als Parameter zu übergebenden Liga + Saison", "parameters": [ { "name": "leagueShortcut", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "leagueSeason", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Group" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Group" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Group" } } } } } } } }, "/getgoalgetters/{leagueShortcut}/{leagueSeason}": { "get": { "tags": [ "Matchdata" ], "summary": "Eine Liste der Spiel-Einteilungen (Spieltag, Vorrunde, Finale, ...) der als Parameter zu übergebenden Liga + Saison", "parameters": [ { "name": "leagueShortcut", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "leagueSeason", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GoalGetter" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GoalGetter" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GoalGetter" } } } } } } } }, "/getavailableteams/{leagueShortcut}/{leagueSeason}": { "get": { "tags": [ "Matchdata" ], "summary": "Eine Liste der Teams der als Parameter zu übergebenden Liga + Saison", "parameters": [ { "name": "leagueShortcut", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "leagueSeason", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Team" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Team" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Team" } } } } } } } }, "/getbltable/{leagueShortcut}/{leagueSeason}": { "get": { "tags": [ "Matchdata" ], "summary": "returns the table", "parameters": [ { "name": "leagueShortcut", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "leagueSeason", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BlTableTeam" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BlTableTeam" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BlTableTeam" } } } } } } } }, "/getgrouptable/{leagueShortcut}/{leagueSeason}": { "get": { "tags": [ "Matchdata" ], "summary": "returns the table", "parameters": [ { "name": "leagueShortcut", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "leagueSeason", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BlTableTeam" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BlTableTeam" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BlTableTeam" } } } } } } } }, "/getmatchesbyteam/{teamFilterstring}/{weekCountPast}/{weekCountFuture}": { "get": { "tags": [ "Matchdata" ], "parameters": [ { "name": "teamFilterstring", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "weekCountPast", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "weekCountFuture", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Match" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Match" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Match" } } } } } } } }, "/getmatchesbyteamid/{teamId}/{weekCountPast}/{weekCountFuture}": { "get": { "tags": [ "Matchdata" ], "parameters": [ { "name": "teamId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "weekCountPast", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "weekCountFuture", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Match" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Match" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Match" } } } } } } } } }, "components": { "schemas": { "BlTableTeam": { "type": "object", "properties": { "teamInfoId": { "type": "integer", "format": "int32" }, "teamName": { "type": "string", "nullable": true }, "shortName": { "type": "string", "nullable": true }, "teamIconUrl": { "type": "string", "nullable": true }, "points": { "type": "integer", "format": "int32" }, "opponentGoals": { "type": "integer", "format": "int32" }, "goals": { "type": "integer", "format": "int32" }, "matches": { "type": "integer", "format": "int32" }, "won": { "type": "integer", "format": "int32" }, "lost": { "type": "integer", "format": "int32" }, "draw": { "type": "integer", "format": "int32" }, "goalDiff": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "GlobalResultInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Goal": { "type": "object", "properties": { "goalID": { "type": "integer", "format": "int32" }, "scoreTeam1": { "type": "integer", "format": "int32", "nullable": true }, "scoreTeam2": { "type": "integer", "format": "int32", "nullable": true }, "matchMinute": { "type": "integer", "format": "int32", "nullable": true }, "goalGetterID": { "type": "integer", "format": "int32" }, "goalGetterName": { "type": "string", "nullable": true }, "isPenalty": { "type": "boolean", "nullable": true }, "isOwnGoal": { "type": "boolean", "nullable": true }, "isOvertime": { "type": "boolean", "nullable": true }, "comment": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GoalGetter": { "type": "object", "properties": { "goalGetterId": { "type": "integer", "format": "int32" }, "goalGetterName": { "type": "string", "nullable": true }, "goalCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Group": { "type": "object", "properties": { "groupName": { "type": "string", "nullable": true }, "groupOrderID": { "type": "integer", "format": "int32" }, "groupID": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "League": { "type": "object", "properties": { "leagueId": { "type": "integer", "format": "int32" }, "leagueName": { "type": "string", "nullable": true }, "leagueShortcut": { "type": "string", "nullable": true }, "leagueSeason": { "type": "string", "nullable": true }, "sport": { "allOf": [ { "$ref": "#/components/schemas/Sport" } ], "nullable": true } }, "additionalProperties": false }, "Location": { "type": "object", "properties": { "locationID": { "type": "integer", "format": "int32" }, "locationCity": { "type": "string", "nullable": true }, "locationStadium": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Match": { "type": "object", "properties": { "matchID": { "type": "integer", "format": "int32" }, "matchDateTime": { "type": "string", "format": "date-time", "nullable": true }, "timeZoneID": { "type": "string", "nullable": true }, "leagueId": { "type": "integer", "format": "int32" }, "leagueName": { "type": "string", "nullable": true }, "leagueSeason": { "type": "integer", "format": "int32" }, "leagueShortcut": { "type": "string", "nullable": true }, "matchDateTimeUTC": { "type": "string", "format": "date-time", "nullable": true }, "group": { "allOf": [ { "$ref": "#/components/schemas/Group" } ], "nullable": true }, "team1": { "allOf": [ { "$ref": "#/components/schemas/Team" } ], "nullable": true }, "team2": { "allOf": [ { "$ref": "#/components/schemas/Team" } ], "nullable": true }, "lastUpdateDateTime": { "type": "string", "format": "date-time", "nullable": true }, "matchIsFinished": { "type": "boolean" }, "matchResults": { "type": "array", "items": { "$ref": "#/components/schemas/MatchResult" }, "nullable": true }, "goals": { "type": "array", "items": { "$ref": "#/components/schemas/Goal" }, "nullable": true }, "location": { "allOf": [ { "$ref": "#/components/schemas/Location" } ], "nullable": true }, "numberOfViewers": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "MatchResult": { "type": "object", "properties": { "resultID": { "type": "integer", "format": "int32" }, "resultName": { "type": "string", "nullable": true }, "pointsTeam1": { "type": "integer", "format": "int32", "nullable": true }, "pointsTeam2": { "type": "integer", "format": "int32", "nullable": true }, "resultOrderID": { "type": "integer", "format": "int32" }, "resultTypeID": { "type": "integer", "format": "int32" }, "resultDescription": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ResultInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "orderId": { "type": "integer", "format": "int32", "nullable": true }, "globalResultInfo": { "allOf": [ { "$ref": "#/components/schemas/GlobalResultInfo" } ], "nullable": true } }, "additionalProperties": false }, "Sport": { "type": "object", "properties": { "sportId": { "type": "integer", "format": "int32" }, "sportName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Team": { "type": "object", "properties": { "teamId": { "type": "integer", "format": "int32" }, "teamName": { "type": "string", "nullable": true }, "shortName": { "type": "string", "nullable": true }, "teamIconUrl": { "type": "string", "nullable": true }, "teamGroupName": { "type": "string", "nullable": true } }, "additionalProperties": false } } }, "tags": [ { "name": "Matchdata" } ] }