API Reference
Complete documentation for all API endpoints.
Endpoint Overview
| Type | Endpoint | Dimensions | Description |
|---|---|---|---|
| Unified Endpoints | |||
| Thumbnail | /:league/thumb[.png] | 1440x1080 | League landscape thumbnail |
/:league/:team1/thumb[.png] | 1440x1080 | Team landscape thumbnail | |
/:league/:team1/:team2/thumb[.png] | 1440x1080 | Matchup landscape thumbnail | |
| Cover | /:league/cover[.png] | 1080x1440 | League portrait cover |
/:league/:team1/cover[.png] | 1080x1440 | Team portrait cover | |
/:league/:team1/:team2/cover[.png] | 1080x1440 | Matchup portrait cover | |
| Logo | /:league/logo[.png] | Original | Raw league logo |
/:league/:team1/logo[.png] | Original | Raw team logo | |
/:league/:team1/:team2/logo[.png] | 1024x1024 | Matchup logo (transparent) | |
| Other Endpoints | |||
| Raw Data | /:league/:team/raw | JSON | Team data from provider |
| Server Info | /info | JSON | Version and git info |
| Deprecated | |||
/:league/:team/teamlogo[.png] | Original | Use /:league/:team/logo | |
/:league/leaguelogo[.png] | Original | Use /:league/logo | |
/:league/leaguethumb[.png] | 1440x1080 | Use /:league/thumb | |
/:league/leaguecover[.png] | 1080x1440 | Use /:league/cover |
Note: The .png extension is optional for all image endpoints. Deprecated endpoints still work but will be removed in a future version.
Quick Reference
Browse detailed documentation for each endpoint:
- Logo Endpoint - League, team, and matchup logos
- Thumbnail Endpoint - League, team, and matchup thumbnails
- Cover Endpoint - League, team, and matchup covers
- NCAA Shorthand - Convenience route for NCAA sports
- Raw Team Data - JSON team data
- Server Info - Server version info
- XC API Proxy - Proxy XC API with EPG logo replacement (Dev only)
NCAA Shorthand Route
Endpoints:
/ncaa/:sport/:type(league-only)/ncaa/:sport/:team/:type(single team)/ncaa/:sport/:team1/:team2/:type(matchup)
A convenience endpoint for NCAA sports that uses sport names instead of league codes.
Parameters
sport- NCAA sport identifier (e.g.,football,basketball,womens-basketball)team/team1- First team (name, city, or abbreviation) (optional for league-only)team2- Second team (name, city, or abbreviation) (optional for single team)type- Image type:thumb,cover,logo, orraw
Supported Sports
| Primary Sport | Additional Aliases | Maps to |
|---|---|---|
football | footballm | ncaaf |
basketball | basketballm, march-madness | ncaam |
hockey | ice-hockey, hockeym | ncaah |
soccer | soccerm | ncaas |
baseball | baseballm | ncaabb |
lacrosse | lacrossem, mens-lacrosse | ncaalax |
volleyball | volleyballm, mens-volleyball | ncaavb |
water-polo | waterpolo, waterpolom | ncaawp |
womens-basketball | basketballw | ncaaw |
womens-hockey | hockeyw | ncaawh |
womens-soccer | soccerw | ncaaws |
softball | softballw | ncaasbw |
womens-lacrosse | lacrossew | ncaawlax |
womens-volleyball | volleyballw | ncaawvb |
womens-water-polo | waterpolow | ncaawwp |
field-hockey | fieldhockey | ncaawfh |
Examples
# League images
GET /ncaa/football/thumb
GET /ncaa/basketball/logo
# Single team images
GET /ncaa/football/alabama/thumb
GET /ncaa/basketball/duke/cover
# Matchup images
GET /ncaa/football/alabama/georgia/thumb
GET /ncaa/basketball/duke/unc/cover
GET /ncaa/womens-basketball/uconn/south-carolina/thumb?style=2
# Raw data
GET /ncaa/football/alabama/raw