Skip to main content

​
Make Your First Request

Get started with the RaidHub API by making your first request. We’ll use the status endpoint to verify the API is working.
1

Get an API key (production only)

If you’re developing locally (from localhost), you can skip this step. The API does not require authentication for development requests.
For production use, you’ll need an API key. Contact the RaidHub team to request access:
  • Join the RaidHub Discord
  • Request an API key in the developer channel
  • Provide your application’s origin domain for CORS configuration
2

Make a request to the status endpoint

Use curl to make a request to the /status endpoint:
curl https://api.raidhub.io/status
3

Examine the response

The API will return a JSON response with information about the RaidHub services:
{
  "code": "Success",
  "minted": "2026-03-03T12:00:00.000Z",
  "success": true,
  "response": {
    "AtlasPGCR": {
      "status": "Crawling",
      "medianSecondsBehindNow": 145.23,
      "estimatedCatchUpTimestamp": "2026-03-03T12:30:00.000Z",
      "latestResolvedInstance": {
        "instanceId": "12345678901234567",
        "dateCompleted": "2026-03-03T11:57:00.000Z",
        "dateResolved": "2026-03-03T11:58:00.000Z"
      }
    },
    "FloodgatesPGCR": {
      "status": "Empty",
      "incomingRate": 0.05,
      "resolveRate": 0.1,
      "backlog": 0,
      "latestResolvedInstance": null,
      "estimatedBacklogEmptied": null
    }
  }
}
All successful responses follow this format with success: true, a code, a minted timestamp, and the response data.

​
Understanding the Response

Every RaidHub API response follows a consistent format:
  • code: Response code (e.g., “Success” or error codes)
  • minted: Timestamp when the response was generated
  • success: Boolean indicating if the request succeeded
  • response: The actual data payload (only present on success)
  • error: Error details (only present on failure)

​
Next Steps

Now that you’ve made your first request, explore the API’s capabilities:

Search for Players

Find players by their Bungie name or platform display name.

View Leaderboards

Query global and raid-specific leaderboards.

Get Player Stats

Access detailed raid statistics for any player.

Authentication

Learn more about API key authentication and CORS.
Remember to keep your API key secure and never expose it in client-side code. Use environment variables or secure configuration management.

Build docs developers (and LLMs) love

Get started for freeTalk to us