Team-Up Elo Rating API

API for managing Elo ratings across various game formats and team sizes

Version: 1.0.0

API Endpoint

https://kh3pbctcnk.execute-api.us-east-2.amazonaws.com/team-up-api
post /clear_all_client_data

Delete all data associated with a client
Permanently removes all leaderboards, matches, ratings, and metadata associated with a client

post /delete_leaderboard

Delete a leaderboard and all associated data
Permanently removes a leaderboard and all its associated matches, ratings, metadata, and history

post /export_leaderboard

Export a leaderboard's data
Export ratings, profiles, and limited match history for a leaderboard

get /get_api_docs

Get API documentation
Retrieve the complete OpenAPI specification for the Team Up API

post /get_client_leaderboards

Get a list of all leaderboards for a client
Retrieves all leaderboards and their metadata for a given client ID

post /get_leaderboard

Get ratings for a specific leaderboard
Retrieve ratings for a specific leaderboard and rating type, sorted by rating in descending order. Supports pagination and filtering by rating type, with optional parameters for specific formats.

post /get_leaderboard_profile

Get a leaderboard's profile information
Retrieve profile data for a specific leaderboard including display settings and tiers

post /get_leaderboard_history

Get match history for a leaderboard
Retrieve paginated match history for a specific leaderboard, sorted by timestamp in descending order

post /get_leaderboard_rating_types

List available rating types for a leaderboard
Retrieve all rating types that have data for the specified leaderboard

post /get_player_history

Get match history for a specific player
Retrieve paginated match history for a specific player across all leaderboards

post /get_random_clients

Get a random selection of clients
Retrieves a random sample of client IDs for discovery and testing purposes using a random seed index

post /get_rating_history

Get rating history for a specific rating type
Retrieve paginated match history with rating changes for a specific leaderboard and rating type

post /get_subscription_tier

Get a client's subscription tier
Retrieve the current subscription tier and limits for a client

post /get_team_history

Get match history for a specific team
Retrieve paginated match history for a specific team combination

post /import_leaderboard

Import a new leaderboard
Create a new leaderboard from exported data. Will fail if the leaderboard already exists.

post /record_match

Record a new match
Record match results and update ratings for all applicable rating types. Supports multiple team sizes and formats including 1v1, 2v2, 2v6, 1v1v1, 2v2v2 and more.

post /record_match_with_deltas

Record a match with pre-calculated rating deltas
Record match results using provided rating changes rather than calculating them internally

post /set_client_profile

Set or update a client's profile information
Configure display settings and metadata for a client. Sending an empty object will delete the profile. Invalid keys will be ignored and reported in the response.

post /set_leaderboard_profile

Set or update a leaderboard's display information
Configure display settings and metadata for a leaderboard

post /set_player_connection

Set or remove a gaming platform connection for a player
Update or remove a gaming platform connection for a player. Providing neither id nor name will remove the connection.

post /set_player_profile

Set or update a player's profile information
Update display information and connection details for a player ID

post /set_rating_visibility

Set visibility of ratings for a player or team
Configure whether a player's or team's ratings are hidden from leaderboards

post /set_team_profile

Set or update a team's profile information
Associate display information for a specific team combination of players

post /undo_last_match

Undo the most recently recorded match
Remove the last recorded match and revert its Elo rating changes. This will update the match history, rating records, and metadata counters accordingly.

Discord X