Skip to main content
GET
/
player
/
search
Search for Players
curl --request GET \
  --url https://api.example.com/player/search
{
  "params": {
    "count": 123,
    "query": "<string>"
  },
  "results": [
    {
      "membershipId": "<string>",
      "membershipType": 123,
      "iconPath": "<string>",
      "displayName": "<string>",
      "bungieGlobalDisplayName": "<string>",
      "bungieGlobalDisplayNameCode": "<string>",
      "lastSeen": "<string>",
      "isPrivate": true,
      "cheatLevel": 123
    }
  ],
  "QueryValidationError": {
    "issues": [
      {}
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Raid-Hub/API/llms.txt

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

Search for players in the RaidHub database by Bungie name or platform display name. Players who have not attempted a raid may not appear in the search results. Results are ordered by a combination of the number of raid completions and last played date.

Query Parameters

query
string
required
The search query string. Minimum 1 character, maximum 40 characters.
count
integer
default:"20"
Number of results to return. Minimum 1, maximum 50.
membershipType
integer
default:"-1"
Filter by Destiny membership type. Defaults to -1 (all platforms).The membership type of an account is determined by the platform the account was first created on.Valid values:
  • -1: All platforms
  • 1: Xbox
  • 2: PlayStation
  • 3: Steam
  • 4: Blizzard (deprecated)
  • 5: Stadia (deprecated)
  • 6: Epic Games Store
global
boolean
default:"true"
Search by Bungie global name. Set to false to search by platform-specific display name instead.

Response

params
object
Search parameters used in the query.
results
array
Array of player information objects matching the search query.

Example Request

curl -X GET "https://api.raidhub.io/player/search?query=Newo&count=10" \
  -H "X-API-Key: your_api_key_here"

Example Response

{
  "minted": "2026-03-03T12:34:56.789Z",
  "success": true,
  "response": {
    "params": {
      "count": 10,
      "query": "Newo"
    },
    "results": [
      {
        "membershipId": "4611686018488107374",
        "membershipType": 3,
        "iconPath": "/common/destiny2_content/icons/93844c8b76ea80683a880479e3506980.jpg",
        "displayName": "xx_newo_xx",
        "bungieGlobalDisplayName": "Newo",
        "bungieGlobalDisplayNameCode": "9010",
        "lastSeen": "2021-05-01T00:00:00.000Z",
        "isPrivate": false,
        "cheatLevel": 0
      }
    ]
  }
}

Error Responses

QueryValidationError
object
Returned when query parameters are invalid.

Example Error Response

{
  "minted": "2026-03-03T12:34:56.789Z",
  "success": false,
  "code": "QueryValidationError",
  "error": {
    "issues": [
      {
        "code": "too_small",
        "message": "String must contain at least 1 character(s)",
        "path": ["query"]
      }
    ]
  }
}

Use Cases

  • Player lookup: Search for players by their Bungie name or legacy platform name
  • Autocomplete: Implement search-as-you-type functionality
  • Player verification: Confirm a player exists in the RaidHub database before fetching detailed stats
  • Multi-platform search: Find players across all Destiny 2 platforms