{"openapi":"3.1.0","info":{"title":"Highlightly NBA (BYOK) API","version":"0.1.0","description":"Highlightly NBA (BYOK) lets an AI assistant read your own Highlightly NBA data through the Highlightly NBA API with a key you supply (Highlightly API key). Read-only: 11 tools (list_matches, get_match, list_teams, get_team, get_standings, get_head_to_head, get_last_five_games, list_highlights, list_players, get_player, get_player_statistics). The BYOK key travels with each request, is used for...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-highlightly-nba.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-highlightly-nba/docs"},"termsOfService":"https://connectorbay.com/byok-highlightly-nba/terms"},"servers":[{"url":"https://byok-highlightly-nba.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-highlightly-nba/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_matches":{"post":{"operationId":"list_matches","summary":"List NBA and college basketball matches with teams, league, date and score. Give at least one filter besides timezone, l","description":"List NBA and college basketball matches with teams, league, date and score. Give at least one filter besides timezone, limit and offset, such as a date or a league. Use for \"Which NBA and college basketball matches are on 2026-03-14\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"date":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Date as YYYY-MM-DD, for example 2024-05-20.","title":"Date"},"timezone":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Time zone identifier used for dates and times, for example 'Europe/London' (default Etc/UTC).","title":"Timezone"},"league":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"League to filter by, for example 'NBA'.","title":"League"},"season":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"description":"Season year, for example 2024.","title":"Season"},"home_team_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"description":"Only items whose home team has this id.","title":"Home Team Id"},"away_team_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"description":"Only items whose away team has this id.","title":"Away Team Id"},"home_team_name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only items whose home team has this name, for example 'Nuggets'.","title":"Home Team Name"},"away_team_name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only items whose away team has this name, for example 'Timberwolves'.","title":"Away Team Name"},"home_team_abbreviation":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only items whose home team has this abbreviation, for example 'DEN'.","title":"Home Team Abbreviation"},"away_team_abbreviation":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only items whose away team has this abbreviation, for example 'MIN'.","title":"Away Team Abbreviation"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"How many results to return (default 100, at most 100; your plan may cap it lower).","title":"Limit"},"offset":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many results to skip, for paging.","title":"Offset"}},"title":"list_matchesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_match":{"post":{"operationId":"get_match","summary":"Get one NBA and college basketball match with teams, league, state and score plus events or statistics where the provide","description":"Get one NBA and college basketball match with teams, league, state and score plus events or statistics where the provider has them. Use for \"What is the score and what happened in a NBA and college basketball match with id 12345\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"id":{"description":"Match id (from list_matches).","title":"Id","type":"integer"}},"required":["id"],"title":"get_matchArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_teams":{"post":{"operationId":"list_teams","summary":"List NBA and college basketball teams with ids, names and abbreviations, optionally filtered by name or abbreviation. Us","description":"List NBA and college basketball teams with ids, names and abbreviations, optionally filtered by name or abbreviation. Use for \"Find the NBA and college basketball team called Lakers\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Name or part of a name to search for, for example 'Nuggets'.","title":"Name"},"display_name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Display name to filter by, for example 'Denver Nuggets'.","title":"Display Name"},"abbreviation":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Abbreviation to filter by, for example 'DEN'.","title":"Abbreviation"},"league":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"League to filter by, for example 'NBA'.","title":"League"}},"title":"list_teamsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_team":{"post":{"operationId":"get_team","summary":"Get one NBA and college basketball team by id. Use for \"Show the NBA and college basketball team with id 1001\".","description":"Get one NBA and college basketball team by id. Use for \"Show the NBA and college basketball team with id 1001\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"id":{"description":"Team id (from list_teams).","title":"Id","type":"integer"}},"required":["id"],"title":"get_teamArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_standings":{"post":{"operationId":"get_standings","summary":"Get NBA and college basketball standings for a season and league type with each team's statistics. Use for \"What are the","description":"Get NBA and college basketball standings for a season and league type with each team's statistics. Use for \"What are the NBA standings for 2025\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"league_type":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"League type to filter by, for example 'NCAA'.","title":"League Type"},"league_name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"League or competition name to filter by, for example 'America East Conference'.","title":"League Name"},"abbreviation":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Abbreviation to filter by, for example 'AEAST'.","title":"Abbreviation"},"year":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"description":"Season year, for example 2024.","title":"Year"},"limit":{"anyOf":[{"maximum":10,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many results to return (default 10, at most 10; your plan may cap it lower).","title":"Limit"},"offset":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many results to skip, for paging.","title":"Offset"}},"title":"get_standingsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_head_to_head":{"post":{"operationId":"get_head_to_head","summary":"List past NBA and college basketball matches between two teams, with scores. Use for \"How have team 1001 and team 1002 d","description":"List past NBA and college basketball matches between two teams, with scores. Use for \"How have team 1001 and team 1002 done against each other in NBA and college basketball\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"team_id_one":{"description":"Id of the first team.","title":"Team Id One","type":"integer"},"team_id_two":{"description":"Id of the second team.","title":"Team Id Two","type":"integer"}},"required":["team_id_one","team_id_two"],"title":"get_head_to_headArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_last_five_games":{"post":{"operationId":"get_last_five_games","summary":"List the last five finished NBA and college basketball matches of a team, with scores. Use for \"How did NBA and college ","description":"List the last five finished NBA and college basketball matches of a team, with scores. Use for \"How did NBA and college basketball team 1001 do in its last five games\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"team_id":{"description":"Team id.","title":"Team Id","type":"integer"}},"required":["team_id"],"title":"get_last_five_gamesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_highlights":{"post":{"operationId":"list_highlights","summary":"List NBA and college basketball video highlights (title, link and embed link) with the match they belong to. Free and ba","description":"List NBA and college basketball video highlights (title, link and embed link) with the match they belong to. Free and basic plans may have restrictions; give at least one filter such as a date or match id. Use for \"Are there NBA and college basketball highlights for matches on 2026-03-14\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"league_name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"League or competition name to filter by, for example 'NCAA'.","title":"League Name"},"date":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Date as YYYY-MM-DD, for example 2024-04-07.","title":"Date"},"timezone":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Time zone identifier used for dates and times, for example 'Europe/London' (default Etc/UTC).","title":"Timezone"},"season":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"description":"Season year, for example 2024.","title":"Season"},"match_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"description":"Only items of this match id.","title":"Match Id"},"home_team_name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only items whose home team has this name, for example 'Huskies'.","title":"Home Team Name"},"away_team_name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only items whose away team has this name, for example 'Crimson Tide'.","title":"Away Team Name"},"limit":{"anyOf":[{"maximum":40,"minimum":1,"type":"integer"},{"type":"null"}],"default":40,"description":"How many results to return (default 40, at most 40; your plan may cap it lower).","title":"Limit"},"offset":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many results to skip, for paging.","title":"Offset"}},"title":"list_highlightsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_players":{"post":{"operationId":"list_players","summary":"List NBA and college basketball players by name with ids. Use for \"Find the NBA and college basketball player named Smit","description":"List NBA and college basketball players by name with ids. Use for \"Find the NBA and college basketball player named Smith\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Name or part of a name to search for, for example 'Dwight Howard'.","title":"Name"},"limit":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1000,"description":"How many results to return (default 1000, at most 1000; your plan may cap it lower).","title":"Limit"},"offset":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many results to skip, for paging.","title":"Offset"}},"title":"list_playersArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_player":{"post":{"operationId":"get_player","summary":"Get a NBA and college basketball player's profile (position, team or club and career summary where available). Use for \"","description":"Get a NBA and college basketball player's profile (position, team or club and career summary where available). Use for \"Show the NBA and college basketball player with id 2001\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"id":{"description":"Player id (from list_players).","title":"Id","type":"integer"}},"required":["id"],"title":"get_playerArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_player_statistics":{"post":{"operationId":"get_player_statistics","summary":"Get a NBA and college basketball player's statistics by season. Use for \"What are the season statistics of NBA and colle","description":"Get a NBA and college basketball player's statistics by season. Use for \"What are the season statistics of NBA and college basketball player 2001\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"id":{"description":"Player id (from list_players).","title":"Id","type":"integer"}},"required":["id"],"title":"get_player_statisticsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}