Skip to main content

Game Object

idinteger<int32>

Unique game id.

Example: 2
statusGame Status Enum (integer)

Status of the game (see status and visibility for details)

Enum ValueDescription
NOT_ACCEPTED (0)Not accepted.
ACCEPTED (1)Accepted and live.
DELETED (3)Deleted.

Possible values: [0, 1, 3]

Default value: 1
Example: 1
submitted_byobjectdeprecated

Value will always be an empty object, this will be removed in subsequent API version.

Example: null
date_addedinteger<int32>

Unix timestamp of date game was registered.

Example: 1493702614
date_updatedinteger<int32>

Unix timestamp of date game was updated.

Example: 1499410290
date_liveinteger<int32>

Unix timestamp of date game was set live.

Example: 1499841403
presentation_optionGame Presentation Enum (integer)

Presentation style used on the mod.io website.

Enum ValueDescription
GRID (0)Grid View: Displays mods in a grid
TABLE (1)Table View: Displays mods in a table

Possible values: [0, 1]

Example: 0
submission_optionSubmission Options Enum (integer)

Submission process modders must follow.

Enum ValueDescription
CONTROLLED (0)Mod uploads must occur via the API using a tool created by the game developers
ALL (1)Mod uploads can occur from anywhere, including the website and API

Possible values: [0, 1]

Example: 0
dependency_optionDependency Enum (integer)

Dependency option for this game's mods.

Enum ValueDescription
DISALLOW_DEPENDENCIES (0)Disallow dependencies
ALLOW_DEPENDENCIES_OPT_IN (1)Allow dependencies, mods must opt in
ALLOW_DEPENDENCIES_OPT_OUT (2)Allow dependencies, mods must opt out
ALLOW_DEPENDENCIES (3)Allow dependencies with no restrictions

Possible values: [0, 1, 2, 3]

Example: 0
curation_optionCuration Enum (integer)

Curation option enabled by this game to approve mods.

Enum ValueDescription
DISABLED (0)Disabled
MARKETPLACE_QUEUE (1)Marketplace queue
LIVE_REQUIRES_APPROVAL (2)Live requires approval

Possible values: [0, 1, 2]

Example: 0
community_optionsGame Community Option Enum (integer)

Community features enabled for this game. Add the options you want together, to enable multiple features (see BITWISE fields)

Enum ValueDescription
DISABLED (0)None
ALLOW_MOD_COMMENTS (1)Allow comments on mods
GUIDES (2)Allow guides
PIN_HOMEPAGE (4)Pin on homepage
SHOW_ON_HOMEPAGE (8)Show on homepage
SHOW_MORE_ON_HOMEPAGE (16)Show more on homepage
CAN_CHANGE_STATUS (32)Allow change status
ALLOW_PREVIEWS (64)Enable Previews (Game must be hidden)
ALLOW_PREVIEW_URL (128)Allow preview share-URL (Previews must be enabled)
ALLOW_NEGATIVE_RATINGS (256)Allow negative ratings
ALLOW_MODS_TO_BE_EDITED_VIA_WEB (512)Allow mods to be edited via web
ALLOW_DEPENDENCY (1024)Allow mod dependencies
ALLOW_GUIDE_COMMENTS (2048)Allow comments on guides

Possible values: [0, 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048]

Example: 0
monetization_optionsMonetization Permission Enum (integer)

Monetization options enabled for this game. Add the options you want together, to enable multiple features (see BITWISE fields)

Enum ValueDescription
DISABLED (0)Access to monetization features disabled
MONETIZATION (1)Access to monetization features enabled by mod.io
MARKETPLACE (2)Marketplace enabled
PARTNER_PROGRAM (4)Creator partner program enabled
LIMITED (8)Quantity limited mods supported
FORCED_LIMITED (16)All mods must be quantity limited

Possible values: [0, 1, 2, 4, 8, 16]

revenue_optionsinteger<int32>deprecated

Please use monetization_options instead, this will be removed in subsequent API version.

Example: 0
limit_collection_modsinteger<int32>

The default limit of mods allowed within a collection.

Example: 100
cloud_cooking_statusCloud Cooking Enum (integer)

Cloud Cooking status for this game

Enum ValueDescription
CLOUD_COOKING_DISABLED (0)Cloud Cooking disabled
CLOUD_COOKING_INITIALIZING (1)Cloud Cooking initializing
CLOUD_COOKING_INITIALIZED (2)Cloud Cooking initialized
CLOUD_COOKING_FINALIZING (3)Cloud Cooking finalizing
CLOUD_COOKING_ENABLED (4)Cloud Cooking finalized
CLOUD_COOKING_ACTION_REQUIRED (5)Cloud cooking action required

Possible values: [0, 1, 2, 3, 4, 5]

Default value: 0
Example: 0
monetization_team object

The monetization team for this resource. Game Monetization Team Object.

team_idinteger<int32>

The ID of the monetization team.

Example: 1
max_stockinteger<int32>

Max Stock for limited mods.

Example: 8388607
api_access_optionsApi Access Enum (integer)

Level of API access allowed by this game. Add the options you want together, to enable multiple features (see BITWISE fields)

Enum ValueDescription
NONE (0)none
OPEN (1)Allow 3rd parties to access this games API endpoints
DOWNLOADS (2)Allow mods to be downloaded directly (if disabled all download URLs will contain a frequently changing verification hash to stop unauthorized use)
AUTHORISED_DOWNLOADS (4)Requires a bearer token to be supplied when attempting the download to enforce authenticated downloads only
PAID_DOWNLOADS (8)Requires a bearer token to be supplied and for the user to own the file when attempting the download

Possible values: [0, 1, 2, 4, 8]

maturity_optionsGame Maturity Enum (integer)

Mature content setup for this game.

Enum ValueDescription
MODS_DENY (0)Don't allow mature content in mods
MODS_ALLOW (1)Allow mature content in mods
ADULTS_ONLY (2)This game is for mature audiences only

Possible values: [0, 1, 2]

ugc_namestring

Word used to describe user-generated content (mods, items, addons etc).

Example: mods
token_namestring

Word used to describe the games token.

Example: MIO
icon object

Contains icon data.

filenamestring

Icon filename including extension.

Example: icon.png
originalstring

URL to the full-sized icon.

Example: https://assets.modcdn.io/images/placeholder/icon.png
thumb_64x64string

URL to the small icon thumbnail.

Example: https://assets.modcdn.io/images/placeholder/icon.png
thumb_128x128string

URL to the medium icon thumbnail.

Example: https://assets.modcdn.io/images/placeholder/icon.png
thumb_256x256string

URL to the large icon thumbnail.

Example: https://assets.modcdn.io/images/placeholder/icon.png
logo object

Contains logo data.

filenamestring

Logo filename including extension.

Example: card.png
originalstring

URL to the full-sized logo.

Example: https://assets.modcdn.io/images/placeholder/card.png
thumb_320x180string

URL to the small logo thumbnail.

Example: https://assets.modcdn.io/images/placeholder/card.png
thumb_640x360string

URL to the medium logo thumbnail.

Example: https://assets.modcdn.io/images/placeholder/card.png
thumb_1280x720string

URL to the large logo thumbnail.

Example: https://assets.modcdn.io/images/placeholder/card.png
header object

Contains header data.

filenamestring

Header image filename including extension.

Example: modio-logo-bluedark.png
originalstring

URL to the full-sized header image.

Example: https://assets.modcdn.io/images/branding/modio-logo-bluedark.png
namestring

Name of the game.

Example: Rogue Knight
name_idstring

Path for the game on mod.io. For example: https://mod.io/g/__rogue-knight__

Example: rogue-knight
summarystring

Summary of the games mod support.

Example: Rogue Knight is a brand new 2D pixel platformer that supports custom levels and characters.
instructionsstring

A guide about creating and uploading mods for this game to mod.io (applicable if submission_option = 0).

Example: Instructions on the process to upload mods.
instructions_urlstring

Link to a mod.io guide, your modding wiki or a page where modders can learn how to make and submit mods to your games profile.

Example: https://www.rogue-knight-game.com/modding/getting-started
profile_urlstring

URL to the game.

Example: https://mod.io/g/rogue-knight
other_urls object[]

Creator defined URLs to share.

  • Array [
    • labelstring

    Label of the link you are sharing.

    Example: Our Steam Page
    urlstring

    The URL to be associated with the label.

    Example: https://www.steampowered.com/2348329042
  • ]
    • tag_options object[]

    Groups of tags configured by the game developer, that mods can select. Hidden tags will only be returned if show_hidden_tags is set to true. Group names and tags will be localized into the specified Accept-Language header value if provided, for a list of supported languages see Localization (Note that if a localized variant of a tag is not available it will default to English).

  • Array [
    • namestring

    Name of the tag group.

    Example: Theme
    name_localizedstring
    typestring

    Can multiple tags be selected via 'checkboxes' or should only a single tag be selected via a 'dropdown'.

    Example: checkboxes
    tagsstring[]

    Array of tags in this group.

    tags_localized object

    List of tag names and the localized variant of the tag.

    property name*string
    tag_count_map object

    List of tag names and the count of mods with these tags.

    property name*integer<int32>
    hiddenboolean

    Groups of tags flagged as 'hidden' are intended to be used for filtering (eg. game version), but should not be displayed to users. Hidden tags will only be returned if show_hidden_tags is set to true.

    Example: false
    lockedboolean

    Groups of tags flagged as 'locked' are editable only if the authenticated user is a team member of the parent game. Useful for games to tag special functionality, which users can see and filter on (eg. competition winners).

    Example: false
  • ]
    • stats object

    Contains stats data.

    game_idinteger<int32>

    Unique game id.

    Example: 2
    mods_count_totalinteger<int32>

    Available mod count for the game.

    Example: 13
    mods_downloads_todayinteger<int32>

    Last 24hours of mod downloads for the game.

    Example: 204
    mods_downloads_totalinteger<int32>

    Total mods downloaded for the game.

    Example: 27492
    mods_downloads_daily_averageinteger<int32>

    Average mods downloaded on a daily basis.

    Example: 1230
    mods_subscribers_totalinteger<int32>

    Total users who have subscribed to the mods for the game.

    Example: 16394
    date_expiresinteger<int32>

    Unix timestamp until this game's statistics are considered stale.

    Example: 1492564103
    theme object

    Contains theme variables.

    primarystring

    The primary hex color code.

    Example: #44bfd5
    darkstring

    The dark hex color code.

    Example: #2c2c3f
    lightstring

    The light hex color code.

    Example: #ffffff
    successstring

    The success hex color code.

    Example: #68D391
    warningstring

    The warning hex color code.

    Example: #d6af2e
    dangerstring

    The danger hex color code.

    Example: #ff000e
    platforms object[]

    Platforms that are supported by this title.

  • Array [
    • platformPlatform String Enum (string)

    A target platform.

    Enum ValueDescription
    ALLAll Platforms
    WINDOWSWindows
    MACMac
    LINUXLinux
    ANDROIDAndroid
    IOSIphone IOS
    XBOXONEXbox One
    XBOXSERIESXXbox Series X
    PLAYSTATION4Playstation 4
    PLAYSTATION5Playstation 5
    SWITCHSwitch
    OCULUSOculus
    SOURCESource

    Possible values: [ALL, WINDOWS, MAC, LINUX, ANDROID, IOS, XBOXONE, XBOXSERIESX, PLAYSTATION4, PLAYSTATION5, SWITCH, OCULUS, SOURCE]

    Example: PLAYSTATION5
    labelstring

    A presentable label of the platform.

    Example: PlayStation 5
    moderatedboolean

    Is this platform moderated by game admins? If false, then user submissions for the platform will be available immediately providing the game has mod curation disabled.

    Example: true
    lockedboolean

    Are users able to upload files to this platform? By default, users are able to upload to all supported platforms, platforms set to true may only be used by game admins only.

    Example: true
  • ]
    • Game Object
    {
      "id": 2,
      "status": 1,
      "date_added": 1493702614,
      "date_updated": 1499410290,
      "date_live": 1499841403,
      "presentation_option": 0,
      "submission_option": 0,
      "dependency_option": 0,
      "curation_option": 0,
      "community_options": 0,
      "monetization_options": 0,
      "limit_collection_mods": 100,
      "cloud_cooking_status": 0,
      "monetization_team": {
        "team_id": "1"
      },
      "max_stock": 8388607,
      "api_access_options": 0,
      "maturity_options": 0,
      "ugc_name": "mods",
      "token_name": "MIO",
      "icon": {
        "filename": "icon.png",
        "original": "https://assets.modcdn.io/images/placeholder/icon.png",
        "thumb_64x64": "https://assets.modcdn.io/images/placeholder/icon.png",
        "thumb_128x128": "https://assets.modcdn.io/images/placeholder/icon.png",
        "thumb_256x256": "https://assets.modcdn.io/images/placeholder/icon.png"
      },
      "logo": {
        "filename": "card.png",
        "original": "https://assets.modcdn.io/images/placeholder/card.png",
        "thumb_320x180": "https://assets.modcdn.io/images/placeholder/card.png",
        "thumb_640x360": "https://assets.modcdn.io/images/placeholder/card.png",
        "thumb_1280x720": "https://assets.modcdn.io/images/placeholder/card.png"
      },
      "header": {
        "filename": "modio-logo-bluedark.png",
        "original": "https://assets.modcdn.io/images/branding/modio-logo-bluedark.png"
      },
      "name": "Rogue Knight",
      "name_id": "rogue-knight",
      "summary": "Rogue Knight is a brand new 2D pixel platformer that supports custom levels and characters.",
      "instructions": "Instructions on the process to upload mods.",
      "instructions_url": "https://www.rogue-knight-game.com/modding/getting-started",
      "profile_url": "https://mod.io/g/rogue-knight",
      "other_urls": [
        {
          "label": "Our Steam Page",
          "url": "https://www.steampowered.com/2348329042"
        }
      ],
      "tag_options": [
        {
          "name": "Theme",
          "name_localized": "string",
          "type": "checkboxes",
          "tags": [
            "Horror"
          ],
          "tags_localized": {
            "Horror": "Horreur"
          },
          "tag_count_map": {
            "Horror": 52
          },
          "hidden": false,
          "locked": false
        }
      ],
      "stats": {
        "game_id": 2,
        "mods_count_total": 13,
        "mods_downloads_today": 204,
        "mods_downloads_total": 27492,
        "mods_downloads_daily_average": 1230,
        "mods_subscribers_total": 16394,
        "date_expires": 1492564103
      },
      "theme": {
        "primary": "#44bfd5",
        "dark": "#2c2c3f",
        "light": "#ffffff",
        "success": "#68D391",
        "warning": "#d6af2e",
        "danger": "#ff000e"
      },
      "platforms": [
        {
          "platform": "PLAYSTATION5",
          "label": "PlayStation 5",
          "moderated": true,
          "locked": true
        }
      ]
    }