{ "info": { "_postman_id": "ef13823c-f883-42de-96c3-90d3597c9763", "name": "USL Match & Player Statistics API Documentation", "description": "### USL Match Statistics API Documentation\n\n**Version**: 1.0\n\n**Description**: Match Statistics and Match Events from USL soccer league matches.", "schema": "https://schema.getpostman.com/json/collection/v2.0.0/collection.json", "_exporter_id": "10559322" }, "item": [ { "name": "matches", "item": [ { "name": "{id}", "item": [ { "name": "events", "item": [ { "name": "Get events of a match by ID", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/matches/:id/events", "host": [ "{{baseUrl}}" ], "path": [ "matches", ":id", "events" ], "variable": [ { "key": "id", "value": "" } ] } }, "response": [ { "name": "Returns array of match events from match if id found.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/matches/:id/events", "host": [ "{{baseUrl}}" ], "path": [ "matches", ":id", "events" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Match not found.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/matches/:id/events", "host": [ "{{baseUrl}}" ], "path": [ "matches", ":id", "events" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Get a match by ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/matches/:id", "host": [ "{{baseUrl}}" ], "path": [ "matches", ":id" ], "variable": [ { "key": "id", "value": "" } ] } }, "response": [ { "name": "Returns a match by ID if found.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/matches/:id", "host": [ "{{baseUrl}}" ], "path": [ "matches", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"\",\n \"date\": \"\",\n \"season\": \"\",\n \"homeTeamId\": \"\",\n \"awayTeamId\": \"\",\n \"homeTeamUslId\": \"\",\n \"awayTeamUslId\": \"\",\n \"homeTeamScore\": \"\",\n \"awayTeamScore\": \"\",\n \"score\": \"\",\n \"stats\": []\n}" }, { "name": "Match not found.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/matches/:id", "host": [ "{{baseUrl}}" ], "path": [ "matches", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Get all matches - optionally by season", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/matches?page=1&perPage=10&season=2023", "host": [ "{{baseUrl}}" ], "path": [ "matches" ], "query": [ { "key": "page", "value": "1" }, { "key": "perPage", "value": "10" }, { "key": "season", "value": "2023", "description": "match season to query 2020-2023" } ] } }, "response": [ { "name": "Returns matches - Optionally by a season string", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/matches?season=2021&page=&perPage=", "host": [ "{{baseUrl}}" ], "path": [ "matches" ], "query": [ { "key": "season", "value": "2021" }, { "key": "page", "value": "", "description": "Page number" }, { "key": "perPage", "value": "", "description": "Items per page" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"id\": \"\",\n \"date\": \"\",\n \"season\": \"\",\n \"homeTeamId\": \"\",\n \"awayTeamId\": \"\",\n \"homeTeamUslId\": \"\",\n \"awayTeamUslId\": \"\",\n \"homeTeamScore\": \"\",\n \"awayTeamScore\": \"\",\n \"score\": \"\",\n \"stats\": []\n },\n {\n \"id\": \"\",\n \"date\": \"\",\n \"season\": \"\",\n \"homeTeamId\": \"\",\n \"awayTeamId\": \"\",\n \"homeTeamUslId\": \"\",\n \"awayTeamUslId\": \"\",\n \"homeTeamScore\": \"\",\n \"awayTeamScore\": \"\",\n \"score\": \"\",\n \"stats\": []\n }\n]" } ] } ] }, { "name": "match-events", "item": [ { "name": "{id}", "item": [ { "name": "Get match events by MATCH ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/match-events/:id", "host": [ "{{baseUrl}}" ], "path": [ "match-events", ":id" ], "variable": [ { "key": "id", "value": "" } ] } }, "response": [ { "name": "Returns a match event array by MatchID if found.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/match-events/:id", "host": [ "{{baseUrl}}" ], "path": [ "match-events", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"\",\n \"events\": []\n}" }, { "name": "Match and events not found.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/match-events/:id", "host": [ "{{baseUrl}}" ], "path": [ "match-events", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Get all match events from all matches", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/match-events" }, "response": [ { "name": "Returns an array of matches with match events", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/match-events" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"id\": \"\",\n \"events\": []\n },\n {\n \"id\": \"\",\n \"events\": []\n }\n]" }, { "name": "Missing Bearer Key", "originalRequest": { "method": "GET", "header": [], "url": "{{baseUrl}}/match-events" }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "teams", "item": [ { "name": "{uslTeamId}", "item": [ { "name": "matches", "item": [ { "name": "Get matches by USL team ID", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/:uslTeamId/matches?home/away=18", "host": [ "{{baseUrl}}" ], "path": [ "teams", ":uslTeamId", "matches" ], "query": [ { "key": "home/away", "value": "18" } ], "variable": [ { "key": "uslTeamId", "value": "6" } ] } }, "response": [ { "name": "Returns matches for a team.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/:uslTeamId/matches?home/away=18", "host": [ "{{baseUrl}}" ], "path": [ "teams", ":uslTeamId", "matches" ], "query": [ { "key": "home/away", "value": "18" } ], "variable": [ { "key": "uslTeamId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "match-teams", "item": [ { "name": "Get match teams and lineups by USL team ID", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/:uslTeamId/match-teams", "host": [ "{{baseUrl}}" ], "path": [ "teams", ":uslTeamId", "match-teams" ], "variable": [ { "key": "uslTeamId", "value": "6" } ] } }, "response": [ { "name": "Returns an array of match teams and lineups for a team.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/:uslTeamId/match-teams", "host": [ "{{baseUrl}}" ], "path": [ "teams", ":uslTeamId", "match-teams" ], "variable": [ { "key": "uslTeamId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Get USL Team by ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/:uslTeamId", "host": [ "{{baseUrl}}" ], "path": [ "teams", ":uslTeamId" ], "variable": [ { "key": "uslTeamId", "value": "6" } ] } }, "response": [ { "name": "Returns a USL team by USL team id if found.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/:uslTeamId", "host": [ "{{baseUrl}}" ], "path": [ "teams", ":uslTeamId" ], "variable": [ { "key": "uslTeamId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"conference\": \"\",\n \"active\": \"\"\n}" }, { "name": "USL Team not found.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/:uslTeamId", "host": [ "{{baseUrl}}" ], "path": [ "teams", ":uslTeamId" ], "variable": [ { "key": "uslTeamId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "{uslTeamOneId}", "item": [ { "name": "matches", "item": [ { "name": "{uslTeamTwoId}", "item": [ { "name": "Get matches between two teams", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/:uslTeamOneId/matches/:uslTeamTwoId", "host": [ "{{baseUrl}}" ], "path": [ "teams", ":uslTeamOneId", "matches", ":uslTeamTwoId" ], "variable": [ { "key": "uslTeamOneId", "value": "6" }, { "key": "uslTeamTwoId", "value": "6" } ] } }, "response": [ { "name": "Returns 5 recent matches between two teams.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/:uslTeamOneId/matches/:uslTeamTwoId", "host": [ "{{baseUrl}}" ], "path": [ "teams", ":uslTeamOneId", "matches", ":uslTeamTwoId" ], "variable": [ { "key": "uslTeamOneId" }, { "key": "uslTeamTwoId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] } ] }, { "name": "Get all USL Teams", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/teams" }, "response": [ { "name": "Returns an array of USL Teams and their IDs", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/teams" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"conference\": \"\",\n \"active\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"conference\": \"\",\n \"active\": \"\"\n }\n]" } ] } ] }, { "name": "match-teams", "item": [ { "name": "{id}", "item": [ { "name": "Get Match Team by ID", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/match-teams/:id", "host": [ "{{baseUrl}}" ], "path": [ "match-teams", ":id" ], "variable": [ { "key": "id", "value": "" } ] } }, "response": [ { "name": "Returns a specific match team by id", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/match-teams/:id", "host": [ "{{baseUrl}}" ], "path": [ "match-teams", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Team not found.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/match-teams/:id", "host": [ "{{baseUrl}}" ], "path": [ "match-teams", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Match Team Info", "request": { "method": "GET", "header": [], "url": "{{baseUrl}}/match-teams" }, "response": [ { "name": "Returns an array of Match Teams", "originalRequest": { "method": "GET", "header": [], "url": "{{baseUrl}}/match-teams" }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "stats", "item": [ { "name": "{type}", "item": [ { "name": "Get Stat Leaders by stat - Goal | Assist | Shot | Cross | Pass | ChancesCreated | CleanSheet | Save | Clearance | YellowCard | RedCard", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stats/:type?season=2023", "host": [ "{{baseUrl}}" ], "path": [ "stats", ":type" ], "query": [ { "key": "season", "value": "2023" } ], "variable": [ { "key": "type", "value": "YellowCard" } ] } }, "response": [ { "name": "Returns stat leaders by stat type - Optionally by a season (default 2023)", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stats/:type?season=2023", "host": [ "{{baseUrl}}" ], "path": [ "stats", ":type" ], "query": [ { "key": "season", "value": "2023" } ], "variable": [ { "key": "type" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] }, { "name": "analytics", "item": [ { "name": "{uslTeamOneId}", "item": [ { "name": "matches", "item": [ { "name": "{uslTeamTwoId}", "item": [ { "name": "Analyze the 5 most recent matches of two teams", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/analytics/:uslTeamOneId/matches/:uslTeamTwoId", "host": [ "{{baseUrl}}" ], "path": [ "analytics", ":uslTeamOneId", "matches", ":uslTeamTwoId" ], "variable": [ { "key": "uslTeamOneId", "value": "" }, { "key": "uslTeamTwoId", "value": "" } ] } }, "response": [ { "name": "Returns ", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/analytics/:uslTeamOneId/matches/:uslTeamTwoId", "host": [ "{{baseUrl}}" ], "path": [ "analytics", ":uslTeamOneId", "matches", ":uslTeamTwoId" ], "variable": [ { "key": "uslTeamOneId" }, { "key": "uslTeamTwoId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"teamOne\": {\n \"teamName\": \"\",\n \"pastFiveMatchStats\": {\n \"totalGoalsScored\": \"\",\n \"matchesWithMoreThanOneGoal\": \"\",\n \"cleanSheets\": \"\",\n \"shotsVsTarget\": \"\",\n \"longBallPercentage\": \"\",\n \"averagePassingAccuracy\": \"\",\n \"averageCrossingAccuracy\": \"\",\n \"possessionPlusMinus\": \"\"\n },\n \"matchData\": [\n \"\",\n \"\"\n ]\n },\n \"teamTwo\": {\n \"teamName\": \"\",\n \"pastFiveMatchStats\": {\n \"totalGoalsScored\": \"\",\n \"matchesWithMoreThanOneGoal\": \"\",\n \"cleanSheets\": \"\",\n \"shotsVsTarget\": \"\",\n \"longBallPercentage\": \"\",\n \"averagePassingAccuracy\": \"\",\n \"averageCrossingAccuracy\": \"\",\n \"possessionPlusMinus\": \"\"\n },\n \"matchData\": [\n \"\",\n \"\"\n ]\n }\n}" } ] } ] } ] } ] } ] }, { "name": "health", "item": [ { "name": "Health Controller check Health", "request": { "method": "GET", "header": [], "url": "{{baseUrl}}/health" }, "response": [ { "name": "Untitled Response", "originalRequest": { "method": "GET", "header": [], "url": "{{baseUrl}}/health" }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ], "variable": [ { "key": "baseUrl", "value": "https://usl-unwrapped-277334b8c4d7.herokuapp.com" }, { "key": "baseUrl_dev", "value": "http://localhost:3000", "type": "string" }, { "key": "id", "value": "1", "type": "string" } ] }