Wiki Navigation

API Reference
Read Only

Workshop Mods API

Query Steam Workshop mods for DayZ. Access mod metadata including names, descriptions, subscription counts, and Steam Workshop IDs.

Authentication required: All endpoints require a valid Bearer token. See Authentication for details.

GET

List Workshop Mods

Retrieve a paginated list of Steam Workshop mods, sorted by subscription count.

Endpoint

GET /api/workshop-mod

Query Parameters

like string

Filter mods by name using partial match.

workshop_id string

Filter by exact Steam Workshop ID.

amount integer

Results per page (default: 30).

Response

{
  "current_page": 1,
  "data": [
    {
      "id": 1,
      "workshop_id": "2116157322",
      "app_id": "221100",
      "name": "CF",
      "description": "Community Framework for DayZ...",
      "url": "https://steamcommunity.com/sharedfiles/filedetails/?id=2116157322",
      "file_size": 1234567,
      "subscriptions": 500000,
      "favorited": 25000,
      "views": 1500000,
      "vote_score": 0.95,
      "last_updated": "2025-01-15T12:00:00.000000Z"
    }
  ],
  "per_page": 30,
  "total": 150
}
GET

Get Workshop Mod

Retrieve a specific workshop mod by its database ID.

Endpoint

GET /api/workshop-mod/{id}

Response Fields

workshop_id

Steam Workshop file ID

app_id

Steam App ID (221100 for DayZ)

name

Mod display name

subscriptions

Total subscriber count

vote_score

Rating score (0.0-1.0)

last_updated

Last update timestamp

Pro Tips

Use the workshop_id filter to look up specific mods by their Steam Workshop ID. Results are sorted by subscription count by default, showing the most popular mods first. The url field links directly to the Steam Workshop page.