Skip to main content
API docs by Redocly

DHB / api (0.2.0)

Download OpenAPI specification:Download

DHB / support: support@dhb.digital URL: https://get.support.dhb.digital/servicedesk/customer/portal/9 License: License agreement Terms of Service

Documentation of the DHB / hockey API. Please note that the contents is currently still under development and returned values are likely to change.

Organisations

getAllOrganisations

Retrieve a list of available organisations

Authorizations:
DHBApiKey

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getOrganisationDetails

Retrieve the details of the organisation.

Authorizations:
DHBApiKey
path Parameters
id
required
string

Organisation ID to fetch information for.

Responses

Response samples

Content type
application/json
{
  • "id": 123,
  • "parent_id": 234,
  • "name": "Musterorganisation",
  • "address": {
    }
}

getOrganisationLeagues

Retrieve a list of available leagues within a given organisation

Authorizations:
DHBApiKey
path Parameters
id
required
string

Organisation ID to fetch information for.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getOrganisationClubs

Retrieve a list of available clubs within a given organisation

Authorizations:
DHBApiKey
path Parameters
id
required
string

Organisation ID to fetch information for.

Responses

Response samples

Content type
application/json
[]

getOrganisationUmpires

DRAFT ONLY - Retrieve a list of available umpires within a given organisation

Authorizations:
DHBApiKey
path Parameters
id
required
string

Organisation ID to fetch information for.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Leagues

getLeagueDetails

Retrieve the details of a league.

Authorizations:
DHBApiKey
path Parameters
id
required
string

League ID to fetch information for.

Responses

Response samples

Content type
application/json
{
  • "id": 7,
  • "name": "1. Bundesliga Herren Feld",
  • "abbreviation": "1BLH",
  • "age_group": "string",
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "umpire_license": [
    ],
  • "umpire_classification": [
    ],
  • "season": {
    },
  • "stages": [
    ]
}

getTeamsByLeague

Retrieve the teams playing in a league.

Authorizations:
DHBApiKey
path Parameters
id
required
string

League ID to fetch information for.

Responses

Response samples

Content type
application/json
[]

getMatchesByLeague

Retrieve the matches of a given league.

Authorizations:
DHBApiKey
path Parameters
id
required
string

League ID to fetch information for.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getStandingsByLeague

Retrieve the standings for a league.

Authorizations:
DHBApiKey
path Parameters
id
required
string

League ID to fetch information for.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getTopScorersByLeague

Retrieve the table for a league.

Authorizations:
DHBApiKey
path Parameters
id
required
string

League ID to fetch information for.

Responses

Response samples

Content type
application/json
[]

Clubs

getClubDetails

Retrieve details of a club.

Authorizations:
DHBApiKey
path Parameters
id
required
string

Club ID to fetch information for.

Responses

Response samples

Content type
application/json
{
  • "id": 456,
  • "name": "Muster Hockey Club e.V.",
  • "short_name": "Muster HC",
  • "abbreviation": "MHC",
  • "organisation": {
    },
  • "logo": "https://magazin.hockey.de/path/to/clublogo.svg",
  • "contact": {
    },
  • "address": {
    },
  • "tags": [
    ]
}

getTeamsByClub

Retrieve the teams playing for a club.

Authorizations:
DHBApiKey
path Parameters
id
required
string

Club ID to fetch information for.

Responses

Response samples

Content type
application/json
[]

getClubLocations

Retrieve a list of available locations within a club

Authorizations:
DHBApiKey
path Parameters
id
required
string

Club ID to fetch information for.

Responses

Response samples

Content type
application/json
[]

Locations

Teams

getTeamDetails

Retrieve the details for a team.

Authorizations:
DHBApiKey
path Parameters
id
required
string

Team ID to fetch information for.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Matches

getMatchDetails

Retrieve a single match's details.

Authorizations:
DHBApiKey
path Parameters
id
required
string

Match ID to fetch information for.

Responses

Response samples

Content type
application/json
{
  • "id": 12032,
  • "stage": "PLAYOFFS",
  • "periods": 4,
  • "periods_minutes": 15,
  • "status": "WARMUP",
  • "score_home": 3,
  • "score_away": 2,
  • "pushback": "2023-06-22T14:30:00+00:00",
  • "home_team_id": 102,
  • "away_team_id": 102,
  • "location": {},
  • "pitch": {
    },
  • "umpire_license": [
    ],
  • "umpire_classification": [
    ]
}

getHomeTeamMatchDetails

Retrieve a single match's home team's details.

Authorizations:
DHBApiKey
path Parameters
id
required
string

Match ID to fetch information for.

Responses

Response samples

Content type
application/json
{
  • "id": 102,
  • "club_id": 456,
  • "leagueId": 7,
  • "name": "1. Herren Muster HC",
  • "shortName": "MHC",
  • "ageGroup": "Erwachsene",
  • "image": "https://magazin.hockey.de/path/to/teamimage.jpg",
  • "socialNetworks": [],
  • "players": [
    ],
  • "staff": [
    ]
}

getAwayTeamMatchDetails

Retrieve a single match's away team's details.

Authorizations:
DHBApiKey
path Parameters
id
required
string

Match ID to fetch information for.

Responses

Response samples

Content type
application/json
{
  • "id": 102,
  • "club_id": 456,
  • "leagueId": 7,
  • "name": "1. Herren Muster HC",
  • "shortName": "MHC",
  • "ageGroup": "Erwachsene",
  • "image": "https://magazin.hockey.de/path/to/teamimage.jpg",
  • "socialNetworks": [],
  • "players": [
    ],
  • "staff": [
    ]
}

getLiveMatchDetails

Retrieve a single match's live ticker details and high level status.

Authorizations:
DHBApiKey
path Parameters
id
required
string

Match ID to fetch information for.

Responses

Response samples

Content type
application/json
{
  • "status": "In progress",
  • "phase": "Q3",
  • "home_team": {},
  • "away_team": {},
  • "period_scores": [
    ],
  • "umpire1": {
    },
  • "umpire2": {
    }
}

getLiveMatchEvents

Provides a play-by-play event timeline for a current live game.

Authorizations:
DHBApiKey
path Parameters
id
required
string

Match ID to fetch information for.

Responses

Response samples

Content type
application/json
{
  • "subtype": "GOAL-SCORED",
  • "type_commentary": "string",
  • "period": 0,
  • "timestamp": "2023-06-22T14:30:00+00:00",
  • "team": {},
  • "player": {
    },
  • "staff": {
    }
}

getLiveMatchTime

Provides the current times of a match.

Authorizations:
DHBApiKey
path Parameters
id
required
string

Match ID to fetch information for.

Responses

Response samples

Content type
application/json
{
  • "elapsed_match": 48,
  • "elapsed_period": 3
}

getMatchUmpires

Retrieve the umpires for a single match.

Authorizations:
DHBApiKey
path Parameters
id
required
string

Match ID to fetch information for.

Responses

Response samples

Content type
application/json
{
  • "id": 102032,
  • "legacy_id": 823920,
  • "name": "John",
  • "surname": "Doe",
  • "license": {
    },
  • "classification": {
    }
}

getMatchArticles

Retrieve news articles for a single match.

Authorizations:
DHBApiKey
path Parameters
id
required
string

Match ID to fetch information for.

Responses

Response samples

Content type
application/json
[]

setMatchOfficials

DRAFT ONLY - Set the umpires and umpire observers for matches.

Authorizations:
DHBApiKey
path Parameters
id
required
string

Match ID to fetch information for.

Request Body schema: application/json
required

Update customer with properties to be changed

Array
id
integer <int64>

The ID of the person.

role
string
Enum: "UMPIRE" "UMPIRE_OBSERVER" "UMPIRE_VIDEO" "JUDGE"

Role of the official in the match

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "id": 102032,
  • "legacy_id": 823920,
  • "name": "John",
  • "surname": "Doe",
  • "license": {
    },
  • "classification": {
    }
}

Players

getPlayerDetails

Retrieve a single player's details.

Authorizations:
DHBApiKey
path Parameters
id
required
string

Player ID to fetch information for.

Responses

Response samples

Content type
application/json
{}

Staff

getStaffDetails

Retrieve a single staff member's details.

Authorizations:
DHBApiKey
path Parameters
id
required
string

Staff ID to fetch information for.

Responses

Response samples

Content type
application/json
{
  • "id": 823920,
  • "name": "Jane",
  • "surname": "Doe",
  • "role_title": "Trainer*in"
}

Umpires

Retrieve a single umpire's details.

Authorizations:
DHBApiKey
path Parameters
id
required
string

Umpire ID to fetch information for.

Responses

Response samples

Content type
application/json
{
  • "id": 102032,
  • "legacy_id": 823920,
  • "name": "John",
  • "surname": "Doe",
  • "license": {
    },
  • "classification": {
    }
}