Skip to main content

Endpoint

instanceId
string
required
The unique identifier for the activity instance. This is a 64-bit integer represented as a string.
GET /instance/{instanceId}

Description

Returns a PGCR (Post Game Carnage Report) object with a shape more aligned with how RaidHub displays PGCRs. This endpoint provides comprehensive information about a raid or dungeon instance, including all players who participated, their individual statistics, weapons used, and activity metadata.
This endpoint replaces the deprecated /activity endpoint. Use /instance for all new implementations.

Response

instanceId
string
required
The unique instance identifier (64-bit integer as string)
hash
integer
required
The Bungie.net activity hash (uint32)
completed
boolean
required
Whether the activity was successfully completed
flawless
boolean | null
required
Whether the activity was completed flawlessly (no deaths). Null if not applicable.
fresh
boolean | null
required
Whether this was a fresh run (started from the beginning). Null if not applicable.
playerCount
integer
required
Number of players who participated (minimum 1)
skullHashes
array
required
Array of modifier hashes applied to the activity. Each hash maps to a FeatDefinition by its skullHash.
score
integer
required
The final score achieved in the activity (minimum 0)
dateStarted
string
required
ISO 8601 timestamp when the activity started
dateCompleted
string
required
ISO 8601 timestamp when the activity completed
season
integer
required
The Destiny 2 season number when this instance occurred (minimum 1)
duration
integer
required
Total activity duration in seconds (minimum 1)
platformType
integer
required
The platform type. If all players are on the same platform, this will be the platform type (1=Xbox, 2=PSN, 3=Steam, 4=Stadia, 5=EGS, 6=BattleNet). Otherwise, it will be 0 for cross-platform.
activityId
integer
required
RaidHub’s internal activity identifier (minimum 1)
versionId
integer
required
RaidHub’s internal version identifier (minimum 1)
isDayOne
boolean
required
Whether the instance was completed before the day one end date
isContest
boolean
required
Whether the instance was completed before the contest mode end date
isWeekOne
boolean
required
Whether the instance was completed before the week one end date
isBlacklisted
boolean
required
Whether the instance is blacklisted from leaderboards
leaderboardRank
integer | null
required
The instance’s rank on the leaderboard, if applicable. Null if not ranked.
metadata
object
required
Activity metadata information
players
array
required
Array of player objects with detailed statistics

Example Request

curl -X GET "https://api.raidhub.io/instance/13526539362" \
  -H "x-api-key: YOUR_API_KEY"

Example Response

{
  "minted": "2024-03-03T12:00:00.000Z",
  "success": true,
  "response": {
    "instanceId": "13526539362",
    "hash": 1485585878,
    "completed": true,
    "flawless": false,
    "fresh": true,
    "playerCount": 6,
    "skullHashes": [],
    "score": 0,
    "dateStarted": "2024-03-03T10:30:00.000Z",
    "dateCompleted": "2024-03-03T11:45:00.000Z",
    "season": 23,
    "duration": 4500,
    "platformType": 0,
    "activityId": 9,
    "versionId": 1,
    "isDayOne": false,
    "isContest": false,
    "isWeekOne": false,
    "isBlacklisted": false,
    "leaderboardRank": 1523,
    "metadata": {
      "activityName": "Vault of Glass",
      "versionName": "Standard",
      "isRaid": true
    },
    "players": [
      {
        "playerInfo": {
          "membershipId": "4611686018488107374",
          "membershipType": 3,
          "iconPath": "/common/destiny2_content/icons/93844c8b76ea80683a880479e3506980.jpg",
          "displayName": "xx_newo_xx",
          "bungieGlobalDisplayName": "Newo",
          "bungieGlobalDisplayNameCode": "9010",
          "lastSeen": "2024-03-03T11:45:00.000Z",
          "isPrivate": false,
          "cheatLevel": 0
        },
        "completed": true,
        "isFirstClear": false,
        "sherpas": 1,
        "timePlayedSeconds": 4500,
        "characters": [
          {
            "characterId": "2305843009504575107",
            "classHash": 3655393761,
            "emblemHash": 1230443376,
            "completed": true,
            "timePlayedSeconds": 4500,
            "startSeconds": 0,
            "score": 0,
            "kills": 342,
            "deaths": 8,
            "assists": 156,
            "precisionKills": 198,
            "superKills": 45,
            "grenadeKills": 23,
            "meleeKills": 12,
            "weapons": [
              {
                "weaponHash": 1541131350,
                "kills": 125,
                "precisionKills": 89
              },
              {
                "weaponHash": 2926662317,
                "kills": 98,
                "precisionKills": 67
              }
            ]
          }
        ]
      }
    ]
  }
}

Error Responses

404 - InstanceNotFoundError
object
The specified instance was not found in the RaidHub database.

Notes

  • Response is cached for 5 minutes (300 seconds)
  • After returning the response, the API queues background jobs to update missing character data
  • The first 12 players are also queued for profile updates
  • All timestamps are in ISO 8601 format with timezone
  • BigInt values (instanceId, characterId, membershipId) are serialized as strings

Build docs developers (and LLMs) love