⬇️Third Party API

Anyone can build seamless integrations from your leaderboard into other services like Discord with the Third Party API. To get started, create an API key in Settings > External Service Settings in your dashboard. These keys can be revoked at any time without consequences to your game.

These are the read-only endpoints that can be used with a third party API key.

Get a leaderboard

GET https://api.galaxysdk.com/api/v1/third_party/leaderboards/:leaderboard_id

Get all records on a clan or non clan leaderboard

Path Parameters

Name	Type	Description
leaderboard_id*	String	Path parameter of the leaderboard ID you want to get

Query Parameters

Name	Type	Description
limit	String	Limit for pagination
offset	String	Offset for pagination
clan	Boolean	Fetch clans as opposed to individuals

Headers

Name	Type	Description
Api-Key*	String	3rd party API key

200: OK

401: Unauthorized

{
    // Response
}

Get user record

GET https://api.galaxysdk.com/api/v1/third_party/leaderboards/:leaderboard_id/player/:alias_id?alias_type=playfab

Get a user by their alias_id

Path Parameters

Name	Type	Description
alias_id*	String	Player alias ID
leaderboard_id*	String	Leaderboard ID

Query Parameters

Name	Type	Description
alias_type	String	Type of player ID (set to "playfab" for Playfab ID). If not present, alias_id will be treated as player_id
clan	Boolean	Fetch clan record as opposed to individual info

Headers

Name	Type	Description
Api-Key*	String	3rd party API key

200: OK

{
    // Response
}

401: Unauthorized

{
    // Response
}

Get clan record

GET https://api.galaxysdk.com/api/v1/third_party/leaderboards/:leaderboard_id/clans/:clan_id

Get a specific clan's record

Path Parameters

Name	Type	Description
leaderboard_id*	String	The leaderboard to return rankings and scores from
clan_id*	String	The clan ID you want to retrieve

Headers

Name	Type	Description
Api-Key	String	3rd party API key

200: OK

{
    // Response
}

401: Unauthorized

{
    // Response
}

Get clan members

GET https://api.galaxysdk.com/api/v1/third_party/leaderboards/:leaderboard_id/clans/:clan_id/members

Path Parameters

Name	Type	Description
clan_id*	String	The clan ID you want to retrieve
leaderboard_id*	String	The leaderboard to return rankings and scores from

Query Parameters

Name	Type	Description
offset	String	Offset for pagination
limit	String	Limit for pagination

Headers

Name	Type	Description
Api-Key*	String	3rd party API key

200: OK

{
    // Response
}

401: Unauthorized

{
    // Response
}