Minigames

Returns information about several minigames. Unfortunately you can’t access the stats of other players, so all the requests below return your own (the account who authorized the requests) statistics.

Darts

GET /games/gtav/api/minigames/sport?minigame=darts&slot=Freemode

Example request:

GET /games/gtav/api/minigames/sport?minigame=darts&slot=Freemode HTTP/1.1
Host: socialclub.rockstargames.com

Example response (full):

{
  "sl_translate": "NameLocalised,DisplayName,Description,Value",
  "sl_path_variant": "Minigames/MinigameGroup/1/Minigames/0/Challenges/0/Challenge/6/DisplayName|fsShootingRange",
  "Leaderboard": {
    "Id": 190,
    "Name": "darts",
    "DisplayName": "Darts",
    "GroupName": "sport",
    "StatGroups": [
      {
        "Stats": [
          {
            "Name": "NUM_BULLS_EYE",
            "Value": "N/A",
            "NameLocalised": "Number of bullseyes"
          },
          {
            "Name": "NUM_180S",
            "Value": "N/A",
            "NameLocalised": "Number of 180's"
          },
          {
            "Value": "N/A",
            "NameLocalised": "Won / Lost"
          }
        ]
      }
    ],
    "HasMedals": true,
    "Medals": {}

Query Parameters:  

• slot – needs to be Freeroam

Arm wrestling

GET /games/gtav/api/minigames/sport?minigame=armwrestling&slot=Freemode

Example request:

GET /games/gtav/api/minigames/sport?minigame=armwrestling&slot=Freemode HTTP/1.1
Host: socialclub.rockstargames.com

Example response (full):

{
  "sl_translate": "NameLocalised,DisplayName,Description,Value",
  "sl_path_variant": "Minigames/MinigameGroup/1/Minigames/0/Challenges/0/Challenge/6/DisplayName|fsShootingRange",
  "Leaderboard": {
    "Id": 749,
    "Name": "armwrestling",
    "GroupName": "sport",
    "StatGroups": [
      {
        "Stats": [
          {
            "Name": "WIN_STREAK",
            "Value": "1",
            "NameLocalised": "Winning streak"
          },
          {
            "Name": "FASTEST_WIN_TIME",
            "Value": "00:02.845",
            "NameLocalised": "Fastest win time"
          },
          {
            "Value": "1 / 0",
            "NameLocalised": "Won / Lost"
          }
        ]
      }
    ],
    "HasMedals": true,
    "Medals": {}
  },

Query Parameters:  

• slot – needs to be Freeroam

Flight school

GET /games/gtav/api/minigames/sport?minigame=flightschool&slot=Freemode

Example request:

GET /games/gtav/api/minigames/sport?minigame=flightschool&slot=Freemode HTTP/1.1
Host: socialclub.rockstargames.com

Example response (full):

{
  "sl_translate": "NameLocalised,DisplayName,Description,Value",
  "sl_path_variant": "Minigames/MinigameGroup/1/Minigames/0/Challenges/0/Challenge/6/DisplayName|fsShootingRange",
  "Leaderboard": {
    "Id": 965,
    "Name": "flightschool",
    "GroupName": "activity",
    "StatGroups": [
      {
        "Stats": []
      }
    ],
    "HasMedals": true,
    "Medal": "",
    "Medals": {
      "Medal": [
        {
          "Type": "gold",
          "Value": "00:58.000"
        },
        {
          "Type": "silver",
          "Value": "01:20.000"
        },
        {
          "Type": "bronze",
          "Value": "02:00.000"
        }
      ]
    }

Query Parameters:  

• slot – needs to be Freeroam

Golf

GET /games/gtav/api/minigames/sport?minigame=golf&slot=Freemode

Example request:

GET /games/gtav/api/minigames/sport?minigame=golf&slot=Freemode HTTP/1.1
Host: socialclub.rockstargames.com

Example response (full):

{
  "sl_translate": "NameLocalised,DisplayName,Description,Value",
  "sl_path_variant": "Minigames/MinigameGroup/1/Minigames/0/Challenges/0/Challenge/6/DisplayName|fsShootingRange",
  "Leaderboard": {
    "Id": 193,
    "Name": "golf",
    "DisplayName": "Golf",
    "GroupName": "sport",
    "StatGroups": [
      {
        "Stats": [
          {
            "Name": "HOLE_1_DRIVE",
            "Value": "214.00 yd",
            "NameLocalised": "Drive Distance"
          },
          {
            "Name": "HOLE_1_PUTT",
            "Value": "10.00 ft",
            "NameLocalised": "Putt Distance"
          },
          {
            "Name": "HOLE_1_SHOTS",
            "Value": "7",
            "NameLocalised": "Number of shots"
          }
        ]
      },
      {
        "Stats": [

Query Parameters:  

• slot – needs to be Freeroam

Tennis

GET /games/gtav/api/minigames/sport?minigame=tennis&slot=Freemode

Example request:

GET /games/gtav/api/minigames/sport?minigame=tennis&slot=Freemode HTTP/1.1
Host: socialclub.rockstargames.com

Example response (full):

{
  "sl_translate": "NameLocalised,DisplayName,Description,Value",
  "sl_path_variant": "Minigames/MinigameGroup/1/Minigames/0/Challenges/0/Challenge/6/DisplayName|fsShootingRange",
  "Leaderboard": {
    "Id": 283,
    "Name": "tennis",
    "DisplayName": "Tennis",
    "GroupName": "sport",
    "StatGroups": [
      {
        "Stats": [
          {
            "Name": "MATCHES_WON",
            "Value": "0",
            "NameLocalised": "Matches won"
          },
          {
            "Name": "NUMBER_ACES",
            "Value": "1",
            "NameLocalised": "Number of aces"
          },
          {
            "Value": "0 / 6",
            "NameLocalised": "Won / Lost"
          }
        ]
      }
    ],
    "HasMedals": true,
    "Medals": {}

Query Parameters:  

• slot – needs to be Freeroam