API reference
SEARCH GAMES · READ VERIFIED COMPRESSION STATS
Base URL
https://cx-api.coreutils.app/v1
1 · Search for games
Search for games by partial or full name match.
GET/search
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Partial or full name of the game |
Response · 200 OK
[
{
"app_id": "1091500",
"app_name": "Cyberpunk 2077",
"storefront": "steam",
"available_providers": ["fastest", "balanced", "slow", "slowest"]
}
]
Error · 400
{ "error": "Missing required query parameter: name" }
Notes
- Search is case-insensitive and matches partial names.
- Results are grouped by
app_id,app_name, andstorefront. - Providers map to SNUG levels:
fastest= Fastest,balanced= Balanced,slow= Smaller,slowest= Smallest.
2 · Get compression stats
Retrieve averaged compression statistics for a specific game, storefront, and provider.
GET/stats
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
appId | string | Yes | Unique identifier of the game |
storefront | string | Yes | Storefront (e.g. steam, epic) |
provider | string | Yes | Compression provider (e.g. balanced) |
Response · 200 OK
{
"app_name": "Cyberpunk 2077",
"avg_uncompressed_size": 68719476736,
"avg_compressed_size": 45097156608,
"avg_compression_ratio": 1.52,
"avg_space_saved_percentage": 34.38,
"sample_count": 1000,
"oldest_sample": "2023-01-01T00:00:00Z",
"newest_sample": "2023-12-31T23:59:59Z"
}
Error · 400 / 404
{ "error": "Missing required query parameters: appId, storefront, and provider" }
{ "error": "Invalid storefront or provider" }
{ "message": "No data found for the specified parameters" }
Notes
storefrontandproviderare case-insensitive.- Use the
appIdreturned by/search. - Statistics are averaged across all samples for the given combination.
- Sizes are in bytes — convert to GB/TB for display.
Rate limiting
The API is rate limited for fair usage. Get in touch if you plan heavy use.
Errors
Standard HTTP status codes indicate success or failure. Errors return a JSON body with an error (or message) field describing the issue.
Support
Questions about the API? Email [email protected].