### Get Seasonal Campaigns (v2) Request Example Source: https://github.com/openplanet-nl/nadeoapi-docs/blob/main/docs/live/campaigns/campaigns-v2.md This is an example of a GET request to retrieve official seasonal campaigns. It uses query parameters `offset` and `length` to specify the starting point and the number of campaigns to fetch. The base URL is provided for context. ```plaintext GET https://live-services.trackmania.nadeo.live/api/campaign/official?offset=0&length=1 ``` -------------------------------- ### Example GET Request for Favorite Maps Source: https://github.com/openplanet-nl/nadeoapi-docs/blob/main/docs/oauth/reference/favorites/favorites.md Demonstrates an example GET request to retrieve a player's favorite maps using the Nadeo API. This includes specifying the desired length and offset for the retrieved maps. ```http GET https://api.trackmania.com/api/user/maps/favorite?length=1&offset=3 ``` -------------------------------- ### Example Request: Get Equipped Skins (Plain Text) Source: https://github.com/openplanet-nl/nadeoapi-docs/blob/main/docs/core/skins/equipped.md Demonstrates how to make a GET request to the Nadeo API to fetch equipped skins for a list of account IDs. This example uses plain text to show the HTTP request structure. ```plain GET https://prod.trackmania.core.nadeo.online/accounts/skins/?accountIdList=5b4d42f4-c2de-407d-b367-cbff3fe817bc,da4642f9-6acf-43fe-88b6-b120ff1308ba ``` -------------------------------- ### Example Request for Get API Routes Source: https://github.com/openplanet-nl/nadeoapi-docs/blob/main/docs/core/meta/routes.md Demonstrates how to make a GET request to the Core API to retrieve a list of available routes. The 'usage' parameter is required and accepts 'Client' or 'Server' as values. This example shows a request for client-specific routes. ```http GET https://prod.trackmania.core.nadeo.online/api/routes?usage=Client ``` -------------------------------- ### Example Request: Get Favorited Skins Source: https://github.com/openplanet-nl/nadeoapi-docs/blob/main/docs/core/skins/favorites.md This snippet shows an example of how to make a GET request to the Nadeo API to fetch the favorited skins for a given account ID. It assumes you have the base URL and the account ID. ```http GET https://prod.trackmania.core.nadeo.online/accounts/5b4d42f4-c2de-407d-b367-cbff3fe817bc/skins/favorites/ ``` -------------------------------- ### Get Player WebIdentities Example Request Source: https://github.com/openplanet-nl/nadeoapi-docs/blob/main/docs/core/accounts/webidentities-account.md Demonstrates an example HTTP GET request to the Nadeo API to retrieve web identities for a list of account IDs. This endpoint requires a comma-separated list of account IDs as a query parameter. ```HTTP GET https://prod.trackmania.core.nadeo.online/webidentities/by-account/?accountIdList=5b4d42f4-c2de-407d-b367-cbff3fe817bc,7398eeb6-9b4e-44b8-a7a1-a2149955ac70 ``` -------------------------------- ### Get Player Zones Request Example Source: https://github.com/openplanet-nl/nadeoapi-docs/blob/main/docs/core/accounts/zones.md This example demonstrates how to make a GET request to the Nadeo API to retrieve player zones. It requires a comma-separated list of account IDs as a query parameter. The request is authenticated via Ubisoft user accounts. ```http GET https://prod.trackmania.core.nadeo.online/accounts/zones/?accountIdList=5b4d42f4-c2de-407d-b367-cbff3fe817bc,7398eeb6-9b4e-44b8-a7a1-a2149955ac70 ``` -------------------------------- ### Get Club Competitions Request Example Source: https://github.com/openplanet-nl/nadeoapi-docs/blob/main/docs/meet/club-competitions/club-competitions.md Demonstrates an example HTTP GET request to retrieve club competitions. It specifies the number of competitions to fetch (length) and the number to skip (offset). ```plain GET https://meet.trackmania.nadeo.club/api/me/club-competitions?length=1&offset=3 ``` -------------------------------- ### Example Request for Matchmaking IDs (Plain Text) Source: https://github.com/openplanet-nl/nadeoapi-docs/blob/main/docs/meet/matchmaking/summary.md This snippet shows a plain text example of a GET request to retrieve matchmaking IDs. It specifies the URL and the API route. No specific libraries or dependencies are required for this format. ```plain GET https://meet.trackmania.nadeo.club/api/official/summary ``` -------------------------------- ### Example GET Request for Player Ranking Source: https://github.com/openplanet-nl/nadeoapi-docs/blob/main/docs/live/leaderboards/campaign-ranking.md Demonstrates how to make a GET request to the Nadeo Live Services API to retrieve a player's ranking within a specified group (season/campaign). This example uses a plain text format for the request details. ```plain GET https://live-services.trackmania.nadeo.live/api/token/leaderboard/group/ee54d6c5-954c-49b9-bd82-b51f8175b3f7?accountId=5b4d42f4-c2de-407d-b367-cbff3fe817bc ``` -------------------------------- ### Get Competition Match Results Example Source: https://github.com/openplanet-nl/nadeoapi-docs/blob/main/docs/meet/competition-matches/results.md An example of a GET request to retrieve results for a specific competition match ID. The endpoint requires the competition match ID as a path parameter and optionally accepts length and offset as query parameters. ```plain GET https://meet.trackmania.nadeo.club/api/matches/54430/results ``` -------------------------------- ### HTTP Request Example: Get Challenges Source: https://github.com/openplanet-nl/nadeoapi-docs/blob/main/docs/meet/challenges/challenges.md An example of an HTTP GET request to retrieve challenges from the Nadeo API. It demonstrates the base URL and query parameters for specifying the number of challenges to fetch. The 'length' parameter controls the quantity of results, while 'offset' can be used for pagination. ```HTTP GET https://meet.trackmania.nadeo.club/api/challenges?length=3 ``` -------------------------------- ### Example Request for Club Upload Activities Source: https://github.com/openplanet-nl/nadeoapi-docs/blob/main/docs/live/clubs/uploads.md Demonstrates how to make a GET request to the Nadeo Live Services API to retrieve club upload activities. This example specifically requests 'item-upload' activities with a length of 3 and an offset of 0. ```plain GET https://live-services.trackmania.nadeo.live/api/token/club/bucket/item-upload/all?length=3&offset=0 ``` -------------------------------- ### Get Map Leaderboard (Plain Text Request Example) Source: https://github.com/openplanet-nl/nadeoapi-docs/blob/main/docs/live/leaderboards/top.md An example of how to construct a GET request to retrieve map leaderboard data. This includes the base URL, route, and query parameters for filtering and pagination. Note that this endpoint has limitations on the number of records retrievable. ```plaintext GET https://live-services.trackmania.nadeo.live/api/token/leaderboard/group/Personal_Best/map/ZJw6_4CItmVlRMPgELl4Q37Utw2/top?onlyWorld=true&length=10&offset=50 ``` -------------------------------- ### Get Map Info (Multiple) by IDs - Request Example Source: https://github.com/openplanet-nl/nadeoapi-docs/blob/main/docs/core/maps/info-multiple-id.md This example demonstrates how to construct a GET request to the Nadeo API to retrieve information for multiple maps using their IDs. The `mapIdList` query parameter accepts a comma-separated string of map identifiers. ```plain GET https://prod.trackmania.core.nadeo.online/maps/by-id/?mapIdList=a74716be-d124-4de1-87c2-834304ccef5b,5546883f-b1ed-49e0-9397-55fc46f1d00c ``` -------------------------------- ### Example Request: Get Competition Teams (Plain Text) Source: https://github.com/openplanet-nl/nadeoapi-docs/blob/main/docs/meet/competitions/teams.md This code snippet demonstrates an example GET request to the Nadeo API for retrieving competition teams. It shows the endpoint URL with a placeholder for the competition ID. No specific client libraries are required, as it's a standard HTTP request. ```plain text GET https://meet.trackmania.nadeo.club/api/competitions/4621/mode-teams ``` -------------------------------- ### Example Request for Get Match Teams Source: https://github.com/openplanet-nl/nadeoapi-docs/blob/main/docs/meet/matches/teams.md Demonstrates how to make a GET request to the Nadeo Live Services API to retrieve team information for a specific match ID. ```plaintext GET https://meet.trackmania.nadeo.club/api/matches/3018551/teams ``` -------------------------------- ### Get Map Info (Multiple) - Example Request Source: https://github.com/openplanet-nl/nadeoapi-docs/blob/main/docs/live/maps/info-multiple.md This snippet demonstrates an example HTTP GET request to retrieve information for multiple maps using their UIDs. It shows the base URL, the specific endpoint, and how to pass the mapUidList as a query parameter. The endpoint is part of the Nadeo Live Services API. ```plaintext GET https://live-services.trackmania.nadeo.live/api/token/map/get-multiple?mapUidList=YewzuEnjmnh_ShMW1cX0puuZHcf,HisPAAWhTMTjQPxhMJtMak7Daud ``` -------------------------------- ### Get Super Royal Status Response (JSON) Source: https://github.com/openplanet-nl/nadeoapi-docs/blob/main/docs/meet/super-royal/status.md This is an example of the JSON response received when querying the Super Royal status. It indicates the time remaining until the competition starts, its current status (e.g., 'pending'), and a match live ID if applicable. ```json { "startsIn": 15318, "status": "pending", "matchLiveId": null } ``` -------------------------------- ### Example Request for Weekly Shorts Campaigns Source: https://github.com/openplanet-nl/nadeoapi-docs/blob/main/docs/live/campaigns/weekly-shorts.md Demonstrates how to make a GET request to the Nadeo Live Services API to retrieve weekly shorts campaigns. Requires 'offset' and 'length' query parameters. ```http GET https://live-services.trackmania.nadeo.live/api/campaign/weekly-shorts?offset=0&length=1 ``` -------------------------------- ### Get Club Members Request Example (Plain Text) Source: https://github.com/openplanet-nl/nadeoapi-docs/blob/main/docs/live/clubs/members.md An example of an HTTP GET request to retrieve club members. It specifies the base URL, endpoint, club ID, and pagination parameters (length and offset). ```plaintext GET https://live-services.trackmania.nadeo.live/api/token/club/9/member?length=3&offset=0 ``` -------------------------------- ### Example Request for Matchmaking Divisions Source: https://github.com/openplanet-nl/nadeoapi-docs/blob/main/docs/meet/matchmaking/divisions.md Demonstrates how to make a GET request to the Nadeo API to retrieve matchmaking division rules. This example uses a simple cURL-like format and assumes the user has the necessary authentication. The response will contain a list of divisions, each with its unique ID, position, and display rule type (e.g., points_range, minimum_rank_and_points). ```plain GET https://meet.trackmania.nadeo.club/api/matchmaking/2/division/display-rules ``` -------------------------------- ### Get Submitted Maps Request Example Source: https://github.com/openplanet-nl/nadeoapi-docs/blob/main/docs/core/maps/submitted.md This example demonstrates how to make a GET request to the Nadeo API to retrieve maps submitted by the authenticated user. It targets the /maps/by-submitter route on the core Nadeo services URL. ```plaintext GET https://prod.trackmania.core.nadeo.online/maps/by-submitter ``` -------------------------------- ### Example Active Maniapubs Response (JSON) Source: https://github.com/openplanet-nl/nadeoapi-docs/blob/main/docs/live/maniapubs/active.md This JSON structure represents a typical response from the 'Get active Maniapubs' endpoint. It includes details for each Maniapub, such as campaign identifiers, URLs for various image formats and screen resolutions, and display timing information. Note that the 'mediaUrl' and 'displayFormat' fields may be empty. ```json { "displayList": [ { "campaignUid": "b7ef5b35-f1bf-41ae-a58e-7356c86b9c2d", "name": "Beacon World League", "adType": "ugc", "externalUrl": "https://discord.gg/aJBcSYN2dj", "screen2x3Url": "https://trackmania-prod-media-s3.cdn.ubi.com/media/image/live-api/3e5306aa-8e44-4cbe-bb26-aeee38a2a70f/dds/game.dds?timestamp=1702643396.dds", "screen2x3UrlJpgLarge": "https://trackmania-prod-media-s3.cdn.ubi.com/media/image/live-api/3e5306aa-8e44-4cbe-bb26-aeee38a2a70f/jpg/large.jpg?timestamp=1702643396.jpg", "screen2x3UrlJpgMedium": "https://trackmania-prod-media-s3.cdn.ubi.com/media/image/live-api/3e5306aa-8e44-4cbe-bb26-aeee38a2a70f/jpg/medium.jpg?timestamp=1702643396.jpg", "screen2x3UrlJpgSmall": "https://trackmania-prod-media-s3.cdn.ubi.com/media/image/live-api/3e5306aa-8e44-4cbe-bb26-aeee38a2a70f/jpg/small.jpg?timestamp=1702643396.jpg", "screen2x3UrlDds": "https://trackmania-prod-media-s3.cdn.ubi.com/media/image/live-api/3e5306aa-8e44-4cbe-bb26-aeee38a2a70f/dds/game.dds?timestamp=1702643396.dds", "screen16x9Url": "https://trackmania-prod-media-s3.cdn.ubi.com/media/image/live-api/335586ba-e30a-4f75-8e24-8a23deab5afa/dds/game.dds?timestamp=1702987488.dds", "screen16x9UrlJpgLarge": "https://trackmania-prod-media-s3.cdn.ubi.com/media/image/live-api/335586ba-e30a-4f75-8e24-8a23deab5afa/jpg/large.jpg?timestamp=1702987488.jpg", "screen16x9UrlJpgMedium": "https://trackmania-prod-media-s3.cdn.ubi.com/media/image/live-api/335586ba-e30a-4f75-8e24-8a23deab5afa/jpg/medium.jpg?timestamp=1702987488.jpg", "screen16x9UrlJpgSmall": "https://trackmania-prod-media-s3.cdn.ubi.com/media/image/live-api/335586ba-e30a-4f75-8e24-8a23deab5afa/jpg/small.jpg?timestamp=1702987488.jpg", "screen16x9UrlDds": "https://trackmania-prod-media-s3.cdn.ubi.com/media/image/live-api/335586ba-e30a-4f75-8e24-8a23deab5afa/dds/game.dds?timestamp=1702987488.dds", "screen64x41Url": "https://trackmania-prod-media-s3.cdn.ubi.com/media/image/live-api/335586ba-e30a-4f75-8e24-8a23deab5afa/dds/game.dds?timestamp=1702987488.dds", "screen64x41UrlJpgLarge": "https://trackmania-prod-media-s3.cdn.ubi.com/media/image/live-api/335586ba-e30a-4f75-8e24-8a23deab5afa/jpg/large.jpg?timestamp=1702987488.jpg", "screen64x41UrlJpgMedium": "https://trackmania-prod-media-s3.cdn.ubi.com/media/image/live-api/335586ba-e30a-4f75-8e24-8a23deab5afa/jpg/medium.jpg?timestamp=1702987488.jpg", "screen64x41UrlJpgSmall": "https://trackmania-prod-media-s3.cdn.ubi.com/media/image/live-api/335586ba-e30a-4f75-8e24-8a23deab5afa/jpg/small.jpg?timestamp=1702987488.jpg", "screen64x41UrlDds": "https://trackmania-prod-media-s3.cdn.ubi.com/media/image/live-api/335586ba-e30a-4f75-8e24-8a23deab5afa/dds/game.dds?timestamp=1702987488.dds", "screen64x10Url": "https://trackmania-prod-media-s3.cdn.ubi.com/media/image/live-api/9effcdf4-66ab-49af-af68-8f85068b3d53/dds/game.dds?timestamp=1702651418.dds", "screen64x10UrlJpgLarge": "https://trackmania-prod-media-s3.cdn.ubi.com/media/image/live-api/9effcdf4-66ab-49af-af68-8f85068b3d53/jpg/large.jpg?timestamp=1702651418.jpg", "screen64x10UrlJpgMedium": "https://trackmania-prod-media-s3.cdn.ubi.com/media/image/live-api/9effcdf4-66ab-49af-af68-8f85068b3d53/jpg/medium.jpg?timestamp=1702651418.jpg", "screen64x10UrlJpgSmall": "https://trackmania-prod-media-s3.cdn.ubi.com/media/image/live-api/9effcdf4-66ab-49af-af68-8f85068b3d53/jpg/small.jpg?timestamp=1702651418.jpg", "screen64x10UrlDds": "https://trackmania-prod-media-s3.cdn.ubi.com/media/image/live-api/9effcdf4-66ab-49af-af68-8f85068b3d53/dds/game.dds?timestamp=1702651418.dds", "mediaUrl": "", "displayFormat": "", "ratio": 0, "displayRatio": 0, "endTimestamp": 1703460488, "relativeEnd": 282414 }, ... ], "itemCount": 10 } ``` -------------------------------- ### Get Map Record by ID - Example Request Source: https://github.com/openplanet-nl/nadeoapi-docs/blob/main/docs/core/records/map-record.md This snippet shows an example of how to request a single map record using its ID via the Nadeo API. It utilizes a GET request to the specified URL with the mapRecordId as a path parameter. No specific programming language is defined for this example, as it represents a generic HTTP request. ```plain GET https://prod.trackmania.core.nadeo.online/mapRecords/ade1de4c-dd53-4a65-9d9b-89c5b1b9fa44 ``` -------------------------------- ### Initiate OAuth Authorization Code Flow Source: https://github.com/openplanet-nl/nadeoapi-docs/blob/main/docs/oauth/auth.md This code snippet demonstrates how to construct the URL to initiate the Authorization Code OAuth flow. It includes required parameters like response_type, client_id, redirect_uri, and an optional state parameter for security. ```http GET https://api.trackmania.com/oauth/authorize ?response_type=code &client_id=CLIENT_ID &redirect_uri=https://yourapp.com/callback &state=randomstring ``` -------------------------------- ### Get Competition Rounds Request Example Source: https://github.com/openplanet-nl/nadeoapi-docs/blob/main/docs/meet/competitions/rounds.md This snippet demonstrates how to make a GET request to the Nadeo Live Services API to retrieve rounds details for a given competition ID. The example uses a plain text format for the request. ```plain GET https://meet.trackmania.nadeo.club/api/competitions/3633/rounds ``` -------------------------------- ### Example Response for Non-existent Weekly Shorts Campaigns Source: https://github.com/openplanet-nl/nadeoapi-docs/blob/main/docs/live/campaigns/weekly-shorts.md Illustrates the JSON response when no weekly shorts campaigns are found for the given parameters. The 'campaignList' will be empty. ```json { "itemCount": 2, "campaignList": [], "nextRequestTimestamp": 1735491600, "relativeNextRequest": 449777 } ``` -------------------------------- ### Get Club Competitions Response Example (No Competitions) Source: https://github.com/openplanet-nl/nadeoapi-docs/blob/main/docs/meet/club-competitions/club-competitions.md An example JSON response when no relevant club competitions are found for the user. The 'clubCompetitions' array will be empty, and the count will be zero. ```json { "clubCompetitions": [], "clubCompetitionsCount": 0 } ``` -------------------------------- ### Example Response: Get Equipped Skins (JSON) Source: https://github.com/openplanet-nl/nadeoapi-docs/blob/main/docs/core/skins/equipped.md Illustrates a successful JSON response from the Nadeo API when retrieving equipped skins. Each object in the array contains the account ID, skin ID, skin type, and timestamp of the equipped skin. ```json [ { "accountId": "5b4d42f4-c2de-407d-b367-cbff3fe817bc", "skinId": "dca3a74a-acf5-4780-8842-15ba80c3b673", "skinType": "Models/CarSport", "timestamp": "2023-06-01T15:18:02+00:00" }, { "accountId": "da4642f9-6acf-43fe-88b6-b120ff1308ba", "skinId": "28ea4f72-7a5b-42b2-a082-cc6c59616918", "skinType": "Models/CarSport", "timestamp": "2023-05-25T22:16:09+00:00" } ] ```