GameAPI Documentation

Game Intelligence API — real-time friction detection, signal analysis, and resolution intelligence for games.

Base URL https://api.gameapi.co.uk

Overview

GameAPI provides a REST API for monitoring game performance issues, detecting player friction, and delivering real-time intelligence. All responses are JSON.

All endpoints use https://api.gameapi.co.uk as the base URL. Append the path shown in each endpoint section.

Authentication

Most endpoints require an API key. Include it as an X-API-Key header with every request:

curl https://api.gameapi.co.uk/v1/status \
  -H "X-API-Key: gapi_your_key_here"

Key Format

All API keys are prefixed with gapi_ followed by a base64url-encoded token. Keys are hashed server-side — if you lose your key, you'll need to register a new one or rotate.

Rate Limits

Rate limits are based on your plan tier:

Tier	Requests / Minute
Starter	10
Pro	30
Business	60
Enterprise	Custom

When rate-limited, the API returns 429 Too Many Requests.

Error Handling

All errors follow a consistent format:

{
  "error": "Description of what went wrong"
}

Code	Meaning
`400`	Bad request — missing or invalid parameters
`401`	Unauthorized — invalid or missing API key
`403`	Forbidden — insufficient scope
`404`	Not found
`429`	Rate limited
`500`	Server error

Register API Key

POST /v1/auth/register

🟢 Public — no auth required

Request Body

Field	Type	Required	Description
`email`	string	Yes	Owner's email address
`owner_type`	string	No	developer, studio, platform (default: developer)
`scopes`	array	No	Requested scopes (default: read-only)

Response

{
  "key_id": "key_a1b2c3d4e5f6g7h8",
  "api_key": "gapi_xxxxxxxxxxxxxxxxxxxxxxx",
  "owner_type": "developer",
  "rate_limit_tier": "starter",
  "message": "Store this key securely — it cannot be retrieved later."
}

Key Info

GET /v1/auth/me

Get information about the authenticated API key.

🔑 Requires API key

Rotate Key

POST /v1/auth/rotate

Generate a new key, invalidating the old one. Returns the new raw key.

🔑 Requires API key

Revoke Key

DELETE /v1/auth/revoke

Permanently revoke the authenticated API key.

🔑 Requires API key

Platform Status

GET /v1/status

Platform health including active signals, tracked games, and processing stats.

🔑 Requires API key • Rate limited

Response

{
  "platform": "GameAPI",
  "version": "1.0",
  "status": "operational",
  "signals_active": 142,
  "games_tracked": 87,
  "processing_24h": 2340
}

Live Hotspots

GET /v1/live/hotspots

Active friction hotspots across all tracked games. Returns the top issues sorted by severity.

🔑 Requires API key • Rate limited

Active Signals

GET /v1/signals/active

Raw signal data — friction events, trends, and severity scores.

🔑 Requires API key • Scope: read:signals

Friction Scan

POST /v1/friction/scan

Analyze friction for a specific game. Returns current issues, severity, and player sentiment index (PSI).

🔑 Requires API key • Rate limited

Request Body

Field	Type	Required	Description
`game`	string	Yes	Game name or ID
`platform`	string	No	Filter by platform (pc, ps5, xbox, switch, mobile)
`friction_types`	array	No	Filter by type (crash, lag, matchmaking, etc.)

Response

{
  "game": "Fortnite",
  "game_id": "game_fn_001",
  "signals": [
    {
      "friction_type": "matchmaking",
      "severity": 7.2,
      "psi": -3.8,
      "volume": 1240,
      "trend": "rising",
      "summary": "Extended queue times in ranked mode..."
    }
  ],
  "confidence": 0.89
}

Solve

POST /v1/solve

Match known solutions to a game's friction issues. Returns fix recommendations and estimated resolution times.

🔑 Requires API key • Rate limited

Device Optimize

POST /v1/device/optimize

Handheld/mobile optimization recommendations based on device profile and game requirements.

🔑 Requires API key • Rate limited

Event Ingest

POST /v1/events/ingest

Ingest a raw friction event from an external source (news, forums, social media). Processed by the GameAPI engine.

🔑 Requires API key • Scope: ingest

Dev Telemetry

POST /v1/dev/friction

Submit developer-side telemetry — crash logs, retry counts, and location data for games you publish.

🔑 Requires API key • Rate limited

Create Webhook

POST /v1/webhooks

🔑 Requires API key • Scope: webhooks:manage

Request Body

Field	Type	Required	Description
`endpoint_url`	string	Yes	HTTPS URL to receive events
`events`	array	Yes	Event types: signal.new, signal.resolved, hotspot.detected

List Webhooks

GET /v1/webhooks

List all registered webhooks for your API key.

🔑 Requires API key

Delete Webhook

DELETE /v1/webhooks/{id}

Remove a webhook.

🔑 Requires API key • Scope: webhooks:manage

Test Webhook

POST /v1/webhooks/{id}/test

Send a test payload to your webhook endpoint.

🔑 Requires API key • Scope: webhooks:manage

Webhook Deliveries

GET /v1/webhooks/{id}/deliveries

View delivery history for a webhook — includes status, response codes, and timestamps.

🔑 Requires API key

Game Registry

GET /v1/games

Browse the game registry — all tracked titles with metadata.

🔑 Requires API key

POST /v1/games

🔑 Requires API key • Scope: registry:write

Discovery Queue

GET /v1/discovery

View unresolved game references detected in signals — pending review and matching.

🔑 Requires API key

CSV Import

POST /v1/import/csv

Bulk import games from a CSV file. Returns processing stats.

🔑 Requires API key • Scope: registry:write

gameapi.co.uk