{"id":17845475,"url":"https://github.com/pololacoste/r6-api","last_synced_at":"2025-03-20T06:32:49.716Z","repository":{"id":40417465,"uuid":"326503592","full_name":"PoloLacoste/r6-api","owner":"PoloLacoste","description":"Rainbow Six Siege API","archived":false,"fork":false,"pushed_at":"2023-10-19T05:48:55.000Z","size":828,"stargazers_count":29,"open_issues_count":4,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-17T15:55:25.126Z","etag":null,"topics":["api","docker","docker-compose","mongodb","nestjs","nodejs","r6","rainbow-six-siege","redis","rest","rest-api","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PoloLacoste.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-01-03T21:25:18.000Z","updated_at":"2025-03-04T14:37:39.000Z","dependencies_parsed_at":"2024-10-27T22:26:38.022Z","dependency_job_id":"d31c8597-0751-4913-a906-7abd5523813b","html_url":"https://github.com/PoloLacoste/r6-api","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PoloLacoste%2Fr6-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PoloLacoste%2Fr6-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PoloLacoste%2Fr6-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PoloLacoste%2Fr6-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PoloLacoste","download_url":"https://codeload.github.com/PoloLacoste/r6-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244566328,"owners_count":20473439,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","docker","docker-compose","mongodb","nestjs","nodejs","r6","rainbow-six-siege","redis","rest","rest-api","typescript"],"created_at":"2024-10-27T21:36:01.053Z","updated_at":"2025-03-20T06:32:44.705Z","avatar_url":"https://github.com/PoloLacoste.png","language":"TypeScript","readme":"# Rainbow Six Siege API\n\n![R6-Api CI](https://github.com/PoloLacoste/r6-api/workflows/R6-Api%20CI/badge.svg?branch=main)\n\nREST API version of [r6api.js](https://github.com/danielwerg/r6api.js) using Docker.\nThe data can be cached if you want to use redis and mongodb.\n\nDocker image avalaible at [r6-api](https://hub.docker.com/repository/docker/pololacoste/r6-api).\n\n# Install\n\n## Docker\n\n```bash\ndocker run --name r6-api -e EMAIL=UBISOFT_EMAIL -e PASSWORD=UBISOFT_PASSWORD -e PORT=3000 -p 3000:3000 -d pololacoste/r6-api\n```\n\n## Docker compose\n\n```yaml\nr6-api:\n  restart: always \n  image: pololacoste/r6-api\n  container_name: r6-api\n  environment: \n    - EMAIL=${UBISOFT_EMAIL}\n    - PASSWORD=${UBISOFT_PASSWORD}\n    - PORT=3000\n  ports:\n    - 3000:3000\n```\n\n## Docker compose with Redis and Mongodb\n\n```yaml\nversion: '2.1'\nservices:\n\n  mongo:\n    image: mongo:4.4.3-bionic\n    container_name: mongo\n    restart: always\n    environment:\n      MONGO_INITDB_ROOT_USERNAME: root\n      MONGO_INITDB_ROOT_PASSWORD: password\n      MONGO_INITDB_DATABASE: r6\n  \n  redis:\n    image: redis:6.0.9-alpine\n    container_name: redis\n    restart: always\n\n  r6-api:\n    restart: always \n    image: pololacoste/r6-api\n    container_name: r6-api\n    environment: \n      - EMAIL=${EMAIL}\n      - PASSWORD=${PASSWORD}\n      - PORT=3000\n      - MONGO_URL=mongodb://root:password@mongo:27017/?ssl=false\n      - REDIS_URL=redis://redis:6379\n      - CACHING=true\n    ports:\n      - 3000:3000\n    depends_on: \n      - mongo\n      - redis\n```\n\n# HTTP API\n\nA swagger documentation is available on the `/` endpoint.\n\n## Get id\n\nGets the id of a player from their username.\n\n**URL** : `/{platform}/id/{username}`\n\n**Method** : `GET`\n\n**Parameters** : \n- `platform` [string] : `uplay` (pc), `xbl` (Xbox Live) or `psn` (PlayStation Network)\n- `username` [string] : username of the player\n\n**Response** :\n\n```json\n{\n  \"id\": \"be3313d6-d443-4eae-818f-bb7f56837781\"\n}\n```\n\n## Get level\n\nGets the level, xp and alpha pack drop chance of a player.\n\n**URLS** : \n- `/{platform}/level/id/{id}`\n- `/{platform}/level/username/{username}`\n\n**Method** : `GET`\n\n**Parameters** : \n- `platform` [string] : `uplay` (pc), `xbl` (Xbox Live) or `psn` (PlayStation Network)\n- `id` [string] : id of the player\n- `username` [string] : username of the player\n\n**Response** :\n\n```json\n{\n  \"id\": \"be3313d6-d443-4eae-818f-bb7f56837781\",\n  \"level\": 377,\n  \"xp\": 137702,\n  \"lootboxProbability\": {\n    \"raw\": 4320,\n    \"percent\": \"43.20%\"\n  }\n}\n```\n\n## Get playtime\n\nGets the playtime of a player.\n\n**URLS** : \n- `/{platform}/playtime/id/{id}`\n- `/{platform}/playtime/username/{username}`\n\n**Method** : `GET`\n\n**Parameters** : \n- `platform` [string] : `uplay` (pc), `xbl` (Xbox Live) or `psn` (PlayStation Network)\n- `id` [string] : id of the player\n- `username` [string] : username of the player\n\n**Response** :\n\n```json\n{\n  \"id\": \"be3313d6-d443-4eae-818f-bb7f56837781\",\n  \"pvp\": {\n    \"general\": 6343064,\n    \"ranked\": 5699426,\n    \"casual\": 499943,\n    \"custom\": 0,\n    \"other\": 143695\n  },\n  \"pve\": {\n    \"general\": 989429\n  }\n}\n```\n\n## Get rank\n\nGets seasonal stats of a player.\n\nReturn all the \n\n**URLS** : \n- `/{platform}/rank/id/{id}`\n- `/{platform}/rank/username/{username}`\n\n**Method** : `GET`\n\n**Parameters** : \n- `platform` [string] : `uplay` (pc), `xbl` (Xbox Live) or `psn` (PlayStation Network)\n- `id` [string] : id of the player\n- `username` [string] : username of the player\n\n**Response** :\n\n```json\n{\n  \"id\": \"be3313d6-d443-4eae-818f-bb7f56837781\",\n  \"seasons\": {\n    \"20\": {\n      \"id\": 20,\n      \"name\": \"Neon Dawn\",\n      \"color\": \"#D14007\",\n      \"image\": \"https://staticctf.akamaized.net/J3yJr34U2pZ2Ieem48Dwy9uqj5PNUQTn/3vRTyOgSmwcUVxiOk60p3w/e2f41521df1f67704dae051d147a32cc/r6s-seasons-y5s4.jpg\",\n      \"regions\": {\n        \"emea\": {\n          \"region\": \"emea\",\n          \"skillMean\": 44.754280517,\n          \"skillStdev\": 4.1872731355,\n          \"current\": {\n            \"name\": \"Diamond\",\n            \"id\": 22,\n            \"mmr\": 4475,\n            \"image\": \"https://i.imgur.com/dPuxt0u.png\"\n          },\n          \"max\": {\n            \"name\": \"Diamond\",\n            \"id\": 22,\n            \"mmr\": 4669,\n            \"image\": \"https://i.imgur.com/dPuxt0u.png\"\n          },\n          \"lastMatch\": {\n            \"mmrChange\": -35,\n            \"won\": false,\n            \"skillStdevChange\": -0.0127268645\n          },\n          \"previousMmr\": 4400,\n          \"nextMmr\": 5000,\n          \"nextRankMatchesNeeded\": 15,\n          \"topRankPosition\": 0,\n          \"kills\": 365,\n          \"deaths\": 271,\n          \"wins\": 48,\n          \"losses\": 20,\n          \"matches\": 68,\n          \"abandons\": 1,\n          \"updateTime\": \"2021-01-16T19:06:55.075000+00:00\"\n        }\n      }\n    }\n  }\n}\n```\n\n## Get stats\n\nGets general stats of a player.\n\n**URLS** : \n- `/{platform}/stats/id/{id}`\n- `/{platform}/stats/username/{username}`\n\n**Method** : `GET`\n\n**Parameters** : \n- `platform` [string] : `uplay` (pc), `xbl` (Xbox Live) or `psn` (PlayStation Network)\n- `id` [string] : id of the player\n- `username` [string] : username of the player\n\n**Response** :\n\n```json\n{\n  \"id\": \"be3313d6-d443-4eae-818f-bb7f56837781\",\n  \"pvp\": {\n    \"weapons\": {},\n    \"operators\": {},\n    \"general\": {},\n    \"modes\": {},\n    \"queue\": {},\n  },\n  \"pve\": {\n    \"weapons\": {},\n    \"operators\": {},\n    \"general\": {},\n    \"modes\": {},\n    \"types\": {},\n  }\n}\n```\n\n## Get servers status\n\nGets Rainbow Six Siege servers status.\n\n**URL** : `/status`\n\n**Method** : `GET`\n\n**Response** :\n\n```json\n{\n  \"PC\": {\n    \"AppID \": \"e3d5ea9e-50bd-43b7-88bf-39794f4e3d40\",\n    \"MDM\": \"4073\",\n    \"SpaceID\": \"5172a557-50b5-4665-b7db-e3f2e8c5041d\",\n    \"Category\": \"Instance\",\n    \"Name\": \"Rainbow Six Siege - PC - LIVE\",\n    \"Platform\": \"PC\",\n    \"Status\": \"Online\",\n    \"Maintenance\": null,\n    \"ImpactedFeatures\": []\n  },\n  \"PS4\": {\n    \"AppID \": \"fb4cc4c9-2063-461d-a1e8-84a7d36525fc\",\n    \"MDM\": \"14922\",\n    \"SpaceID\": \"05bfb3f7-6c21-4c42-be1f-97a33fb5cf66\",\n    \"Category\": \"Instance\",\n    \"Name\": \"Rainbow Six Siege - PS4 - LIVE\",\n    \"Platform\": \"PS4\",\n    \"Status\": \"Online\",\n    \"Maintenance\": null,\n    \"ImpactedFeatures\": []\n  },\n  \"XBOX\": {\n    \"AppID \": \"4008612d-3baf-49e4-957a-33066726a7bc\",\n    \"MDM\": \"4075\",\n    \"SpaceID\": \"98a601e5-ca91-4440-b1c5-753f601a2c90\",\n    \"Category\": \"Instance\",\n    \"Name\": \"Rainbow Six Siege - XBOXONE - LIVE\",\n    \"Platform\": \"XBOXONE\",\n    \"Status\": \"Online\",\n    \"Maintenance\": null,\n    \"ImpactedFeatures\": []\n  }\n}\n```\n\n## Get username\n\nGets the username of a player from their id.\n\n**URL** : `/{platform}/username/{id}`\n\n**Method** : `GET`\n\n**Parameters** : \n- `platform` [string] : `uplay` (pc), `xbl` (Xbox Live) or `psn` (PlayStation Network)\n- `id` [string] : id of the player\n\n**Response** :\n\n```json\n{\n  \"id\": \"be3313d6-d443-4eae-818f-bb7f56837781\",\n  \"userid\": \"be3313d6-d443-4eae-818f-bb7f56837781\",\n  \"username\": \"Godly\",\n  \"platform\": \"uplay\"\n}\n```\n\n# TODO\n\n* More stats routes, split data in routes\n* Tests 😭\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpololacoste%2Fr6-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpololacoste%2Fr6-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpololacoste%2Fr6-api/lists"}