Skip to main content

Documentation Index

Fetch the complete documentation index at: https://rocks.docs.rive.wtf/llms.txt

Use this file to discover all available pages before exploring further.

Every API key is tied to one IP. To apply for a key, DM southctrl on Discord.
Use the endpoint path below, replace the required params, and send Authorization: Bearer YOUR_API_KEY.

​
Quick Start

1

Choose a username

Use the player name you want to look up.
2

Pick a platform

Common values are ubi, uplay, pc, xbox, and psn.
3

Call the profile route

Send a request to /api/siege/profile?username=...&platform=....
The current Siege data comes from the public r6data.eu stats source.

​
Get Profile

Get Rainbow Six Siege account info and summarized stats for a player.

​
Endpoint

GET /api/siege/profile

​
Query Parameters

​
username
string
required
Siege username on the selected platform.
​
platform
string
default:"ubi"
Platform name. ubi, uplay, and pc map to uplay.

​
Example Request

curl -X GET "https://rocks.rive.wtf/api/siege/profile?username=beaulo&platform=ubi" \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Example Response

{
  "ok": true,
  "data": {
    "username": "beaulo",
    "platform": "uplay",
    "source_url": "https://r6data.eu/search?q=beaulo",
    "scrape_source": "public r6data site api",
    "account_info": {
      "profile": {
        "level": 1435,
        "xp": 0
      },
      "profiles": [
        {
          "platformType": "uplay",
          "nameOnPlatform": "beaulo"
        }
      ]
    },
    "profile": {
      "level": 1435,
      "xp": 0
    },
    "level": 1435,
    "ranked_summary": {
      "platform_profiles": [
        {
          "profile_id": "3cc51897-49c4-45f6-af9d-66507b8ef0e1",
          "boards": [
            {
              "board_id": "pvp_ranked",
              "season_id": 41,
              "rank": 36,
              "rank_points": 4765,
              "max_rank": 36,
              "max_rank_points": 4828,
              "kills": 1547,
              "deaths": 980,
              "wins": 190,
              "losses": 72,
              "abandons": 1,
              "kd": 1.579,
              "win_rate": 72.52
            }
          ]
        }
      ]
    }
  }
}

​
Response Fields

​
ok
boolean
Whether the request was successful.
​
data
object
Siege profile data, raw stats payloads, and summarized ranked boards.
FieldTypeDescription
usernamestringUsername used for the lookup
platformstringNormalized platform returned by the API
source_urlstringPublic source search URL
scrape_sourcestringSource used to build the response
account_infoobjectRaw account information payload
stats_dataobjectRaw stats payload from the source
api_debugobjectRequest debug info including URLs and status codes
profilesarrayProfile identities returned by the source
profileobjectFlattened main profile object
levelnumberPlayer level when available
ranked_summaryobjectSimplified stats grouped by profile and board

​
ranked_summary Fields

FieldTypeDescription
platform_profilesarrayProfiles returned for the selected platform family

​
boards Object

FieldTypeDescription
board_idstringBoard type such as pvp_ranked or pvp_casual
season_idnumberMost recent season ID used for that board
ranknumberCurrent rank value
rank_pointsnumberCurrent rank points
max_ranknumberHighest rank reached
max_rank_pointsnumberHighest rank points reached
killsnumberTotal kills in that board
deathsnumberTotal deaths in that board
winsnumberTotal wins
lossesnumberTotal losses
abandonsnumberTotal abandons
kdnumberCalculated kill/death ratio
win_ratenumberCalculated win rate percentage

​
Get Matches

Get recent Siege match data for a player.

​
Endpoint

GET /api/siege/matches

​
Query Parameters

​
username
string
required
Siege username on the selected platform.
​
platform
string
default:"ubi"
Platform name. ubi, uplay, and pc map to uplay.

​
Example Request

curl -X GET "https://rocks.rive.wtf/api/siege/matches?username=beaulo&platform=ubi" \
  -H "Authorization: Bearer YOUR_API_KEY"
Response shape depends on the current match scraper/source. Use the profile route if you mainly need stable ranked stats.
api_debug is useful while testing because it shows the exact upstream URLs and status codes used to build the response.