API Reference
Real-time game updates, simplified. Access patch notes, sentiment analysis, and meta statistics via our REST endpoints.
Core REST Resources
Fetch structured game data with predictable, versioned endpoints. All responses return JSON with consistent envelope formatting and ISO 8601 timestamps.
GET /v2/games/{slug}/patches
Retrieve versioned patch notes for titles like `league-of-legends`, `valorant`, or `overwatch-2`. Supports filtering by `version`, `tier`, and `date_range`.
{
"data": [
{
"id": "patch_14.2",
"title": "Season 2024: Patch 14.2",
"release_date": "2024-01-10T09:00:00Z",
"changelog_url": "https://patchpulse.io/patches/lol/14.2",
"sections": ["champions", "items", "map_adjustments"]
}
],
"meta": { "total": 42, "page": 1 }
}
GET /v2/games/{slug}/sentiment
Aggregate community sentiment scores based on forum posts, Reddit threads, and Discord activity. Returns normalized values between -1.0 (highly negative) and 1.0 (highly positive).
{
"data": {
"game_slug": "valorant",
"patch": "ep9_act3",
"overall_score": 0.42,
"trend": "improving",
"breakdown": {
"balance": 0.65,
"performance": 0.18,
"content": 0.88
}
}
}
GET /v2/games/{slug}/meta
Track win rates, pick rates, and tier rankings for champions, agents, or heroes across ranked queues. Data refreshes every 4 hours.
{
"data": [
{
"entity": "Jinx",
"queue": "ranked_solo",
"win_rate": 0.512,
"pick_rate": 0.184,
"tier": "S",
"sample_size": 148203
}
]
}
Secure Access via API Keys
All requests to the PatchPulse v2 API require a valid API key passed in the `Authorization` header. Keys are scoped to your developer dashboard and rotate automatically every 90 days.
Include your key in every request using the Bearer scheme. Invalid or expired keys return a `401 Unauthorized` response with error code `AUTH_INVALID`. Store keys securely in environment variables; never commit them to public repositories.
Request Header Format
`Authorization: Bearer pk_live_8f3a9c2d1e4b5f6a7g8h9i0j`
Key Scopes
`read:patch_notes`, `read:sentiment`, `read:meta_stats`. Granular permissions prevent over-privileged access to sensitive telemetry data.
Usage Quotas & Throttling
PatchPulse enforces tiered rate limits to ensure platform stability during major release cycles. Exceeding your quota returns `429 Too Many Requests` with a `Retry-After` header.
Free tier developers receive 1,000 requests per hour with a burst limit of 10 requests per second. Pro accounts unlock 15,000 requests per hour and 50 requests per second. Enterprise plans support custom quotas up to 200,000 requests per hour. Implement exponential backoff with jitter to handle transient throttling gracefully.
Rate Limit Headers
`X-RateLimit-Limit`: Max requests allowed in window
`X-RateLimit-Remaining`: Requests left
`X-RateLimit-Reset`: Unix timestamp for window reset
Best Practices
Cache patch notes locally for 6 hours. Use webhooks for real-time updates instead of polling. Monitor dashboard metrics to avoid quota exhaustion during major release weeks.