Interactive API documentation with live test endpoints and examples
Complete reference of all available API endpoints with methods, parameters, and examples.
In addition to the API endpoints below, the following web interface routes are available:
/?type={type} - Filter homepage by package type (e.g., /?type=game)/{org}/ - View organization profile and packages (e.g., /facepunch/)/{org}/{package}/ - View package details (e.g., /facepunch/flatgrass/)/t/{type}/?tags={tag} - Filter by type and tag (e.g., /t/game/?tags=community)Retrieve a paginated list of all available packages with basic information.
| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | No | Page number (1-based) |
Click "Test Endpoint" to see live data
Search for packages using keywords and filters with pagination.
| Parameter | Type | Required | Description |
|---|---|---|---|
| q | string | No | Search query string |
| type | string | No | Filter by package type (e.g., game, map, model) |
| page | integer | No | Page number (1-based) |
GET /api.php/packages/search?q=zombie&type=game
GET /api.php/packages/search?type=map&page=2
Click "Test Endpoint" to see live data
Retrieve detailed information about a specific package including metadata, stats, and versions.
| Parameter | Type | Required | Description |
|---|---|---|---|
| ident | string | Yes | Package identifier in format org.name (e.g., facepunch.flatgrass) |
GET /api.php/package?ident=facepunch.sandbox
Click "Test Endpoint" to see live data
Retrieve version history and changelog for a package.
| Parameter | Type | Required | Description |
|---|---|---|---|
| package | string | Yes | Package identifier in format org.name |
Click "Test Endpoint" to see live data
Retrieve paginated reviews and ratings for a specific package.
| Parameter | Type | Required | Description |
|---|---|---|---|
| package | string | Yes | Package identifier in format org.name |
| skip | integer | No | Number of items to skip (default: 0) |
| take | integer | No | Number of items to return (default: 10, max: 100) |
Click "Test Endpoint" to see live data
Retrieve detailed usage statistics for a specific package.
| Parameter | Type | Required | Description |
|---|---|---|---|
| package | string | Yes | Package identifier in format org.name |
Click "Test Endpoint" to see live data
Retrieve all game-type packages with pagination.
| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | No | Page number (1-based) |
| count | integer | No | Items per page (default: 20, max: 100) |
Click "Test Endpoint" to see live data
Retrieve all addon-type packages with pagination.
| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | No | Page number (1-based) |
| count | integer | No | Items per page (default: 20, max: 100) |
Click "Test Endpoint" to see live data
Retrieve all map-type packages with pagination.
| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | No | Page number (1-based) |
| count | integer | No | Items per page (default: 20, max: 100) |
Click "Test Endpoint" to see live data
Retrieve all model-type packages with pagination.
| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | No | Page number (1-based) |
| count | integer | No | Items per page (default: 20, max: 100) |
Click "Test Endpoint" to see live data
Retrieve all material-type packages with pagination.
| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | No | Page number (1-based) |
| count | integer | No | Items per page (default: 20, max: 100) |
Click "Test Endpoint" to see live data
Retrieve all library-type packages with pagination.
| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | No | Page number (1-based) |
| count | integer | No | Items per page (default: 20, max: 100) |
Click "Test Endpoint" to see live data
Retrieve all prefab-type packages with pagination.
| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | No | Page number (1-based) |
| count | integer | No | Items per page (default: 20, max: 100) |
Click "Test Endpoint" to see live data
Retrieve all collection-type packages with pagination.
| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | No | Page number (1-based) |
| count | integer | No | Items per page (default: 20, max: 100) |
Click "Test Endpoint" to see live data
Retrieve all texture-type packages with pagination.
| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | No | Page number (1-based) |
| count | integer | No | Items per page (default: 20, max: 100) |
Click "Test Endpoint" to see live data
Retrieve all shader-type packages with pagination.
| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | No | Page number (1-based) |
| count | integer | No | Items per page (default: 20, max: 100) |
Click "Test Endpoint" to see live data
Retrieve detailed profile and statistics for a player using their SteamID64.
| Parameter | Type | Required | Description |
|---|---|---|---|
| steamid | string | Yes | SteamID64 of the player (e.g., 76561197991348132) |
GET /api.php/player?steamid=76561197991348132
Click "Test Endpoint" to see live data
Retrieve all package news and updates from organizations with pagination.
| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | No | Page number (1-based) |
| count | integer | No | Items per page (default: 20, max: 100) |
Click "Test Endpoint" to see live data
Retrieve news and updates from a specific organization.
| Parameter | Type | Required | Description |
|---|---|---|---|
| org | string | Yes | Organization name (e.g., facepunch, nightstudio) |
GET /api.php/news/org?org=facepunch
GET /api.php/news/org?org=nightstudio
Click "Test Endpoint" to see live data
Retrieve a list of available avatar images and their metadata.
Click "Test Endpoint" to see live data
Retrieve global platform statistics including package counts, user counts, and activity metrics.
Click "Test Endpoint" to see live data
Check the health and status of the API service.
Click "Test Endpoint" to see live data