NAV Navbar
Shell HTTP JavaScript Node.JS Python Java
  • Reference Getting Started
  • Reference Games
  • Reference Mods
  • Reference Files
  • Reference Media
  • Reference Subscribe
  • Reference Events
  • Reference Tags
  • Reference Ratings
  • Reference Metadata
  • Reference Dependencies
  • Reference Teams
  • Reference Comments
  • Reference Users
  • Reference Reports
  • Reference Me
  • Reference Response Schemas
  • Getting Started

    mod.io API v1

    Welcome to the official documentation for mod.io, an API which makes it a joy to search, sort and share mods in-game. We recommend you read our Getting Started guide to accurately and efficiently consume our REST API.

    Current version: v1

    API path: https://api.mod.io/v1

    How It Works

    Compatible with all builds of your game, mod.io operates silently in the background (without requiring your users to install another client), to give you complete control over your modding ecosystem.

    mod.io Overview.

    Implementation

    You have 3 options to get connected to the mod.io API which you can use interchangeably depending on your needs. Here's the breakdown of each option.

    Option Usage Suited for Docs
    API For connecting directly to the mod.io REST API Web apps that need a JSON REST API, or game developers that like a challenge and want control over their implementation. You are reading them
    SDK Drop our open source C/C++ SDK into your game to call mod.io functionality. Developers that want a SDK that abstracts the uploading, downloading and unzip flows behind easy to use function calls. Here
    Tools/Plugins Use tools and plugins created by the community to make implementation in various engines easy. Game developers that want a pre-built modding solution for their engine (Unity, Unreal) of choice. Available per tool

    Here is a brief list of the things to know about our API, as explained in more detail in the following sections.

    Authentication

    Authentication can be done via 3 ways:

    You can use these methods of authentication interchangably, depending on the level of access you require.

    Authentication Type In HTTP Methods Abilities Purpose
    API Key Query GET Read-only GET requests and email authentication flow. Browsing and downloading content.
    Access Token (OAuth 2) Header GET, POST, PUT, DELETE Read, create, update, delete. View, add, edit and delete content the authenticated user has subscribed to or has permission to change.

    API Key Authentication

    To access the API authentication is required. All users and games get a private API key. It is quick and easy to use in your apps but limited to read-only GET requests, due to the limited security it offers. View your private API key(s).

    Email Authentication Flow

    To perform writes, you will need to authenticate your users via OAuth 2. To make this frictionless in-game, we use an email verification system, similar to what Slack and others pioneered. It works by users supplying their email, which we send a time-limited 5 digit security code too. They exchange this code in-game, for an OAuth 2 access token you can save to authenticate future requests. The benefit of this approach is it avoids complex website redirects and doesn't require your users to complete a slow registration flow.

    mod.io Email Authentication Flow

    // Example POST requesting security code be sent to supplied email
    
    curl -X POST https://api.mod.io/v1/oauth/emailrequest \
      -H 'Content-Type: application/x-www-form-urlencoded' \
      -d 'api_key=0d0ba6756d032246f1299f8c01abc424' \
      -d 'email=john.snow@westeros.com'
    
    // Authentication Code Request Response
    
    {
        "code": 200,
        "message": "Enter the 5-digit security code sent to your email address (john.snow@westeros.com)"
    }
    

    Step 1: Requesting a security code

    Request a security_code be sent to the email address of the user you wish to authenticate:

    POST /oauth/emailrequest

    Parameter Value
    api_key Your API key generated from 'API' tab within your game profile.
    email A valid and secure email address your user has access to.

    Step 2: Exchanging security code for access token

    After retrieving the 5-digit security_code sent to the email specified, you exchange it for an OAuth 2 access_token:

    // Example POST requesting access token
    
    curl -X POST https://api.mod.io/v1/oauth/emailexchange \
      -H 'Content-Type: application/x-www-form-urlencoded' \    
      -d 'api_key=0d0ba6756d032246f1299f8c01abc424' \
      -d 'security_code=3EW50'
    
    // Access Token Request Response (access token truncated for brevity)
    
    {
        "code": 200,
        "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0......"
    }
    

    POST /oauth/emailexchange

    Parameter Value
    api_key Your API key generated from 'API' tab within your game profile.
    security_code Unique 5-digit code sent to the email address supplied in the previous request.

    There are a few important things to know when using the email authentication flow:

    If you do not exchange your security_code for an access_token within 15 minutes of generation, you will need to begin the flow again to receive another code.

    Step 3: Use access token to access resources.

    See Making Requests section.

    Scopes (OAuth 2)

    mod.io allows you to specify the permission each access token has (default is read+write), this is done by the use of scopes. See below for a full list of scopes available, you must include at least one scope when generating a new token.

    Scope Abilities
    read When authenticated with a token that only contains the read scope, you will only be able to read data via GET requests.
    write When authenticated with a token that contains the write scope, you are able to add, edit and remove resources.
    read+write The above scopes combined. Default for email verification flow.

    Making Requests

    Requests to the mod.io API must be over HTTPS (Port 443), any requests made over HTTP will return a 400 Bad Request response.

    Using an API Key

    curl -X get https://api.mod.io/v1/games?api_key=xxxxxxxxxxxxxxxx
    

    To authenticate using your unique 32-character API key, append the api_key=xxxxxxxxxxxxxxxx parameter to the end of your request. Remember that using an API key means requests are read-only, if you want to create, update or delete resources - authentication via OAuth 2 is required which you can set up with your api key.

    Using an Access Token

    To authenticate using an OAuth 2 access token, you must include the HTTP header Authorization in your request with the value Bearer your-token-here. Verification via Access Token allows much greater power including creating, updating and deleting resources that you have access to. Also because OAuth 2 access tokens are tied to a user account, you can personalize the output by viewing content they are subscribed and connected to via the me endpoint and by using relevant filters.

    // Example POST request with no binary files
    
    curl -X post https://api.mod.io/v1/games/1/mods/1/tags \
      -H 'Authorization: Bearer your-token-here' \
      -H 'Content-Type: application/x-www-form-urlencoded' \
      -d 'tags[]=Unity' \
      -d 'tags[]=FPS'
    

    Request Content-Type

    If you are making a request that includes a file, your request Content-Type header must be multipart/form-data, otherwise if the request contains data (but no files) it should be application/x-www-form-urlencoded with text encoded in UTF-8 format.

    // Example POST request with binary file
    
    curl -X post https://api.mod.io/v1/games/1/mods \
      -H 'Authorization: Bearer your-token-here' \
      -H 'Content-Type: multipart/form-data' \ 
      -F 'logo=@path/to/image.jpg' \
      -F 'name=Rogue Knight Clear Skies' \
      -F 'homepage=http://www.clearsies-rk.com/' \
      -F 'summary=It rains in Rogue Knight an awful lot, want sunshine all the time? Yeah you do.'
    
    Body Contains Method Content-Type
    Binary Files POST multipart/form-data
    Non-Binary Data POST, PUT, DELETE application/x-www-form-urlencoded
    Nothing GET No Content-Type required.

    If the endpoint you are making a request to expects a file it will expect the correct Content-Type as mentioned. Supplying an incorrect Content-Type header will return a 415 Unsupported Media Type response.

    JSON Request Data

    // Example json-encoded POST request 
    
    curl -X post https://api.mod.io/v1/games/1/team \
      -H 'Authorization: Bearer your-token-here' \
      -H 'Content-Type: application/x-www-form-urlencoded' \  
      -d 'input_json={
            "member":"patrick@diabolical.com",
            "level":"8",
            "position":"King in the North"
          }'
    

    For POST & PUT requests that do not submit files you have the option to supply your data as HTTP POST parameters, or as a UTF-8 encoded JSON object inside the parameter input_json which contains all required data. Regardless, whether you use JSON or not the Content-Type of your request still needs to be application/x-www-form-urlencoded with the data provided in the body of the request.

    NOTE: If you supply identical key-value pairs as a request parameter and also as a parameter in your JSON object, the JSON object will take priority as only one can exist.

    Response Content-Type

    Responses will always be returned as application/json.

    Errors

    // Error object
    
    "error": {
        "code": 403,
        "message": "You do not have the required permissions to access this resource."
    }
    

    If an error occurs, mod.io returns an error object with the HTTP code and message to describe what happened and when possible how to avoid repeating the error. It's important to know that if you encounter errors that are not server errors (500+ codes) - you should review the error message before continuing to send requests to the endpoint.

    When requests contain invalid input data or query parameters (for filtering), an optional field object called errors can be supplied inside the error object, which contains a list of the invalid inputs. The nested errors object is only supplied with 422 Unprocessable Entity responses. Be sure to review the Response Codes to be aware of the HTTP codes that the mod.io API returns.

    // Error object with input errors
    
    "error": {
        "code": 422,
        "message": "Validation Failed. Please see below to fix invalid input.",
        "errors": {
            "member":"The member must be an integer.",
            "name":"The name may not be greater than 50 characters."
        }
    }
    
    

    Remember that Rate Limiting applies whether an error is returned or not, so to avoid exceeding your daily quota be sure to always investigate error messages - instead of continually retrying.

    Response Codes

    Here is a list of the most common HTTP response codes you will see while using the API.

    Response Code Meaning
    200 OK -- Your request was successful.
    201 Created -- Resource created, inspect Location header for newly created resource URL.
    204 No Content -- Request was successful and there was no data to be returned.
    400 Bad request -- Server cannot process the request due to malformed syntax or invalid request message framing.
    401 Unauthorized -- Your API key/access token is incorrect.
    403 Forbidden -- You do not have permission to perform the requested action.
    404 Not Found -- The resource requested could not be found.
    405 Method Not Allowed -- The method of your request is incorrect.
    406 Not Acceptable -- You supplied or requested an incorrect Content-Type.
    410 Gone -- The requested resource is no longer available.
    422 Unprocessable Entity -- The request was well formed but unable to be followed due to semantic errors.
    429 Too Many Requests -- You have made too many requests, inspect headers for reset time.
    500 Internal Server Error -- We had a problem with our server. Try again later. (rare)
    503 Service Unavailable -- We're temporarily offline for maintenance. Please try again later. (rare)

    Response Formats

    // Single 'view' response
    
    {
        "id": 2,
        "mod": 0,
        "member": 31342,
        "date": 1492570177,
        "datevirus": 0,
        "virusstatus": 0,
        "viruspositive": 0,
        "filesize": 15181,
        "filehash": "2d4a0e2d7273db6b0a94b0740a88ad0d",
        "filename": "rogue-knight-v1.zip",
        "version": "1.0",
        "virustotal": "No threats detected.",
        "changelog": "v1.0 - First release of Rogue Knight!",
        "download": "https://mod.io/mods/file/2/c489a0354111a4dx6640d47f0cdcb294"
    }
    

    The way in which mod.io formats responses is entirely dependant on whether the requesting endpoint is returning a single item or a collection of items.

    Single item Responses

    For single items, mod.io returns a single JSON object which contains the requested resource. There is no nesting for single responses.

    Multiple item Responses

    Endpoints that return more than one result, return a JSON object which contains a data array and metadata fields:

    // Get response
    
    {
        "data": [
            {
                "id": 2,
                "mod": 2,
                "member": 31342,
                "date": 1492570177,
                "datevirus": 1492570177,
                "virusstatus": 0,
                "viruspositive": 0,
                "filesize": 15181,
                "filehash": "2d4a0e2d7273db6b0a94b0740a88ad0d",
                "filename": "rogue-knightv1.zip",
                "version": "1.0",
                "virustotal": null,
                "changelog": "v1.0 --- First Release --- Added main mod.",
                "download": "https://mod.io/mods/file/2/c489a0354111a4d76640d47f0cdcb294"
            },
            {
                ...
            },
        ],
        "result_count": 100,
    }  
    

    Status & Visibility

    To manage games and mods via the API we use the fields status and visible. The values of these fields determines what is returned in API requests, so it is important to understand who is authorized to view what content.

    Visible attribute states & privileges

    Only mods use the visible attribute allowing mod admins to control their availability. Public is the default value:

    Meaning Value Description Modify Authorization Filter Authorization
    Hidden 0 Resource is hidden and not returned when browsing.

    If requested directly it will be returned provided the user is an admin or subscribed to the content. All resources are always returned via the /me endpoints.
    Game & Mod Admins Game & Mod Admins
    Public 1 Resource is visible and returned via all endpoints. Game & Mod Admins Everyone

    Status attribute states & privileges

    Games and mods use the status attribute allowing game admins to control their availability. For mods this is important because it allows game admins to control which mods are available without changing the visible value set by the mod admin. Not accepted is the default value until changed by a game admin, or if a file is added to a mods profile it will be moved to an accepted state (provided the game developer has elected "not to curate" new mods):

    Meaning Value Description Modify Authorization Filter Authorization
    Not Accepted 0 Resource is not accepted and not returned when browsing.

    Games will be returned if requested directly provided the user is an admin or the apikey used belongs to the game.

    Mods will be returned if requested directly provided the user is an admin or subscribed to the content. All resources are always returned via the /me endpoints.
    Game Admins Only Game Admins Only
    Accepted 1 Resource is accepted and returned via all endpoints. Game Admins Only Everyone
    Archived 2 Resource is accepted and returned via all endpoints (but flagged as out of date/incompatible). Game Admins Only Everyone
    Deleted 3 Resource is deleted and only returned via the /me endpoints. Game Admins Only Game Admins Only

    Game admin privileges

    As a game admin, you can modify your games status to show or hide it from API requests. When a game is not accepted you can still view it provided you are the games admin or using the games apikey. You can call Get User Games endpoint to retrieve all games associated with the authenticated user regardless of their status.

    By default mods connected to a game will not be returned if they are hidden or not accepted. As a game admin, you can modify a mods status and visible fields and filter by these values (to view content normal users cannot see). We recommend you only change the status and let mod admins control the visible field.

    Mod admin privileges

    As a mod admin, you can modify visible to show or hide your mod from API requests. You cannot modify the status of your mod. When a mod is hidden you can still view it provided you are the mods admin or subscribed to the mod. You can call Get User Mods endpoint to retrieve all mods associated with the authenticated user regardless of their status and visible.

    Pagination

    When requesting data from endpoints that contain more than one object, you can supply an _offset and _limit to paginate through the results. Think of it as a page 1, 2, 3... system but you control the number of results per page, and the page to start from. Appended to each response will be the pagination metadata:

    // Metadata example
    "result_count": 100,
    "result_limit": 100,
    "result_offset": 0
    
    Parameter Value
    result_count Number of results returned in the current request.
    result_limit Maximum number of results returned. Defaults to 100 unless overridden by _limit.
    result_offset Number of results skipped over. Defaults to 1 unless overridden by _offset.

    _limit (Limit)

    v1/games?_limit=5
    

    Limit the number of results for a request. By default 100 results are returned per request:

    _offset (Offset)

    v1/games?_offset=30
    

    Use _offset to skip over the specified number of results, regardless of the data they contain. This works the same way offset does in a SQL query:

    Combining offset with a limit

    v1/games?_offset=30&_limit=5
    

    You can combine offset with a limit to build queries that return exactly the number of results you want:

    If the result_count parameter matches the result_limit parameter (5 in this case) in the response, that means there are probably more results to get, so our next query might be:

    Sorting

    All endpoints are sorted by the id column in ascending order by default. You can override this by including a _sort with the column you want to sort by in the request. You can sort on all columns in the parent object only. You cannot sort on columns in nested objects, so if a game contains a user you cannot sort on the username column, but you can sort by the games name since the column resides in the parent object.

    NOTE: Some endpoints like get all mods have special sort columns like popular, downloads, rating and subscribers which are documented alongside the filters.

    _sort (Sort)

    v1/games?_sort=name
    

    Sort by a column, in ascending or descending order.

    Filtering

    mod.io has powerful filtering available to assist you when making requests to the API. You can filter on all columns in the parent object only. You cannot apply filters to columns in nested objects, so if a game contains a user object you cannot filter by the username column, but you can filter by the games name since the column resides in the parent object.

    v1/games?_q=The Lord Of The Rings
    

    Full-text search is a lenient search filter that is only available if the endpoint you are querying contains a name column. Wildcards should not be applied to this filter as they are ignored.

    = (Equals)

    v1/games?id=10
    

    The simpliest filter you can apply is columnname equals. This will return all rows which contain a column matching the value provided.

    -not (Not Equal To)

    v1/games?curation-not=1
    

    Where the preceding column value does not equal the value specified.

    -lk (Like)

    v1/games?name-lk=texture
    

    Where the string supplied matches the preceding column value. This is equivalent to SQL's LIKE. Consider using wildcard's * for the best chance of results as described below.

    -not-lk (Not Like)

    v1/games?name-not-lk=dungeon
    

    Where the string supplied does not match the preceding column value. This is equivalent to SQL's NOT LIKE.

    -lk & -not-lk Wildcards

    v1/games?name-lk=The Witcher*
    
    v1/games?name-lk=*Asset Pack
    

    You can utilize the -lk wildcard value * to match more records. This is equivalent to SQL's %.

    -in (In)

    v1/games?id-in=3,11,16,29
    

    Where the supplied list of values appears in the preceding column value. This is equivalent to SQL's IN.

    -not-in (Not In)

    v1/games?modfile-not-in=8,13,22
    

    Where the supplied list of values does not equal the preceding column value. This is equivalent to SQL's NOT IN

    -max (Smaller Than or Equal To)

    v1/games?game-max=40
    

    Where the preceding column value is smaller than or equal to the value specified.

    -min (Greater Than or Equal To)

    v1/games?game-min=20
    

    Where the preceding column value is greater than or equal to the value specified.

    -st (Smaller Than)

    v1/games?modfile-st=200
    

    Where the preceding column value is smaller than the value specified.

    -gt (Greater Than)

    v1/games?modfile-gt=600
    

    Where the preceding column value is greater than the value specified.

    -bitwise-and (Bitwise AND)

    v1/games?api-bitwise-and=5
    

    Some columns are stored as bits within an integer. Their value depends on the bits selected. For example, suppose a column has 4 options:

    You can combine any of these options by adding them together which means there are (2 ^ 4 = 16 possible combinations). For example Option A (1) and Option C (4) would be (1 + 4 = 5), Option A (1), Option C (4) and Option D (8) would be (1 + 4 + 8 = 13), all Options together would be (1 + 2 + 4 + 8 = 15).

    The number of combinations makes using equals, in and other filters a little complex. To solve this we support Bitwise AND (&) which makes it easy to match a column which contains any of the Options you want.

    Localization

    Example HTTP Header Request
    ---------------------
    HTTP/1.1 200 OK
    ...
    ...
    Accept-Language: de
    
    Example response (assuming a validation error occurred)
    
    {
        "error": {
            "code": 422,
            "message": "Überprüfung fehlgeschlagen. Bitte lesen Sie unten, um ungültige Eingaben zu korrigieren:",
            "errors": {
                "name": "Name darf maximal 50 Zeichen haben."
            }
        }
    }
    

    The mod.io API provides localization for a collection of languages. To specify responses from the API to be in a particular language, simply provide the Accept-Language header with an ISO 639 compliant language code. If a valid language code is not provided and the user is authenticated, the language they have selected in their profile will be used. All other requests will default to English (US). The list of supported codes includes:

    Language Code Language
    en English (US) default
    bg Bulgarian
    fr French
    de German
    it Italian
    pl Polish
    pt Portuguese
    hu Hungarian
    ja Japanese
    ko Korean
    ru Russian
    es Spanish
    th Thai
    zh-CN Chinese (Simplified)
    zh-TW Chinese (Traditional)

    NOTE: Localization for mod.io is currently a work-in-progress and thus not all responses may be in the desired language.

    Rate Limiting

    mod.io implements rate limiting to stop users abusing the service. Exceeding your rate limit will result in requests receiving a 429 Too Many Requests response until your reset time is reached.

    It is highly recommended you architect your app to check for the X-RateLimit headers below and the 429 HTTP response code to ensure you are not making too many requests, or continuing to make requests after a 429 code is repeatedly returned. Users who continue to send requests despite a 429 response could potentially have their access tokens revoked. The following limits are implemented by default:

    API key Rate Limiting

    Example HTTP Header Response
    ---------------------
    HTTP/1.1 200 OK
    ...
    ...
    X-RateLimit-Limit: 60
    X-RateLimit-Remaining: 59
    

    OAuth2 Rate Limiting

    Headers

    mod.io returns the following headers in each request to inform you of your limit & remaining requests until reset.

    Optimize your requests

    You should always plan to minimize requests and cache API responses. It will make your app feel fluid and fast for your users. If your usage is excessive we shall reach out to discuss ways of optimizing, but our aim is to never restrict legitimate use of the API. We have set high limits that should cover 99% of use-cases, and are happy to discuss your scenario if you require more.

    Testing

    To help familiarize yourself with the mod.io API and to ensure your implementation is battle-hardened and operating as intended, we have setup a test sandbox which is identical to the production environment. The test sandbox allows you to make requests to the API whilst your integration is a work in progress and the submitted data is not important. When you are ready to go live it's as easy as making sure your game's production profile and apikey is correct, and substituting the API test URL for the production URL.

    To begin using the test sandbox you will need to register a test account and add your game. You will see only games you are a team member of and there is no connection between the data added to the test environment and production. We highly recommend you use the test environment when integrating as it allows you to keep your development private, and you can submit as much dummy data as you need to try the functionality required, without having to clean it up at the end.

    Test version: v1

    Test site: https://test.mod.io

    Test API path: https://api.test.mod.io/v1

    NOTE: We periodically reset the test environment to default - with the exception of user accounts so please do not rely on it to store important information. Any data you intend on peristing should be submitted to the production environment.

    Contact

    If you spot any errors within the mod.io documentation, have feedback on how we can make it easier to follow or simply want to discuss how awesome mods are, feel free to reach out anytime to developers@mod.io. We are here to help you grow and maximise the potential of mods in your game.

    Games

    Get All Games

    Example request

    # You can also use wget
    curl -X GET https://api.mod.io/v1/games?api_key=YourApiKey \
      -H 'Accept: application/json'
    
    
    GET https://api.mod.io/v1/games?api_key=YourApiKey HTTP/1.1
    Host: api.mod.io
    
    Accept: application/json
    
    
    var headers = {
      'Accept':'application/json'
    
    };
    
    $.ajax({
      url: 'https://api.mod.io/v1/games',
      method: 'get',
      data: '?api_key=YourApiKey',
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    const request = require('node-fetch');
    
    const headers = {
      'Accept':'application/json'
    
    };
    
    fetch('https://api.mod.io/v1/games?api_key=YourApiKey',
    {
      method: 'GET',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    r = requests.get('https://api.mod.io/v1/games', params={
      'api_key': 'YourApiKey'
    }, headers = headers)
    
    print r.json()
    
    URL obj = new URL("https://api.mod.io/v1/games?api_key=YourApiKey");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    

    GET /games

    Get all games. Successful request will return an array of Game Objects. We recommended reading the filtering documentation to return only the records you want.

    Filter Type Description
    id integer Unique id of the game.
    status integer Status of the game (only admins can filter by this field, see status and visibility for details):

    0 = Not accepted
    1 = Accepted (default with archived)
    2 = Archived
    3 = Deleted
    submitted_by integer Unique id of the user who has ownership of the game.
    date_added integer Unix timestamp of date game was registered.
    date_updated integer Unix timestamp of date game was updated.
    date_live integer Unix timestamp of date game was set live.
    name string Name of the game.
    name_id string Subdomain for the game on mod.io.
    summary string Summary of the game.
    homepage string Official homepage of the game.
    ugc_name string Word used to describe user-generated content (mods, items, addons etc).
    presentation_option integer Presentation style used on the mod.io website:

    0 = Grid View: Displays mods in a grid
    1 = Table View: Displays mods in a table
    submission_option integer Submission process modders must follow:

    0 = Mod uploads must occur via a tool created by the game developers
    1 = Mod uploads can occur from anywhere, including the website and API
    curation_option integer Curation process used to approve mods:

    0 = No curation: Mods are immediately available to play
    1 = Paid curation: Mods are immediately available to play unless they choose to receive donations. These mods must be accepted to be listed
    2 = Full curation: All mods must be accepted by someone to be listed
    community_options integer Community features enabled on the mod.io website:

    0 = All of the options below are disabled
    1 = Discussion board enabled
    2 = Guides and news enabled
    ? = Combine to find games with multiple options enabled (see BITWISE fields)
    revenue_options integer Revenue capabilities mods can enable:

    0 = All of the options below are disabled
    1 = Allow mods to be sold
    2 = Allow mods to receive donations
    4 = Allow mods to be traded
    8 = Allow mods to control supply and scarcity
    ? = Combine to find games with multiple options enabled (see BITWISE fields)
    api_access_options integer Level of API access allowed by this game:

    0 = All of the options below are disabled
    1 = Allow 3rd parties to access this games API endpoints
    2 = Allow mods to be downloaded directly (if disabled all download URLs will contain a frequently changing verification hash to stop unauthorized use)
    ? = Combine to find games with multiple options enabled (see BITWISE fields)

    Example response

    {
      "data": [
        {
          "id": 2,
          "status": 1,
          "submitted_by": {
            "id": 1,
            "name_id": "xant",
            "username": "XanT",
            "date_online": 1509922961,
            "avatar": {
              "filename": "modio-dark.png",
              "original": "https://static.mod.io/v1/images/global/ao_modio-dark.png",
              "thumb_50x50": "https://static.mod.io/v1/images/global/modio-dark.png",
              "thumb_100x100": "https://static.mod.io/v1/images/global/am_modio-dark.png"
            },
            "timezone": "America/Los_Angeles",
            "language": "en",
            "profile_url": "https://mod.io/members/xant"
          },
          "date_added": 1493702614,
          "date_updated": 1499410290,
          "date_live": 1499841403,
          "presentation_option": 1,
          "submission_option": 0,
          "curation_option": 0,
          "community_options": 3,
          "revenue_options": 1500,
          "api_access_options": 3,
          "ugc_name": "map",
          "icon": {
            "filename": "modio-dark.png",
            "original": "https://static.mod.io/v1/images/global/ao_modio-dark.png",
            "thumb_64x64": "https://static.mod.io/v1/images/global/modio-dark.png",
            "thumb_128x128": "https://static.mod.io/v1/images/global/am_modio-dark.png",
            "thumb_256x256": "https://static.mod.io/v1/images/global/al_modio-dark.png"
          },
          "logo": {
            "filename": "modio-dark.png",
            "original": "https://static.mod.io/v1/images/global/modio-dark.png",
            "thumb_320x180": "https://static.mod.io/v1/images/global/modio-dark.png",
            "thumb_640x360": "https://static.mod.io/v1/images/global/modio-dark.png",
            "thumb_1280x720": "https://static.mod.io/v1/images/global/modio-dark.png"
          },
          "header": {
            "filename": "demo.png",
            "original": "https://static.mod.io/v1/images/global/modio-dark.png"
          },
          "homepage": "https://www.rogue-knight-game.com/",
          "name": "Rogue Knight",
          "name_id": "rogue-knight",
          "summary": "Rogue Knight is a brand new 2D pixel platformer.",
          "instructions": "Instructions on the process to upload mods.",
          "profile_url": "https://rogue-knight.mod.io",
          "tag_options": [
            {
              "name": "Theme",
              "type": "checkboxes",
              "tags": [
                "Horror"
              ],
              "hidden": false
            }
          ]
        },
        {
            ...
        }
      ],
      "result_count": 100,
      "result_limit": 100,
      "result_offset": 0
    }
    

    Responses

    Status Meaning Description Response Schema
    200 OK OK Get All Games

    Get Game

    Example request

    # You can also use wget
    curl -X GET https://api.mod.io/v1/games/{game-id}?api_key=YourApiKey \
      -H 'Accept: application/json'
    
    
    GET https://api.mod.io/v1/games/{game-id}?api_key=YourApiKey HTTP/1.1
    Host: api.mod.io
    
    Accept: application/json
    
    
    var headers = {
      'Accept':'application/json'
    
    };
    
    $.ajax({
      url: 'https://api.mod.io/v1/games/{game-id}',
      method: 'get',
      data: '?api_key=YourApiKey',
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    const request = require('node-fetch');
    
    const headers = {
      'Accept':'application/json'
    
    };
    
    fetch('https://api.mod.io/v1/games/{game-id}?api_key=YourApiKey',
    {
      method: 'GET',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    r = requests.get('https://api.mod.io/v1/games/{game-id}', params={
      'api_key': 'YourApiKey'
    }, headers = headers)
    
    print r.json()
    
    URL obj = new URL("https://api.mod.io/v1/games/{game-id}?api_key=YourApiKey");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    

    GET /games/{game-id}

    Get a game. Successful request will return a single Game Object.

    Example response

    {
      "id": 2,
      "status": 1,
      "submitted_by": {
        "id": 1,
        "name_id": "xant",
        "username": "XanT",
        "date_online": 1509922961,
        "avatar": {
          "filename": "modio-dark.png",
          "original": "https://static.mod.io/v1/images/global/ao_modio-dark.png",
          "thumb_50x50": "https://static.mod.io/v1/images/global/modio-dark.png",
          "thumb_100x100": "https://static.mod.io/v1/images/global/am_modio-dark.png"
        },
        "timezone": "America/Los_Angeles",
        "language": "en",
        "profile_url": "https://mod.io/members/xant"
      },
      "date_added": 1493702614,
      "date_updated": 1499410290,
      "date_live": 1499841403,
      "presentation_option": 1,
      "submission_option": 0,
      "curation_option": 0,
      "community_options": 3,
      "revenue_options": 1500,
      "api_access_options": 3,
      "ugc_name": "map",
      "icon": {
        "filename": "modio-dark.png",
        "original": "https://static.mod.io/v1/images/global/ao_modio-dark.png",
        "thumb_64x64": "https://static.mod.io/v1/images/global/modio-dark.png",
        "thumb_128x128": "https://static.mod.io/v1/images/global/am_modio-dark.png",
        "thumb_256x256": "https://static.mod.io/v1/images/global/al_modio-dark.png"
      },
      "logo": {
        "filename": "modio-dark.png",
        "original": "https://static.mod.io/v1/images/global/modio-dark.png",
        "thumb_320x180": "https://static.mod.io/v1/images/global/modio-dark.png",
        "thumb_640x360": "https://static.mod.io/v1/images/global/modio-dark.png",
        "thumb_1280x720": "https://static.mod.io/v1/images/global/modio-dark.png"
      },
      "header": {
        "filename": "demo.png",
        "original": "https://static.mod.io/v1/images/global/modio-dark.png"
      },
      "homepage": "https://www.rogue-knight-game.com/",
      "name": "Rogue Knight",
      "name_id": "rogue-knight",
      "summary": "Rogue Knight is a brand new 2D pixel platformer.",
      "instructions": "Instructions on the process to upload mods.",
      "profile_url": "https://rogue-knight.mod.io",
      "tag_options": [
        {
          "name": "Theme",
          "type": "checkboxes",
          "tags": [
            "Horror"
          ],
          "hidden": false
        }
      ]
    }
    

    Responses

    Status Meaning Description Response Schema
    200 OK Request successful Game Object

    Edit Game

    Example request

    # You can also use wget
    curl -X PUT https://api.mod.io/v1/games/{game-id} \
      -H 'Authorization: Bearer {access-token}' \
      -H 'Content-Type: application/x-www-form-urlencoded' \
      -H 'Accept: application/json'
    
    
    PUT https://api.mod.io/v1/games/{game-id} HTTP/1.1
    Host: api.mod.io
    
    Accept: application/json
    Authorization: Bearer {access-token}
    Content-Type: application/x-www-form-urlencoded
    
    
    
    var headers = {
      'Authorization':'Bearer {access-token}',
      'Content-Type':'application/x-www-form-urlencoded',
      'Accept':'application/json'
    
    };
    
    $.ajax({
      url: 'https://api.mod.io/v1/games/{game-id}',
      method: 'put',
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    const request = require('node-fetch');
    
    const headers = {
      'Authorization':'Bearer {access-token}',
      'Content-Type':'application/x-www-form-urlencoded',
      'Accept':'application/json'
    
    };
    
    fetch('https://api.mod.io/v1/games/{game-id}',
    {
      method: 'PUT',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Authorization': 'Bearer {access-token}',
      'Content-Type': 'application/x-www-form-urlencoded',
      'Accept': 'application/json'
    }
    
    r = requests.put('https://api.mod.io/v1/games/{game-id}', params={
    
    }, headers = headers)
    
    print r.json()
    
    URL obj = new URL("https://api.mod.io/v1/games/{game-id}");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("PUT");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    

    PUT /games/{game-id}

    Update details for a game. If you want to update the icon, logo or header fields you need to use the Add Game Media endpoint. Successful request will return updated Game Object.

    NOTE: You can also edit your games profile on the mod.io website. This is the recommended approach.

    Parameter Type Required Description
    status integer Status of a game. We recommend you never change this once you have accepted your game to be available via the API (see status and visibility for details):

    0 = Not accepted
    1 = Accepted
    name string Name of your game. Cannot exceed 80 characters.
    name_id string Subdomain for the game on mod.io. Highly recommended to not change this unless absolutely required. Cannot exceed 20 characters.
    summary string Explain your games mod support in 1 paragraph. Cannot exceed 250 characters.
    instructions string Instructions and links creators should follow to upload mods. Keep it short and explain details like are mods submitted in-game or via tools you have created.
    homepage string Official homepage for your game. Must be a valid URL.
    ugc_name string Word used to describe user-generated content (mods, items, addons etc).
    presentation_option integer Choose the presentation style you want on the mod.io website:

    0 = Grid View: Displays mods in a grid (visual but less informative, default setting)
    1 = Table View: Displays mods in a table (easier to browse)
    submission_option integer Choose the submission process you want modders to follow:

    0 = Control the mod upload process (recommended): You will have to build an upload system either in-game or via a standalone tool, which enables creators to submit mods to the tags you have configured. Because you control the flow you can prevalidate and compile mods, to ensure they will work in your game and attach metadata about what settings the mod can change. In the long run this option will save you time as you can accept more submissions, but it requires more setup to get running and isn't as open as the above option. NOTE: mod profiles can still be created online, but uploads will have to occur via the API using tools you create.

    1 = Enable mod uploads from anywhere: Allow developers to upload mods via the website and API, and pick the tags their mod is built for. No validation will be done on the files submitted, it will be the responsibility of your game and apps to process the mods installation based on the tags selected and determine if the mod is valid and works. For example a mod might be uploaded with the 'map' tag. When a user subscribes to this mod, your game will need to verify it contains a map file and install it where maps are located. If this fails, your game or the community will have to flag the mod as 'incompatible' to remove it from the listing.
    curation_option integer Choose the curation process your team follows to approve mods:

    0 = No curation (recommended): Mods are immediately available to play, without any intervention or work from your team.

    1 = Paid curation: Screen only mods the creator wants to sell, before they are available to receive donations or be purchased via the API.

    2 = Full curation: All mods must be accepted by someone on your team. This option is useful for games that have a small number of mods and want to control the experience, or you need to set the parameters attached to a mod (i.e. a weapon may require the rate of fire, power level, clip size etc). It can also be used for complex mods, which you may need to build into your game or distribute as DLC.
    community_options integer Choose the community features enabled on the mod.io website:

    0 = All of the options below are disabled
    1 = Discussion board enabled
    2 = Guides and news enabled
    ? = Add the options you want together, to enable multiple features (see BITWISE fields)
    revenue_options integer Choose the revenue capabilities mods can enable:

    0 = All of the options below are disabled
    1 = Allow mods to be sold
    2 = Allow mods to receive donations
    4 = Allow mods to be traded (not subject to revenue share)
    8 = Allow mods to control supply and scarcity
    ? = Add the options you want together, to enable multiple features (see BITWISE fields)
    api_access_options integer Choose the level of API access your game allows:

    0 = All of the options below are disabled

    1 = Allow 3rd parties to access this games API endpoints. We recommend you enable this feature, an open API will encourage a healthy ecosystem of tools and apps. If you do not enable this feature, your /games/{games-id} endpoints will return 403 Forbidden unless you are a member of the games team or using the games apikey

    2 = Allow mods to be downloaded directly (makes implementation easier for you, game servers and services because you can save, share and reuse download URLs). If disabled all download URLs will contain a frequently changing verification hash to stop unauthorized use

    ? = Add the options you want together, to enable multiple features (see BITWISE fields)

    Example response

    {
      "id": 2,
      "status": 1,
      "submitted_by": {
        "id": 1,
        "name_id": "xant",
        "username": "XanT",
        "date_online": 1509922961,
        "avatar": {
          "filename": "modio-dark.png",
          "original": "https://static.mod.io/v1/images/global/ao_modio-dark.png",
          "thumb_50x50": "https://static.mod.io/v1/images/global/modio-dark.png",
          "thumb_100x100": "https://static.mod.io/v1/images/global/am_modio-dark.png"
        },
        "timezone": "America/Los_Angeles",
        "language": "en",
        "profile_url": "https://mod.io/members/xant"
      },
      "date_added": 1493702614,
      "date_updated": 1499410290,
      "date_live": 1499841403,
      "presentation_option": 1,
      "submission_option": 0,
      "curation_option": 0,
      "community_options": 3,
      "revenue_options": 1500,
      "api_access_options": 3,
      "ugc_name": "map",
      "icon": {
        "filename": "modio-dark.png",
        "original": "https://static.mod.io/v1/images/global/ao_modio-dark.png",
        "thumb_64x64": "https://static.mod.io/v1/images/global/modio-dark.png",
        "thumb_128x128": "https://static.mod.io/v1/images/global/am_modio-dark.png",
        "thumb_256x256": "https://static.mod.io/v1/images/global/al_modio-dark.png"
      },
      "logo": {
        "filename": "modio-dark.png",
        "original": "https://static.mod.io/v1/images/global/modio-dark.png",
        "thumb_320x180": "https://static.mod.io/v1/images/global/modio-dark.png",
        "thumb_640x360": "https://static.mod.io/v1/images/global/modio-dark.png",
        "thumb_1280x720": "https://static.mod.io/v1/images/global/modio-dark.png"
      },
      "header": {
        "filename": "demo.png",
        "original": "https://static.mod.io/v1/images/global/modio-dark.png"
      },
      "homepage": "https://www.rogue-knight-game.com/",
      "name": "Rogue Knight",
      "name_id": "rogue-knight",
      "summary": "Rogue Knight is a brand new 2D pixel platformer.",
      "instructions": "Instructions on the process to upload mods.",
      "profile_url": "https://rogue-knight.mod.io",
      "tag_options": [
        {
          "name": "Theme",
          "type": "checkboxes",
          "tags": [
            "Horror"
          ],
          "hidden": false
        }
      ]
    }
    

    Responses

    Status Meaning Description Response Schema
    200 OK Update successful Game Object

    Mods

    Get All Mods

    Example request

    # You can also use wget
    curl -X GET https://api.mod.io/v1/games/{game-id}/mods?api_key=YourApiKey \
      -H 'Accept: application/json'
    
    
    GET https://api.mod.io/v1/games/{game-id}/mods?api_key=YourApiKey HTTP/1.1
    Host: api.mod.io
    
    Accept: application/json
    
    
    var headers = {
      'Accept':'application/json'
    
    };
    
    $.ajax({
      url: 'https://api.mod.io/v1/games/{game-id}/mods',
      method: 'get',
      data: '?api_key=YourApiKey',
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    const request = require('node-fetch');
    
    const headers = {
      'Accept':'application/json'
    
    };
    
    fetch('https://api.mod.io/v1/games/{game-id}/mods?api_key=YourApiKey',
    {
      method: 'GET',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    r = requests.get('https://api.mod.io/v1/games/{game-id}/mods', params={
      'api_key': 'YourApiKey'
    }, headers = headers)
    
    print r.json()
    
    URL obj = new URL("https://api.mod.io/v1/games/{game-id}/mods?api_key=YourApiKey");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    

    GET /games/{game-id}/mods

    Get all mods for the corresponding game. Successful request will return an array of Mod Objects. We recommended reading the filtering documentation to return only the records you want.

    Filter Type Description
    id integer Unique id of the mod.
    game_id integer Unique id of the parent game.
    status integer Status of the mod (only game admins can filter by this field, see status and visibility for details):

    0 = Not accepted
    1 = Accepted (default with archived)
    2 = Archived
    3 = Deleted
    visible integer Visibility of the mod (only game admins can filter by this field, see status and visibility for details):

    0 = Hidden
    1 = Public
    submitted_by integer Unique id of the user who has ownership of the mod.
    date_added integer Unix timestamp of date mod was registered.
    date_updated integer Unix timestamp of date mod was updated.
    date_live integer Unix timestamp of date mod was set live.
    name string Name of the mod.
    name_id string Path for the mod on mod.io. For example: https://gamename.mod.io/mod-name-id-here
    summary string Summary of the mod.
    description string Detailed description of the mod which allows HTML.
    homepage string Official homepage of the mod.
    modfile integer Unique id of the file that is the current active release.
    metadata_blob string Metadata stored by the game developer.
    metadata_kvp string Colon-separated values representing the key-value pairs you want to filter the results by. If you supply more than one key-pair, separate the pairs by a comma. Will only filter by an exact key-pair match.
    tags string Comma-separated values representing the tags you want to filter the results by. Only tags that are supported by the parent game can be applied. To determine what tags are eligible, see the tags values within tag_options column on the parent Game Object.
    downloads string Sort results by most downloads using _sort filter parameter, value should be downloads for descending or -downloads for ascending results.
    popular string Sort results by popularity using _sort filter, value should be popular for descending or -popular for ascending results.
    rating string Sort results by weighted rating using _sort filter, value should be rating for descending or -rating for ascending results.
    subscribers string Sort results by most subscribers using _sort filter, value should be subscribers for descending or -subscribers for ascending results.

    Example response

    {
      "data": [
        {
          "id": 2,
          "game_id": 2,
          "status": 1,
          "visible": 1,
          "submitted_by": {
            "id": 1,
            "name_id": "xant",
            "username": "XanT",
            "date_online": 1509922961,
            "avatar": {
              "filename": "modio-dark.png",
              "original": "https://static.mod.io/v1/images/global/ao_modio-dark.png",
              "thumb_50x50": "https://static.mod.io/v1/images/global/modio-dark.png",
              "thumb_100x100": "https://static.mod.io/v1/images/global/am_modio-dark.png"
            },
            "timezone": "America/Los_Angeles",
            "language": "en",
            "profile_url": "https://mod.io/members/xant"
          },
          "date_added": 1492564103,
          "date_updated": 1499841487,
          "date_live": 1499841403,
          "logo": {
            "filename": "modio-dark.png",
            "original": "https://static.mod.io/v1/images/global/modio-dark.png",
            "thumb_320x180": "https://static.mod.io/v1/images/global/modio-dark.png",
            "thumb_640x360": "https://static.mod.io/v1/images/global/modio-dark.png",
            "thumb_1280x720": "https://static.mod.io/v1/images/global/modio-dark.png"
          },
          "homepage": "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": "<h2>About</h2><p>Rogue HD Pack does exactly what you thi...",
          "metadata_blob": "rogue,hd,high-res,4k,hd textures",
          "profile_url": "https://rogue-knight.mod.io/rogue-knight-hd-pack",
          "modfile": {
            "id": 2,
            "mod_id": 2,
            "date_added": 1499841487,
            "date_scanned": 1499841487,
            "virus_status": 0,
            "virus_positive": 0,
            "virustotal_hash": "f9a7bf4a95ce20787337b685a79677cae2281b83c63ab0a25f091407741692af-1508147401",
            "filesize": 15181,
            "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://mod.io/mods/file/1/c489a0354111a4d76640d47f0cdcb294",
              "date_expires": 1579316848
            }
          },
          "media": {
            "youtube": [
              "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
            ],
            "sketchfab": [
              "https://sketchfab.com/models/ef40b2d300334d009984c8865b2db1c8"
            ],
            "images": [
              {
                "filename": "modio-dark.png",
                "original": "https://static.mod.io/v1/images/global/modio-dark.png",
                "thumb_320x180": "https://static.mod.io/v1/images/global/modio-dark.png"
              }
            ]
          },
          "rating_summary": {
            "total_ratings": 1230,
            "positive_ratings": 1047,
            "negative_ratings": 183,
            "percentage_positive": 91,
            "weighted_aggregate": 87.38,
            "display_text": "Very Positive"
          },
          "tags": [
            {
              "name": "Unity",
              "date_added": 1499841487
            }
          ]
        },
        {
            ...
        }
      ],
      "result_count": 100,
      "result_limit": 100,
      "result_offset": 0
    }
    

    Responses

    Status Meaning Description Response Schema
    200 OK Successful Request Get All Mods

    Get Mod

    Example request

    # You can also use wget
    curl -X GET https://api.mod.io/v1/games/{game-id}/mods/{mod-id}?api_key=YourApiKey \
      -H 'Accept: application/json'
    
    
    GET https://api.mod.io/v1/games/{game-id}/mods/{mod-id}?api_key=YourApiKey HTTP/1.1
    Host: api.mod.io
    
    Accept: application/json
    
    
    var headers = {
      'Accept':'application/json'
    
    };
    
    $.ajax({
      url: 'https://api.mod.io/v1/games/{game-id}/mods/{mod-id}',
      method: 'get',
      data: '?api_key=YourApiKey',
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    const request = require('node-fetch');
    
    const headers = {
      'Accept':'application/json'
    
    };
    
    fetch('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}?api_key=YourApiKey',
    {
      method: 'GET',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    r = requests.get('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}', params={
      'api_key': 'YourApiKey'
    }, headers = headers)
    
    print r.json()
    
    URL obj = new URL("https://api.mod.io/v1/games/{game-id}/mods/{mod-id}?api_key=YourApiKey");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    

    GET /games/{game-id}/mods/{mod-id}

    Get a mod. Successful request will return a single Mod Object.

    Example response

    {
      "id": 2,
      "game_id": 2,
      "status": 1,
      "visible": 1,
      "submitted_by": {
        "id": 1,
        "name_id": "xant",
        "username": "XanT",
        "date_online": 1509922961,
        "avatar": {
          "filename": "modio-dark.png",
          "original": "https://static.mod.io/v1/images/global/ao_modio-dark.png",
          "thumb_50x50": "https://static.mod.io/v1/images/global/modio-dark.png",
          "thumb_100x100": "https://static.mod.io/v1/images/global/am_modio-dark.png"
        },
        "timezone": "America/Los_Angeles",
        "language": "en",
        "profile_url": "https://mod.io/members/xant"
      },
      "date_added": 1492564103,
      "date_updated": 1499841487,
      "date_live": 1499841403,
      "logo": {
        "filename": "modio-dark.png",
        "original": "https://static.mod.io/v1/images/global/modio-dark.png",
        "thumb_320x180": "https://static.mod.io/v1/images/global/modio-dark.png",
        "thumb_640x360": "https://static.mod.io/v1/images/global/modio-dark.png",
        "thumb_1280x720": "https://static.mod.io/v1/images/global/modio-dark.png"
      },
      "homepage": "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": "<h2>About</h2><p>Rogue HD Pack does exactly what you thi...",
      "metadata_blob": "rogue,hd,high-res,4k,hd textures",
      "profile_url": "https://rogue-knight.mod.io/rogue-knight-hd-pack",
      "modfile": {
        "id": 2,
        "mod_id": 2,
        "date_added": 1499841487,
        "date_scanned": 1499841487,
        "virus_status": 0,
        "virus_positive": 0,
        "virustotal_hash": "f9a7bf4a95ce20787337b685a79677cae2281b83c63ab0a25f091407741692af-1508147401",
        "filesize": 15181,
        "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://mod.io/mods/file/1/c489a0354111a4d76640d47f0cdcb294",
          "date_expires": 1579316848
        }
      },
      "media": {
        "youtube": [
          "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
        ],
        "sketchfab": [
          "https://sketchfab.com/models/ef40b2d300334d009984c8865b2db1c8"
        ],
        "images": [
          {
            "filename": "modio-dark.png",
            "original": "https://static.mod.io/v1/images/global/modio-dark.png",
            "thumb_320x180": "https://static.mod.io/v1/images/global/modio-dark.png"
          }
        ]
      },
      "rating_summary": {
        "total_ratings": 1230,
        "positive_ratings": 1047,
        "negative_ratings": 183,
        "percentage_positive": 91,
        "weighted_aggregate": 87.38,
        "display_text": "Very Positive"
      },
      "tags": [
        {
          "name": "Unity",
          "date_added": 1499841487
        }
      ]
    }
    

    Responses

    Status Meaning Description Response Schema
    200 OK Successful Request Mod Object

    Add Mod

    Example request

    # You can also use wget
    curl -X POST https://api.mod.io/v1/games/{game-id}/mods \
      -H 'Authorization: Bearer {access-token}' \
      -H 'Content-Type: multipart/form-data' \
      -H 'Accept: application/json'
    
    
    POST https://api.mod.io/v1/games/{game-id}/mods HTTP/1.1
    Host: api.mod.io
    
    Accept: application/json
    Authorization: Bearer {access-token}
    Content-Type: multipart/form-data
    
    
    
    var headers = {
      'Authorization':'Bearer {access-token}',
      'Content-Type':'multipart/form-data',
      'Accept':'application/json'
    
    };
    
    $.ajax({
      url: 'https://api.mod.io/v1/games/{game-id}/mods',
      method: 'post',
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    const request = require('node-fetch');
    
    const headers = {
      'Authorization':'Bearer {access-token}',
      'Content-Type':'multipart/form-data',
      'Accept':'application/json'
    
    };
    
    fetch('https://api.mod.io/v1/games/{game-id}/mods',
    {
      method: 'POST',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Authorization': 'Bearer {access-token}',
      'Content-Type': 'multipart/form-data',
      'Accept': 'application/json'
    }
    
    r = requests.post('https://api.mod.io/v1/games/{game-id}/mods', params={
    
    }, headers = headers)
    
    print r.json()
    
    URL obj = new URL("https://api.mod.io/v1/games/{game-id}/mods");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    

    POST /games/{game-id}/mods

    Add a mod. Successful request will return the newly created Mod Object.

    NOTE: By default new mods are 'not accepted' and 'public'. They can only be 'accepted' and made available via the API once a Mod File has been uploaded. Media, Metadata Key Value Pairs and Dependencies can also be added after a mod profile is created.

    Parameter Type Required Description
    visible integer Visibility of the mod (best if this field is controlled by mod admins, see status and visibility for details):

    0 = Hidden
    1 = Public (default)
    logo file true Image file which will represent your mods logo. Must be gif, jpg or png format and cannot exceed 8MB in filesize. Dimensions must be at least 640x360 and we recommended you supply a high resolution image with a 16 / 9 ratio. mod.io will use this image to make three thumbnails for the dimensions 320x180, 640x360 and 1280x720.
    name string true Name of your mod.
    name_id string Path for the mod on mod.io. For example: https://gamename.mod.io/mod-name-id-here. If no name_id is specified the name will be used. For example: 'Stellaris Shader Mod' will become 'stellaris-shader-mod'. Cannot exceed 80 characters.
    summary string true Summary for your mod, giving a brief overview of what it's about. Cannot exceed 250 characters.
    description string Detailed description for your mod, which can include details such as 'About', 'Features', 'Install Instructions', 'FAQ', etc. HTML supported and encouraged.
    homepage string Official homepage for your mod. Must be a valid URL.
    stock integer Maximium number of subscribers for this mod. A value of 0 disables this limit.
    metadata_blob string Metadata stored by the game developer which may include properties as to how the item works, or other information you need to display. Metadata can also be stored as searchable key value pairs, and to individual mod files.
    tags string[] An array of strings that represent what the mod has been tagged as. Only tags that are supported by the parent game can be applied. To determine what tags are eligible, see the tags values within tag_options column on the parent Game Object.

    Example response

    {
      "id": 2,
      "game_id": 2,
      "status": 1,
      "visible": 1,
      "submitted_by": {
        "id": 1,
        "name_id": "xant",
        "username": "XanT",
        "date_online": 1509922961,
        "avatar": {
          "filename": "modio-dark.png",
          "original": "https://static.mod.io/v1/images/global/ao_modio-dark.png",
          "thumb_50x50": "https://static.mod.io/v1/images/global/modio-dark.png",
          "thumb_100x100": "https://static.mod.io/v1/images/global/am_modio-dark.png"
        },
        "timezone": "America/Los_Angeles",
        "language": "en",
        "profile_url": "https://mod.io/members/xant"
      },
      "date_added": 1492564103,
      "date_updated": 1499841487,
      "date_live": 1499841403,
      "logo": {
        "filename": "modio-dark.png",
        "original": "https://static.mod.io/v1/images/global/modio-dark.png",
        "thumb_320x180": "https://static.mod.io/v1/images/global/modio-dark.png",
        "thumb_640x360": "https://static.mod.io/v1/images/global/modio-dark.png",
        "thumb_1280x720": "https://static.mod.io/v1/images/global/modio-dark.png"
      },
      "homepage": "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": "<h2>About</h2><p>Rogue HD Pack does exactly what you thi...",
      "metadata_blob": "rogue,hd,high-res,4k,hd textures",
      "profile_url": "https://rogue-knight.mod.io/rogue-knight-hd-pack",
      "modfile": {
        "id": 2,
        "mod_id": 2,
        "date_added": 1499841487,
        "date_scanned": 1499841487,
        "virus_status": 0,
        "virus_positive": 0,
        "virustotal_hash": "f9a7bf4a95ce20787337b685a79677cae2281b83c63ab0a25f091407741692af-1508147401",
        "filesize": 15181,
        "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://mod.io/mods/file/1/c489a0354111a4d76640d47f0cdcb294",
          "date_expires": 1579316848
        }
      },
      "media": {
        "youtube": [
          "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
        ],
        "sketchfab": [
          "https://sketchfab.com/models/ef40b2d300334d009984c8865b2db1c8"
        ],
        "images": [
          {
            "filename": "modio-dark.png",
            "original": "https://static.mod.io/v1/images/global/modio-dark.png",
            "thumb_320x180": "https://static.mod.io/v1/images/global/modio-dark.png"
          }
        ]
      },
      "rating_summary": {
        "total_ratings": 1230,
        "positive_ratings": 1047,
        "negative_ratings": 183,
        "percentage_positive": 91,
        "weighted_aggregate": 87.38,
        "display_text": "Very Positive"
      },
      "tags": [
        {
          "name": "Unity",
          "date_added": 1499841487
        }
      ]
    }
    

    Responses

    Status Meaning Description Response Schema
    201 Created Resource Created Mod Object

    Response Headers

    Status Header Type Format Description
    201 Location string URL to newly created resource

    Edit Mod

    Example request

    # You can also use wget
    curl -X PUT https://api.mod.io/v1/games/{game-id}/mods/{mod-id} \
      -H 'Authorization: Bearer {access-token}' \
      -H 'Content-Type: application/x-www-form-urlencoded' \
      -H 'Accept: application/json'
    
    
    PUT https://api.mod.io/v1/games/{game-id}/mods/{mod-id} HTTP/1.1
    Host: api.mod.io
    
    Accept: application/json
    Authorization: Bearer {access-token}
    Content-Type: application/x-www-form-urlencoded
    
    
    
    var headers = {
      'Authorization':'Bearer {access-token}',
      'Content-Type':'application/x-www-form-urlencoded',
      'Accept':'application/json'
    
    };
    
    $.ajax({
      url: 'https://api.mod.io/v1/games/{game-id}/mods/{mod-id}',
      method: 'put',
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    const request = require('node-fetch');
    
    const headers = {
      'Authorization':'Bearer {access-token}',
      'Content-Type':'application/x-www-form-urlencoded',
      'Accept':'application/json'
    
    };
    
    fetch('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}',
    {
      method: 'PUT',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Authorization': 'Bearer {access-token}',
      'Content-Type': 'application/x-www-form-urlencoded',
      'Accept': 'application/json'
    }
    
    r = requests.put('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}', params={
    
    }, headers = headers)
    
    print r.json()
    
    URL obj = new URL("https://api.mod.io/v1/games/{game-id}/mods/{mod-id}");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("PUT");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    

    PUT /games/{game-id}/mods/{mod-id}

    Edit details for a mod. If you want to update the logo or media associated with this mod, you need to use the Add Mod Media endpoint. The same applies to Mod Files, Metadata Key Value Pairs and Dependencies which are all managed via other endpoints. Successful request will return the updated Mod Object.

    Parameter Type Required Description
    status integer Status of a mod. The mod must have at least one uploaded modfile to be 'accepted' or 'archived' (best if this field is controlled by game admins, see status and visibility for details):

    0 = Not accepted
    1 = Accepted (game admins only)
    2 = Archived (out of date or incompatible, game admins only)
    3 = Deleted (use the delete mod endpoint to set this status)
    visible integer Visibility of the mod (best if this field is controlled by mod admins, see status and visibility for details):

    0 = Hidden
    1 = Public
    name string Name of your mod. Cannot exceed 80 characters.
    name_id string Path for the mod on mod.io. For example: https://gamename.mod.io/mod-name-id-here. Cannot exceed 80 characters.
    summary string Summary for your mod, giving a brief overview of what it's about. Cannot exceed 250 characters.
    description string Detailed description for your mod, which can include details such as 'About', 'Features', 'Install Instructions', 'FAQ', etc. HTML supported and encouraged.
    homepage string Official homepage for your mod. Must be a valid URL.
    stock integer Maximium number of subscribers for this mod. A value of 0 disables this limit.
    metadata_blob string Metadata stored by the game developer which may include properties as to how the item works, or other information you need to display. Metadata can also be stored as searchable key value pairs, and to individual mod files.

    Example response

    {
      "id": 2,
      "game_id": 2,
      "status": 1,
      "visible": 1,
      "submitted_by": {
        "id": 1,
        "name_id": "xant",
        "username": "XanT",
        "date_online": 1509922961,
        "avatar": {
          "filename": "modio-dark.png",
          "original": "https://static.mod.io/v1/images/global/ao_modio-dark.png",
          "thumb_50x50": "https://static.mod.io/v1/images/global/modio-dark.png",
          "thumb_100x100": "https://static.mod.io/v1/images/global/am_modio-dark.png"
        },
        "timezone": "America/Los_Angeles",
        "language": "en",
        "profile_url": "https://mod.io/members/xant"
      },
      "date_added": 1492564103,
      "date_updated": 1499841487,
      "date_live": 1499841403,
      "logo": {
        "filename": "modio-dark.png",
        "original": "https://static.mod.io/v1/images/global/modio-dark.png",
        "thumb_320x180": "https://static.mod.io/v1/images/global/modio-dark.png",
        "thumb_640x360": "https://static.mod.io/v1/images/global/modio-dark.png",
        "thumb_1280x720": "https://static.mod.io/v1/images/global/modio-dark.png"
      },
      "homepage": "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": "<h2>About</h2><p>Rogue HD Pack does exactly what you thi...",
      "metadata_blob": "rogue,hd,high-res,4k,hd textures",
      "profile_url": "https://rogue-knight.mod.io/rogue-knight-hd-pack",
      "modfile": {
        "id": 2,
        "mod_id": 2,
        "date_added": 1499841487,
        "date_scanned": 1499841487,
        "virus_status": 0,
        "virus_positive": 0,
        "virustotal_hash": "f9a7bf4a95ce20787337b685a79677cae2281b83c63ab0a25f091407741692af-1508147401",
        "filesize": 15181,
        "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://mod.io/mods/file/1/c489a0354111a4d76640d47f0cdcb294",
          "date_expires": 1579316848
        }
      },
      "media": {
        "youtube": [
          "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
        ],
        "sketchfab": [
          "https://sketchfab.com/models/ef40b2d300334d009984c8865b2db1c8"
        ],
        "images": [
          {
            "filename": "modio-dark.png",
            "original": "https://static.mod.io/v1/images/global/modio-dark.png",
            "thumb_320x180": "https://static.mod.io/v1/images/global/modio-dark.png"
          }
        ]
      },
      "rating_summary": {
        "total_ratings": 1230,
        "positive_ratings": 1047,
        "negative_ratings": 183,
        "percentage_positive": 91,
        "weighted_aggregate": 87.38,
        "display_text": "Very Positive"
      },
      "tags": [
        {
          "name": "Unity",
          "date_added": 1499841487
        }
      ]
    }
    

    Responses

    Status Meaning Description Response Schema
    200 OK Update Successful Mod Object

    Delete Mod

    Example request

    # You can also use wget
    curl -X DELETE https://api.mod.io/v1/games/{game-id}/mods/{mod-id} \
      -H 'Authorization: Bearer {access-token}' \
      -H 'Content-Type: application/x-www-form-urlencoded' \
      -H 'Accept: application/json'
    
    
    DELETE https://api.mod.io/v1/games/{game-id}/mods/{mod-id} HTTP/1.1
    Host: api.mod.io
    
    Accept: application/json
    Authorization: Bearer {access-token}
    Content-Type: application/x-www-form-urlencoded
    
    
    
    var headers = {
      'Authorization':'Bearer {access-token}',
      'Content-Type':'application/x-www-form-urlencoded',
      'Accept':'application/json'
    
    };
    
    $.ajax({
      url: 'https://api.mod.io/v1/games/{game-id}/mods/{mod-id}',
      method: 'delete',
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    const request = require('node-fetch');
    
    const headers = {
      'Authorization':'Bearer {access-token}',
      'Content-Type':'application/x-www-form-urlencoded',
      'Accept':'application/json'
    
    };
    
    fetch('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}',
    {
      method: 'DELETE',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Authorization': 'Bearer {access-token}',
      'Content-Type': 'application/x-www-form-urlencoded',
      'Accept': 'application/json'
    }
    
    r = requests.delete('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}', params={
    
    }, headers = headers)
    
    print r.json()
    
    URL obj = new URL("https://api.mod.io/v1/games/{game-id}/mods/{mod-id}");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("DELETE");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    

    DELETE /games/{game-id}/mods/{mod-id}

    Delete a mod profile. Successful request will return 204 No Content and fire a MOD_UNAVAILABLE event.

    NOTE: This will close the mod profile which means it cannot be viewed or retrieved via API requests but will still exist in-case you choose to restore it at a later date. If you believe a mod should be permanently removed please contact us.

    Example response

     204 No Content 
    

    Responses

    Status Meaning Description Response Schema
    204 No Content No Content None

    Files

    Get All Modfiles

    Example request

    # You can also use wget
    curl -X GET https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/files?api_key=YourApiKey \
      -H 'Accept: application/json'
    
    
    GET https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/files?api_key=YourApiKey HTTP/1.1
    Host: api.mod.io
    
    Accept: application/json
    
    
    var headers = {
      'Accept':'application/json'
    
    };
    
    $.ajax({
      url: 'https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/files',
      method: 'get',
      data: '?api_key=YourApiKey',
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    const request = require('node-fetch');
    
    const headers = {
      'Accept':'application/json'
    
    };
    
    fetch('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/files?api_key=YourApiKey',
    {
      method: 'GET',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    r = requests.get('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/files', params={
      'api_key': 'YourApiKey'
    }, headers = headers)
    
    print r.json()
    
    URL obj = new URL("https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/files?api_key=YourApiKey");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    

    GET /games/{game-id}/mods/{mod-id}/files

    Get all files that are published for the corresponding mod. Successful request will return an array of Modfile Objects. We recommended reading the filtering documentation to return only the records you want.

    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.

    Filter Type Description
    id integer Unique id of the file.
    mod_id integer Unique id of the mod.
    date_added integer Unix timestamp of date file was added.
    date_scanned integer Unix timestamp of date file was virus scanned.
    virus_status 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:

    0 = Not scanned
    1 = Scan complete
    2 = In progress
    3 = Too large to scan
    4 = File not found
    5 = Error Scanning
    virus_positive integer Was a virus detected:

    0 = No threats detected
    1 = Flagged as malicious
    filesize integer Size of the file in bytes.
    filehash string MD5 hash of the file.
    filename string Filename including extension.
    version string Release version this file represents.
    changelog string Changelog for the file.
    metadata_blob string Metadata stored by the game developer for this file.

    Example response

    {
      "data": [
        {
          "id": 2,
          "mod_id": 2,
          "date_added": 1499841487,
          "date_scanned": 1499841487,
          "virus_status": 0,
          "virus_positive": 0,
          "virustotal_hash": "f9a7bf4a95ce20787337b685a79677cae2281b83c63ab0a25f091407741692af-1508147401",
          "filesize": 15181,
          "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://mod.io/mods/file/1/c489a0354111a4d76640d47f0cdcb294",
            "date_expires": 1579316848
          }
        },
        {
            ...
        }
      ],
      "result_count": 100,
      "result_limit": 100,
      "result_offset": 0
    }
    

    Responses

    Status Meaning Description Response Schema
    200 OK Successful Request Get All Modfiles

    Get Modfile

    Example request

    # You can also use wget
    curl -X GET https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/files/{file-id}?api_key=YourApiKey \
      -H 'Accept: application/json'
    
    
    GET https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/files/{file-id}?api_key=YourApiKey HTTP/1.1
    Host: api.mod.io
    
    Accept: application/json
    
    
    var headers = {
      'Accept':'application/json'
    
    };
    
    $.ajax({
      url: 'https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/files/{file-id}',
      method: 'get',
      data: '?api_key=YourApiKey',
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    const request = require('node-fetch');
    
    const headers = {
      'Accept':'application/json'
    
    };
    
    fetch('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/files/{file-id}?api_key=YourApiKey',
    {
      method: 'GET',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    r = requests.get('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/files/{file-id}', params={
      'api_key': 'YourApiKey'
    }, headers = headers)
    
    print r.json()
    
    URL obj = new URL("https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/files/{file-id}?api_key=YourApiKey");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    

    GET /games/{game-id}/mods/{mod-id}/files/{file-id}

    Get a file. Successful request will return a single Modfile Object.

    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 response

    {
      "id": 2,
      "mod_id": 2,
      "date_added": 1499841487,
      "date_scanned": 1499841487,
      "virus_status": 0,
      "virus_positive": 0,
      "virustotal_hash": "f9a7bf4a95ce20787337b685a79677cae2281b83c63ab0a25f091407741692af-1508147401",
      "filesize": 15181,
      "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://mod.io/mods/file/1/c489a0354111a4d76640d47f0cdcb294",
        "date_expires": 1579316848
      }
    }
    

    Responses

    Status Meaning Description Response Schema
    200 OK Successful Request Modfile Object

    Add Modfile

    Example request

    # You can also use wget
    curl -X POST https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/files \
      -H 'Authorization: Bearer {access-token}' \
      -H 'Content-Type: multipart/form-data' \
      -H 'Accept: application/json'
    
    
    POST https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/files HTTP/1.1
    Host: api.mod.io
    
    Accept: application/json
    Authorization: Bearer {access-token}
    Content-Type: multipart/form-data
    
    
    
    var headers = {
      'Authorization':'Bearer {access-token}',
      'Content-Type':'multipart/form-data',
      'Accept':'application/json'
    
    };
    
    $.ajax({
      url: 'https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/files',
      method: 'post',
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    const request = require('node-fetch');
    
    const headers = {
      'Authorization':'Bearer {access-token}',
      'Content-Type':'multipart/form-data',
      'Accept':'application/json'
    
    };
    
    fetch('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/files',
    {
      method: 'POST',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Authorization': 'Bearer {access-token}',
      'Content-Type': 'multipart/form-data',
      'Accept': 'application/json'
    }
    
    r = requests.post('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/files', params={
    
    }, headers = headers)
    
    print r.json()
    
    URL obj = new URL("https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/files");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    

    POST /games/{game-id}/mods/{mod-id}/files

    Upload a file for the corresponding mod. Successful request will return the newly created Modfile Object. Ensure that the release you are uploading is stable and free from any critical issues. Files are scanned upon upload, any users who upload malicious files will have their accounts closed promptly.

    NOTE: This endpoint does not support input_json even if you base64-encode your file method due to the already-large file sizes of some releases and base64-encoding inflating the filesize.

    Parameter Type Required Description
    filedata file true The binary file for the release. For compatibility you should ZIP the base folder of your mod, or if it is a collection of files which live in a pre-existing game folder, you should ZIP those files. Your file must meet the following conditions:

    - File must be zipped and cannot exceed 10GB in filesize
    - Mods which span multiple game directories are not supported unless the game manages this
    - Mods which overwrite files are not supported unless the game manages this
    version string Version of the file release.
    changelog string Changelog of this release.
    active boolean Default value is true. Label this upload as the current release, this will change the modfile field on the parent mod to the id of this file after upload.

    NOTE: If the active parameter is true, a MODFILE_CHANGED event will be fired, so game clients know there is an update available for this mod.
    filehash string MD5 of the submitted file. When supplied the MD5 will be compared against the uploaded files MD5. If they don't match a 422 Unprocessible Entity error will be returned.
    metadata_blob string Metadata stored by the game developer which may include properties such as what version of the game this file is compatible with. Metadata can also be stored as searchable key value pairs, and to the mod object.

    Example response

    {
      "id": 2,
      "mod_id": 2,
      "date_added": 1499841487,
      "date_scanned": 1499841487,
      "virus_status": 0,
      "virus_positive": 0,
      "virustotal_hash": "f9a7bf4a95ce20787337b685a79677cae2281b83c63ab0a25f091407741692af-1508147401",
      "filesize": 15181,
      "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://mod.io/mods/file/1/c489a0354111a4d76640d47f0cdcb294",
        "date_expires": 1579316848
      }
    }
    

    Responses

    Status Meaning Description Response Schema
    201 Created Resource Created Modfile Object

    Response Headers

    Status Header Type Format Description
    201 Location string URL to newly created resource

    Edit Modfile

    Example request

    # You can also use wget
    curl -X PUT https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/files/{file-id} \
      -H 'Authorization: Bearer {access-token}' \
      -H 'Content-Type: application/x-www-form-urlencoded' \
      -H 'Accept: application/json'
    
    
    PUT https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/files/{file-id} HTTP/1.1
    Host: api.mod.io
    
    Accept: application/json
    Authorization: Bearer {access-token}
    Content-Type: application/x-www-form-urlencoded
    
    
    
    var headers = {
      'Authorization':'Bearer {access-token}',
      'Content-Type':'application/x-www-form-urlencoded',
      'Accept':'application/json'
    
    };
    
    $.ajax({
      url: 'https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/files/{file-id}',
      method: 'put',
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    const request = require('node-fetch');
    
    const headers = {
      'Authorization':'Bearer {access-token}',
      'Content-Type':'application/x-www-form-urlencoded',
      'Accept':'application/json'
    
    };
    
    fetch('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/files/{file-id}',
    {
      method: 'PUT',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Authorization': 'Bearer {access-token}',
      'Content-Type': 'application/x-www-form-urlencoded',
      'Accept': 'application/json'
    }
    
    r = requests.put('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/files/{file-id}', params={
    
    }, headers = headers)
    
    print r.json()
    
    URL obj = new URL("https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/files/{file-id}");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("PUT");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    

    PUT /games/{game-id}/mods/{mod-id}/files/{file-id}

    Edit the details of a published file. If you want to update fields other than the changelog, version and active status, you should add a new file instead. Successful request will return updated Modfile Object.

    Parameter Type Required Description
    version string Version of the file release.
    changelog string Changelog of this release.
    active boolean Default value is true. Label this upload as the current release, this will change the modfile field on the parent mod to the id of this file after upload.

    NOTE: If the active parameter causes the parent mods modfile parameter to change, a MODFILE_CHANGED event will be fired, so game clients know there is an update available for this mod.
    metadata_blob string Metadata stored by the game developer which may include properties such as what version of the game this file is compatible with. Metadata can also be stored as searchable key value pairs, and to the mod object.

    Example response

    {
      "id": 2,
      "mod_id": 2,
      "date_added": 1499841487,
      "date_scanned": 1499841487,
      "virus_status": 0,
      "virus_positive": 0,
      "virustotal_hash": "f9a7bf4a95ce20787337b685a79677cae2281b83c63ab0a25f091407741692af-1508147401",
      "filesize": 15181,
      "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://mod.io/mods/file/1/c489a0354111a4d76640d47f0cdcb294",
        "date_expires": 1579316848
      }
    }
    

    Responses

    Status Meaning Description Response Schema
    200 OK Update Successful Modfile Object

    Media

    Add Game Media

    Example request

    # You can also use wget
    curl -X POST https://api.mod.io/v1/games/{game-id}/media \
      -H 'Authorization: Bearer {access-token}' \
      -H 'Content-Type: multipart/form-data' \
      -H 'Accept: application/json'
    
    
    POST https://api.mod.io/v1/games/{game-id}/media HTTP/1.1
    Host: api.mod.io
    
    Accept: application/json
    Authorization: Bearer {access-token}
    Content-Type: multipart/form-data
    
    
    
    var headers = {
      'Authorization':'Bearer {access-token}',
      'Content-Type':'multipart/form-data',
      'Accept':'application/json'
    
    };
    
    $.ajax({
      url: 'https://api.mod.io/v1/games/{game-id}/media',
      method: 'post',
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    const request = require('node-fetch');
    
    const headers = {
      'Authorization':'Bearer {access-token}',
      'Content-Type':'multipart/form-data',
      'Accept':'application/json'
    
    };
    
    fetch('https://api.mod.io/v1/games/{game-id}/media',
    {
      method: 'POST',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Authorization': 'Bearer {access-token}',
      'Content-Type': 'multipart/form-data',
      'Accept': 'application/json'
    }
    
    r = requests.post('https://api.mod.io/v1/games/{game-id}/media', params={
    
    }, headers = headers)
    
    print r.json()
    
    URL obj = new URL("https://api.mod.io/v1/games/{game-id}/media");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    

    POST /games/{game-id}/media

    Upload new media to a game. Any request you make to this endpoint should contain a binary file for each of the fields you want to update below. Successful request will return Message Object.

    NOTE: You can also add media to your games profile on the mod.io website. This is the recommended approach.

    Parameter Type Required Description
    logo file Image file which will represent your games logo. Must be gif, jpg or png format and cannot exceed 8MB in filesize. Dimensions must be at least 640x360 and we recommended you supply a high resolution image with a 16 / 9 ratio. mod.io will use this logo to create three thumbnails with the dimensions of 320x180, 640x360 and 1280x720.
    icon file Image file which will represent your games icon. Must be gif, jpg or png format and cannot exceed 1MB in filesize. Dimensions must be at least 64x64 and a transparent png that works on a colorful background is recommended. mod.io will use this icon to create three thumbnails with the dimensions of 64x64, 128x128 and 256x256.
    header file Image file which will represent your games header. Must be gif, jpg or png format and cannot exceed 256KB in filesize. Dimensions of 400x100 and a light transparent png that works on a dark background is recommended.

    Example response

    {
      "code": "200",
      "message": "You have successfully added new media to the specified game profile."
    }
    

    Responses

    Status Meaning Description Response Schema
    200 OK Media Successfully uploaded Message Object

    Add Mod Media

    Example request

    # You can also use wget
    curl -X POST https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/media \
      -H 'Authorization: Bearer {access-token}' \
      -H 'Content-Type: multipart/form-data' \
      -H 'Accept: application/json'
    
    
    POST https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/media HTTP/1.1
    Host: api.mod.io
    
    Accept: application/json
    Authorization: Bearer {access-token}
    Content-Type: multipart/form-data
    
    
    
    var headers = {
      'Authorization':'Bearer {access-token}',
      'Content-Type':'multipart/form-data',
      'Accept':'application/json'
    
    };
    
    $.ajax({
      url: 'https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/media',
      method: 'post',
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    const request = require('node-fetch');
    
    const headers = {
      'Authorization':'Bearer {access-token}',
      'Content-Type':'multipart/form-data',
      'Accept':'application/json'
    
    };
    
    fetch('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/media',
    {
      method: 'POST',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Authorization': 'Bearer {access-token}',
      'Content-Type': 'multipart/form-data',
      'Accept': 'application/json'
    }
    
    r = requests.post('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/media', params={
    
    }, headers = headers)
    
    print r.json()
    
    URL obj = new URL("https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/media");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    

    POST /games/{game-id}/mods/{mod-id}/media

    This endpoint is very flexible and will add any images posted to the mods gallery regardless of their body name providing they are a valid image. The request Content-Type header must be multipart/form-data to submit image files. Successful request will return Message Object.

    NOTE: You can also add media to your mods profile on the mod.io website. This is the easiest way.

    Parameter Type Required Description
    logo file Image file which will represent your mods logo. Must be gif, jpg or png format and cannot exceed 8MB in filesize. Dimensions must be at least 640x360 and we recommended you supply a high resolution image with a 16 / 9 ratio. mod.io will use this logo to create three thumbnails with the dimensions of 320x180, 640x360 and 1280x720.
    images zip Zip archive of images to upload. Only valid gif, jpg and png images in the zip file will be processed. The filename must be images.zip all other zips will be ignored. Alternatively you can POST one or more images to this endpoint and they will be detected and added to the mods gallery.
    youtube string[] Full Youtube link(s) you want to add - example 'https://www.youtube.com/watch?v=IGVZOLV9SPo'
    sketchfab string[] Full Sketchfab link(s) you want to add - example 'https://sketchfab.com/models/71f04e390ff54e5f8d9a51b4e1caab7e'

    Example response

    {
      "code": "201",
      "message": "You have successfully added new media to the specified mod."
    }
    

    Responses

    Status Meaning Description Response Schema
    201 Created Resource Created Message Object

    Response Headers

    Status Header Type Format Description
    201 Location string URL to newly created resource

    Delete Mod Media

    Example request

    # You can also use wget
    curl -X DELETE https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/media \
      -H 'Authorization: Bearer {access-token}' \
      -H 'Content-Type: application/x-www-form-urlencoded' \
      -H 'Accept: application/json'
    
    
    DELETE https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/media HTTP/1.1
    Host: api.mod.io
    
    Accept: application/json
    Authorization: Bearer {access-token}
    Content-Type: application/x-www-form-urlencoded
    
    
    
    var headers = {
      'Authorization':'Bearer {access-token}',
      'Content-Type':'application/x-www-form-urlencoded',
      'Accept':'application/json'
    
    };
    
    $.ajax({
      url: 'https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/media',
      method: 'delete',
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    const request = require('node-fetch');
    
    const headers = {
      'Authorization':'Bearer {access-token}',
      'Content-Type':'application/x-www-form-urlencoded',
      'Accept':'application/json'
    
    };
    
    fetch('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/media',
    {
      method: 'DELETE',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Authorization': 'Bearer {access-token}',
      'Content-Type': 'application/x-www-form-urlencoded',
      'Accept': 'application/json'
    }
    
    r = requests.delete('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/media', params={
    
    }, headers = headers)
    
    print r.json()
    
    URL obj = new URL("https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/media");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("DELETE");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    

    DELETE /games/{game-id}/mods/{mod-id}/media

    Delete images, sketchfab or youtube links from a mod profile. Successful request will return 204 No Content.

    NOTE: You can also delete media from your mods profile on the mod.io website. This is the easiest way.

    Parameter Type Required Description
    images string[] Filename's of the image(s) you want to delete - example 'gameplay2.jpg'.
    youtube string[] Full Youtube link(s) you want to delete - example 'https://www.youtube.com/watch?v=IGVZOLV9SPo'.
    sketchfab string[] Full Sketchfab link(s) you want to delete - example 'https://sketchfab.com/models/71f04e390ff54e5f8d9a51b4e1caab7e'.

    Example response

     204 No Content 
    

    Responses

    Status Meaning Description Response Schema
    204 No Content No Content None

    Subscribe

    Subscribe To Mod

    Example request

    # You can also use wget
    curl -X POST https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/subscribe \
      -H 'Authorization: Bearer {access-token}' \
      -H 'Content-Type: application/x-www-form-urlencoded' \
      -H 'Accept: application/json'
    
    
    POST https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/subscribe HTTP/1.1
    Host: api.mod.io
    
    Accept: application/json
    Authorization: Bearer {access-token}
    Content-Type: application/x-www-form-urlencoded
    
    
    
    var headers = {
      'Authorization':'Bearer {access-token}',
      'Content-Type':'application/x-www-form-urlencoded',
      'Accept':'application/json'
    
    };
    
    $.ajax({
      url: 'https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/subscribe',
      method: 'post',
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    const request = require('node-fetch');
    
    const headers = {
      'Authorization':'Bearer {access-token}',
      'Content-Type':'application/x-www-form-urlencoded',
      'Accept':'application/json'
    
    };
    
    fetch('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/subscribe',
    {
      method: 'POST',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Authorization': 'Bearer {access-token}',
      'Content-Type': 'application/x-www-form-urlencoded',
      'Accept': 'application/json'
    }
    
    r = requests.post('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/subscribe', params={
    
    }, headers = headers)
    
    print r.json()
    
    URL obj = new URL("https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/subscribe");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    

    POST /games/{game-id}/mods/{mod-id}/subscribe

    Subscribe the authenticated user to a corresponding mod. No body parameters are required for this action. Successful request will return the Mod Object of the newly subscribed mod.

    NOTE: Users can subscribe to mods via mod.io, we recommend you poll the Get All Events endpoint to keep a users mods collection up to date.

    Example response

    {
      "id": 2,
      "game_id": 2,
      "status": 1,
      "visible": 1,
      "submitted_by": {
        "id": 1,
        "name_id": "xant",
        "username": "XanT",
        "date_online": 1509922961,
        "avatar": {
          "filename": "modio-dark.png",
          "original": "https://static.mod.io/v1/images/global/ao_modio-dark.png",
          "thumb_50x50": "https://static.mod.io/v1/images/global/modio-dark.png",
          "thumb_100x100": "https://static.mod.io/v1/images/global/am_modio-dark.png"
        },
        "timezone": "America/Los_Angeles",
        "language": "en",
        "profile_url": "https://mod.io/members/xant"
      },
      "date_added": 1492564103,
      "date_updated": 1499841487,
      "date_live": 1499841403,
      "logo": {
        "filename": "modio-dark.png",
        "original": "https://static.mod.io/v1/images/global/modio-dark.png",
        "thumb_320x180": "https://static.mod.io/v1/images/global/modio-dark.png",
        "thumb_640x360": "https://static.mod.io/v1/images/global/modio-dark.png",
        "thumb_1280x720": "https://static.mod.io/v1/images/global/modio-dark.png"
      },
      "homepage": "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": "<h2>About</h2><p>Rogue HD Pack does exactly what you thi...",
      "metadata_blob": "rogue,hd,high-res,4k,hd textures",
      "profile_url": "https://rogue-knight.mod.io/rogue-knight-hd-pack",
      "modfile": {
        "id": 2,
        "mod_id": 2,
        "date_added": 1499841487,
        "date_scanned": 1499841487,
        "virus_status": 0,
        "virus_positive": 0,
        "virustotal_hash": "f9a7bf4a95ce20787337b685a79677cae2281b83c63ab0a25f091407741692af-1508147401",
        "filesize": 15181,
        "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://mod.io/mods/file/1/c489a0354111a4d76640d47f0cdcb294",
          "date_expires": 1579316848
        }
      },
      "media": {
        "youtube": [
          "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
        ],
        "sketchfab": [
          "https://sketchfab.com/models/ef40b2d300334d009984c8865b2db1c8"
        ],
        "images": [
          {
            "filename": "modio-dark.png",
            "original": "https://static.mod.io/v1/images/global/modio-dark.png",
            "thumb_320x180": "https://static.mod.io/v1/images/global/modio-dark.png"
          }
        ]
      },
      "rating_summary": {
        "total_ratings": 1230,
        "positive_ratings": 1047,
        "negative_ratings": 183,
        "percentage_positive": 91,
        "weighted_aggregate": 87.38,
        "display_text": "Very Positive"
      },
      "tags": [
        {
          "name": "Unity",
          "date_added": 1499841487
        }
      ]
    }
    

    Responses

    Status Meaning Description Response Schema
    201 Created Subscription Successful Mod Object

    Unsubscribe To Mod

    Example request

    # You can also use wget
    curl -X DELETE https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/subscribe \
      -H 'Authorization: Bearer {access-token}' \
      -H 'Content-Type: application/x-www-form-urlencoded' \
      -H 'Accept: application/json'
    
    
    DELETE https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/subscribe HTTP/1.1
    Host: api.mod.io
    
    Accept: application/json
    Authorization: Bearer {access-token}
    Content-Type: application/x-www-form-urlencoded
    
    
    
    var headers = {
      'Authorization':'Bearer {access-token}',
      'Content-Type':'application/x-www-form-urlencoded',
      'Accept':'application/json'
    
    };
    
    $.ajax({
      url: 'https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/subscribe',
      method: 'delete',
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    const request = require('node-fetch');
    
    const headers = {
      'Authorization':'Bearer {access-token}',
      'Content-Type':'application/x-www-form-urlencoded',
      'Accept':'application/json'
    
    };
    
    fetch('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/subscribe',
    {
      method: 'DELETE',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Authorization': 'Bearer {access-token}',
      'Content-Type': 'application/x-www-form-urlencoded',
      'Accept': 'application/json'
    }
    
    r = requests.delete('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/subscribe', params={
    
    }, headers = headers)
    
    print r.json()
    
    URL obj = new URL("https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/subscribe");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("DELETE");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    

    DELETE /games/{game-id}/mods/{mod-id}/subscribe

    Unsubscribe the authenticated user from the corresponding mod. No body parameters are required for this action. Successful request will return 204 No Content.

    NOTE: Users can unsubscribe from mods via mod.io, we recommend you poll the Get All Mod Events endpoint to keep a users mods collection up to date.

    Example response

     204 No Content 
    

    Responses

    Status Meaning Description Response Schema
    204 No Content No Content None

    Events

    Get Mod Events

    Example request

    # You can also use wget
    curl -X GET https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/events?api_key=YourApiKey \
      -H 'Accept: application/json'
    
    
    GET https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/events?api_key=YourApiKey HTTP/1.1
    Host: api.mod.io
    
    Accept: application/json
    
    
    var headers = {
      'Accept':'application/json'
    
    };
    
    $.ajax({
      url: 'https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/events',
      method: 'get',
      data: '?api_key=YourApiKey',
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    const request = require('node-fetch');
    
    const headers = {
      'Accept':'application/json'
    
    };
    
    fetch('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/events?api_key=YourApiKey',
    {
      method: 'GET',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    r = requests.get('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/events', params={
      'api_key': 'YourApiKey'
    }, headers = headers)
    
    print r.json()
    
    URL obj = new URL("https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/events?api_key=YourApiKey");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    

    GET /games/{game-id}/mods/{mod-id}/events

    Get the event log for a mod, showing changes made sorted by latest event first. Successful request will return an array of Event Objects. We recommended reading the filtering documentation to return only the records you want.

    Filter Type Description
    id integer Unique id of the event object.
    mod_id integer Unique id of the parent mod.
    user_id integer Unique id of the user who performed the action.
    date_added integer Unix timestamp of date mod was updated.
    event_type string Type of change that occurred:

    MODFILE_CHANGED = Primary file changed, the mod should be updated
    MOD_AVAILABLE = Mod is marked as accepted and public
    MOD_UNAVAILABLE = Mod is marked as not accepted, deleted or hidden
    MOD_EDITED = The mod was updated (triggered when any column value changes)

    Example response

    {
      "data": [
        {
          "id": 13,
          "mod_id": 13,
          "user_id": 13,
          "date_added": 1499846132,
          "event_type": "MODFILE_CHANGED"
        },
        {
            ...
        }
      ],
      "result_count": 100,
      "result_limit": 100,
      "result_offset": 0
    }
    

    Responses

    Status Meaning Description Response Schema
    200 OK Successful Request Get Mod Events

    Get All Mod Events

    Example request

    # You can also use wget
    curl -X GET https://api.mod.io/v1/games/{game-id}/mods/events?api_key=YourApiKey \
      -H 'Accept: application/json'
    
    
    GET https://api.mod.io/v1/games/{game-id}/mods/events?api_key=YourApiKey HTTP/1.1
    Host: api.mod.io
    
    Accept: application/json
    
    
    var headers = {
      'Accept':'application/json'
    
    };
    
    $.ajax({
      url: 'https://api.mod.io/v1/games/{game-id}/mods/events',
      method: 'get',
      data: '?api_key=YourApiKey',
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    const request = require('node-fetch');
    
    const headers = {
      'Accept':'application/json'
    
    };
    
    fetch('https://api.mod.io/v1/games/{game-id}/mods/events?api_key=YourApiKey',
    {
      method: 'GET',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    r = requests.get('https://api.mod.io/v1/games/{game-id}/mods/events', params={
      'api_key': 'YourApiKey'
    }, headers = headers)
    
    print r.json()
    
    URL obj = new URL("https://api.mod.io/v1/games/{game-id}/mods/events?api_key=YourApiKey");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    

    GET /games/{game-id}/mods/events

    Get all mods events for the corresponding game sorted by latest event first. Successful request will return an array of Event Objects.

    NOTE: We recommend you poll this endpoint to keep mods up-to-date. If polling this endpoint for updates you should store the id or date_updated of the latest event, and on subsequent requests use that information in the filter, to return only newer events to process.

    Filter Type Description
    id integer Unique id of the event object.
    mod_id integer Unique id of the parent mod.
    user_id integer Unique id of the user who performed the action.
    date_added integer Unix timestamp of date mod was added.
    event_type string Type of change that occurred:

    MODFILE_CHANGED = Primary file changed
    MOD_AVAILABLE = Mod is marked as accepted and public
    MOD_UNAVAILABLE = Mod is marked as not accepted, deleted or hidden
    MOD_EDITED = The mod was updated (triggered when any column value changes)
    latest boolean Default value is true. Returns only the latest unique events, which is useful for checking if the primary modfile has changed.
    subscribed boolean Default value is false. Returns only events connected to mods the authenticated user is subscribed to, which is useful for keeping the users mods up-to-date.

    Example response

    {
      "data": [
        {
          "id": 13,
          "mod_id": 13,
          "user_id": 13,
          "date_added": 1499846132,
          "event_type": "MODFILE_CHANGED"
        },
        {
            ...
        }
      ],
      "result_count": 100,
      "result_limit": 100,
      "result_offset": 0
    }
    

    Responses

    Status Meaning Description Response Schema
    200 OK Successful Request Get Mod Events

    Tags

    Get All Game Tag Options

    Example request

    # You can also use wget
    curl -X GET https://api.mod.io/v1/games/{game-id}/tags?api_key=YourApiKey \
      -H 'Accept: application/json'
    
    
    GET https://api.mod.io/v1/games/{game-id}/tags?api_key=YourApiKey HTTP/1.1
    Host: api.mod.io
    
    Accept: application/json
    
    
    var headers = {
      'Accept':'application/json'
    
    };
    
    $.ajax({
      url: 'https://api.mod.io/v1/games/{game-id}/tags',
      method: 'get',
      data: '?api_key=YourApiKey',
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    const request = require('node-fetch');
    
    const headers = {
      'Accept':'application/json'
    
    };
    
    fetch('https://api.mod.io/v1/games/{game-id}/tags?api_key=YourApiKey',
    {
      method: 'GET',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    r = requests.get('https://api.mod.io/v1/games/{game-id}/tags', params={
      'api_key': 'YourApiKey'
    }, headers = headers)
    
    print r.json()
    
    URL obj = new URL("https://api.mod.io/v1/games/{game-id}/tags?api_key=YourApiKey");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    

    GET /games/{game-id}/tags

    Get all tags for the corresponding game, that can be applied to any of its mods. Successful request will return an array of Game Tag Option Objects.

    Example response

    {
      "data": [
        {
          "name": "Theme",
          "type": "checkboxes",
          "tags": [
            "Horror"
          ],
          "hidden": false
        },
        {
            ...
        }
      ],
      "result_count": 100,
      "result_limit": 100,
      "result_offset": 0
    }
    

    Responses

    Status Meaning Description Response Schema
    200 OK Successful Request Get All Game Tag Options

    Add Game Tag Option

    Example request

    # You can also use wget
    curl -X POST https://api.mod.io/v1/games/{game-id}/tags \
      -H 'Authorization: Bearer {access-token}' \
      -H 'Content-Type: application/x-www-form-urlencoded' \
      -H 'Accept: application/json'
    
    
    POST https://api.mod.io/v1/games/{game-id}/tags HTTP/1.1
    Host: api.mod.io
    
    Accept: application/json
    Authorization: Bearer {access-token}
    Content-Type: application/x-www-form-urlencoded
    
    
    
    var headers = {
      'Authorization':'Bearer {access-token}',
      'Content-Type':'application/x-www-form-urlencoded',
      'Accept':'application/json'
    
    };
    
    $.ajax({
      url: 'https://api.mod.io/v1/games/{game-id}/tags',
      method: 'post',
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    const request = require('node-fetch');
    
    const headers = {
      'Authorization':'Bearer {access-token}',
      'Content-Type':'application/x-www-form-urlencoded',
      'Accept':'application/json'
    
    };
    
    fetch('https://api.mod.io/v1/games/{game-id}/tags',
    {
      method: 'POST',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Authorization': 'Bearer {access-token}',
      'Content-Type': 'application/x-www-form-urlencoded',
      'Accept': 'application/json'
    }
    
    r = requests.post('https://api.mod.io/v1/games/{game-id}/tags', params={
    
    }, headers = headers)
    
    print r.json()
    
    URL obj = new URL("https://api.mod.io/v1/games/{game-id}/tags");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    

    POST /games/{game-id}/tags

    Add tags which mods can apply to their profiles. Successful request will return Message Object.

    Tagging is a critical feature that powers the searching and filtering of mods for your game, as well as allowing you to control how mods are installed and played. For example you might enforce mods to be a particular type (map, model, script, save, effects, blueprint), which dictates how you install it. You may use tags to specify what the mod replaces (building, prop, car, boat, character). Or perhaps the tags describe the theme of the mod (fun, scenic, realism). The implementation is up to you, but the more detail you support the better filtering and searching becomes. If you need to store more advanced information, you can also use Metadata Key Value Pairs.

    NOTE: You can also manage tags by editing your games profile on the mod.io website. This is the recommended approach.

    Parameter Type Required Description
    name string true Name of the tag group, for example you may want to have 'Difficulty' as the name with 'Easy', 'Medium' and 'Hard' as the tag values.

    NOTE: If the tag name already exists, its parameters will be overwritten and new tags will be added to the group (an edit). There is a separate endpoint to delete tags.
    type string true Determines whether you allow users to only select one tag (dropdown) or multiple tags (checkbox):

    dropdown = Mods can select only one tag from this group, dropdown menu shown on site profile.
    checkboxes = Mods can select multiple tags from this group, checkboxes shown on site profile.
    hidden boolean This group of tags should be hidden from users and mod developers. Useful for games to tag special functionality, to filter on and use behind the scenes. You can also use Metadata Key Value Pairs for more arbitary data.
    tags array true Array of tags mod creators can choose to apply to their profiles.

    Example response

    {
      "code": "201",
      "message": "You have successfully added categories/tags to the specified game."
    }
    

    Responses

    Status Meaning Description Response Schema
    201 Created Created Message Object

    Delete Game Tag Option

    Example request

    # You can also use wget
    curl -X DELETE https://api.mod.io/v1/games/{game-id}/tags \
      -H 'Authorization: Bearer {access-token}' \
      -H 'Content-Type: application/x-www-form-urlencoded' \
      -H 'Accept: application/json'
    
    
    DELETE https://api.mod.io/v1/games/{game-id}/tags HTTP/1.1
    Host: api.mod.io
    
    Accept: application/json
    Authorization: Bearer {access-token}
    Content-Type: application/x-www-form-urlencoded
    
    
    
    var headers = {
      'Authorization':'Bearer {access-token}',
      'Content-Type':'application/x-www-form-urlencoded',
      'Accept':'application/json'
    
    };
    
    $.ajax({
      url: 'https://api.mod.io/v1/games/{game-id}/tags',
      method: 'delete',
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    const request = require('node-fetch');
    
    const headers = {
      'Authorization':'Bearer {access-token}',
      'Content-Type':'application/x-www-form-urlencoded',
      'Accept':'application/json'
    
    };
    
    fetch('https://api.mod.io/v1/games/{game-id}/tags',
    {
      method: 'DELETE',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Authorization': 'Bearer {access-token}',
      'Content-Type': 'application/x-www-form-urlencoded',
      'Accept': 'application/json'
    }
    
    r = requests.delete('https://api.mod.io/v1/games/{game-id}/tags', params={
    
    }, headers = headers)
    
    print r.json()
    
    URL obj = new URL("https://api.mod.io/v1/games/{game-id}/tags");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("DELETE");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    

    DELETE /games/{game-id}/tags

    Delete an entire group of tags or individual tags. Successful request will return 204 No Content.

    NOTE: You can also manage tags by editing your games profile on the mod.io website. This is the recommended approach.

    Parameter Type Required Description
    name string true Name of the tag group that you want to delete tags from.
    tags string[] true Array of strings representing the tag options to delete. An empty array will delete the entire group. For example:

    Assume you have a group of tags titled 'Difficulty' and you want to remove the tag option 'Hard' from it. The name parameter would have the value 'Difficulty', and the tags array would have one value 'Hard'.

    Example response

     204 No Content 
    

    Responses

    Status Meaning Description Response Schema
    204 No Content No Content None

    Get All Mod Tags

    Example request

    # You can also use wget
    curl -X GET https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/tags?api_key=YourApiKey \
      -H 'Accept: application/json'
    
    
    GET https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/tags?api_key=YourApiKey HTTP/1.1
    Host: api.mod.io
    
    Accept: application/json
    
    
    var headers = {
      'Accept':'application/json'
    
    };
    
    $.ajax({
      url: 'https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/tags',
      method: 'get',
      data: '?api_key=YourApiKey',
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    const request = require('node-fetch');
    
    const headers = {
      'Accept':'application/json'
    
    };
    
    fetch('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/tags?api_key=YourApiKey',
    {
      method: 'GET',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    r = requests.get('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/tags', params={
      'api_key': 'YourApiKey'
    }, headers = headers)
    
    print r.json()
    
    URL obj = new URL("https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/tags?api_key=YourApiKey");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    

    GET /games/{game-id}/mods/{mod-id}/tags

    Get all tags for the corresponding mod. Successful request will return an array of Mod Tag Objects. We recommended reading the filtering documentation to return only the records you want.

    Filter Type Description
    date_added integer Unix timestamp of date tag was added.
    tag string String representation of the tag. You can check the eligible tags on the parent game object to determine all possible values for this field.

    Example response

    {
      "data": [
        {
          "name": "Unity",
          "date_added": 1499841487
        },
        {
            ...
        }
      ],
      "result_count": 100,
      "result_limit": 100,
      "result_offset": 0
    }
    

    Responses

    Status Meaning Description Response Schema
    200 OK Successful Request Get All Mod Tags

    Add Mod Tag

    Example request

    # You can also use wget
    curl -X POST https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/tags \
      -H 'Authorization: Bearer {access-token}' \
      -H 'Content-Type: application/x-www-form-urlencoded' \
      -H 'Accept: application/json'
    
    
    POST https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/tags HTTP/1.1
    Host: api.mod.io
    
    Accept: application/json
    Authorization: Bearer {access-token}
    Content-Type: application/x-www-form-urlencoded
    
    
    
    var headers = {
      'Authorization':'Bearer {access-token}',
      'Content-Type':'application/x-www-form-urlencoded',
      'Accept':'application/json'
    
    };
    
    $.ajax({
      url: 'https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/tags',
      method: 'post',
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    const request = require('node-fetch');
    
    const headers = {
      'Authorization':'Bearer {access-token}',
      'Content-Type':'application/x-www-form-urlencoded',
      'Accept':'application/json'
    
    };
    
    fetch('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/tags',
    {
      method: 'POST',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Authorization': 'Bearer {access-token}',
      'Content-Type': 'application/x-www-form-urlencoded',
      'Accept': 'application/json'
    }
    
    r = requests.post('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/tags', params={
    
    }, headers = headers)
    
    print r.json()
    
    URL obj = new URL("https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/tags");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    

    POST /games/{game-id}/mods/{mod-id}/tags

    Add tags to a mod's profile. You can only add tags allowed by the parent game, which are listed in the tag_option column in the Game's Object. Successful request will return Message Object.

    Parameter Type Required Description
    tags string[] true An array of tags to add. For example: If the parent game has a 'Theme' tag group with 'Fantasy', 'Sci-fi', 'Western' and 'Realistic' as the options, you could add 'Fantasy' and 'Sci-fi' to the tags array in your request. Provided the tags are valid you can add any number.

    Example response

    {
      "code": "201",
      "message": "You have successfully added tags to the specified mod."
    }
    

    Responses

    Status Meaning Description Response Schema
    201 Created Created Message Object

    Delete Mod Tag

    Example request

    # You can also use wget
    curl -X DELETE https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/tags \
      -H 'Authorization: Bearer {access-token}' \
      -H 'Content-Type: application/x-www-form-urlencoded' \
      -H 'Accept: application/json'
    
    
    DELETE https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/tags HTTP/1.1
    Host: api.mod.io
    
    Accept: application/json
    Authorization: Bearer {access-token}
    Content-Type: application/x-www-form-urlencoded
    
    
    
    var headers = {
      'Authorization':'Bearer {access-token}',
      'Content-Type':'application/x-www-form-urlencoded',
      'Accept':'application/json'
    
    };
    
    $.ajax({
      url: 'https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/tags',
      method: 'delete',
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    const request = require('node-fetch');
    
    const headers = {
      'Authorization':'Bearer {access-token}',
      'Content-Type':'application/x-www-form-urlencoded',
      'Accept':'application/json'
    
    };
    
    fetch('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/tags',
    {
      method: 'DELETE',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Authorization': 'Bearer {access-token}',
      'Content-Type': 'application/x-www-form-urlencoded',
      'Accept': 'application/json'
    }
    
    r = requests.delete('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/tags', params={
    
    }, headers = headers)
    
    print r.json()
    
    URL obj = new URL("https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/tags");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("DELETE");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    

    DELETE /games/{game-id}/mods/{mod-id}/tags

    Delete tags from a mod's profile. Deleting tags is identical to adding tags except the request method is DELETE instead of POST. Successful request will return 204 No Content.

    Parameter Type Required Description
    tags string[] true An array of tags to delete.

    Example response

     204 No Content 
    

    Responses

    Status Meaning Description Response Schema
    204 No Content No Content None

    Ratings

    Add Mod Rating

    Example request

    # You can also use wget
    curl -X POST https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/ratings \
      -H 'Authorization: Bearer {access-token}' \
      -H 'Content-Type: application/x-www-form-urlencoded' \
      -H 'Accept: application/json'
    
    
    POST https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/ratings HTTP/1.1
    Host: api.mod.io
    
    Accept: application/json
    Authorization: Bearer {access-token}
    Content-Type: application/x-www-form-urlencoded
    
    
    
    var headers = {
      'Authorization':'Bearer {access-token}',
      'Content-Type':'application/x-www-form-urlencoded',
      'Accept':'application/json'
    
    };
    
    $.ajax({
      url: 'https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/ratings',
      method: 'post',
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    const request = require('node-fetch');
    
    const headers = {
      'Authorization':'Bearer {access-token}',
      'Content-Type':'application/x-www-form-urlencoded',
      'Accept':'application/json'
    
    };
    
    fetch('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/ratings',
    {
      method: 'POST',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Authorization': 'Bearer {access-token}',
      'Content-Type': 'application/x-www-form-urlencoded',
      'Accept': 'application/json'
    }
    
    r = requests.post('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/ratings', params={
    
    }, headers = headers)
    
    print r.json()
    
    URL obj = new URL("https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/ratings");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    

    POST /games/{game-id}/mods/{mod-id}/ratings

    Submit a positive or negative rating for a mod. Each user can supply only one rating for a mod, subsequent ratings will override the old value. Successful request will return Message Object.

    NOTE: You can order mods by their rating, and view their rating in the Mod Object.

    Parameter Type Required Description
    rating integer true The authenticated users mod rating:

    1 = Positive rating (thumbs up)
    -1 = Negative rating (thumbs down)

    Example response

    {
      "code": "201",
      "message": "You have successfully submitted a rating for the specified mod."
    }
    

    Responses

    Status Meaning Description Response Schema
    201 Created Resource created Message Object

    Metadata

    Get All Mod KVP Metadata

    Example request

    # You can also use wget
    curl -X GET https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/metadatakvp?api_key=YourApiKey \
      -H 'Accept: application/json'
    
    
    GET https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/metadatakvp?api_key=YourApiKey HTTP/1.1
    Host: api.mod.io
    
    Accept: application/json
    
    
    var headers = {
      'Accept':'application/json'
    
    };
    
    $.ajax({
      url: 'https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/metadatakvp',
      method: 'get',
      data: '?api_key=YourApiKey',
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    const request = require('node-fetch');
    
    const headers = {
      'Accept':'application/json'
    
    };
    
    fetch('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/metadatakvp?api_key=YourApiKey',
    {
      method: 'GET',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    r = requests.get('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/metadatakvp', params={
      'api_key': 'YourApiKey'
    }, headers = headers)
    
    print r.json()
    
    URL obj = new URL("https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/metadatakvp?api_key=YourApiKey");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    

    GET /games/{game-id}/mods/{mod-id}/metadatakvp

    Get all metadata stored by the game developer for this mod as searchable key value pairs. Successful request will return an array of Metadata KVP Objects.

    NOTE: Metadata can also be stored as metadata_blob in the Mod Object.

    Example response

    {
      "data": [
        {
          "metakey": "pistol-dmg",
          "metavalue": "800"
        },
        {
            ...
        }
      ],
      "result_count": 100,
      "result_limit": 100,
      "result_offset": 0
    }
    

    Responses

    Status Meaning Description Response Schema
    200 OK Successful Request Get All Mod KVP Metadata

    Add Mod KVP Metadata

    Example request

    # You can also use wget
    curl -X POST https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/metadatakvp \
      -H 'Authorization: Bearer {access-token}' \
      -H 'Content-Type: application/x-www-form-urlencoded' \
      -H 'Accept: application/json'
    
    
    POST https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/metadatakvp HTTP/1.1
    Host: api.mod.io
    
    Accept: application/json
    Authorization: Bearer {access-token}
    Content-Type: application/x-www-form-urlencoded
    
    
    
    var headers = {
      'Authorization':'Bearer {access-token}',
      'Content-Type':'application/x-www-form-urlencoded',
      'Accept':'application/json'
    
    };
    
    $.ajax({
      url: 'https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/metadatakvp',
      method: 'post',
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    const request = require('node-fetch');
    
    const headers = {
      'Authorization':'Bearer {access-token}',
      'Content-Type':'application/x-www-form-urlencoded',
      'Accept':'application/json'
    
    };
    
    fetch('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/metadatakvp',
    {
      method: 'POST',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Authorization': 'Bearer {access-token}',
      'Content-Type': 'application/x-www-form-urlencoded',
      'Accept': 'application/json'
    }
    
    r = requests.post('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/metadatakvp', params={
    
    }, headers = headers)
    
    print r.json()
    
    URL obj = new URL("https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/metadatakvp");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    

    POST /games/{game-id}/mods/{mod-id}/metadatakvp

    Add metadata for this mod as searchable key value pairs. Metadata is useful to define how a mod works, or other information you need to display and manage the mod. Successful request will return Message Object.

    For example: A mod might change gravity and the rate of fire of weapons, you could define these properties as key value pairs. We recommend the mod upload tool you create defines and submits metadata behind the scenes, because if these settings affect gameplay, invalid information may cause problems.

    NOTE: Metadata can also be stored as metadata_blob in the Mod Object.

    Parameter Type Required Description
    metadata string[] true Array containing one or more key value pairs where the the key and value are separated by a colon ':' (if the string contains multiple colons the split will occur on the first matched, i.e. pistol-dmg:800:400 will become key: pistol-dmg, value: 800:400). NOTE:

    - Keys support alphanumeric, '_' and '-' characters only.
    - Keys can map to multiple values (1-to-many relationship).
    - Keys and values cannot exceed 255 characters in length.
    - Key value pairs are searchable by exact match only.

    Example response

    {
      "code": "201",
      "message": "You have successfully added new key-value metadata to the specified mod."
    }
    

    Responses

    Status Meaning Description Response Schema
    201 Created Created Message Object

    Delete Mod KVP Metadata

    Example request

    # You can also use wget
    curl -X DELETE https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/metadatakvp \
      -H 'Authorization: Bearer {access-token}' \
      -H 'Content-Type: application/x-www-form-urlencoded' \
      -H 'Accept: application/json'
    
    
    DELETE https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/metadatakvp HTTP/1.1
    Host: api.mod.io
    
    Accept: application/json
    Authorization: Bearer {access-token}
    Content-Type: application/x-www-form-urlencoded
    
    
    
    var headers = {
      'Authorization':'Bearer {access-token}',
      'Content-Type':'application/x-www-form-urlencoded',
      'Accept':'application/json'
    
    };
    
    $.ajax({
      url: 'https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/metadatakvp',
      method: 'delete',
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    const request = require('node-fetch');
    
    const headers = {
      'Authorization':'Bearer {access-token}',
      'Content-Type':'application/x-www-form-urlencoded',
      'Accept':'application/json'
    
    };
    
    fetch('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/metadatakvp',
    {
      method: 'DELETE',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Authorization': 'Bearer {access-token}',
      'Content-Type': 'application/x-www-form-urlencoded',
      'Accept': 'application/json'
    }
    
    r = requests.delete('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/metadatakvp', params={
    
    }, headers = headers)
    
    print r.json()
    
    URL obj = new URL("https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/metadatakvp");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("DELETE");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    

    DELETE /games/{game-id}/mods/{mod-id}/metadatakvp

    Delete key value pairs metadata defined for this mod. Successful request will return 204 No Content.

    Parameter Type Required Description
    metadata string[] true Array containing one or more key value pairs to delete where the the key and value are separated by a colon ':'. NOTE: If an array value contains only the key and no colon ':', all metadata with that key will be removed.

    Example response

     204 No Content 
    

    Responses

    Status Meaning Description Response Schema
    204 No Content No Content None

    Dependencies

    Get All Mod Dependencies

    Example request

    # You can also use wget
    curl -X GET https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/dependencies?api_key=YourApiKey \
      -H 'Accept: application/json'
    
    
    GET https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/dependencies?api_key=YourApiKey HTTP/1.1
    Host: api.mod.io
    
    Accept: application/json
    
    
    var headers = {
      'Accept':'application/json'
    
    };
    
    $.ajax({
      url: 'https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/dependencies',
      method: 'get',
      data: '?api_key=YourApiKey',
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    const request = require('node-fetch');
    
    const headers = {
      'Accept':'application/json'
    
    };
    
    fetch('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/dependencies?api_key=YourApiKey',
    {
      method: 'GET',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    r = requests.get('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/dependencies', params={
      'api_key': 'YourApiKey'
    }, headers = headers)
    
    print r.json()
    
    URL obj = new URL("https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/dependencies?api_key=YourApiKey");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    

    GET /games/{game-id}/mods/{mod-id}/dependencies

    Get all dependencies the chosen mod has selected. This is useful if a mod requires other mods be installed for it to run. Successful request will return an array of Mod Dependencies Objects.

    NOTE: Some developers might select soft dependencies to promote or credit other mods. We advise against this but it is possible to do.

    Example response

    {
      "data": [
        {
          "mod_id": 231,
          "date_added": 1499841487
        },
        {
            ...
        }
      ],
      "result_count": 100,
      "result_limit": 100,
      "result_offset": 0
    }
    

    Responses

    Status Meaning Description Response Schema
    200 OK Successful Request Get All Mod Dependencies

    Add Mod Dependencies

    Example request

    # You can also use wget
    curl -X POST https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/dependencies \
      -H 'Authorization: Bearer {access-token}' \
      -H 'Content-Type: application/x-www-form-urlencoded' \
      -H 'Accept: application/json'
    
    
    POST https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/dependencies HTTP/1.1
    Host: api.mod.io
    
    Accept: application/json
    Authorization: Bearer {access-token}
    Content-Type: application/x-www-form-urlencoded
    
    
    
    var headers = {
      'Authorization':'Bearer {access-token}',
      'Content-Type':'application/x-www-form-urlencoded',
      'Accept':'application/json'
    
    };
    
    $.ajax({
      url: 'https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/dependencies',
      method: 'post',
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    const request = require('node-fetch');
    
    const headers = {
      'Authorization':'Bearer {access-token}',
      'Content-Type':'application/x-www-form-urlencoded',
      'Accept':'application/json'
    
    };
    
    fetch('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/dependencies',
    {
      method: 'POST',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Authorization': 'Bearer {access-token}',
      'Content-Type': 'application/x-www-form-urlencoded',
      'Accept': 'application/json'
    }
    
    r = requests.post('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/dependencies', params={
    
    }, headers = headers)
    
    print r.json()
    
    URL obj = new URL("https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/dependencies");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    

    POST /games/{game-id}/mods/{mod-id}/dependencies

    Add mod dependencies required by the corresponding mod. A dependency is a mod that must be installed for this mod to run. Successful request will return Message Object.

    NOTE: Some developers might select soft dependencies to promote or credit other mods. We advise against this but it is possible to do.

    Parameter Type Required Description
    dependencies integer[] true Array containing one or more mod id's that this mod is dependent on. Max of 5 dependencies per request.

    Example response

    {
      "code": "201",
      "message": "You have successfully added new dependencies to the specified mod."
    }
    

    Responses

    Status Meaning Description Response Schema
    201 Created Created Message Object

    Delete Mod Dependencies

    Example request

    # You can also use wget
    curl -X DELETE https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/dependencies \
      -H 'Authorization: Bearer {access-token}' \
      -H 'Content-Type: application/x-www-form-urlencoded' \
      -H 'Accept: application/json'
    
    
    DELETE https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/dependencies HTTP/1.1
    Host: api.mod.io
    
    Accept: application/json
    Authorization: Bearer {access-token}
    Content-Type: application/x-www-form-urlencoded
    
    
    
    var headers = {
      'Authorization':'Bearer {access-token}',
      'Content-Type':'application/x-www-form-urlencoded',
      'Accept':'application/json'
    
    };
    
    $.ajax({
      url: 'https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/dependencies',
      method: 'delete',
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    const request = require('node-fetch');
    
    const headers = {
      'Authorization':'Bearer {access-token}',
      'Content-Type':'application/x-www-form-urlencoded',
      'Accept':'application/json'
    
    };
    
    fetch('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/dependencies',
    {
      method: 'DELETE',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Authorization': 'Bearer {access-token}',
      'Content-Type': 'application/x-www-form-urlencoded',
      'Accept': 'application/json'
    }
    
    r = requests.delete('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/dependencies', params={
    
    }, headers = headers)
    
    print r.json()
    
    URL obj = new URL("https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/dependencies");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("DELETE");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    

    DELETE /games/{game-id}/mods/{mod-id}/dependencies

    Delete mod dependencies the corresponding mod has selected. Successful request will return 204 No Content.

    Parameter Type Required Description
    dependencies integer[] true Array containing one or more mod id's that can be deleted as dependencies.

    Example response

     204 No Content 
    

    Responses

    Status Meaning Description Response Schema
    204 No Content No Content None

    Teams

    Get All Mod Team Members

    Example request

    # You can also use wget
    curl -X GET https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/team?api_key=YourApiKey \
      -H 'Accept: application/json'
    
    
    GET https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/team?api_key=YourApiKey HTTP/1.1
    Host: api.mod.io
    
    Accept: application/json
    
    
    var headers = {
      'Accept':'application/json'
    
    };
    
    $.ajax({
      url: 'https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/team',
      method: 'get',
      data: '?api_key=YourApiKey',
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    const request = require('node-fetch');
    
    const headers = {
      'Accept':'application/json'
    
    };
    
    fetch('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/team?api_key=YourApiKey',
    {
      method: 'GET',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    r = requests.get('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/team', params={
      'api_key': 'YourApiKey'
    }, headers = headers)
    
    print r.json()
    
    URL obj = new URL("https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/team?api_key=YourApiKey");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    

    GET /games/{game-id}/mods/{mod-id}/team

    Get all users that are part of a mod team. Successful request will return an array of Team Member Objects. We recommended reading the filtering documentation to return only the records you want.

    Filter Type Required Description
    id integer Unique id of the team member record.
    user_id integer Unique id of the user.
    username string Username of the user.
    level integer Level of permission the user has:

    1 = Moderator (can moderate comments and content attached)
    4 = Creator (moderator access, including uploading builds and edit all settings except supply and team members)
    8 = Administrator (full access, including editing the supply and team)
    date_added integer Unix timestamp of the date the user was added to the team.
    position string Custom title given to the user in this team.

    Example response

    {
      "data": [
        {
          "id": 457,
          "user": {
            "id": 1,
            "name_id": "xant",
            "username": "XanT",
            "date_online": 1509922961,
            "avatar": {
              "filename": "modio-dark.png",
              "original": "https://static.mod.io/v1/images/global/ao_modio-dark.png",
              "thumb_50x50": "https://static.mod.io/v1/images/global/modio-dark.png",
              "thumb_100x100": "https://static.mod.io/v1/images/global/am_modio-dark.png"
            },
            "timezone": "America/Los_Angeles",
            "language": "en",
            "profile_url": "https://mod.io/members/xant"
          },
          "level": 8,
          "date_added": 1492058857,
          "position": "Supreme Overlord"
        },
        {
            ...
        }
      ],
      "result_count": 100,
      "result_limit": 100,
      "result_offset": 0
    }
    

    Responses

    Status Meaning Description Response Schema
    200 OK Successful Request Get All Team Members

    Add Mod Team Member

    Example request

    # You can also use wget
    curl -X POST https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/team \
      -H 'Authorization: Bearer {access-token}' \
      -H 'Content-Type: application/x-www-form-urlencoded' \
      -H 'Accept: application/json'
    
    
    POST https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/team HTTP/1.1
    Host: api.mod.io
    
    Accept: application/json
    Authorization: Bearer {access-token}
    Content-Type: application/x-www-form-urlencoded
    
    
    
    var headers = {
      'Authorization':'Bearer {access-token}',
      'Content-Type':'application/x-www-form-urlencoded',
      'Accept':'application/json'
    
    };
    
    $.ajax({
      url: 'https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/team',
      method: 'post',
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    const request = require('node-fetch');
    
    const headers = {
      'Authorization':'Bearer {access-token}',
      'Content-Type':'application/x-www-form-urlencoded',
      'Accept':'application/json'
    
    };
    
    fetch('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/team',
    {
      method: 'POST',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Authorization': 'Bearer {access-token}',
      'Content-Type': 'application/x-www-form-urlencoded',
      'Accept': 'application/json'
    }
    
    r = requests.post('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/team', params={
    
    }, headers = headers)
    
    print r.json()
    
    URL obj = new URL("https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/team");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    

    POST /games/{game-id}/mods/{mod-id}/team

    Add a user to a mod team. Successful request will return Message Object.

    NOTE: You can also add users to your mods team on the mod.io website. This is the recommended way.

    Parameter Type Required Description
    email string true Email of the mod.io user you want to add to your team.
    level integer true Level of permission the user will get:

    1 = Moderator (can moderate comments and content attached)
    4 = Creator (moderator access, including uploading builds and edit all settings except supply and team members)
    8 = Administrator (full access, including editing the supply and team)
    position string Title of the users position. For example: 'Team Leader', 'Artist'.

    Example response

    {
      "code": "201",
      "message": "You have successfully added a member to the specified team."
    }
    

    Responses

    Status Meaning Description Response Schema
    201 Created Created Message Object

    Update Mod Team Member

    Example request

    # You can also use wget
    curl -X PUT https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/team/{team-member-id} \
      -H 'Authorization: Bearer {access-token}' \
      -H 'Content-Type: application/x-www-form-urlencoded' \
      -H 'Accept: application/json'
    
    
    PUT https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/team/{team-member-id} HTTP/1.1
    Host: api.mod.io
    
    Accept: application/json
    Authorization: Bearer {access-token}
    Content-Type: application/x-www-form-urlencoded
    
    
    
    var headers = {
      'Authorization':'Bearer {access-token}',
      'Content-Type':'application/x-www-form-urlencoded',
      'Accept':'application/json'
    
    };
    
    $.ajax({
      url: 'https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/team/{team-member-id}',
      method: 'put',
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    const request = require('node-fetch');
    
    const headers = {
      'Authorization':'Bearer {access-token}',
      'Content-Type':'application/x-www-form-urlencoded',
      'Accept':'application/json'
    
    };
    
    fetch('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/team/{team-member-id}',
    {
      method: 'PUT',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Authorization': 'Bearer {access-token}',
      'Content-Type': 'application/x-www-form-urlencoded',
      'Accept': 'application/json'
    }
    
    r = requests.put('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/team/{team-member-id}', params={
    
    }, headers = headers)
    
    print r.json()
    
    URL obj = new URL("https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/team/{team-member-id}");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("PUT");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    

    PUT /games/{game-id}/mods/{mod-id}/team/{team-member-id}

    Update a mod team members details. Successful request will return Message Object.

    NOTE: You can also update your mods team users on the mod.io website. This is the recommended way.

    Parameter Type Required Description
    level integer Level of permission the user should have:

    1 = Moderator (can moderate comments and content attached)
    4 = Creator (moderator access, including uploading builds and edit all settings except supply and team members)
    8 = Administrator (full access, including editing the supply and team)
    position string Title of the users position. For example: 'Team Leader', 'Artist'.

    Example response

    {
      "code": "201",
      "message": "You have successfully updated the specified team members details."
    }
    

    Responses

    Status Meaning Description Response Schema
    200 OK OK Message Object

    Delete Mod Team Member

    Example request

    # You can also use wget
    curl -X DELETE https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/team/{team-member-id} \
      -H 'Authorization: Bearer {access-token}' \
      -H 'Content-Type: application/x-www-form-urlencoded' \
      -H 'Accept: application/json'
    
    
    DELETE https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/team/{team-member-id} HTTP/1.1
    Host: api.mod.io
    
    Accept: application/json
    Authorization: Bearer {access-token}
    Content-Type: application/x-www-form-urlencoded
    
    
    
    var headers = {
      'Authorization':'Bearer {access-token}',
      'Content-Type':'application/x-www-form-urlencoded',
      'Accept':'application/json'
    
    };
    
    $.ajax({
      url: 'https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/team/{team-member-id}',
      method: 'delete',
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    const request = require('node-fetch');
    
    const headers = {
      'Authorization':'Bearer {access-token}',
      'Content-Type':'application/x-www-form-urlencoded',
      'Accept':'application/json'
    
    };
    
    fetch('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/team/{team-member-id}',
    {
      method: 'DELETE',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Authorization': 'Bearer {access-token}',
      'Content-Type': 'application/x-www-form-urlencoded',
      'Accept': 'application/json'
    }
    
    r = requests.delete('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/team/{team-member-id}', params={
    
    }, headers = headers)
    
    print r.json()
    
    URL obj = new URL("https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/team/{team-member-id}");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("DELETE");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    

    DELETE /games/{game-id}/mods/{mod-id}/team/{team-member-id}

    Delete a user from a mod team. This will revoke their access rights if they are not the original creator of the resource. Successful request will return 204 No Content.

    Example response

     204 No Content 
    

    Responses

    Status Meaning Description Response Schema
    204 No Content No Content None

    Comments

    Get All Mod Comments

    Example request

    # You can also use wget
    curl -X GET https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/comments?api_key=YourApiKey \
      -H 'Accept: application/json'
    
    
    GET https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/comments?api_key=YourApiKey HTTP/1.1
    Host: api.mod.io
    
    Accept: application/json
    
    
    var headers = {
      'Accept':'application/json'
    
    };
    
    $.ajax({
      url: 'https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/comments',
      method: 'get',
      data: '?api_key=YourApiKey',
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    const request = require('node-fetch');
    
    const headers = {
      'Accept':'application/json'
    
    };
    
    fetch('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/comments?api_key=YourApiKey',
    {
      method: 'GET',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    r = requests.get('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/comments', params={
      'api_key': 'YourApiKey'
    }, headers = headers)
    
    print r.json()
    
    URL obj = new URL("https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/comments?api_key=YourApiKey");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    

    GET /games/{game-id}/mods/{mod-id}/comments

    Get all comments posted in the mods profile. Successful request will return an array of Comment Objects. We recommended reading the filtering documentation to return only the records you want.

    Filter Type Description
    id integer Unique id of the comment.
    mod_id integer Unique id of the mod.
    submitted_by integer Unique id of the user who posted the comment.
    date_added integer Unix timestamp of date comment was posted.
    reply_id integer Id of the parent comment this comment is replying to (can be 0 if the comment is not a reply).
    reply_position string Levels of nesting in a comment thread. You should order by this field, to maintain comment grouping. How it works:

    - The first comment will have the position '01'.
    - The second comment will have the position '02'.
    - If someone responds to the second comment the position will be '02.01'.
    - A maximum of 3 levels is supported.
    karma integer Karma received for the comment (can be postive or negative).
    summary string Contents of the comment.

    Example response

    {
      "data": [
        {
          "id": 2,
          "mod_id": 2,
          "submitted_by": {
            "id": 1,
            "name_id": "xant",
            "username": "XanT",
            "date_online": 1509922961,
            "avatar": {
              "filename": "modio-dark.png",
              "original": "https://static.mod.io/v1/images/global/ao_modio-dark.png",
              "thumb_50x50": "https://static.mod.io/v1/images/global/modio-dark.png",
              "thumb_100x100": "https://static.mod.io/v1/images/global/am_modio-dark.png"
            },
            "timezone": "America/Los_Angeles",
            "language": "en",
            "profile_url": "https://mod.io/members/xant"
          },
          "date_added": 1499841487,
          "reply_id": 1499,
          "reply_position": "01",
          "karma": 1,
          "karma_guest": 0,
          "content": "This mod is kickass! Great work!"
        },
        {
            ...
        }
      ],
      "result_count": 100,
      "result_limit": 100,
      "result_offset": 0
    }
    

    Responses

    Status Meaning Description Response Schema
    200 OK OK Get All Mod Comments

    Delete Mod Comment

    Example request

    # You can also use wget
    curl -X DELETE https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/comments/{comment-id} \
      -H 'Authorization: Bearer {access-token}' \
      -H 'Content-Type: application/x-www-form-urlencoded' \
      -H 'Accept: application/json'
    
    
    DELETE https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/comments/{comment-id} HTTP/1.1
    Host: api.mod.io
    
    Accept: application/json
    Authorization: Bearer {access-token}
    Content-Type: application/x-www-form-urlencoded
    
    
    
    var headers = {
      'Authorization':'Bearer {access-token}',
      'Content-Type':'application/x-www-form-urlencoded',
      'Accept':'application/json'
    
    };
    
    $.ajax({
      url: 'https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/comments/{comment-id}',
      method: 'delete',
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    const request = require('node-fetch');
    
    const headers = {
      'Authorization':'Bearer {access-token}',
      'Content-Type':'application/x-www-form-urlencoded',
      'Accept':'application/json'
    
    };
    
    fetch('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/comments/{comment-id}',
    {
      method: 'DELETE',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Authorization': 'Bearer {access-token}',
      'Content-Type': 'application/x-www-form-urlencoded',
      'Accept': 'application/json'
    }
    
    r = requests.delete('https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/comments/{comment-id}', params={
    
    }, headers = headers)
    
    print r.json()
    
    URL obj = new URL("https://api.mod.io/v1/games/{game-id}/mods/{mod-id}/comments/{comment-id}");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("DELETE");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    

    DELETE /games/{game-id}/mods/{mod-id}/comments/{comment-id}

    Delete a comment from a mod profile. Successful request will return 204 No Content.

    Example response

     204 No Content 
    

    Responses

    Status Meaning Description Response Schema
    204 No Content No Content None

    Users

    Get Resource Owner

    Example request

    # You can also use wget
    curl -X POST https://api.mod.io/v1/general/ownership \
      -H 'Authorization: Bearer {access-token}' \
      -H 'Content-Type: application/x-www-form-urlencoded' \
      -H 'Accept: application/json'
    
    
    POST https://api.mod.io/v1/general/ownership HTTP/1.1
    Host: api.mod.io
    
    Accept: application/json
    Authorization: Bearer {access-token}
    Content-Type: application/x-www-form-urlencoded
    
    
    
    var headers = {
      'Authorization':'Bearer {access-token}',
      'Content-Type':'application/x-www-form-urlencoded',
      'Accept':'application/json'
    
    };
    
    $.ajax({
      url: 'https://api.mod.io/v1/general/ownership',
      method: 'post',
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    const request = require('node-fetch');
    
    const headers = {
      'Authorization':'Bearer {access-token}',
      'Content-Type':'application/x-www-form-urlencoded',
      'Accept':'application/json'
    
    };
    
    fetch('https://api.mod.io/v1/general/ownership',
    {
      method: 'POST',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Authorization': 'Bearer {access-token}',
      'Content-Type': 'application/x-www-form-urlencoded',
      'Accept': 'application/json'
    }
    
    r = requests.post('https://api.mod.io/v1/general/ownership', params={
    
    }, headers = headers)
    
    print r.json()
    
    URL obj = new URL("https://api.mod.io/v1/general/ownership");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    

    POST /general/ownership

    Get the user that is the original submitter of a resource. Successful request will return a single User Object.

    NOTE: Mods and games can be managed by teams of users, for the most accurate information you should use the Team endpoints.

    Parameter Type Required Description
    resource_type string true Type of resource you are checking the ownership of. Must be one of the following values:

    games
    mods
    files
    resource_id integer true Unique id of the resource you are checking the ownership of.

    Example response

    {
      "id": 1,
      "name_id": "xant",
      "username": "XanT",
      "date_online": 1509922961,
      "avatar": {
        "filename": "modio-dark.png",
        "original": "https://static.mod.io/v1/images/global/ao_modio-dark.png",
        "thumb_50x50": "https://static.mod.io/v1/images/global/modio-dark.png",
        "thumb_100x100": "https://static.mod.io/v1/images/global/am_modio-dark.png"
      },
      "timezone": "America/Los_Angeles",
      "language": "en",
      "profile_url": "https://mod.io/members/xant"
    }
    

    Responses

    Status Meaning Description Response Schema
    200 OK Successful Request User Object

    Get All Users

    Example request

    # You can also use wget
    curl -X GET https://api.mod.io/v1/users?api_key=YourApiKey \
      -H 'Accept: application/json'
    
    
    GET https://api.mod.io/v1/users?api_key=YourApiKey HTTP/1.1
    Host: api.mod.io
    
    Accept: application/json
    
    
    var headers = {
      'Accept':'application/json'
    
    };
    
    $.ajax({
      url: 'https://api.mod.io/v1/users',
      method: 'get',
      data: '?api_key=YourApiKey',
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    const request = require('node-fetch');
    
    const headers = {
      'Accept':'application/json'
    
    };
    
    fetch('https://api.mod.io/v1/users?api_key=YourApiKey',
    {
      method: 'GET',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    r = requests.get('https://api.mod.io/v1/users', params={
      'api_key': 'YourApiKey'
    }, headers = headers)
    
    print r.json()
    
    URL obj = new URL("https://api.mod.io/v1/users?api_key=YourApiKey");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    

    GET /users

    Get all users registered on mod.io. Successful request will return an array of User Objects. We recommended reading the filtering documentation to return only the records you want.

    Filter Type Description
    id integer Unique id of the user.
    name_id string Path for the user on mod.io. For example: https://mod.io/members/username-id-here Usually a simplified version of their username.
    date_online integer Unix timestamp of date the user was last online.
    username string Username of the user.
    timezone string Timezone of the user, format is country/city.
    language string 2-character representation of language.

    Example response

    {
      "data": [
        {
          "id": 1,
          "name_id": "xant",
          "username": "XanT",
          "date_online": 1509922961,
          "avatar": {
            "filename": "modio-dark.png",
            "original": "https://static.mod.io/v1/images/global/ao_modio-dark.png",
            "thumb_50x50": "https://static.mod.io/v1/images/global/modio-dark.png",
            "thumb_100x100": "https://static.mod.io/v1/images/global/am_modio-dark.png"
          },
          "timezone": "America/Los_Angeles",
          "language": "en",
          "profile_url": "https://mod.io/members/xant"
        },
        {
            ...
        }
      ],
      "result_count": 100,
      "result_limit": 100,
      "result_offset": 0
    }
    

    Responses

    Status Meaning Description Response Schema
    200 OK OK Get All Users

    Get User

    Example request

    # You can also use wget
    curl -X GET https://api.mod.io/v1/users/{user-id}?api_key=YourApiKey \
      -H 'Accept: application/json'
    
    
    GET https://api.mod.io/v1/users/{user-id}?api_key=YourApiKey HTTP/1.1
    Host: api.mod.io
    
    Accept: application/json
    
    
    var headers = {
      'Accept':'application/json'
    
    };
    
    $.ajax({
      url: 'https://api.mod.io/v1/users/{user-id}',
      method: 'get',
      data: '?api_key=YourApiKey',
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    const request = require('node-fetch');
    
    const headers = {
      'Accept':'application/json'
    
    };
    
    fetch('https://api.mod.io/v1/users/{user-id}?api_key=YourApiKey',
    {
      method: 'GET',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    r = requests.get('https://api.mod.io/v1/users/{user-id}', params={
      'api_key': 'YourApiKey'
    }, headers = headers)
    
    print r.json()
    
    URL obj = new URL("https://api.mod.io/v1/users/{user-id}?api_key=YourApiKey");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    

    GET /users/{user-id}

    Get a user. Successful request will return a single User Object.

    Example response

    {
      "id": 1,
      "name_id": "xant",
      "username": "XanT",
      "date_online": 1509922961,
      "avatar": {
        "filename": "modio-dark.png",
        "original": "https://static.mod.io/v1/images/global/ao_modio-dark.png",
        "thumb_50x50": "https://static.mod.io/v1/images/global/modio-dark.png",
        "thumb_100x100": "https://static.mod.io/v1/images/global/am_modio-dark.png"
      },
      "timezone": "America/Los_Angeles",
      "language": "en",
      "profile_url": "https://mod.io/members/xant"
    }
    

    Responses

    Status Meaning Description Response Schema
    200 OK OK User Object

    Reports

    Submit Report

    Example request

    # You can also use wget
    curl -X POST https://api.mod.io/v1/report \
      -H 'Authorization: Bearer {access-token}' \
      -H 'Content-Type: application/x-www-form-urlencoded' \
      -H 'Accept: application/json'
    
    
    POST https://api.mod.io/v1/report HTTP/1.1
    Host: api.mod.io
    
    Accept: application/json
    Authorization: Bearer {access-token}
    Content-Type: application/x-www-form-urlencoded
    
    
    
    var headers = {
      'Authorization':'Bearer {access-token}',
      'Content-Type':'application/x-www-form-urlencoded',
      'Accept':'application/json'
    
    };
    
    $.ajax({
      url: 'https://api.mod.io/v1/report',
      method: 'post',
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    const request = require('node-fetch');
    
    const headers = {
      'Authorization':'Bearer {access-token}',
      'Content-Type':'application/x-www-form-urlencoded',
      'Accept':'application/json'
    
    };
    
    fetch('https://api.mod.io/v1/report',
    {
      method: 'POST',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Authorization': 'Bearer {access-token}',
      'Content-Type': 'application/x-www-form-urlencoded',
      'Accept': 'application/json'
    }
    
    r = requests.post('https://api.mod.io/v1/report', params={
    
    }, headers = headers)
    
    print r.json()
    
    URL obj = new URL("https://api.mod.io/v1/report");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    

    POST /report

    Submit a report for any resource on mod.io. Successful request will return Message Object.

    NOTE: You can also submit a report online and read our terms of use for information about what is/isn't acceptable.

    Parameter Type Required Description
    resource string true Type of resource you are reporting. Must be one of the following values:

    games
    mods
    users
    id integer true Unique id of the resource you are reporting.
    type integer true The type of report you are submitting. Must be one of the following values:

    0 = Generic Report
    1 = DMCA Report
    name string true Informative title for your report.
    summary string true Detailed description of your report. Make sure you include all relevant information and links to help moderators investigate and respond appropiately.

    Example response

    {
      "code": "201",
      "message": "You have successfully submitted a report and it will be reviewed by the mod.io team as soon as possible."
    }
    

    Responses

    Status Meaning Description Response Schema
    201 Created Report Created Message Object

    Me

    Get Authenticated User

    Example request

    # You can also use wget
    curl -X GET https://api.mod.io/v1/me \
      -H 'Authorization: Bearer {access-token}' \
      -H 'Accept: application/json'
    
    
    GET https://api.mod.io/v1/me HTTP/1.1
    Host: api.mod.io
    
    Accept: application/json
    Authorization: Bearer {access-token}
    
    
    
    var headers = {
      'Authorization':'Bearer {access-token}',
      'Accept':'application/json'
    
    };
    
    $.ajax({
      url: 'https://api.mod.io/v1/me',
      method: 'get',
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    const request = require('node-fetch');
    
    const headers = {
      'Authorization':'Bearer {access-token}',
      'Accept':'application/json'
    
    };
    
    fetch('https://api.mod.io/v1/me',
    {
      method: 'GET',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Authorization': 'Bearer {access-token}',
      'Accept': 'application/json'
    }
    
    r = requests.get('https://api.mod.io/v1/me', params={
    
    }, headers = headers)
    
    print r.json()
    
    URL obj = new URL("https://api.mod.io/v1/me");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    

    GET /me

    Get the authenticated user details. Successful request will return a single User Object.

    Example response

    {
      "id": 1,
      "name_id": "xant",
      "username": "XanT",
      "date_online": 1509922961,
      "avatar": {
        "filename": "modio-dark.png",
        "original": "https://static.mod.io/v1/images/global/ao_modio-dark.png",
        "thumb_50x50": "https://static.mod.io/v1/images/global/modio-dark.png",
        "thumb_100x100": "https://static.mod.io/v1/images/global/am_modio-dark.png"
      },
      "timezone": "America/Los_Angeles",
      "language": "en",
      "profile_url": "https://mod.io/members/xant"
    }
    

    Responses

    Status Meaning Description Response Schema
    200 OK Request Successful User Object

    Get User Subscriptions

    Example request

    # You can also use wget
    curl -X GET https://api.mod.io/v1/me/subscribed \
      -H 'Authorization: Bearer {access-token}' \
      -H 'Accept: application/json'
    
    
    GET https://api.mod.io/v1/me/subscribed HTTP/1.1
    Host: api.mod.io
    
    Accept: application/json
    Authorization: Bearer {access-token}
    
    
    
    var headers = {
      'Authorization':'Bearer {access-token}',
      'Accept':'application/json'
    
    };
    
    $.ajax({
      url: 'https://api.mod.io/v1/me/subscribed',
      method: 'get',
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    const request = require('node-fetch');
    
    const headers = {
      'Authorization':'Bearer {access-token}',
      'Accept':'application/json'
    
    };
    
    fetch('https://api.mod.io/v1/me/subscribed',
    {
      method: 'GET',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Authorization': 'Bearer {access-token}',
      'Accept': 'application/json'
    }
    
    r = requests.get('https://api.mod.io/v1/me/subscribed', params={
    
    }, headers = headers)
    
    print r.json()
    
    URL obj = new URL("https://api.mod.io/v1/me/subscribed");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    

    GET /me/subscribed

    Get all mod's the authenticated user is subscribed to. Successful request will return an array of Mod Objects. We recommended reading the filtering documentation to return only the records you want.

    Filter Type Description
    id integer Unique id of the mod.
    game_id integer Unique id of the parent game.
    submitted_by integer Unique id of the user who has ownership of the mod.
    date_added integer Unix timestamp of date mod was registered.
    date_updated integer Unix timestamp of date mod was updated.
    date_live integer Unix timestamp of date mod was set live.
    name string Name of the mod.
    name_id string Path for the mod on mod.io. For example: https://gamename.mod.io/mod-name-id-here
    summary string Summary of the mod.
    description string Detailed description of the mod which allows HTML.
    homepage string Official homepage of the mod.
    metadata_blob string Metadata stored by the game developer.
    tags string Comma-separated values representing the tags you want to filter the results by. Only tags that are supported by the parent game can be applied. To determine what tags are eligible, see the tags values within tag_options column on the parent Game Object.
    downloads string Sort results by most downloads using _sort filter parameter, value should be downloads for descending or -downloads for ascending results.
    popular string Sort results by popularity using _sort filter, value should be popular for descending or -popular for ascending results.
    rating string Sort results by weighted rating using _sort filter, value should be rating for descending or -rating for ascending results.
    subscribers string Sort results by most subscribers using _sort filter, value should be subscribers for descending or -subscribers for ascending results.

    Example response

    {
      "data": [
        {
          "id": 2,
          "game_id": 2,
          "status": 1,
          "visible": 1,
          "submitted_by": {
            "id": 1,
            "name_id": "xant",
            "username": "XanT",
            "date_online": 1509922961,
            "avatar": {
              "filename": "modio-dark.png",
              "original": "https://static.mod.io/v1/images/global/ao_modio-dark.png",
              "thumb_50x50": "https://static.mod.io/v1/images/global/modio-dark.png",
              "thumb_100x100": "https://static.mod.io/v1/images/global/am_modio-dark.png"
            },
            "timezone": "America/Los_Angeles",
            "language": "en",
            "profile_url": "https://mod.io/members/xant"
          },
          "date_added": 1492564103,
          "date_updated": 1499841487,
          "date_live": 1499841403,
          "logo": {
            "filename": "modio-dark.png",
            "original": "https://static.mod.io/v1/images/global/modio-dark.png",
            "thumb_320x180": "https://static.mod.io/v1/images/global/modio-dark.png",
            "thumb_640x360": "https://static.mod.io/v1/images/global/modio-dark.png",
            "thumb_1280x720": "https://static.mod.io/v1/images/global/modio-dark.png"
          },
          "homepage": "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": "<h2>About</h2><p>Rogue HD Pack does exactly what you thi...",
          "metadata_blob": "rogue,hd,high-res,4k,hd textures",
          "profile_url": "https://rogue-knight.mod.io/rogue-knight-hd-pack",
          "modfile": {
            "id": 2,
            "mod_id": 2,
            "date_added": 1499841487,
            "date_scanned": 1499841487,
            "virus_status": 0,
            "virus_positive": 0,
            "virustotal_hash": "f9a7bf4a95ce20787337b685a79677cae2281b83c63ab0a25f091407741692af-1508147401",
            "filesize": 15181,
            "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://mod.io/mods/file/1/c489a0354111a4d76640d47f0cdcb294",
              "date_expires": 1579316848
            }
          },
          "media": {
            "youtube": [
              "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
            ],
            "sketchfab": [
              "https://sketchfab.com/models/ef40b2d300334d009984c8865b2db1c8"
            ],
            "images": [
              {
                "filename": "modio-dark.png",
                "original": "https://static.mod.io/v1/images/global/modio-dark.png",
                "thumb_320x180": "https://static.mod.io/v1/images/global/modio-dark.png"
              }
            ]
          },
          "rating_summary": {
            "total_ratings": 1230,
            "positive_ratings": 1047,
            "negative_ratings": 183,
            "percentage_positive": 91,
            "weighted_aggregate": 87.38,
            "display_text": "Very Positive"
          },
          "tags": [
            {
              "name": "Unity",
              "date_added": 1499841487
            }
          ]
        },
        {
            ...
        }
      ],
      "result_count": 100,
      "result_limit": 100,
      "result_offset": 0
    }
    

    Responses

    Status Meaning Description Response Schema
    200 OK Request Successful Get All Mods

    Get User Events

    Example request

    # You can also use wget
    curl -X GET https://api.mod.io/v1/me/events?api_key=YourApiKey \
      -H 'Accept: application/json'
    
    
    GET https://api.mod.io/v1/me/events?api_key=YourApiKey HTTP/1.1
    Host: api.mod.io
    
    Accept: application/json
    
    
    var headers = {
      'Accept':'application/json'
    
    };
    
    $.ajax({
      url: 'https://api.mod.io/v1/me/events',
      method: 'get',
      data: '?api_key=YourApiKey',
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    const request = require('node-fetch');
    
    const headers = {
      'Accept':'application/json'
    
    };
    
    fetch('https://api.mod.io/v1/me/events?api_key=YourApiKey',
    {
      method: 'GET',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    r = requests.get('https://api.mod.io/v1/me/events', params={
      'api_key': 'YourApiKey'
    }, headers = headers)
    
    print r.json()
    
    URL obj = new URL("https://api.mod.io/v1/me/events?api_key=YourApiKey");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    

    GET /me/events

    Get events that have been fired specific to the user. Successful request will return an array of Event Objects. We recommended reading the filtering documentation to return only the records you want.

    Filter Type Description
    id integer Unique id of the event object.
    mod_id integer Unique id of the parent mod.
    user_id integer Unique id of the user who performed the action.
    date_added integer Unix timestamp of date mod was updated.
    event_type string Type of change that occurred:

    USER_TEAM_JOIN = User has joined a team.
    USER_TEAM_LEAVE = User has left a team.
    USER_SUBSCRIBE = User has subscribed to a mod.
    USER_UNSUBSCRIBE = User has un-subscribed from a mod.

    Example response

    {
      "data": [
        {
          "id": 13,
          "mod_id": 13,
          "user_id": 13,
          "date_added": 1499846132,
          "event_type": "MODFILE_CHANGED"
        },
        {
            ...
        }
      ],
      "result_count": 100,
      "result_limit": 100,
      "result_offset": 0
    }
    

    Responses

    Status Meaning Description Response Schema
    200 OK Successful Request Get Mod Events

    Get User Games

    Example request

    # You can also use wget
    curl -X GET https://api.mod.io/v1/me/games \
      -H 'Authorization: Bearer {access-token}' \
      -H 'Accept: application/json'
    
    
    GET https://api.mod.io/v1/me/games HTTP/1.1
    Host: api.mod.io
    
    Accept: application/json
    Authorization: Bearer {access-token}
    
    
    
    var headers = {
      'Authorization':'Bearer {access-token}',
      'Accept':'application/json'
    
    };
    
    $.ajax({
      url: 'https://api.mod.io/v1/me/games',
      method: 'get',
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    const request = require('node-fetch');
    
    const headers = {
      'Authorization':'Bearer {access-token}',
      'Accept':'application/json'
    
    };
    
    fetch('https://api.mod.io/v1/me/games',
    {
      method: 'GET',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Authorization': 'Bearer {access-token}',
      'Accept': 'application/json'
    }
    
    r = requests.get('https://api.mod.io/v1/me/games', params={
    
    }, headers = headers)
    
    print r.json()
    
    URL obj = new URL("https://api.mod.io/v1/me/games");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    

    GET /me/games

    Get all games the authenticated user added or is a team member of. Successful request will return an array of Game Objects.

    Example response

    {
      "data": [
        {
          "id": 2,
          "status": 1,
          "submitted_by": {
            "id": 1,
            "name_id": "xant",
            "username": "XanT",
            "date_online": 1509922961,
            "avatar": {
              "filename": "modio-dark.png",
              "original": "https://static.mod.io/v1/images/global/ao_modio-dark.png",
              "thumb_50x50": "https://static.mod.io/v1/images/global/modio-dark.png",
              "thumb_100x100": "https://static.mod.io/v1/images/global/am_modio-dark.png"
            },
            "timezone": "America/Los_Angeles",
            "language": "en",
            "profile_url": "https://mod.io/members/xant"
          },
          "date_added": 1493702614,
          "date_updated": 1499410290,
          "date_live": 1499841403,
          "presentation_option": 1,
          "submission_option": 0,
          "curation_option": 0,
          "community_options": 3,
          "revenue_options": 1500,
          "api_access_options": 3,
          "ugc_name": "map",
          "icon": {
            "filename": "modio-dark.png",
            "original": "https://static.mod.io/v1/images/global/ao_modio-dark.png",
            "thumb_64x64": "https://static.mod.io/v1/images/global/modio-dark.png",
            "thumb_128x128": "https://static.mod.io/v1/images/global/am_modio-dark.png",
            "thumb_256x256": "https://static.mod.io/v1/images/global/al_modio-dark.png"
          },
          "logo": {
            "filename": "modio-dark.png",
            "original": "https://static.mod.io/v1/images/global/modio-dark.png",
            "thumb_320x180": "https://static.mod.io/v1/images/global/modio-dark.png",
            "thumb_640x360": "https://static.mod.io/v1/images/global/modio-dark.png",
            "thumb_1280x720": "https://static.mod.io/v1/images/global/modio-dark.png"
          },
          "header": {
            "filename": "demo.png",
            "original": "https://static.mod.io/v1/images/global/modio-dark.png"
          },
          "homepage": "https://www.rogue-knight-game.com/",
          "name": "Rogue Knight",
          "name_id": "rogue-knight",
          "summary": "Rogue Knight is a brand new 2D pixel platformer.",
          "instructions": "Instructions on the process to upload mods.",
          "profile_url": "https://rogue-knight.mod.io",
          "tag_options": [
            {
              "name": "Theme",
              "type": "checkboxes",
              "tags": [
                "Horror"
              ],
              "hidden": false
            }
          ]
        },
        {
            ...
        }
      ],
      "result_count": 100,
      "result_limit": 100,
      "result_offset": 0
    }
    

    Responses

    Status Meaning Description Response Schema
    200 OK Request Successful Get All Games

    Get User Mods

    Example request

    # You can also use wget
    curl -X GET https://api.mod.io/v1/me/mods \
      -H 'Authorization: Bearer {access-token}' \
      -H 'Accept: application/json'
    
    
    GET https://api.mod.io/v1/me/mods HTTP/1.1
    Host: api.mod.io
    
    Accept: application/json
    Authorization: Bearer {access-token}
    
    
    
    var headers = {
      'Authorization':'Bearer {access-token}',
      'Accept':'application/json'
    
    };
    
    $.ajax({
      url: 'https://api.mod.io/v1/me/mods',
      method: 'get',
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    const request = require('node-fetch');
    
    const headers = {
      'Authorization':'Bearer {access-token}',
      'Accept':'application/json'
    
    };
    
    fetch('https://api.mod.io/v1/me/mods',
    {
      method: 'GET',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Authorization': 'Bearer {access-token}',
      'Accept': 'application/json'
    }
    
    r = requests.get('https://api.mod.io/v1/me/mods', params={
    
    }, headers = headers)
    
    print r.json()
    
    URL obj = new URL("https://api.mod.io/v1/me/mods");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    

    GET /me/mods

    Get all mods the authenticated user added or is a team member of. Successful request will return an array of Mod Objects.

    Example response

    {
      "data": [
        {
          "id": 2,
          "game_id": 2,
          "status": 1,
          "visible": 1,
          "submitted_by": {
            "id": 1,
            "name_id": "xant",
            "username": "XanT",
            "date_online": 1509922961,
            "avatar": {
              "filename": "modio-dark.png",
              "original": "https://static.mod.io/v1/images/global/ao_modio-dark.png",
              "thumb_50x50": "https://static.mod.io/v1/images/global/modio-dark.png",
              "thumb_100x100": "https://static.mod.io/v1/images/global/am_modio-dark.png"
            },
            "timezone": "America/Los_Angeles",
            "language": "en",
            "profile_url": "https://mod.io/members/xant"
          },
          "date_added": 1492564103,
          "date_updated": 1499841487,
          "date_live": 1499841403,
          "logo": {
            "filename": "modio-dark.png",
            "original": "https://static.mod.io/v1/images/global/modio-dark.png",
            "thumb_320x180": "https://static.mod.io/v1/images/global/modio-dark.png",
            "thumb_640x360": "https://static.mod.io/v1/images/global/modio-dark.png",
            "thumb_1280x720": "https://static.mod.io/v1/images/global/modio-dark.png"
          },
          "homepage": "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": "<h2>About</h2><p>Rogue HD Pack does exactly what you thi...",
          "metadata_blob": "rogue,hd,high-res,4k,hd textures",
          "profile_url": "https://rogue-knight.mod.io/rogue-knight-hd-pack",
          "modfile": {
            "id": 2,
            "mod_id": 2,
            "date_added": 1499841487,
            "date_scanned": 1499841487,
            "virus_status": 0,
            "virus_positive": 0,
            "virustotal_hash": "f9a7bf4a95ce20787337b685a79677cae2281b83c63ab0a25f091407741692af-1508147401",
            "filesize": 15181,
            "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://mod.io/mods/file/1/c489a0354111a4d76640d47f0cdcb294",
              "date_expires": 1579316848
            }
          },
          "media": {
            "youtube": [
              "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
            ],
            "sketchfab": [
              "https://sketchfab.com/models/ef40b2d300334d009984c8865b2db1c8"
            ],
            "images": [
              {
                "filename": "modio-dark.png",
                "original": "https://static.mod.io/v1/images/global/modio-dark.png",
                "thumb_320x180": "https://static.mod.io/v1/images/global/modio-dark.png"
              }
            ]
          },
          "rating_summary": {
            "total_ratings": 1230,
            "positive_ratings": 1047,
            "negative_ratings": 183,
            "percentage_positive": 91,
            "weighted_aggregate": 87.38,
            "display_text": "Very Positive"
          },
          "tags": [
            {
              "name": "Unity",
              "date_added": 1499841487
            }
          ]
        },
        {
            ...
        }
      ],
      "result_count": 100,
      "result_limit": 100,
      "result_offset": 0
    }
    

    Responses

    Status Meaning Description Response Schema
    200 OK Request Successful Get All Mods

    Get User Modfiles

    Example request

    # You can also use wget
    curl -X GET https://api.mod.io/v1/me/files \
      -H 'Authorization: Bearer {access-token}' \
      -H 'Accept: application/json'
    
    
    GET https://api.mod.io/v1/me/files HTTP/1.1
    Host: api.mod.io
    
    Accept: application/json
    Authorization: Bearer {access-token}
    
    
    
    var headers = {
      'Authorization':'Bearer {access-token}',
      'Accept':'application/json'
    
    };
    
    $.ajax({
      url: 'https://api.mod.io/v1/me/files',
      method: 'get',
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    const request = require('node-fetch');
    
    const headers = {
      'Authorization':'Bearer {access-token}',
      'Accept':'application/json'
    
    };
    
    fetch('https://api.mod.io/v1/me/files',
    {
      method: 'GET',
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    import requests
    headers = {
      'Authorization': 'Bearer {access-token}',
      'Accept': 'application/json'
    }
    
    r = requests.get('https://api.mod.io/v1/me/files', params={
    
    }, headers = headers)
    
    print r.json()
    
    URL obj = new URL("https://api.mod.io/v1/me/files");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    

    GET /me/files

    Get all modfiles the authenticated user uploaded. Successful request will return an array of Modfile Objects.

    Example response

    {
      "data": [
        {
          "id": 2,
          "mod_id": 2,
          "date_added": 1499841487,
          "date_scanned": 1499841487,
          "virus_status": 0,
          "virus_positive": 0,
          "virustotal_hash": "f9a7bf4a95ce20787337b685a79677cae2281b83c63ab0a25f091407741692af-1508147401",
          "filesize": 15181,
          "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://mod.io/mods/file/1/c489a0354111a4d76640d47f0cdcb294",
            "date_expires": 1579316848
          }
        },
        {
            ...
        }
      ],
      "result_count": 100,
      "result_limit": 100,
      "result_offset": 0
    }
    

    Responses

    Status Meaning Description Response Schema
    200 OK Request Successful Get All Modfiles

    Response Schemas

    Message Object

    {
      "code": 200,
      "message": "Your request was successful."
    } 
    

    Properties

    Name Type Description
    code integer HTTP status code of response.
    message string The server response to your request. Responses will vary depending on the endpoint, but the object structure will persist.

    Error Object

    {
      "error": {
        "code": 403,
        "message": "You do not have the required permissions to access this resource.",
        "errors": {}
      }
    } 
    

    Properties

    Name Type Description
    error object Contains error data.
    » code integer HTTP code of the error.
    » message string The server response to your request. Responses will vary depending on the endpoint, but the object structure will persist.
    » errors object Optional Validation errors object. This field is only supplied if the response is a validation error 422 Unprocessible Entity. See errors documentation for more information.

    Logo Object

    {
      "filename": "modio-dark.png",
      "original": "https://static.mod.io/v1/images/global/modio-dark.png",
      "thumb_320x180": "https://static.mod.io/v1/images/global/modio-dark.png",
      "thumb_640x360": "https://static.mod.io/v1/images/global/modio-dark.png",
      "thumb_1280x720": "https://static.mod.io/v1/images/global/modio-dark.png"
    } 
    

    Properties

    Name Type Description
    filename string Logo filename including extension.
    original string URL to the full-sized logo.
    thumb_320x180 string URL to the small logo thumbnail.
    thumb_640x360 string URL to the medium logo thumbnail.
    thumb_1280x720 string URL to the large logo thumbnail.

    Icon Object

    {
      "filename": "modio-dark.png",
      "original": "https://static.mod.io/v1/images/global/ao_modio-dark.png",
      "thumb_64x64": "https://static.mod.io/v1/images/global/modio-dark.png",
      "thumb_128x128": "https://static.mod.io/v1/images/global/am_modio-dark.png",
      "thumb_256x256": "https://static.mod.io/v1/images/global/al_modio-dark.png"
    } 
    

    Properties

    Name Type Description
    filename string Icon filename including extension.
    original string URL to the full-sized icon.
    thumb_64x64 string URL to the small thumbnail image.
    thumb_128x128 string URL to the medium thumbnail image.
    thumb_256x256 string URL to the large thumbnail image.

    Header Object

    {
      "filename": "demo.png",
      "original": "https://static.mod.io/v1/images/global/modio-dark.png"
    } 
    

    Properties

    Name Type Description
    filename string Header image filename including extension.
    original string URL to the full-sized header image.

    Avatar Object

    {
      "filename": "modio-dark.png",
      "original": "https://static.mod.io/v1/images/global/ao_modio-dark.png",
      "thumb_50x50": "https://static.mod.io/v1/images/global/modio-dark.png",
      "thumb_100x100": "https://static.mod.io/v1/images/global/am_modio-dark.png"
    } 
    

    Properties

    Name Type Description
    filename string Avatar filename including extension.
    original string URL to the full-sized avatar.
    thumb_50x50 string URL to the small thumbnail image.
    thumb_100x100 string URL to the medium thumbnail image.

    Image Object

    {
      "filename": "modio-dark.png",
      "original": "https://static.mod.io/v1/images/global/modio-dark.png",
      "thumb_320x180": "https://static.mod.io/v1/images/global/modio-dark.png"
    } 
    

    Properties

    Name Type Description
    filename string Image filename including extension.
    original string URL to the full-sized image.
    thumb_320x180 string URL to the image thumbnail.

    Event Object

    {
      "id": 13,
      "mod_id": 13,
      "user_id": 13,
      "date_added": 1499846132,
      "event_type": "MODFILE_CHANGED"
    } 
    

    Properties

    Name Type Description
    id integer Unique id of the event object.
    mod_id integer Unique id of the parent mod.
    user_id integer Unique id of the user who performed the action.
    date_added integer Unix timestamp of date the event occurred.
    event_type string Type of event was 'MODFILE_CHANGED', 'MOD_AVAILABLE', 'MOD_UNAVAILABLE', 'MOD_EDITED'.

    Comment Object

    {
      "id": 2,
      "mod_id": 2,
      "submitted_by": {
        "id": 1,
        "name_id": "xant",
        "username": "XanT",
        "date_online": 1509922961,
        "avatar": {
          "filename": "modio-dark.png",
          "original": "https://static.mod.io/v1/images/global/ao_modio-dark.png",
          "thumb_50x50": "https://static.mod.io/v1/images/global/modio-dark.png",
          "thumb_100x100": "https://static.mod.io/v1/images/global/am_modio-dark.png"
        },
        "timezone": "America/Los_Angeles",
        "language": "en",
        "profile_url": "https://mod.io/members/xant"
      },
      "date_added": 1499841487,
      "reply_id": 1499,
      "reply_position": "01",
      "karma": 1,
      "karma_guest": 0,
      "content": "This mod is kickass! Great work!"
    } 
    

    Properties

    Name Type Description
    id integer Unique id of the comment.
    mod_id integer Unique id of the parent mod.
    submitted_by User Object Contains user data.
    » id integer Unique id of the user.
    » name_id string Path for the user on mod.io. For example: https://mod.io/members/username-id-here Usually a simplified version of their username.
    » username string Username of the user.
    » date_online integer Unix timestamp of date the user was last online.
    » avatar Avatar Object Contains avatar data.
    »» filename string Avatar filename including extension.
    »» original string URL to the full-sized avatar.
    »» thumb_50x50 string URL to the small thumbnail image.
    »» thumb_100x100 string URL to the medium thumbnail image.
    » timezone string Timezone of the user, format is country/city.
    » language string Users language preference. See localization for the supported languages.
    » profile_url string URL to the user's mod.io profile.
    date_added integer Unix timestamp of date the comment was posted.
    reply_id integer Id of the parent comment this comment is replying to (can be 0 if the comment is not a reply).
    reply_position string Levels of nesting in a comment thread. How it works:

    - The first comment will have the position '01'.
    - The second comment will have the position '02'.
    - If someone responds to the second comment the position will be '02.01'.
    - A maximum of 3 levels is supported.
    karma integer Karma received for the comment (can be postive or negative).
    karma_guest integer Karma received for guest comments (can be postive or negative).
    content string Contents of the comment.

    Mod Dependencies Object

    {
      "mod_id": 231,
      "date_added": 1499841487
    } 
    

    Properties

    Name Type Description
    mod_id integer Unique id of the mod that is the dependency.
    date_added integer Unix timestamp of date the dependency was added.

    Game Tag Option Object

    {
      "name": "Theme",
      "type": "checkboxes",
      "tags": [
        "Horror"
      ],
      "hidden": false
    } 
    

    Properties

    Name Type Description
    name string Name of the tag group.
    type string Can multiple tags be selected via 'checkboxes' or should only a single tag be selected via a 'dropdown'.
    hidden boolean Groups of tags flagged as 'admin only' should only be used for filtering, and should not be displayed to users.
    tags string[] Array of tags in this group.

    Modfile Object

    {
      "id": 2,
      "mod_id": 2,
      "date_added": 1499841487,
      "date_scanned": 1499841487,
      "virus_status": 0,
      "virus_positive": 0,
      "virustotal_hash": "f9a7bf4a95ce20787337b685a79677cae2281b83c63ab0a25f091407741692af-1508147401",
      "filesize": 15181,
      "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://mod.io/mods/file/1/c489a0354111a4d76640d47f0cdcb294",
        "date_expires": 1579316848
      }
    } 
    

    Properties

    Name Type Description
    id integer Unique modfile id.
    mod_id integer Unique mod id.
    date_added integer Unix timestamp of date file was added.
    date_scanned integer Unix timestamp of date file was virus scanned.
    virus_status 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:

    0 = Not scanned
    1 = Scan complete
    2 = In progress
    3 = Too large to scan
    4 = File not found
    5 = Error Scanning
    virus_positive integer Was a virus detected:

    0 = No threats detected
    1 = Flagged as malicious
    virustotal_hash string VirusTotal proprietary hash to view the scan results.
    filesize integer Size of the file in bytes.
    filehash Filehash Object Contains filehash data.
    » md5 string MD5 hash of the file.
    filename string Filename including extension.
    version string Release version this file represents.
    changelog string Changelog for the file.
    metadata_blob string Metadata stored by the game developer for this file.
    download Download Object Contains download data.
    » binary_url string 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.
    » date_expires integer Unix timestamp of when the binary_url will expire.

    Filehash Object

    {
      "md5": "2d4a0e2d7273db6b0a94b0740a88ad0d"
    } 
    

    Properties

    Name Type Description
    md5 string MD5 hash of the file.

    Download Object

    {
      "binary_url": "https://mod.io/mods/file/1/c489a0354111a4d76640d47f0cdcb294",
      "date_expires": 1579316848
    } 
    

    Properties

    Name Type Description
    binary_url string 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.
    date_expires integer Unix timestamp of when the binary_url will expire.

    Mod Object

    {
      "id": 2,
      "game_id": 2,
      "status": 1,
      "visible": 1,
      "submitted_by": {
        "id": 1,
        "name_id": "xant",
        "username": "XanT",
        "date_online": 1509922961,
        "avatar": {
          "filename": "modio-dark.png",
          "original": "https://static.mod.io/v1/images/global/ao_modio-dark.png",
          "thumb_50x50": "https://static.mod.io/v1/images/global/modio-dark.png",
          "thumb_100x100": "https://static.mod.io/v1/images/global/am_modio-dark.png"
        },
        "timezone": "America/Los_Angeles",
        "language": "en",
        "profile_url": "https://mod.io/members/xant"
      },
      "date_added": 1492564103,
      "date_updated": 1499841487,
      "date_live": 1499841403,
      "logo": {
        "filename": "modio-dark.png",
        "original": "https://static.mod.io/v1/images/global/modio-dark.png",
        "thumb_320x180": "https://static.mod.io/v1/images/global/modio-dark.png",
        "thumb_640x360": "https://static.mod.io/v1/images/global/modio-dark.png",
        "thumb_1280x720": "https://static.mod.io/v1/images/global/modio-dark.png"
      },
      "homepage": "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": "<h2>About</h2><p>Rogue HD Pack does exactly what you thi...",
      "metadata_blob": "rogue,hd,high-res,4k,hd textures",
      "profile_url": "https://rogue-knight.mod.io/rogue-knight-hd-pack",
      "modfile": {
        "id": 2,
        "mod_id": 2,
        "date_added": 1499841487,
        "date_scanned": 1499841487,
        "virus_status": 0,
        "virus_positive": 0,
        "virustotal_hash": "f9a7bf4a95ce20787337b685a79677cae2281b83c63ab0a25f091407741692af-1508147401",
        "filesize": 15181,
        "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://mod.io/mods/file/1/c489a0354111a4d76640d47f0cdcb294",
          "date_expires": 1579316848
        }
      },
      "media": {
        "youtube": [
          "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
        ],
        "sketchfab": [
          "https://sketchfab.com/models/ef40b2d300334d009984c8865b2db1c8"
        ],
        "images": [
          {
            "filename": "modio-dark.png",
            "original": "https://static.mod.io/v1/images/global/modio-dark.png",
            "thumb_320x180": "https://static.mod.io/v1/images/global/modio-dark.png"
          }
        ]
      },
      "rating_summary": {
        "total_ratings": 1230,
        "positive_ratings": 1047,
        "negative_ratings": 183,
        "percentage_positive": 91,
        "weighted_aggregate": 87.38,
        "display_text": "Very Positive"
      },
      "tags": [
        {
          "name": "Unity",
          "date_added": 1499841487
        }
      ]
    } 
    

    Properties

    Name Type Description
    id integer Unique mod id.
    game_id integer Unique game id.
    status integer Status of the mod (see status and visibility for details):

    0 = Not Accepted
    1 = Accepted
    2 = Archived (potentially out of date or incompatible)
    3 = Deleted
    visible integer Visibility of the mod (see status and visibility for details):

    0 = Hidden
    1 = Public
    submitted_by User Object Contains user data.
    » id integer Unique id of the user.
    » name_id string Path for the user on mod.io. For example: https://mod.io/members/username-id-here Usually a simplified version of their username.
    » username string Username of the user.
    » date_online integer Unix timestamp of date the user was last online.
    » avatar Avatar Object Contains avatar data.
    »» filename string Avatar filename including extension.
    »» original string URL to the full-sized avatar.
    »» thumb_50x50 string URL to the small thumbnail image.
    »» thumb_100x100 string URL to the medium thumbnail image.
    » timezone string Timezone of the user, format is country/city.
    » language string Users language preference. See localization for the supported languages.
    » profile_url string URL to the user's mod.io profile.
    date_added integer Unix timestamp of date mod was registered.
    date_updated integer Unix timestamp of date mod was updated.
    date_live integer Unix timestamp of date mod was set live.
    logo Logo Object Contains logo data.
    » filename string Logo filename including extension.
    » original string URL to the full-sized logo.
    » thumb_320x180 string URL to the small logo thumbnail.
    » thumb_640x360 string URL to the medium logo thumbnail.
    » thumb_1280x720 string URL to the large logo thumbnail.
    homepage string Official homepage of the mod.
    name string Name of the mod.
    name_id string Path for the mod on mod.io. For example: https://gamename.mod.io/mod-name-id-here
    summary string Summary of the mod.
    description string Detailed description of the mod which allows HTML.
    metadata_blob string Metadata stored by the game developer. Metadata can also be stored as searchable key value pairs, and to individual mod files.
    profile_url string URL to the mod's mod.io profile.
    modfile Modfile Object Contains modfile data.
    » id integer Unique modfile id.
    » mod_id integer Unique mod id.
    » date_added integer Unix timestamp of date file was added.
    » date_scanned integer Unix timestamp of date file was virus scanned.
    » virus_status 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:

    0 = Not scanned
    1 = Scan complete
    2 = In progress
    3 = Too large to scan
    4 = File not found
    5 = Error Scanning
    » virus_positive integer Was a virus detected:

    0 = No threats detected
    1 = Flagged as malicious
    » virustotal_hash string VirusTotal proprietary hash to view the scan results.
    » filesize integer Size of the file in bytes.
    » filehash Filehash Object Contains filehash data.
    »» md5 string MD5 hash of the file.
    » filename string Filename including extension.
    » version string Release version this file represents.
    » changelog string Changelog for the file.
    » metadata_blob string Metadata stored by the game developer for this file.
    » download Download Object Contains download data.
    »» binary_url string 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.
    »» date_expires integer Unix timestamp of when the binary_url will expire.
    media Mod Media Object Contains mod media data.
    » youtube string[] Array of YouTube links.
    » sketchfab string[] Array of SketchFab links.
    » images Image Object [] Array of image objects (a gallery).
    »» filename string Image filename including extension.
    »» original string URL to the full-sized image.
    »» thumb_320x180 string URL to the image thumbnail.
    rating_summary Rating Summary Object Contains ratings summary.
    » total_ratings integer Number of times this item has been rated.
    » positive_ratings integer Number of positive ratings.
    » negative_ratings integer Number of negative ratings.
    » percentage_positive integer Number of positive ratings, divided by the total ratings to determine it’s percentage score.
    » weighted_aggregate 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.
    » display_text string Textual representation of the rating in format:

    - Overwhelmingly Positive
    - Very Positive
    - Positive
    - Mostly Positive
    - Mixed
    - Negative
    - Mostly Negative
    - Very Negative
    - Overwhelmingly Negative
    tags Mod Tag Object [] Contains mod tag data.
    » name string Tag name.
    » date_added integer Unix timestamp of date tag was applied.

    Mod Media Object

    {
      "youtube": [
        "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
      ],
      "sketchfab": [
        "https://sketchfab.com/models/ef40b2d300334d009984c8865b2db1c8"
      ],
      "images": [
        {
          "filename": "modio-dark.png",
          "original": "https://static.mod.io/v1/images/global/modio-dark.png",
          "thumb_320x180": "https://static.mod.io/v1/images/global/modio-dark.png"
        }
      ]
    } 
    

    Properties

    Name Type Description
    youtube string[] Array of YouTube links.
    sketchfab string[] Array of SketchFab links.
    images Image Object [] Array of image objects (a gallery).
    » filename string Image filename including extension.
    » original string URL to the full-sized image.
    » thumb_320x180 string URL to the image thumbnail.

    Mod Tag Object

    {
      "name": "Unity",
      "date_added": 1499841487
    } 
    

    Properties

    Name Type Description
    name string Tag name.
    date_added integer Unix timestamp of date tag was applied.

    Game Object

    {
      "id": 2,
      "status": 1,
      "submitted_by": {
        "id": 1,
        "name_id": "xant",
        "username": "XanT",
        "date_online": 1509922961,
        "avatar": {
          "filename": "modio-dark.png",
          "original": "https://static.mod.io/v1/images/global/ao_modio-dark.png",
          "thumb_50x50": "https://static.mod.io/v1/images/global/modio-dark.png",
          "thumb_100x100": "https://static.mod.io/v1/images/global/am_modio-dark.png"
        },
        "timezone": "America/Los_Angeles",
        "language": "en",
        "profile_url": "https://mod.io/members/xant"
      },
      "date_added": 1493702614,
      "date_updated": 1499410290,
      "date_live": 1499841403,
      "presentation_option": 1,
      "submission_option": 0,
      "curation_option": 0,
      "community_options": 3,
      "revenue_options": 1500,
      "api_access_options": 3,
      "ugc_name": "map",
      "icon": {
        "filename": "modio-dark.png",
        "original": "https://static.mod.io/v1/images/global/ao_modio-dark.png",
        "thumb_64x64": "https://static.mod.io/v1/images/global/modio-dark.png",
        "thumb_128x128": "https://static.mod.io/v1/images/global/am_modio-dark.png",
        "thumb_256x256": "https://static.mod.io/v1/images/global/al_modio-dark.png"
      },
      "logo": {
        "filename": "modio-dark.png",
        "original": "https://static.mod.io/v1/images/global/modio-dark.png",
        "thumb_320x180": "https://static.mod.io/v1/images/global/modio-dark.png",
        "thumb_640x360": "https://static.mod.io/v1/images/global/modio-dark.png",
        "thumb_1280x720": "https://static.mod.io/v1/images/global/modio-dark.png"
      },
      "header": {
        "filename": "demo.png",
        "original": "https://static.mod.io/v1/images/global/modio-dark.png"
      },
      "homepage": "https://www.rogue-knight-game.com/",
      "name": "Rogue Knight",
      "name_id": "rogue-knight",
      "summary": "Rogue Knight is a brand new 2D pixel platformer.",
      "instructions": "Instructions on the process to upload mods.",
      "profile_url": "https://rogue-knight.mod.io",
      "tag_options": [
        {
          "name": "Theme",
          "type": "checkboxes",
          "tags": [
            "Horror"
          ],
          "hidden": false
        }
      ]
    } 
    

    Properties

    Name Type Description
    id integer Unique game id.
    status integer Status of the game (see status and visibility for details):

    0 = Not Accepted
    1 = Accepted
    2 = Archived (potentially out of date or incompatible)
    3 = Deleted
    submitted_by User Object Contains user data.
    » id integer Unique id of the user.
    » name_id string Path for the user on mod.io. For example: https://mod.io/members/username-id-here Usually a simplified version of their username.
    » username string Username of the user.
    » date_online integer Unix timestamp of date the user was last online.
    » avatar Avatar Object Contains avatar data.
    »» filename string Avatar filename including extension.
    »» original string URL to the full-sized avatar.
    »» thumb_50x50 string URL to the small thumbnail image.
    »» thumb_100x100 string URL to the medium thumbnail image.
    » timezone string Timezone of the user, format is country/city.
    » language string Users language preference. See localization for the supported languages.
    » profile_url string URL to the user's mod.io profile.
    date_added integer Unix timestamp of date game was registered.
    date_updated integer Unix timestamp of date game was updated.
    date_live integer Unix timestamp of date game was set live.
    presentation_option integer Presentation style used on the mod.io website:

    0 = Grid View: Displays mods in a grid
    1 = Table View: Displays mods in a table
    submission_option integer Submission process modders must follow:

    0 = Mod uploads must occur via a tool created by the game developers
    1 = Mod uploads can occur from anywhere, including the website and API
    curation_option integer Curation process used to approve mods:

    0 = No curation: Mods are immediately available to play
    1 = Paid curation: Mods are immediately available to play unless they choose to receive donations. These mods must be accepted to be listed
    2 = Full curation: All mods must be accepted by someone to be listed
    community_options integer Community features enabled on the mod.io website:

    0 = All of the options below are disabled
    1 = Discussion board enabled
    2 = Guides and news enabled
    ? = Add the options you want together, to enable multiple features (see BITWISE fields)
    revenue_options integer Revenue capabilities mods can enable:

    0 = All of the options below are disabled
    1 = Allow mods to be sold
    2 = Allow mods to receive donations
    4 = Allow mods to be traded
    8 = Allow mods to control supply and scarcity
    ? = Add the options you want together, to enable multiple features (see BITWISE fields)
    api_access_options integer Level of API access allowed by this game:

    0 = All of the options below are disabled
    1 = Allow 3rd parties to access this games API endpoints
    2 = Allow mods to be downloaded directly (if disabled all download URLs will contain a frequently changing verification hash to stop unauthorized use)
    ? = Add the options you want together, to enable multiple features (see BITWISE fields)
    ugc_name string Word used to describe user-generated content (mods, items, addons etc).
    icon Icon Object Contains icon data.
    » filename string Icon filename including extension.
    » original string URL to the full-sized icon.
    » thumb_64x64 string URL to the small thumbnail image.
    » thumb_128x128 string URL to the medium thumbnail image.
    » thumb_256x256 string URL to the large thumbnail image.
    logo Logo Object Contains logo data.
    » filename string Logo filename including extension.
    » original string URL to the full-sized logo.
    » thumb_320x180 string URL to the small logo thumbnail.
    » thumb_640x360 string URL to the medium logo thumbnail.
    » thumb_1280x720 string URL to the large logo thumbnail.
    header Header Object Contains header data.
    » filename string Header image filename including extension.
    » original string URL to the full-sized header image.
    homepage string Official homepage of the game.
    name string Name of the game.
    name_id string Subdomain for the game on mod.io.
    summary string Summary of the game.
    instructions string A guide about creating and uploading mods for this game to mod.io (applicable if submission_option = 0).
    profile_url string URL to the game's mod.io page.
    tag_options Game Tag Option Object [] Groups of tags configured by the game developer, that mods can select.
    » name string Name of the tag group.
    » type string Can multiple tags be selected via 'checkboxes' or should only a single tag be selected via a 'dropdown'.
    » hidden boolean Groups of tags flagged as 'admin only' should only be used for filtering, and should not be displayed to users.
    » tags string[] Array of tags in this group.

    Metadata KVP Object

    {
      "metakey": "pistol-dmg",
      "metavalue": "800"
    } 
    

    Properties

    Name Type Description
    metakey string The key of the key-value pair.
    metavalue string The value of the key-value pair.

    Rating Summary Object

    {
      "total_ratings": 1230,
      "positive_ratings": 1047,
      "negative_ratings": 183,
      "percentage_positive": 91,
      "weighted_aggregate": 87.38,
      "display_text": "Very Positive"
    } 
    

    Properties

    Name Type Description
    total_ratings integer Number of times this item has been rated.
    positive_ratings integer Number of positive ratings.
    negative_ratings integer Number of negative ratings.
    percentage_positive integer Number of positive ratings, divided by the total ratings to determine it’s percentage score.
    weighted_aggregate 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.
    display_text string Textual representation of the rating in format:

    - Overwhelmingly Positive
    - Very Positive
    - Positive
    - Mostly Positive
    - Mixed
    - Negative
    - Mostly Negative
    - Very Negative
    - Overwhelmingly Negative

    Team Member Object

    {
      "id": 457,
      "user": {
        "id": 1,
        "name_id": "xant",
        "username": "XanT",
        "date_online": 1509922961,
        "avatar": {
          "filename": "modio-dark.png",
          "original": "https://static.mod.io/v1/images/global/ao_modio-dark.png",
          "thumb_50x50": "https://static.mod.io/v1/images/global/modio-dark.png",
          "thumb_100x100": "https://static.mod.io/v1/images/global/am_modio-dark.png"
        },
        "timezone": "America/Los_Angeles",
        "language": "en",
        "profile_url": "https://mod.io/members/xant"
      },
      "level": 8,
      "date_added": 1492058857,
      "position": "Supreme Overlord"
    } 
    

    Properties

    Name Type Description
    id integer Unique team member id.
    user User Object Contains user data.
    » id integer Unique id of the user.
    » name_id string Path for the user on mod.io. For example: https://mod.io/members/username-id-here Usually a simplified version of their username.
    » username string Username of the user.
    » date_online integer Unix timestamp of date the user was last online.
    » avatar Avatar Object Contains avatar data.
    »» filename string Avatar filename including extension.
    »» original string URL to the full-sized avatar.
    »» thumb_50x50 string URL to the small thumbnail image.
    »» thumb_100x100 string URL to the medium thumbnail image.
    » timezone string Timezone of the user, format is country/city.
    » language string Users language preference. See localization for the supported languages.
    » profile_url string URL to the user's mod.io profile.
    level integer Level of permission the user has:

    1 = Member
    4 = Manager
    8 = Leader
    date_added integer Unix timestamp of the date the user was added to the team.
    position string Custom title given to the user in this team.

    User Object

    {
      "id": 1,
      "name_id": "xant",
      "username": "XanT",
      "date_online": 1509922961,
      "avatar": {
        "filename": "modio-dark.png",
        "original": "https://static.mod.io/v1/images/global/ao_modio-dark.png",
        "thumb_50x50": "https://static.mod.io/v1/images/global/modio-dark.png",
        "thumb_100x100": "https://static.mod.io/v1/images/global/am_modio-dark.png"
      },
      "timezone": "America/Los_Angeles",
      "language": "en",
      "profile_url": "https://mod.io/members/xant"
    } 
    

    Properties

    Name Type Description
    id integer Unique id of the user.
    name_id string Path for the user on mod.io. For example: https://mod.io/members/username-id-here Usually a simplified version of their username.
    username string Username of the user.
    date_online integer Unix timestamp of date the user was last online.
    avatar Avatar Object Contains avatar data.
    » filename string Avatar filename including extension.
    » original string URL to the full-sized avatar.
    » thumb_50x50 string URL to the small thumbnail image.
    » thumb_100x100 string URL to the medium thumbnail image.
    timezone string Timezone of the user, format is country/city.
    language string Users language preference. See localization for the supported languages.
    profile_url string URL to the user's mod.io profile.

    Get All Mod Comments

    {
      "data": [
        {
          "id": 2,
          "mod_id": 2,
          "submitted_by": {
            "id": 1,
            "name_id": "xant",
            "username": "XanT",
            "date_online": 1509922961,
            "avatar": {
              "filename": "modio-dark.png",
              "original": "https://static.mod.io/v1/images/global/ao_modio-dark.png",
              "thumb_50x50": "https://static.mod.io/v1/images/global/modio-dark.png",
              "thumb_100x100": "https://static.mod.io/v1/images/global/am_modio-dark.png"
            },
            "timezone": "America/Los_Angeles",
            "language": "en",
            "profile_url": "https://mod.io/members/xant"
          },
          "date_added": 1499841487,
          "reply_id": 1499,
          "reply_position": "01",
          "karma": 1,
          "karma_guest": 0,
          "content": "This mod is kickass! Great work!"
        },
        {
            ...
        }
      ],
      "result_count": 100,
      "result_limit": 100,
      "result_offset": 0
    } 
    

    Properties

    Name Type Description
    data Comment Object [] Array containing comment objects.
    » id integer Unique id of the comment.
    » mod_id integer Unique id of the parent mod.
    » submitted_by User Object Contains user data.
    »» id integer Unique id of the user.
    »» name_id string Path for the user on mod.io. For example: https://mod.io/members/username-id-here Usually a simplified version of their username.
    »» username string Username of the user.
    »» date_online integer Unix timestamp of date the user was last online.
    »» avatar Avatar Object Contains avatar data.
    »»» filename string Avatar filename including extension.
    »»» original string URL to the full-sized avatar.
    »»» thumb_50x50 string URL to the small thumbnail image.
    »»» thumb_100x100 string URL to the medium thumbnail image.
    »» timezone string Timezone of the user, format is country/city.
    »» language string Users language preference. See localization for the supported languages.
    »» profile_url string URL to the user's mod.io profile.
    » date_added integer Unix timestamp of date the comment was posted.
    » reply_id integer Id of the parent comment this comment is replying to (can be 0 if the comment is not a reply).
    » reply_position string Levels of nesting in a comment thread. How it works:

    - The first comment will have the position '01'.
    - The second comment will have the position '02'.
    - If someone responds to the second comment the position will be '02.01'.
    - A maximum of 3 levels is supported.
    » karma integer Karma received for the comment (can be postive or negative).
    » karma_guest integer Karma received for guest comments (can be postive or negative).
    » content string Contents of the comment.
    result_count integer Number of results returned in the data array.
    result_limit integer Maximum number of results returned.
    result_offset integer Number of results skipped over.

    Get All Mod Dependencies

    {
      "data": [
        {
          "mod_id": 231,
          "date_added": 1499841487
        },
        {
            ...
        }
      ],
      "result_count": 100,
      "result_limit": 100,
      "result_offset": 0
    } 
    

    Properties

    Name Type Description
    data Mod Dependencies Object [] Array containing mod dependencies objects.
    » mod_id integer Unique id of the mod that is the dependency.
    » date_added integer Unix timestamp of date the dependency was added.
    result_count integer Number of results returned in the data array.
    result_limit integer Maximum number of results returned.
    result_offset integer Number of results skipped over.

    Get All Modfiles

    {
      "data": [
        {
          "id": 2,
          "mod_id": 2,
          "date_added": 1499841487,
          "date_scanned": 1499841487,
          "virus_status": 0,
          "virus_positive": 0,
          "virustotal_hash": "f9a7bf4a95ce20787337b685a79677cae2281b83c63ab0a25f091407741692af-1508147401",
          "filesize": 15181,
          "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://mod.io/mods/file/1/c489a0354111a4d76640d47f0cdcb294",
            "date_expires": 1579316848
          }
        },
        {
            ...
        }
      ],
      "result_count": 100,
      "result_limit": 100,
      "result_offset": 0
    } 
    

    Properties

    Name Type Description
    data Modfile Object [] Array containing modfile objects.
    » id integer Unique modfile id.
    » mod_id integer Unique mod id.
    » date_added integer Unix timestamp of date file was added.
    » date_scanned integer Unix timestamp of date file was virus scanned.
    » virus_status 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:

    0 = Not scanned
    1 = Scan complete
    2 = In progress
    3 = Too large to scan
    4 = File not found
    5 = Error Scanning
    » virus_positive integer Was a virus detected:

    0 = No threats detected
    1 = Flagged as malicious
    » virustotal_hash string VirusTotal proprietary hash to view the scan results.
    » filesize integer Size of the file in bytes.
    » filehash Filehash Object Contains filehash data.
    »» md5 string MD5 hash of the file.
    » filename string Filename including extension.
    » version string Release version this file represents.
    » changelog string Changelog for the file.
    » metadata_blob string Metadata stored by the game developer for this file.
    » download Download Object Contains download data.
    »» binary_url string 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.
    »» date_expires integer Unix timestamp of when the binary_url will expire.
    result_count integer Number of results returned in the data array.
    result_limit integer Maximum number of results returned.
    result_offset integer Number of results skipped over.

    Get All Games

    {
      "data": [
        {
          "id": 2,
          "status": 1,
          "submitted_by": {
            "id": 1,
            "name_id": "xant",
            "username": "XanT",
            "date_online": 1509922961,
            "avatar": {
              "filename": "modio-dark.png",
              "original": "https://static.mod.io/v1/images/global/ao_modio-dark.png",
              "thumb_50x50": "https://static.mod.io/v1/images/global/modio-dark.png",
              "thumb_100x100": "https://static.mod.io/v1/images/global/am_modio-dark.png"
            },
            "timezone": "America/Los_Angeles",
            "language": "en",
            "profile_url": "https://mod.io/members/xant"
          },
          "date_added": 1493702614,
          "date_updated": 1499410290,
          "date_live": 1499841403,
          "presentation_option": 1,
          "submission_option": 0,
          "curation_option": 0,
          "community_options": 3,
          "revenue_options": 1500,
          "api_access_options": 3,
          "ugc_name": "map",
          "icon": {
            "filename": "modio-dark.png",
            "original": "https://static.mod.io/v1/images/global/ao_modio-dark.png",
            "thumb_64x64": "https://static.mod.io/v1/images/global/modio-dark.png",
            "thumb_128x128": "https://static.mod.io/v1/images/global/am_modio-dark.png",
            "thumb_256x256": "https://static.mod.io/v1/images/global/al_modio-dark.png"
          },
          "logo": {
            "filename": "modio-dark.png",
            "original": "https://static.mod.io/v1/images/global/modio-dark.png",
            "thumb_320x180": "https://static.mod.io/v1/images/global/modio-dark.png",
            "thumb_640x360": "https://static.mod.io/v1/images/global/modio-dark.png",
            "thumb_1280x720": "https://static.mod.io/v1/images/global/modio-dark.png"
          },
          "header": {
            "filename": "demo.png",
            "original": "https://static.mod.io/v1/images/global/modio-dark.png"
          },
          "homepage": "https://www.rogue-knight-game.com/",
          "name": "Rogue Knight",
          "name_id": "rogue-knight",
          "summary": "Rogue Knight is a brand new 2D pixel platformer.",
          "instructions": "Instructions on the process to upload mods.",
          "profile_url": "https://rogue-knight.mod.io",
          "tag_options": [
            {
              "name": "Theme",
              "type": "checkboxes",
              "tags": [
                "Horror"
              ],
              "hidden": false
            }
          ]
        },
        {
            ...
        }
      ],
      "result_count": 100,
      "result_limit": 100,
      "result_offset": 0
    } 
    

    Properties

    Name Type Description
    data Game Object [] Array containing game objects.
    » id integer Unique game id.
    » status integer Status of the game (see status and visibility for details):

    0 = Not Accepted
    1 = Accepted
    2 = Archived (potentially out of date or incompatible)
    3 = Deleted
    » submitted_by User Object Contains user data.
    »» id integer Unique id of the user.
    »» name_id string Path for the user on mod.io. For example: https://mod.io/members/username-id-here Usually a simplified version of their username.
    »» username string Username of the user.
    »» date_online integer Unix timestamp of date the user was last online.
    »» avatar Avatar Object Contains avatar data.
    »»» filename string Avatar filename including extension.
    »»» original string URL to the full-sized avatar.
    »»» thumb_50x50 string URL to the small thumbnail image.
    »»» thumb_100x100 string URL to the medium thumbnail image.
    »» timezone string Timezone of the user, format is country/city.
    »» language string Users language preference. See localization for the supported languages.
    »» profile_url string URL to the user's mod.io profile.
    » date_added integer Unix timestamp of date game was registered.
    » date_updated integer Unix timestamp of date game was updated.
    » date_live integer Unix timestamp of date game was set live.
    » presentation_option integer Presentation style used on the mod.io website:

    0 = Grid View: Displays mods in a grid
    1 = Table View: Displays mods in a table
    » submission_option integer Submission process modders must follow:

    0 = Mod uploads must occur via a tool created by the game developers
    1 = Mod uploads can occur from anywhere, including the website and API
    » curation_option integer Curation process used to approve mods:

    0 = No curation: Mods are immediately available to play
    1 = Paid curation: Mods are immediately available to play unless they choose to receive donations. These mods must be accepted to be listed
    2 = Full curation: All mods must be accepted by someone to be listed
    » community_options integer Community features enabled on the mod.io website:

    0 = All of the options below are disabled
    1 = Discussion board enabled
    2 = Guides and news enabled
    ? = Add the options you want together, to enable multiple features (see BITWISE fields)
    » revenue_options integer Revenue capabilities mods can enable:

    0 = All of the options below are disabled
    1 = Allow mods to be sold
    2 = Allow mods to receive donations
    4 = Allow mods to be traded
    8 = Allow mods to control supply and scarcity
    ? = Add the options you want together, to enable multiple features (see BITWISE fields)
    » api_access_options integer Level of API access allowed by this game:

    0 = All of the options below are disabled
    1 = Allow 3rd parties to access this games API endpoints
    2 = Allow mods to be downloaded directly (if disabled all download URLs will contain a frequently changing verification hash to stop unauthorized use)
    ? = Add the options you want together, to enable multiple features (see BITWISE fields)
    » ugc_name string Word used to describe user-generated content (mods, items, addons etc).
    » icon Icon Object Contains icon data.
    »» filename string Icon filename including extension.
    »» original string URL to the full-sized icon.
    »» thumb_64x64 string URL to the small thumbnail image.
    »» thumb_128x128 string URL to the medium thumbnail image.
    »» thumb_256x256 string URL to the large thumbnail image.
    » logo Logo Object Contains logo data.
    »» filename string Logo filename including extension.
    »» original string URL to the full-sized logo.
    »» thumb_320x180 string URL to the small logo thumbnail.
    »» thumb_640x360 string URL to the medium logo thumbnail.
    »» thumb_1280x720 string URL to the large logo thumbnail.
    » header Header Object Contains header data.
    »» filename string Header image filename including extension.
    »» original string URL to the full-sized header image.
    » homepage string Official homepage of the game.
    » name string Name of the game.
    » name_id string Subdomain for the game on mod.io.
    » summary string Summary of the game.
    » instructions string A guide about creating and uploading mods for this game to mod.io (applicable if submission_option = 0).
    » profile_url string URL to the game's mod.io page.
    » tag_options Game Tag Option Object [] Groups of tags configured by the game developer, that mods can select.
    »» name string Name of the tag group.
    »» type string Can multiple tags be selected via 'checkboxes' or should only a single tag be selected via a 'dropdown'.
    »» hidden boolean Groups of tags flagged as 'admin only' should only be used for filtering, and should not be displayed to users.
    »» tags string[] Array of tags in this group.
    result_count integer Number of results returned in the data array.
    result_limit integer Maximum number of results returned.
    result_offset integer Number of results skipped over.

    Get All Mod KVP Metadata

    {
      "data": [
        {
          "metakey": "pistol-dmg",
          "metavalue": "800"
        },
        {
            ...
        }
      ],
      "result_count": 100,
      "result_limit": 100,
      "result_offset": 0
    } 
    

    Properties

    Name Type Description
    data Metadata KVP Object [] Array containing metadata kvp objects.
    » metakey string The key of the key-value pair.
    » metavalue string The value of the key-value pair.
    result_count integer Number of results returned in the data array.
    result_limit integer Maximum number of results returned.
    result_offset integer Number of results skipped over.

    Get All Mods

    {
      "data": [
        {
          "id": 2,
          "game_id": 2,
          "status": 1,
          "visible": 1,
          "submitted_by": {
            "id": 1,
            "name_id": "xant",
            "username": "XanT",
            "date_online": 1509922961,
            "avatar": {
              "filename": "modio-dark.png",
              "original": "https://static.mod.io/v1/images/global/ao_modio-dark.png",
              "thumb_50x50": "https://static.mod.io/v1/images/global/modio-dark.png",
              "thumb_100x100": "https://static.mod.io/v1/images/global/am_modio-dark.png"
            },
            "timezone": "America/Los_Angeles",
            "language": "en",
            "profile_url": "https://mod.io/members/xant"
          },
          "date_added": 1492564103,
          "date_updated": 1499841487,
          "date_live": 1499841403,
          "logo": {
            "filename": "modio-dark.png",
            "original": "https://static.mod.io/v1/images/global/modio-dark.png",
            "thumb_320x180": "https://static.mod.io/v1/images/global/modio-dark.png",
            "thumb_640x360": "https://static.mod.io/v1/images/global/modio-dark.png",
            "thumb_1280x720": "https://static.mod.io/v1/images/global/modio-dark.png"
          },
          "homepage": "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": "<h2>About</h2><p>Rogue HD Pack does exactly what you thi...",
          "metadata_blob": "rogue,hd,high-res,4k,hd textures",
          "profile_url": "https://rogue-knight.mod.io/rogue-knight-hd-pack",
          "modfile": {
            "id": 2,
            "mod_id": 2,
            "date_added": 1499841487,
            "date_scanned": 1499841487,
            "virus_status": 0,
            "virus_positive": 0,
            "virustotal_hash": "f9a7bf4a95ce20787337b685a79677cae2281b83c63ab0a25f091407741692af-1508147401",
            "filesize": 15181,
            "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://mod.io/mods/file/1/c489a0354111a4d76640d47f0cdcb294",
              "date_expires": 1579316848
            }
          },
          "media": {
            "youtube": [
              "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
            ],
            "sketchfab": [
              "https://sketchfab.com/models/ef40b2d300334d009984c8865b2db1c8"
            ],
            "images": [
              {
                "filename": "modio-dark.png",
                "original": "https://static.mod.io/v1/images/global/modio-dark.png",
                "thumb_320x180": "https://static.mod.io/v1/images/global/modio-dark.png"
              }
            ]
          },
          "rating_summary": {
            "total_ratings": 1230,
            "positive_ratings": 1047,
            "negative_ratings": 183,
            "percentage_positive": 91,
            "weighted_aggregate": 87.38,
            "display_text": "Very Positive"
          },
          "tags": [
            {
              "name": "Unity",
              "date_added": 1499841487
            }
          ]
        },
        {
            ...
        }
      ],
      "result_count": 100,
      "result_limit": 100,
      "result_offset": 0
    } 
    

    Properties

    Name Type Description
    data Mod Object [] Array containing mod objects.
    » id integer Unique mod id.
    » game_id integer Unique game id.
    » status integer Status of the mod (see status and visibility for details):

    0 = Not Accepted
    1 = Accepted
    2 = Archived (potentially out of date or incompatible)
    3 = Deleted
    » visible integer Visibility of the mod (see status and visibility for details):

    0 = Hidden
    1 = Public
    » submitted_by User Object Contains user data.
    »» id integer Unique id of the user.
    »» name_id string Path for the user on mod.io. For example: https://mod.io/members/username-id-here Usually a simplified version of their username.
    »» username string Username of the user.
    »» date_online integer Unix timestamp of date the user was last online.
    »» avatar Avatar Object Contains avatar data.
    »»» filename string Avatar filename including extension.
    »»» original string URL to the full-sized avatar.
    »»» thumb_50x50 string URL to the small thumbnail image.
    »»» thumb_100x100 string URL to the medium thumbnail image.
    »» timezone string Timezone of the user, format is country/city.
    »» language string Users language preference. See localization for the supported languages.
    »» profile_url string URL to the user's mod.io profile.
    » date_added integer Unix timestamp of date mod was registered.
    » date_updated integer Unix timestamp of date mod was updated.
    » date_live integer Unix timestamp of date mod was set live.
    » logo Logo Object Contains logo data.
    »» filename string Logo filename including extension.
    »» original string URL to the full-sized logo.
    »» thumb_320x180 string URL to the small logo thumbnail.
    »» thumb_640x360 string URL to the medium logo thumbnail.
    »» thumb_1280x720 string URL to the large logo thumbnail.
    » homepage string Official homepage of the mod.
    » name string Name of the mod.
    » name_id string Path for the mod on mod.io. For example: https://gamename.mod.io/mod-name-id-here
    » summary string Summary of the mod.
    » description string Detailed description of the mod which allows HTML.
    » metadata_blob string Metadata stored by the game developer. Metadata can also be stored as searchable key value pairs, and to individual mod files.
    » profile_url string URL to the mod's mod.io profile.
    » modfile Modfile Object Contains modfile data.
    »» id integer Unique modfile id.
    »» mod_id integer Unique mod id.
    »» date_added integer Unix timestamp of date file was added.
    »» date_scanned integer Unix timestamp of date file was virus scanned.
    »» virus_status 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:

    0 = Not scanned
    1 = Scan complete
    2 = In progress
    3 = Too large to scan
    4 = File not found
    5 = Error Scanning
    »» virus_positive integer Was a virus detected:

    0 = No threats detected
    1 = Flagged as malicious
    »» virustotal_hash string VirusTotal proprietary hash to view the scan results.
    »» filesize integer Size of the file in bytes.
    »» filehash Filehash Object Contains filehash data.
    »»» md5 string MD5 hash of the file.
    »» filename string Filename including extension.
    »» version string Release version this file represents.
    »» changelog string Changelog for the file.
    »» metadata_blob string Metadata stored by the game developer for this file.
    »» download Download Object Contains download data.
    »»» binary_url string 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.
    »»» date_expires integer Unix timestamp of when the binary_url will expire.
    » media Mod Media Object Contains mod media data.
    »» youtube string[] Array of YouTube links.
    »» sketchfab string[] Array of SketchFab links.
    »» images Image Object [] Array of image objects (a gallery).
    »»» filename string Image filename including extension.
    »»» original string URL to the full-sized image.
    »»» thumb_320x180 string URL to the image thumbnail.
    » rating_summary Rating Summary Object Contains ratings summary.
    »» total_ratings integer Number of times this item has been rated.
    »» positive_ratings integer Number of positive ratings.
    »» negative_ratings integer Number of negative ratings.
    »» percentage_positive integer Number of positive ratings, divided by the total ratings to determine it’s percentage score.
    »» weighted_aggregate 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.
    »» display_text string Textual representation of the rating in format:

    - Overwhelmingly Positive
    - Very Positive
    - Positive
    - Mostly Positive
    - Mixed
    - Negative
    - Mostly Negative
    - Very Negative
    - Overwhelmingly Negative
    » tags Mod Tag Object [] Contains mod tag data.
    »» name string Tag name.
    »» date_added integer Unix timestamp of date tag was applied.
    result_count integer Number of results returned in the data array.
    result_limit integer Maximum number of results returned.
    result_offset integer Number of results skipped over.

    Get Mod Events

    {
      "data": [
        {
          "id": 13,
          "mod_id": 13,
          "user_id": 13,
          "date_added": 1499846132,
          "event_type": "MODFILE_CHANGED"
        },
        {
            ...
        }
      ],
      "result_count": 100,
      "result_limit": 100,
      "result_offset": 0
    } 
    

    Properties

    Name Type Description
    data Event Object [] Array containing event objects.
    » id integer Unique id of the event object.
    » mod_id integer Unique id of the parent mod.
    » user_id integer Unique id of the user who performed the action.
    » date_added integer Unix timestamp of date the event occurred.
    » event_type string Type of event was 'MODFILE_CHANGED', 'MOD_AVAILABLE', 'MOD_UNAVAILABLE', 'MOD_EDITED'.
    result_count integer Number of results returned in the data array.
    result_limit integer Maximum number of results returned.
    result_offset integer Number of results skipped over.

    Get All Game Tag Options

    {
      "data": [
        {
          "name": "Theme",
          "type": "checkboxes",
          "tags": [
            "Horror"
          ],
          "hidden": false
        },
        {
            ...
        }
      ],
      "result_count": 100,
      "result_limit": 100,
      "result_offset": 0
    } 
    

    Properties

    Name Type Description
    data Game Tag Option Object [] Array containing game tag objects.
    » name string Name of the tag group.
    » type string Can multiple tags be selected via 'checkboxes' or should only a single tag be selected via a 'dropdown'.
    » hidden boolean Groups of tags flagged as 'admin only' should only be used for filtering, and should not be displayed to users.
    » tags string[] Array of tags in this group.
    result_count integer Number of results returned in the data array.
    result_limit integer Maximum number of results returned.
    result_offset integer Number of results skipped over.

    Get All Mod Tags

    {
      "data": [
        {
          "name": "Unity",
          "date_added": 1499841487
        },
        {
            ...
        }
      ],
      "result_count": 100,
      "result_limit": 100,
      "result_offset": 0
    } 
    

    Properties

    Name Type Description
    data Mod Tag Object [] Array containing mod tag objects.
    » name string Tag name.
    » date_added integer Unix timestamp of date tag was applied.
    result_count integer Number of results returned in the data array.
    result_limit integer Maximum number of results returned.
    result_offset integer Number of results skipped over.

    Get All Team Members

    {
      "data": [
        {
          "id": 457,
          "user": {
            "id": 1,
            "name_id": "xant",
            "username": "XanT",
            "date_online": 1509922961,
            "avatar": {
              "filename": "modio-dark.png",
              "original": "https://static.mod.io/v1/images/global/ao_modio-dark.png",
              "thumb_50x50": "https://static.mod.io/v1/images/global/modio-dark.png",
              "thumb_100x100": "https://static.mod.io/v1/images/global/am_modio-dark.png"
            },
            "timezone": "America/Los_Angeles",
            "language": "en",
            "profile_url": "https://mod.io/members/xant"
          },
          "level": 8,
          "date_added": 1492058857,
          "position": "Supreme Overlord"
        },
        {
            ...
        }
      ],
      "result_count": 100,
      "result_limit": 100,
      "result_offset": 0
    } 
    

    Properties

    Name Type Description
    data Team Member Object [] Array containing team member objects.
    » id integer Unique team member id.
    » user User Object Contains user data.
    »» id integer Unique id of the user.
    »» name_id string Path for the user on mod.io. For example: https://mod.io/members/username-id-here Usually a simplified version of their username.
    »» username string Username of the user.
    »» date_online integer Unix timestamp of date the user was last online.
    »» avatar Avatar Object Contains avatar data.
    »»» filename string Avatar filename including extension.
    »»» original string URL to the full-sized avatar.
    »»» thumb_50x50 string URL to the small thumbnail image.
    »»» thumb_100x100 string URL to the medium thumbnail image.
    »» timezone string Timezone of the user, format is country/city.
    »» language string Users language preference. See localization for the supported languages.
    »» profile_url string URL to the user's mod.io profile.
    » level integer Level of permission the user has:

    1 = Member
    4 = Manager
    8 = Leader
    » date_added integer Unix timestamp of the date the user was added to the team.
    » position string Custom title given to the user in this team.
    result_count integer Number of results returned in the data array.
    result_limit integer Maximum number of results returned.
    result_offset integer Number of results skipped over.

    Get All Users

    {
      "data": [
        {
          "id": 1,
          "name_id": "xant",
          "username": "XanT",
          "date_online": 1509922961,
          "avatar": {
            "filename": "modio-dark.png",
            "original": "https://static.mod.io/v1/images/global/ao_modio-dark.png",
            "thumb_50x50": "https://static.mod.io/v1/images/global/modio-dark.png",
            "thumb_100x100": "https://static.mod.io/v1/images/global/am_modio-dark.png"
          },
          "timezone": "America/Los_Angeles",
          "language": "en",
          "profile_url": "https://mod.io/members/xant"
        },
        {
            ...
        }
      ],
      "result_count": 100,
      "result_limit": 100,
      "result_offset": 0
    } 
    

    Properties

    Name Type Description
    data User Object [] Array containing user objects.
    » id integer Unique id of the user.
    » name_id string Path for the user on mod.io. For example: https://mod.io/members/username-id-here Usually a simplified version of their username.
    » username string Username of the user.
    » date_online integer Unix timestamp of date the user was last online.
    » avatar Avatar Object Contains avatar data.
    »» filename string Avatar filename including extension.
    »» original string URL to the full-sized avatar.
    »» thumb_50x50 string URL to the small thumbnail image.
    »» thumb_100x100 string URL to the medium thumbnail image.
    » timezone string Timezone of the user, format is country/city.
    » language string Users language preference. See localization for the supported languages.
    » profile_url string URL to the user's mod.io profile.
    result_count integer Number of results returned in the data array.
    result_limit integer Maximum number of results returned.
    result_offset integer Number of results skipped over.

    Get All User Events

    {
      "data": [
        {
          "id": 13,
          "mod_id": 13,
          "user_id": 13,
          "date_added": 1499846132,
          "event_type": "MODFILE_CHANGED"
        },
        {
            ...
        }
      ],
      "result_count": 100,
      "result_limit": 100,
      "result_offset": 0
    } 
    

    Properties

    Name Type Description
    data Event Object [] Array containing event objects.
    » id integer Unique id of the event object.
    » mod_id integer Unique id of the parent mod.
    » user_id integer Unique id of the user who performed the action.
    » date_added integer Unix timestamp of date the event occurred.
    » event_type string Type of event was 'MODFILE_CHANGED', 'MOD_AVAILABLE', 'MOD_UNAVAILABLE', 'MOD_EDITED'.
    result_count integer Number of results returned in the data array.
    result_limit integer Maximum number of results returned.
    result_offset integer Number of results skipped over.