Skip to main content

Mod Dependencies Object

youtubestring[]

Array of YouTube links.

sketchfabstring[]

Array of SketchFab links.

images object[]

Array of image objects (a gallery).

  • Array [
    • filenamestring

    Image filename including extension.

    Example: card.png
    originalstring

    URL to the full-sized image.

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

    URL to the image thumbnail.

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

    URL to the image thumbnail.

    Example: https://assets.modcdn.io/images/placeholder/card.png
  • ]
    • idinteger<int32>

    Unique mod id.

    Example: 2
    game_idinteger<int32>

    Unique game id.

    Example: 2
    statusStatus Enum (integer)
    Enum ValueDescription
    NOT_ACCEPTED (0)Not Accepted
    ACCEPTED (1)Accepted
    DELETED (3)Deleted

    Possible values: [0, 1, 3]

    visibleVisibility Enum (integer)
    Enum ValueDescription
    HIDDEN (0)Hidden
    PUBLIC (1)Public

    Possible values: [0, 1]

    submitted_by object

    Contains user data.

    idinteger<int32>

    Unique id of the user.

    Example: 1
    name_idstring

    Path for the user on mod.io. For example: https://mod.io/u/__name-id-here__

    Example: xant
    usernamestring

    Display name of the user.

    Example: XanT
    display_name_portalstring

    The users' display name for the targeted portal. Value will be null if no valid X-Modio-Portal portal header value is provided. For more information see Targeting a Portal.

    Example: null
    date_onlineinteger<int32>

    Unix timestamp of date the user was last online.

    Example: 1509922961
    date_joinedinteger<int32>

    Unix timestamp of date the user joined.

    Example: 1509922961
    avatar object

    Contains avatar data.

    filenamestring

    Avatar filename including extension.

    Example: avatar.png
    originalstring

    URL to the full-sized avatar.

    Example: https://assets.modcdn.io/images/placeholder/avatar.png
    thumb_50x50string

    URL to the small avatar thumbnail.

    Example: https://assets.modcdn.io/images/placeholder/avatar_50x50.png
    thumb_100x100string

    URL to the medium avatar thumbnail.

    Example: https://assets.modcdn.io/images/placeholder/avatar_100x100.png
    timezonestring

    Deprecated: No longer used and will be removed in subsequent API version.

    Example:
    languagestring

    Deprecated: No longer used and will be removed in subsequent API version. To localize the API response we recommend you set the Accept-Language header.

    Example:
    profile_urlstring

    URL to the users profile.

    Example: https://mod.io/u/xant
    date_addedinteger<int32>

    Unix timestamp of date mod was registered.

    Example: 1492564103
    date_updatedinteger<int32>

    Unix timestamp of date mod was updated.

    Example: 1499841487
    date_liveinteger<int32>

    Unix timestamp of date mod was set live.

    Example: 1499841403
    maturity_optionMod Maturity Enum (integer)

    Mature content found in this mod, this is only relevant if the parent game allows mods to be labelled as mature. Add the options you want together, to enable multiple filters (see BITWISE fields)

    Enum ValueDescription
    NONE (0)None
    ALCOHOL (1)Alcohol
    DRUGS (2)Drugs
    VIOLENT (4)Violence
    EXPLICIT (8)Explicit

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

    community_optionsMod Community Option Enum (integer)

    Community features enabled for this mod. 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
    ALLOW_PREVIEWS (64)Enable Previews (Game must be hidden)
    ALLOW_PREVIEW_URL (128)Allow preview share-URL (Previews must be enabled)
    ALLOW_DEPENDENCY (1024)Allow mod dependencies

    Possible values: [0, 1, 64, 128, 1024]

    Example: 0
    monetization_optionsMod Monetization Permission Enum (integer)

    Monetization features enabled for this mod. 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 the game for this mod
    MARKETPLACE (2)Marketplace enabled
    LIMITED (8)Quantity of this mod is limited

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

    stockinteger<int32>

    The stock of the mod. 0 is the default value, and is only used when the mod has limited quantity enabled.

    Example: 0
    priceinteger<int32>

    The price of the mod.

    Example: 0
    taxinteger

    The tax of the mod.

    Example: 0
    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
    homepage_urlstring

    Official homepage of the mod.

    Example: https://www.rogue-hdpack.com/
    namestring

    Name of the mod.

    Example: Rogue Knight HD Pack
    name_idstring

    Path for the mod on mod.io. For example: https://mod.io/g/rogue-knight/m/__rogue-knight-hd-pack__

    Example: rogue-knight-hd-pack
    summarystring

    Summary of the mod.

    Example: It's time to bask in the glory of beautiful 4k textures!
    descriptionstring

    Detailed description of the mod which allows HTML.

    Example: <p>Rogue HD Pack does exactly what you thi...
    description_plaintextstring

    description field converted into plaintext.

    Example: Rogue HD Pack does exactly what you thi...
    metadata_blobstring

    Metadata that is designed to be handled by the game client and is recommended to not be exposed to content creators when submitting their mods. Metadata can also be stored as searchable key value pairs, and to individual mod files.

    Example: rogue,hd,high-res,4k,hd textures
    profile_urlstring

    URL to the mod.

    Example: https://mod.io/g/rogue-knight/m/rogue-knight-hd-pack
    media object

    Contains mod media data.

    youtubestring[]

    Array of YouTube links.

    sketchfabstring[]

    Array of SketchFab links.

    images object[]

    Array of image objects (a gallery).

  • Array [
    • filenamestring

    Image filename including extension.

    Example: card.png
    originalstring

    URL to the full-sized image.

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

    URL to the image thumbnail.

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

    URL to the image thumbnail.

    Example: https://assets.modcdn.io/images/placeholder/card.png
  • ]
    • modfile object

    Contains modfile data.

    idinteger<int32>

    Unique modfile id.

    Example: 2
    mod_idinteger<int32>

    Unique mod id.

    Example: 2
    date_addedinteger<int32>

    Unix timestamp of date file was added.

    Example: 1499841487
    date_updatedinteger<int32>

    Unix timestamp of date file was updated.

    Example: 1499841487
    date_scannedinteger<int32>

    Unix timestamp of date file was virus scanned.

    Example: 1499841487
    virus_statusVirus Scan Status Enum (integer)

    Current virus scan status of the file. For newly added files that have yet to be scanned this field will change frequently until a scan is complete.

    Enum ValueDescription
    NOT_SCANNED (0)Not scanned
    SCANNED (1)Scan complete
    SCAN_IN_PROGRESS (2)In progress
    FILE_TOO_LARGE (3)Too large to scan
    FILE_NOT_FOUND (4)File not found
    SCAN_ERROR (5)Error Scanning

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

    virus_positiveVirus Scan Enum (integer)

    Was a virus detected.

    Enum ValueDescription
    NO_THREATS_FOUND (0)No threats detected
    THREATS_FOUND (1)Flagged as malicious
    POTENTIALLY_HARMFUL (2)Flagged as containing potentially harmful files (i.e. EXEs)

    Possible values: [0, 1, 2]

    virustotal_hashstring

    Deprecated: No longer used and will be removed in subsequent API version.

    Example:
    filesizeinteger<int32>

    Size of the file in bytes.

    Example: 15181
    filesize_uncompressedinteger<int32>

    The uncompressed filesize of the zip archive.

    Example: 16384
    filehash object

    Contains filehash data.

    md5string

    MD5 hash of the file.

    Example: 2d4a0e2d7273db6b0a94b0740a88ad0d
    filenamestring

    Filename including extension.

    Example: rogue-knight-v1.zip
    versionstring

    Release version this file represents.

    Example: 1.3
    changelogstring

    Changelog for the file.

    Example: VERSION 1.3 -- Changes -- Fixed critical castle floor bug.
    metadata_blobstring

    Metadata stored by the game developer for this file.

    Example: rogue,hd,high-res,4k,hd textures
    download object

    Contains download data.

    binary_urlstring

    URL to download the file from the mod.io CDN.

    NOTE: If the game requires mod downloads to be initiated via the API, the binary_url returned will contain a verification hash. This hash must be supplied to get the modfile, and will expire after a certain period of time. Saving and reusing the binary_url won't work in this situation given it's dynamic nature.

    Example: https://api.mod.io.dev.internal/v1/games/1/mods/1/files/1/download/c489a0354111a4d76640d47f0cdcb294
    date_expiresinteger

    Unix timestamp of when the binary_url will expire.

    Example: 1579316848
    platforms object[]

    Contains modfile platform data.

  • 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
    statusMod Platform Status Enum (integer)

    The status of the modfile for the corresponding platform.

    Enum ValueDescription
    PENDING (0)Pending
    APPROVED (1)Approved
    DENIED (2)Denied
    TARGETED (3)Targeted

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

  • ]
    • dependenciesboolean

    If the mod has any dependencies, this value will be set to true.

    Example: false
    platforms object[]

    Contains mod platform data.

  • 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
    modfile_liveinteger<int32>

    The unique id of the modfile that is currently live on the platform specified in the platform field.

    Example: 1
  • ]
    • metadata_kvp object[]

    Contains key-value metadata.

  • Array [
    • metakeystring

    The key of the key-value pair.

    Example: pistol-dmg
    metavaluestring

    The value of the key-value pair.

    Example: 800
  • ]
    • tags object[]

    Contains mod tag data.

  • Array [
    • namestring

    Tag name.

    Example: Unity
    name_localizedstring

    The localized tag name influenced by the Accept-Language header, defaults to English.

    Example: Unity
    date_addedinteger<int32>

    Deprecated: Unix timestamp of date tag was applied.

    Example: 1499841487
  • ]
    • stats object

    Contains stats data.

    mod_idinteger<int32>

    Unique mod id.

    Example: 2
    popularity_rank_positioninteger<int32>

    Current rank of the mod.

    Example: 13
    popularity_rank_total_modsinteger<int32>

    Number of ranking spots the current rank is measured against.

    Example: 204
    downloads_todayinteger<int32>

    Last 24hours of downloads for the mod.

    Example: 327
    downloads_totalinteger<int32>

    Total downloads for the mod.

    Example: 27492
    subscribers_totalinteger<int32>

    Total users who have subscribed to the mod.

    Example: 16394
    ratings_totalinteger<int32>

    Total times the mod has been rated.

    Example: 1230
    ratings_positiveinteger<int32>

    Number of positive ratings.

    Example: 1047
    ratings_negativeinteger<int32>

    Number of negative ratings.

    Example: 183
    ratings_percentage_positiveinteger<int32>

    Number of positive ratings, divided by the total ratings to determine it’s percentage score.

    Example: 91
    ratings_weighted_aggregatenumber<float>

    Overall rating of this item calculated using the Wilson score confidence interval. This column is good to sort on, as it will order items based on number of ratings and will place items with many positive ratings above those with a higher score but fewer ratings.

    Example: 87.38
    ratings_display_textstring

    Textual representation of the rating in format.

    Possible values: [Overwhelmingly Positive, Very Positive, Positive, Mostly Positive, Mixed, Negative, Mostly Negative, Very Negative, Overwhelmingly Negative, Unrated]

    Example: Very Positive
    date_expiresinteger<int32>

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

    Example: 1492564103
    dependency_depthinteger

    The depth of the dependency tree for this mod.

    Example: 0
    Mod Dependencies Object
    {
      "youtube": [
        "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
      ],
      "sketchfab": [
        "https://sketchfab.com/models/ef40b2d300334d009984c8865b2db1c8"
      ],
      "images": [
        {
          "filename": "card.png",
          "original": "https://assets.modcdn.io/images/placeholder/card.png",
          "thumb_320x180": "https://assets.modcdn.io/images/placeholder/card.png",
          "thumb_1280x720": "https://assets.modcdn.io/images/placeholder/card.png"
        }
      ],
      "id": 2,
      "game_id": 2,
      "status": 0,
      "visible": 0,
      "submitted_by": {
        "id": 1,
        "name_id": "xant",
        "username": "XanT",
        "display_name_portal": null,
        "date_online": 1509922961,
        "date_joined": 1509922961,
        "avatar": {
          "filename": "avatar.png",
          "original": "https://assets.modcdn.io/images/placeholder/avatar.png",
          "thumb_50x50": "https://assets.modcdn.io/images/placeholder/avatar_50x50.png",
          "thumb_100x100": "https://assets.modcdn.io/images/placeholder/avatar_100x100.png"
        },
        "timezone": "",
        "language": "",
        "profile_url": "https://mod.io/u/xant"
      },
      "date_added": 1492564103,
      "date_updated": 1499841487,
      "date_live": 1499841403,
      "maturity_option": 0,
      "community_options": 0,
      "monetization_options": 0,
      "stock": 0,
      "price": 0,
      "tax": 0,
      "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"
      },
      "homepage_url": "https://www.rogue-hdpack.com/",
      "name": "Rogue Knight HD Pack",
      "name_id": "rogue-knight-hd-pack",
      "summary": "It's time to bask in the glory of beautiful 4k textures!",
      "description": "<p>Rogue HD Pack does exactly what you thi...",
      "description_plaintext": "Rogue HD Pack does exactly what you thi...",
      "metadata_blob": "rogue,hd,high-res,4k,hd textures",
      "profile_url": "https://mod.io/g/rogue-knight/m/rogue-knight-hd-pack",
      "media": {
        "youtube": [
          "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
        ],
        "sketchfab": [
          "https://sketchfab.com/models/ef40b2d300334d009984c8865b2db1c8"
        ],
        "images": [
          {
            "filename": "card.png",
            "original": "https://assets.modcdn.io/images/placeholder/card.png",
            "thumb_320x180": "https://assets.modcdn.io/images/placeholder/card.png",
            "thumb_1280x720": "https://assets.modcdn.io/images/placeholder/card.png"
          }
        ]
      },
      "modfile": {
        "id": 2,
        "mod_id": 2,
        "date_added": 1499841487,
        "date_updated": 1499841487,
        "date_scanned": 1499841487,
        "virus_status": 0,
        "virus_positive": 0,
        "virustotal_hash": "",
        "filesize": 15181,
        "filesize_uncompressed": 16384,
        "filehash": {
          "md5": "2d4a0e2d7273db6b0a94b0740a88ad0d"
        },
        "filename": "rogue-knight-v1.zip",
        "version": "1.3",
        "changelog": "VERSION 1.3 -- Changes -- Fixed critical castle floor bug.",
        "metadata_blob": "rogue,hd,high-res,4k,hd textures",
        "download": {
          "binary_url": "https://api.mod.io.dev.internal/v1/games/1/mods/1/files/1/download/c489a0354111a4d76640d47f0cdcb294",
          "date_expires": 1579316848
        },
        "platforms": [
          {
            "platform": "PLAYSTATION5",
            "status": 0
          }
        ]
      },
      "dependencies": false,
      "platforms": [
        {
          "platform": "PLAYSTATION5",
          "modfile_live": 1
        }
      ],
      "metadata_kvp": [
        {
          "metakey": "pistol-dmg",
          "metavalue": "800"
        }
      ],
      "tags": [
        {
          "name": "Unity",
          "name_localized": "Unity",
          "date_added": 1499841487
        }
      ],
      "stats": {
        "mod_id": 2,
        "popularity_rank_position": 13,
        "popularity_rank_total_mods": 204,
        "downloads_today": 327,
        "downloads_total": 27492,
        "subscribers_total": 16394,
        "ratings_total": 1230,
        "ratings_positive": 1047,
        "ratings_negative": 183,
        "ratings_percentage_positive": 91,
        "ratings_weighted_aggregate": 87.38,
        "ratings_display_text": "Very Positive",
        "date_expires": 1492564103
      },
      "dependency_depth": 0
    }