Sportarr

https://sportarr.net/docs
Admin
Sportarr is an automated media management application for all sports that monitors leagues,...
Tokens:10,592
Snippets:62
Trust Score:4.7
Update:5 months ago
Show doc for...
Tokens:
Raw
### Jellyfin Plugin Installation

Source: https://sportarr.net/docs

Steps to install the Sportarr plugin for Jellyfin. This involves downloading the plugin DLL and placing it in the Jellyfin plugins directory.

```bash
/config/plugins/Sportarr/
```

--------------------------------

### Plex Custom Metadata Provider Setup

Source: https://sportarr.net/docs

Instructions for adding Sportarr as a custom metadata provider in Plex Media Server version 1.43.0 and later. This method does not require plugin installation.

```bash
https://sportarr.net/plex
```

--------------------------------

### Emby Open Media Provider Setup

Source: https://sportarr.net/docs

Configuration for Emby to use Sportarr's metadata API via Open Media data sources. This allows Emby to pull sports event information.

```bash
https://sportarr.net
```

--------------------------------

### Leagues Endpoints

Source: https://sportarr.net/docs/api

Endpoints for retrieving information about leagues and competitions, including listing all leagues and getting details for a specific league.

```APIDOC
## GET /api/v1/leagues

### Description
List all leagues.

### Method
GET

### Endpoint
/api/v1/leagues
```

```APIDOC
## GET /api/v1/leagues/{league_id}

### Description
Get league details.

### Method
GET

### Endpoint
/api/v1/leagues/{league_id}
```

```APIDOC
## GET /api/v1/leagues/{league_id}/seasons

### Description
List seasons for a league.

### Method
GET

### Endpoint
/api/v1/leagues/{league_id}/seasons
```

```APIDOC
## GET /api/public/v1/leagues

### Description
List all leagues.

### Method
GET

### Endpoint
/api/public/v1/leagues
```

```APIDOC
## GET /api/public/v1/leagues/{identifier}

### Description
Get league by identifier.

### Method
GET

### Endpoint
/api/public/v1/leagues/{identifier}
```

```APIDOC
## GET /api/public/v1/leagues/{identifier}/seasons

### Description
Get seasons for a league.

### Method
GET

### Endpoint
/api/public/v1/leagues/{identifier}/seasons
```

```APIDOC
## GET /api/public/v1/leagues/{identifier}/teams

### Description
Get teams for a league.

### Method
GET

### Endpoint
/api/public/v1/leagues/{identifier}/teams
```

--------------------------------

### Sports Endpoints

Source: https://sportarr.net/docs/api

Endpoints for retrieving information about sports, including listing all sports and getting details for a specific sport.

```APIDOC
## GET /api/v1/sports

### Description
List all sports.

### Method
GET

### Endpoint
/api/v1/sports
```

```APIDOC
## GET /api/v1/sports/{sport_id}

### Description
Get sport details.

### Method
GET

### Endpoint
/api/v1/sports/{sport_id}
```

```APIDOC
## GET /api/v1/sports/{sport_id}/leagues

### Description
List leagues for a sport.

### Method
GET

### Endpoint
/api/v1/sports/{sport_id}/leagues
```

```APIDOC
## GET /api/public/v1/sports

### Description
List all sports.

### Method
GET

### Endpoint
/api/public/v1/sports
```

```APIDOC
## GET /api/public/v1/sports/{identifier}

### Description
Get sport by identifier.

### Method
GET

### Endpoint
/api/public/v1/sports/{identifier}
```

```APIDOC
## GET /api/public/v1/sports/{identifier}/leagues

### Description
Get leagues for a sport.

### Method
GET

### Endpoint
/api/public/v1/sports/{identifier}/leagues
```

--------------------------------

### Run Sportarr with Docker

Source: https://sportarr.net/docs

Use this command to run Sportarr as a Docker container. Ensure you map the necessary volumes for configuration and sports media, and set the correct environment variables for user/group IDs and timezone.

```bash
docker run -d \
  --name=sportarr \
  -e PUID=99 \
  -e PGID=100 \
  -e UMASK=022 \
  -e TZ=America/New_York \
  -p 1867:1867 \
  -v /path/to/config:/config \
  -v /path/to/sports:/sports \
  --restart unless-stopped \
  sportarr/sportarr:latest
```

--------------------------------

### Docker Download Client Connection

Source: https://sportarr.net/docs

Troubleshooting tip for connecting Sportarr to a download client when running in Docker. It is recommended to use the container name instead of 'localhost'.

```text
qbittorrent
```

--------------------------------

### Deploy Sportarr with Docker Compose

Source: https://sportarr.net/docs

Deploy Sportarr using Docker Compose by defining the service in a docker-compose.yml file. This configuration specifies the image, container name, environment variables, volume mappings, port, and restart policy.

```yaml
version: "3.8"
services:
  sportarr:
    image: sportarr/sportarr:latest
    container_name: sportarr
    environment:
      - PUID=99
      - PGID=100
      - UMASK=022
      - TZ=America/New_York
    volumes:
      - /path/to/config:/config
      - /path/to/sports:/sports
    ports:
      - 1867:1867
    restart: unless-stopped
```

--------------------------------

### Media Projection Endpoints

Source: https://sportarr.net/docs/api

Endpoints for read-only media projections for Plex/Emby/Jellyfin compatibility.

```APIDOC
## GET /api/v1/media/series

### Description
List media series.

### Method
GET

### Endpoint
/api/v1/media/series
```

```APIDOC
## GET /api/v1/media/series/{league_id}

### Description
Get media series.

### Method
GET

### Endpoint
/api/v1/media/series/{league_id}
```

```APIDOC
## GET /api/v1/media/series/{league_id}/nfo

### Description
Get series NFO data.

### Method
GET

### Endpoint
/api/v1/media/series/{league_id}/nfo
```

```APIDOC
## GET /api/v1/media/series/{league_id}/seasons

### Description
List seasons for series.

### Method
GET

### Endpoint
/api/v1/media/series/{league_id}/seasons
```

```APIDOC
## GET /api/v1/media/seasons/{competition_season_id}

### Description
Get media season.

### Method
GET

### Endpoint
/api/v1/media/seasons/{competition_season_id}
```

```APIDOC
## GET /api/v1/media/seasons/{competition_season_id}/episodes

### Description
List episodes for season.

### Method
GET

### Endpoint
/api/v1/media/seasons/{competition_season_id}/episodes
```

```APIDOC
## GET /api/v1/media/events/{event_id}

### Description
Get episode for event.

### Method
GET

### Endpoint
/api/v1/media/events/{event_id}
```

```APIDOC
## GET /api/v1/media/events/{event_id}/weekend

### Description
Get all parts of event.

### Method
GET

### Endpoint
/api/v1/media/events/{event_id}/weekend
```

```APIDOC
## GET /api/v1/media/events/{event_id}/nfo

### Description
Get episode NFO data.

### Method
GET

### Endpoint
/api/v1/media/events/{event_id}/nfo
```

```APIDOC
## GET /api/v1/media/lookup

### Description
Look up episode by coordinates.

### Method
GET

### Endpoint
/api/v1/media/lookup
```

```APIDOC
## GET /api/v1/media/series/{league_id}/upcoming

### Description
Get upcoming episodes.

### Method
GET

### Endpoint
/api/v1/media/series/{league_id}/upcoming
```

```APIDOC
## GET /api/v1/media/seasons/{competition_season_id}/weeks

### Description
List weeks in season.

### Method
GET

### Endpoint
/api/v1/media/seasons/{competition_season_id}/weeks
```

```APIDOC
## GET /api/v1/media/seasons/{competition_season_id}/weeks/{week}

### Description
Get week events.

### Method
GET

### Endpoint
/api/v1/media/seasons/{competition_season_id}/weeks/{week}
```

```APIDOC
## GET /api/v1/media/events/{event_id}/media-info

### Description
Get combined media info.

### Method
GET

### Endpoint
/api/v1/media/events/{event_id}/media-info
```

--------------------------------

### Specify Custom Data Path for Sportarr

Source: https://sportarr.net/docs

Configure a custom data path for Sportarr's configuration files on Linux/macOS or Windows. This can be done using command-line arguments or by setting an environment variable.

```bash
# Windows
Sportarr.exe -data C:\ProgramData\Sportarr

# Linux/macOS
./Sportarr -data /var/lib/sportarr

# Or use environment variable
export Sportarr__DataPath=/var/lib/sportarr
./Sportarr
```

--------------------------------

### Plex Metadata API

Source: https://sportarr.net/docs/api

Endpoints for interacting with Plex metadata agent API.

```APIDOC
## GET /api/v1/plex/tv

### Description
Provider definition for Plex metadata.

### Method
GET

### Endpoint
/api/v1/plex/tv
```

```APIDOC
## POST /api/v1/plex/tv/library/metadata/matches

### Description
Match/search metadata for Plex.

### Method
POST

### Endpoint
/api/v1/plex/tv/library/metadata/matches
```

```APIDOC
## GET /api/v1/plex/tv/library/metadata/{rating_key}

### Description
Get Plex metadata by ratingKey.

### Method
GET

### Endpoint
/api/v1/plex/tv/library/metadata/{rating_key}
```

```APIDOC
## GET /api/v1/plex/tv/library/metadata/{rating_key}/children

### Description
Get child items for a Plex metadata item.

### Method
GET

### Endpoint
/api/v1/plex/tv/library/metadata/{rating_key}/children
```

```APIDOC
## GET /api/v1/plex/tv/library/metadata/{rating_key}/grandchildren

### Description
Get grandchild items for a Plex metadata item.

### Method
GET

### Endpoint
/api/v1/plex/tv/library/metadata/{rating_key}/grandchildren
```

```APIDOC
## GET /api/v1/plex/tv/library/metadata/{rating_key}/images

### Description
Get images for a Plex metadata item.

### Method
GET

### Endpoint
/api/v1/plex/tv/library/metadata/{rating_key}/images
```

```APIDOC
## GET /api/v1/plex/tv/library/guid/{guid_path}

### Description
Resolve a GUID to Plex metadata.

### Method
GET

### Endpoint
/api/v1/plex/tv/library/guid/{guid_path}
```

--------------------------------

### Renamer + Plex/Emby/Jellyfin Compatibility Endpoints

Source: https://sportarr.net/docs/api

Endpoints for matching sportarr filenames or series/season/episode information to canonical metadata, and for searching and retrieving league/season/episode details for media servers.

```APIDOC
## GET /api/metadata/match

### Description
Match a sportarr filename or series+season+episode to canonical metadata.

### Method
GET

### Endpoint
/api/metadata/match

### Parameters
#### Query Parameters
- **filename** (string) - Optional - The sportarr filename to match.
- **series** (string) - Optional - The series name.
- **season** (string) - Optional - The season number.
- **episode** (string) - Optional - The episode number.
```

```APIDOC
## GET /api/metadata/agents/search

### Description
Search leagues for media-server agent (Plex/Jellyfin/Emby).

### Method
GET

### Endpoint
/api/metadata/agents/search

### Parameters
#### Query Parameters
- **query** (string) - Required - The search query for leagues.
```

```APIDOC
## GET /api/metadata/agents/series/{league_id}

### Description
Get league details for media-server agent (Plex/Jellyfin/Emby).

### Method
GET

### Endpoint
/api/metadata/agents/series/{league_id}

### Parameters
#### Path Parameters
- **league_id** (string) - Required - The ID of the league.
```

```APIDOC
## GET /api/metadata/agents/series/{league_id}/seasons

### Description
Get league seasons for media-server agent (Plex/Jellyfin/Emby).

### Method
GET

### Endpoint
/api/metadata/agents/series/{league_id}/seasons

### Parameters
#### Path Parameters
- **league_id** (string) - Required - The ID of the league.
```

```APIDOC
## GET /api/metadata/agents/series/{league_id}/season/{season_number}/episodes

### Description
Get league season episodes (events) for media-server agent (Plex/Jellyfin/Emby).

### Method
GET

### Endpoint
/api/metadata/agents/series/{league_id}/season/{season_number}/episodes

### Parameters
#### Path Parameters
- **league_id** (string) - Required - The ID of the league.
- **season_number** (string) - Required - The season number.
```

```APIDOC
## GET /api/metadata/agents/episode/{event_id}

### Description
Get single episode (event) for media-server agent (Plex/Jellyfin/Emby).

### Method
GET

### Endpoint
/api/metadata/agents/episode/{event_id}

### Parameters
#### Path Parameters
- **event_id** (string) - Required - The ID of the event.
```

--------------------------------

### Media Export Endpoints

Source: https://sportarr.net/docs/api

Endpoints for NFO/XML/iCal/RSS exports for media server integration.

```APIDOC
## GET /api/v1/media/export/series/{league_id}/tvshow.nfo

### Description
Download tvshow.nfo.

### Method
GET

### Endpoint
/api/v1/media/export/series/{league_id}/tvshow.nfo
```

```APIDOC
## GET /api/v1/media/export/seasons/{competition_season_id}/season.nfo

### Description
Download season.nfo.

### Method
GET

### Endpoint
/api/v1/media/export/seasons/{competition_season_id}/season.nfo
```

```APIDOC
## GET /api/v1/media/export/events/{event_id}/episode.nfo

### Description
Download episode.nfo.

### Method
GET

### Endpoint
/api/v1/media/export/events/{event_id}/episode.nfo
```

```APIDOC
## GET /api/v1/media/export/seasons/{competition_season_id}/episodes.json

### Description
Bulk episode NFO export.

### Method
GET

### Endpoint
/api/v1/media/export/seasons/{competition_season_id}/episodes.json
```

```APIDOC
## GET /api/v1/media/export/series/{league_id}/full-export.json

### Description
Full series NFO export.

### Method
GET

### Endpoint
/api/v1/media/export/series/{league_id}/full-export.json
```

```APIDOC
## GET /api/v1/media/export/series/{league_id}/calendar.ics

### Description
Download iCal feed for league.

### Method
GET

### Endpoint
/api/v1/media/export/series/{league_id}/calendar.ics
```

```APIDOC
## GET /api/v1/media/export/seasons/{competition_season_id}/calendar.ics

### Description
Download iCal feed for season.

### Method
GET

### Endpoint
/api/v1/media/export/seasons/{competition_season_id}/calendar.ics
```

```APIDOC
## GET /api/v1/media/export/series/{league_id}/feed.rss

### Description
RSS feed for league.

### Method
GET

### Endpoint
/api/v1/media/export/series/{league_id}/feed.rss
```

```APIDOC
## GET /api/v1/media/export/seasons/{competition_season_id}/feed.rss

### Description
RSS feed for season.

### Method
GET

### Endpoint
/api/v1/media/export/seasons/{competition_season_id}/feed.rss
```

--------------------------------

### Plex Custom Metadata Provider Endpoints

Source: https://sportarr.net/docs/api

Endpoints for the Plex Custom Metadata Provider, including manifest, matching, and metadata retrieval.

```APIDOC
## GET /api/plex/provider/sports

### Description
Plex Custom Metadata Provider manifest.

### Method
GET

### Endpoint
/api/plex/provider/sports
```

```APIDOC
## POST /api/plex/provider/sports/library/metadata/matches

### Description
Plex match request.

### Method
POST

### Endpoint
/api/plex/provider/sports/library/metadata/matches

### Request Body
- **match_request** (object) - Required - The details of the match request.
```

```APIDOC
## GET /api/plex/provider/sports/library/metadata/{plex_id}

### Description
Plex metadata for show / season / episode by ratingKey.

### Method
GET

### Endpoint
/api/plex/provider/sports/library/metadata/{plex_id}

### Parameters
#### Path Parameters
- **plex_id** (string) - Required - The Plex ratingKey.
```

```APIDOC
## GET /api/plex/provider/sports/library/metadata/{plex_id}/children

### Description
Plex children of a show (seasons) or season (episodes).

### Method
GET

### Endpoint
/api/plex/provider/sports/library/metadata/{plex_id}/children

### Parameters
#### Path Parameters
- **plex_id** (string) - Required - The Plex ratingKey.
```

```APIDOC
## GET /api/plex/provider/sports/library/metadata/{plex_id}/grandchildren

### Description
Plex grandchildren of a show (all episodes across seasons).

### Method
GET

### Endpoint
/api/plex/provider/sports/library/metadata/{plex_id}/grandchildren

### Parameters
#### Path Parameters
- **plex_id** (string) - Required - The Plex ratingKey.
```

```APIDOC
## GET /api/plex/provider/sports/library/metadata/{plex_id}/images

### Description
Plex images for show / season / episode.

### Method
GET

### Endpoint
/api/plex/provider/sports/library/metadata/{plex_id}/images

### Parameters
#### Path Parameters
- **plex_id** (string) - Required - The Plex ratingKey.
```

--------------------------------

### Health and Readiness Endpoints

Source: https://sportarr.net/docs/api

Endpoints for checking the health and readiness of the service.

```APIDOC
## GET /health

### Description
Health check.

### Method
GET

### Endpoint
/health
```

```APIDOC
## GET /ready

### Description
Readiness check.

### Method
GET

### Endpoint
/ready
```

--------------------------------

### Public API - Leagues

Source: https://sportarr.net/docs/api

Endpoints for retrieving information about leagues.

```APIDOC
## GET /api/public/v1/leagues

### Description
List all available leagues.

### Method
GET

### Endpoint
/api/public/v1/leagues
```

```APIDOC
## GET /api/public/v1/leagues/{identifier}

### Description
Get details for a specific league by its identifier.

### Method
GET

### Endpoint
/api/public/v1/leagues/{identifier}
```

```APIDOC
## GET /api/public/v1/leagues/{identifier}/seasons

### Description
Get a list of seasons for a specific league.

### Method
GET

### Endpoint
/api/public/v1/leagues/{identifier}/seasons
```

```APIDOC
## GET /api/public/v1/leagues/{identifier}/teams

### Description
Get a list of teams associated with a specific league.

### Method
GET

### Endpoint
/api/public/v1/leagues/{identifier}/teams
```

--------------------------------

### Root Endpoint

Source: https://sportarr.net/docs/api

Endpoint for retrieving general API information.

```APIDOC
## GET /api/info

### Description
API Information.

### Method
GET

### Endpoint
/api/info
```

--------------------------------

### Public API - Media Series

Source: https://sportarr.net/docs/api

Endpoints for retrieving information about media series.

```APIDOC
## GET /api/public/v1/series

### Description
List all available media series.

### Method
GET

### Endpoint
/api/public/v1/series
```

```APIDOC
## GET /api/public/v1/series/{identifier}

### Description
Get details for a specific media series by its identifier.

### Method
GET

### Endpoint
/api/public/v1/series/{identifier}
```

```APIDOC
## GET /api/public/v1/series/{identifier}/seasons

### Description
Get a list of seasons for a specific media series.

### Method
GET

### Endpoint
/api/public/v1/series/{identifier}/seasons
```

```APIDOC
## GET /api/public/v1/series/{identifier}/episodes

### Description
Get a list of episodes for a specific media series.

### Method
GET

### Endpoint
/api/public/v1/series/{identifier}/episodes
```

```APIDOC
## GET /api/public/v1/series/{identifier}/episodes/{episode_code}

### Description
Get a specific episode by its code for a media series.

### Method
GET

### Endpoint
/api/public/v1/series/{identifier}/episodes/{episode_code}
```

--------------------------------

### Public API - Venues

Source: https://sportarr.net/docs/api

Endpoints for retrieving information about venues.

```APIDOC
## GET /api/public/v1/venues

### Description
List all available venues.

### Method
GET

### Endpoint
/api/public/v1/venues
```

```APIDOC
## GET /api/public/v1/venues/{identifier}

### Description
Get details for a specific venue by its identifier.

### Method
GET

### Endpoint
/api/public/v1/venues/{identifier}
```

--------------------------------

### Images API

Source: https://sportarr.net/docs/api

Endpoints for retrieving and serving entity images.

```APIDOC
## GET /api/v1/images/{image_id}

### Description
Serve a specific image by its ID.

### Method
GET

### Endpoint
/api/v1/images/{image_id}
```

```APIDOC
## GET /api/v1/images/{image_id}/metadata

### Description
Get metadata for a specific image.

### Method
GET

### Endpoint
/api/v1/images/{image_id}/metadata
```

```APIDOC
## GET /api/v1/images/entity/{entity_type}/{entity_id}

### Description
List all images associated with a given entity.

### Method
GET

### Endpoint
/api/v1/images/entity/{entity_type}/{entity_id}
```

```APIDOC
## GET /api/v1/images/entity/{entity_type}/{entity_id}/primary/{image_type}

### Description
Get the primary image for a specific entity and image type.

### Method
GET

### Endpoint
/api/v1/images/entity/{entity_type}/{entity_id}/primary/{image_type}
```

```APIDOC
## GET /api/v1/images/teams/{team_id}

### Description
List all images associated with a specific team.

### Method
GET

### Endpoint
/api/v1/images/teams/{team_id}
```

```APIDOC
## GET /api/v1/images/teams/{team_id}/logo

### Description
Serve the logo image for a specific team.

### Method
GET

### Endpoint
/api/v1/images/teams/{team_id}/logo
```

```APIDOC
## GET /api/v1/images/leagues/{league_id}

### Description
List all images associated with a specific league.

### Method
GET

### Endpoint
/api/v1/images/leagues/{league_id}
```

```APIDOC
## GET /api/v1/images/persons/{person_id}

### Description
List all images associated with a specific person.

### Method
GET

### Endpoint
/api/v1/images/persons/{person_id}
```

```APIDOC
## GET /api/v1/images/persons/{person_id}/headshot

### Description
Serve the headshot image for a specific person.

### Method
GET

### Endpoint
/api/v1/images/persons/{person_id}/headshot
```

```APIDOC
## GET /api/v1/images/venues/{venue_id}

### Description
List all images associated with a specific venue.

### Method
GET

### Endpoint
/api/v1/images/venues/{venue_id}
```

--------------------------------

### Public API - Events

Source: https://sportarr.net/docs/api

Endpoints for retrieving information about events.

```APIDOC
## GET /api/public/v1/events

### Description
List all available events.

### Method
GET

### Endpoint
/api/public/v1/events
```

```APIDOC
## GET /api/public/v1/events/{identifier}

### Description
Get details for a specific event by its identifier.

### Method
GET

### Endpoint
/api/public/v1/events/{identifier}
```

--------------------------------

### Public API - Seasons

Source: https://sportarr.net/docs/api

Endpoints for retrieving information about seasons.

```APIDOC
## GET /api/public/v1/seasons

### Description
List all available seasons.

### Method
GET

### Endpoint
/api/public/v1/seasons
```

```APIDOC
## GET /api/public/v1/seasons/{identifier}

### Description
Get details for a specific season by its identifier.

### Method
GET

### Endpoint
/api/public/v1/seasons/{identifier}
```

--------------------------------

### Venues Endpoints

Source: https://sportarr.net/docs/api

Endpoints for retrieving information about venues, such as stadiums and arenas.

```APIDOC
## GET /api/v1/venues

### Description
List all venues.

### Method
GET

### Endpoint
/api/v1/venues
```

```APIDOC
## GET /api/v1/venues/{venue_id}

### Description
Get venue details.

### Method
GET

### Endpoint
/api/v1/venues/{venue_id}
```

```APIDOC
## GET /api/v1/venues/{venue_id}/events

### Description
List events at a venue.

### Method
GET

### Endpoint
/api/v1/venues/{venue_id}/events
```

```APIDOC
## GET /api/public/v1/venues

### Description
List all venues.

### Method
GET

### Endpoint
/api/public/v1/venues
```

```APIDOC
## GET /api/public/v1/venues/{identifier}

### Description
Get venue by identifier.

### Method
GET

### Endpoint
/api/public/v1/venues/{identifier}
```

--------------------------------

### Public API - Teams

Source: https://sportarr.net/docs/api

Endpoints for retrieving information about teams.

```APIDOC
## GET /api/public/v1/teams

### Description
List all available teams.

### Method
GET

### Endpoint
/api/public/v1/teams
```

```APIDOC
## GET /api/public/v1/teams/{identifier}

### Description
Get details for a specific team by its identifier.

### Method
GET

### Endpoint
/api/public/v1/teams/{identifier}
```

--------------------------------

### Public API - Persons

Source: https://sportarr.net/docs/api

Endpoints for retrieving information about persons.

```APIDOC
## GET /api/public/v1/persons

### Description
List all available persons.

### Method
GET

### Endpoint
/api/public/v1/persons
```

```APIDOC
## GET /api/public/v1/persons/{identifier}

### Description
Get details for a specific person by their identifier.

### Method
GET

### Endpoint
/api/public/v1/persons/{identifier}
```

--------------------------------

### Teams Endpoints

Source: https://sportarr.net/docs/api

Endpoints for retrieving information about teams and their rosters.

```APIDOC
## GET /api/v1/teams

### Description
List all teams.

### Method
GET

### Endpoint
/api/v1/teams
```

```APIDOC
## GET /api/v1/teams/{team_id}

### Description
Get team details.

### Method
GET

### Endpoint
/api/v1/teams/{team_id}
```

```APIDOC
## GET /api/v1/teams/{team_id}/roster

### Description
Get team roster.

### Method
GET

### Endpoint
/api/v1/teams/{team_id}/roster
```

```APIDOC
## GET /api/public/v1/teams

### Description
List all teams.

### Method
GET

### Endpoint
/api/public/v1/teams
```

```APIDOC
## GET /api/public/v1/teams/{identifier}

### Description
Get team by identifier.

### Method
GET

### Endpoint
/api/public/v1/teams/{identifier}
```

--------------------------------

### TheSportsDB Compatibility Endpoints

Source: https://sportarr.net/docs/api

Endpoints for looking up and searching sports data compatible with TheSportsDB.

```APIDOC
## GET /api/v2/json/lookup/league/{league_id}

### Description
Lookup league by TheSportsDB ID.

### Method
GET

### Endpoint
/api/v2/json/lookup/league/{league_id}

### Parameters
#### Path Parameters
- **league_id** (string) - Required - The ID of the league to look up.
```

```APIDOC
## GET /api/v2/json/lookup/team/{team_id}

### Description
Lookup team by TheSportsDB ID.

### Method
GET

### Endpoint
/api/v2/json/lookup/team/{team_id}

### Parameters
#### Path Parameters
- **team_id** (string) - Required - The ID of the team to look up.
```

```APIDOC
## GET /api/v2/json/lookup/player/{player_id}

### Description
Lookup player by TheSportsDB ID.

### Method
GET

### Endpoint
/api/v2/json/lookup/player/{player_id}

### Parameters
#### Path Parameters
- **player_id** (string) - Required - The ID of the player to look up.
```

```APIDOC
## GET /api/v2/json/lookup/event/{event_id}

### Description
Lookup event by TheSportsDB ID.

### Method
GET

### Endpoint
/api/v2/json/lookup/event/{event_id}

### Parameters
#### Path Parameters
- **event_id** (string) - Required - The ID of the event to look up.
```

```APIDOC
## GET /api/v2/json/lookup/venue/{venue_id}

### Description
Lookup venue by TheSportsDB ID.

### Method
GET

### Endpoint
/api/v2/json/lookup/venue/{venue_id}

### Parameters
#### Path Parameters
- **venue_id** (string) - Required - The ID of the venue to look up.
```

```APIDOC
## GET /api/v2/json/search/league/{query}

### Description
Search leagues by name.

### Method
GET

### Endpoint
/api/v2/json/search/league/{query}

### Parameters
#### Path Parameters
- **query** (string) - Required - The search query for league names.
```

```APIDOC
## GET /api/v2/json/search/team/{query}

### Description
Search teams by name.

### Method
GET

### Endpoint
/api/v2/json/search/team/{query}

### Parameters
#### Path Parameters
- **query** (string) - Required - The search query for team names.
```

```APIDOC
## GET /api/v2/json/search/player/{query}

### Description
Search players (persons) by name.

### Method
GET

### Endpoint
/api/v2/json/search/player/{query}

### Parameters
#### Path Parameters
- **query** (string) - Required - The search query for player names.
```

```APIDOC
## GET /api/v2/json/search/event/{query}

### Description
Search events by name.

### Method
GET

### Endpoint
/api/v2/json/search/event/{query}

### Parameters
#### Path Parameters
- **query** (string) - Required - The search query for event names.
```

```APIDOC
## GET /api/v2/json/list/teams/{league_id}

### Description
List all teams in a league.

### Method
GET

### Endpoint
/api/v2/json/list/teams/{league_id}

### Parameters
#### Path Parameters
- **league_id** (string) - Required - The ID of the league.
```

```APIDOC
## GET /api/v2/json/list/seasons/{league_id}

### Description
List all seasons for a league.

### Method
GET

### Endpoint
/api/v2/json/list/seasons/{league_id}

### Parameters
#### Path Parameters
- **league_id** (string) - Required - The ID of the league.
```

```APIDOC
## GET /api/v2/json/list/leagues/team/{team_id}

### Description
List all leagues a team plays in.

### Method
GET

### Endpoint
/api/v2/json/list/leagues/team/{team_id}

### Parameters
#### Path Parameters
- **team_id** (string) - Required - The ID of the team.
```

```APIDOC
## GET /api/v2/json/schedule/league/{league_id}/{season}

### Description
Events in a league season.

### Method
GET

### Endpoint
/api/v2/json/schedule/league/{league_id}/{season}

### Parameters
#### Path Parameters
- **league_id** (string) - Required - The ID of the league.
- **season** (string) - Required - The season identifier.
```

```APIDOC
## GET /api/v2/json/schedule/team/next10/{team_id}

### Description
Next 10 events for a team.

### Method
GET

### Endpoint
/api/v2/json/schedule/team/next10/{team_id}

### Parameters
#### Path Parameters
- **team_id** (string) - Required - The ID of the team.
```

```APIDOC
## GET /api/v2/json/schedule/team/prev10/{team_id}

### Description
Previous 10 events for a team.

### Method
GET

### Endpoint
/api/v2/json/schedule/team/prev10/{team_id}

### Parameters
#### Path Parameters
- **team_id** (string) - Required - The ID of the team.
```

```APIDOC
## GET /api/v2/json/schedule/previous/team/{team_id}

### Description
Recent events for a team.

### Method
GET

### Endpoint
/api/v2/json/schedule/previous/team/{team_id}

### Parameters
#### Path Parameters
- **team_id** (string) - Required - The ID of the team.
```

```APIDOC
## GET /api/v2/json/schedule/all/team/{team_id}

### Description
All scheduled events for a team.

### Method
GET

### Endpoint
/api/v2/json/schedule/all/team/{team_id}

### Parameters
#### Path Parameters
- **team_id** (string) - Required - The ID of the team.
```

```APIDOC
## GET /api/v2/json/schedule/all/league/{league_id}

### Description
All scheduled events for a league.

### Method
GET

### Endpoint
/api/v2/json/schedule/all/league/{league_id}

### Parameters
#### Path Parameters
- **league_id** (string) - Required - The ID of the league.
```

```APIDOC
## GET /api/v2/json/livescore/all

### Description
All live scores across sports.

### Method
GET

### Endpoint
/api/v2/json/livescore/all
```

```APIDOC
## GET /api/v2/json/livescore/sport/{sport}

### Description
Live scores for a sport.

### Method
GET

### Endpoint
/api/v2/json/livescore/sport/{sport}

### Parameters
#### Path Parameters
- **sport** (string) - Required - The name of the sport.
```

```APIDOC
## GET /api/v2/json/livescore/league/{league_id}

### Description
Live scores for a league.

### Method
GET

### Endpoint
/api/v2/json/livescore/league/{league_id}

### Parameters
#### Path Parameters
- **league_id** (string) - Required - The ID of the league.
```

```APIDOC
## GET /api/v2/json/all/leagues

### Description
All known leagues.

### Method
GET

### Endpoint
/api/v2/json/all/leagues
```

```APIDOC
## GET /api/v2/json/all/teams

### Description
All known teams, optionally filtered by sport name(s).

### Method
GET

### Endpoint
/api/v2/json/all/teams

### Parameters
#### Query Parameters
- **sports** (string) - Optional - Comma-separated list of sport names to filter by.
```

```APIDOC
## GET /api/v2/json/all/sports

### Description
All known sports.

### Method
GET

### Endpoint
/api/v2/json/all/sports
```

```APIDOC
## GET /api/v2/json/all/countries

### Description
All known countries.

### Method
GET

### Endpoint
/api/v2/json/all/countries
```

```APIDOC
## GET /api/v2/json/tv/event/{event_id}

### Description
TV listings for a single event.

### Method
GET

### Endpoint
/api/v2/json/tv/event/{event_id}

### Parameters
#### Path Parameters
- **event_id** (string) - Required - The ID of the event.
```

```APIDOC
## GET /api/v2/json/tv/date/{date}

### Description
TV listings for a date.

### Method
GET

### Endpoint
/api/v2/json/tv/date/{date}

### Parameters
#### Path Parameters
- **date** (string) - Required - The date for which to retrieve TV listings (e.g., YYYY-MM-DD).
```

```APIDOC
## GET /api/v2/json/filter/tv/day/{date}

### Description
TV listings filtered by day.

### Method
GET

### Endpoint
/api/v2/json/filter/tv/day/{date}

### Parameters
#### Path Parameters
- **date** (string) - Required - The date to filter TV listings by (e.g., YYYY-MM-DD).
```

```APIDOC
## GET /api/v2/json/filter/tv/country/{country}

### Description
TV listings filtered by country.

### Method
GET

### Endpoint
/api/v2/json/filter/tv/country/{country}

### Parameters
#### Path Parameters
- **country** (string) - Required - The country to filter TV listings by.
```

--------------------------------

### Search API

Source: https://sportarr.net/docs/api

Endpoints for searching various entities within the API.

```APIDOC
## GET /api/v1/search

### Description
Search across all entities in the API.

### Method
GET

### Endpoint
/api/v1/search
```

```APIDOC
## GET /api/v1/search/quick

### Description
Perform a quick search for autocomplete suggestions.

### Method
GET

### Endpoint
/api/v1/search/quick
```

```APIDOC
## GET /api/public/v1/search

### Description
Search across all entities using the public API.

### Method
GET

### Endpoint
/api/public/v1/search
```

--------------------------------

### Sportarr File Naming Convention

Source: https://sportarr.net/docs

Sportarr uses a TV show-style naming convention for organizing sports media, compatible with Plex and other media servers. This format helps in automatic organization and metadata fetching.

```text
/sports/Sports League/Season 2024/Sports League - s2024e12 - Event Title - 1080p.mkv
```

```text
Sports League - s2024e12 - pt1 - Event Title.mkv  (Early Prelims)
Sports League - s2024e12 - pt2 - Event Title.mkv  (Prelims)
Sports League - s2024e12 - pt3 - Event Title.mkv  (Main Card)
```

--------------------------------

### Public API - Sports

Source: https://sportarr.net/docs/api

Endpoints for retrieving information about sports.

```APIDOC
## GET /api/public/v1/sports

### Description
List all available sports.

### Method
GET

### Endpoint
/api/public/v1/sports
```

```APIDOC
## GET /api/public/v1/sports/{identifier}

### Description
Get details for a specific sport by its identifier.

### Method
GET

### Endpoint
/api/public/v1/sports/{identifier}
```

```APIDOC
## GET /api/public/v1/sports/{identifier}/leagues

### Description
Get a list of leagues associated with a specific sport.

### Method
GET

### Endpoint
/api/public/v1/sports/{identifier}/leagues
```

--------------------------------

### Seasons Endpoints

Source: https://sportarr.net/docs/api

Endpoints for retrieving information about competition seasons.

```APIDOC
## GET /api/v1/seasons/{season_id}

### Description
Get season details.

### Method
GET

### Endpoint
/api/v1/seasons/{season_id}
```

```APIDOC
## GET /api/public/v1/seasons

### Description
List all seasons.

### Method
GET

### Endpoint
/api/public/v1/seasons
```

```APIDOC
## GET /api/public/v1/seasons/{identifier}

### Description
Get season by identifier.

### Method
GET

### Endpoint
/api/public/v1/seasons/{identifier}
```

--------------------------------

### Events Endpoints

Source: https://sportarr.net/docs/api

Endpoints for retrieving information about sporting events, including matches, games, and races.

```APIDOC
## GET /api/v1/events

### Description
List events.

### Method
GET

### Endpoint
/api/v1/events
```

```APIDOC
## GET /api/v1/events/{event_id}

### Description
Get event details.

### Method
GET

### Endpoint
/api/v1/events/{event_id}
```

```APIDOC
## GET /api/v1/events/upcoming

### Description
List upcoming events.

### Method
GET

### Endpoint
/api/v1/events/upcoming
```

```APIDOC
## GET /api/public/v1/events

### Description
List events.

### Method
GET

### Endpoint
/api/public/v1/events
```

```APIDOC
## GET /api/public/v1/events/{identifier}

### Description
Get event by identifier.

### Method
GET

### Endpoint
/api/public/v1/events/{identifier}
```

--------------------------------

### Persons Endpoints

Source: https://sportarr.net/docs/api

Endpoints for retrieving information about persons, such as athletes, coaches, and officials.

```APIDOC
## GET /api/v1/persons

### Description
List all persons.

### Method
GET

### Endpoint
/api/v1/persons
```

```APIDOC
## GET /api/v1/persons/{person_id}

### Description
Get person details.

### Method
GET

### Endpoint
/api/v1/persons/{person_id}
```

```APIDOC
## GET /api/public/v1/persons

### Description
List all persons.

### Method
GET

### Endpoint
/api/public/v1/persons
```

```APIDOC
## GET /api/public/v1/persons/{identifier}

### Description
Get person by identifier.

### Method
GET

### Endpoint
/api/public/v1/persons/{identifier}
```

--------------------------------

### Public Operations Endpoints

Source: https://sportarr.net/docs/api

Endpoints for basic health checks, rate limit information, and public statistics.

```APIDOC
## GET /api/health

### Description
Basic liveness probe.

### Method
GET

### Endpoint
/api/health
```

```APIDOC
## GET /api/rate-limit

### Description
Return caller's current rate-limit bucket usage.

### Method
GET

### Endpoint
/api/rate-limit
```

```APIDOC
## GET /api/stats

### Description
Public stats summary (entity counts).

### Method
GET

### Endpoint
/api/stats
```
Tokens:
Raw