MCJars API

https://mcjars.app/api
Admin
MCJars API is a RESTful API service for managing Minecraft server builds, organizations, and user...
Tokens:26,193
Snippets:108
Trust Score:5.5
Update:8 months ago
Show doc for...
Tokens:
Raw
### GET /api/v2/builds/{type} Request Example (cURL)

Source: https://mcjars.app/api/index

Example cURL command to send a GET request to the /api/v2/builds/{type} endpoint. This endpoint retrieves available builds for a specified server type. The 'type' path parameter is required and must be one of the supported server types.

```shell
curl https://mcjars.app/api/v2/builds/VANILLA
```

--------------------------------

### Get Build Information (Shell Curl)

Source: https://mcjars.app/api/index

This example demonstrates how to fetch detailed information about a specific build using its hash or number via a cURL command. The build identifier is passed as a path parameter.

```shell
curl https://mcjars.app/api/v1/build/b1f3eeac53355d9ba5cf19e36abe8b2a30278c0e60942f3d07ac9ac9e4564951
```

--------------------------------

### POST /api/v2/build Request Example (cURL)

Source: https://mcjars.app/api/index

Example cURL command to send a POST request to the /api/v2/build endpoint. This request is used to initiate the build process for a Minecraft server JAR. It requires a JSON body specifying build parameters such as type, version, and experimental flags.

```shell
curl https://mcjars.app/api/v2/build \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "id": null,
  "type": "VANILLA",
  "versionId": null,
  "projectVersionId": null,
  "name": null,
  "buildNumber": null,
  "experimental": null,
  "jarUrl": null,
  "jarSize": null,
  "zipUrl": null,
  "zipSize": null,
  "hash": {
    "primary": null,
    "sha1": null,
    "sha224": null,
    "sha256": null,
    "sha384": null,
    "sha512": null,
    "md5": null
  }
}'
```

--------------------------------

### GET /api/v2/configs

Source: https://mcjars.app/api/index

Retrieves a list of available server configurations.

```APIDOC
## GET /api/v2/configs

### Description
Retrieves a list of available server configurations.

### Method
GET

### Endpoint
/api/v2/configs

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **configs** (object) - An object containing configuration details.
  - **additionalProperty** (object) - Represents a specific configuration.
    - **type** (string) - The type of the configuration (e.g., VANILLA).
    - **format** (string) - The format of the configuration (e.g., PROPERTIES).
    - **aliases** (array) - A list of aliases for this configuration.

#### Response Example
```json
{
  "success": true,
  "configs": {
    "additionalProperty": {
      "type": "VANILLA",
      "format": "PROPERTIES",
      "aliases": [
        "string"
      ]
    }
  }
}
```
```

--------------------------------

### GET /api/v1/script/{build}/bash

Source: https://mcjars.app/api/index

Generates a bash script for a given build.

```APIDOC
## GET /api/v1/script/{build}/bash

### Description
Generates a bash script for a given build.

### Method
GET

### Endpoint
/api/v1/script/{build}/bash

### Parameters
#### Path Parameters
- **build** (string) - Required - The build number or hash to lookup.

#### Query Parameters
- **echo** (boolean) - Required - Whether to echo inside the script.

### Request Example
```bash
curl 'https://mcjars.app/api/v1/script/b1f3eeac53355d9ba5cf19e36abe8b2a30278c0e60942f3d07ac9ac9e4564951/bash?echo=true'
```

### Response
#### Success Response (200)
- The response is a plain text string containing the bash script.

#### Response Example
```
string
```
```

--------------------------------

### GET /api/v2/types

Source: https://mcjars.app/api/index

Retrieves a list of available server types.

```APIDOC
## GET /api/v2/types

### Description
Retrieves a list of available server types, categorized into recommended, established, experimental, miscellaneous, and limbos.

### Method
GET

### Endpoint
/api/v2/types

### Parameters
None

### Request Example
```shell
curl https://mcjars.app/api/v2/types
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **types** (object) - An object containing different categories of server types.
  - **recommended** (object) - Recommended server types.
  - **established** (object) - Established server types.
  - **experimental** (object) - Experimental server types.
  - **miscellaneous** (object) - Miscellaneous server types.
  - **limbos** (object) - Limbo server types.
    - Each type object within these categories contains properties like name, icon, color, homepage, deprecated, experimental, description, categories, compatibility, builds, and versions.

#### Response Example
```json
{
  "success": true,
  "types": {
    "recommended": {
      "additionalProperty": {
        "name": "string",
        "icon": "string",
        "color": "string",
        "homepage": "string",
        "deprecated": true,
        "experimental": true,
        "description": "string",
        "categories": [
          "string"
        ],
        "compatibility": [
          "string"
        ],
        "builds": 1,
        "versions": {
          "minecraft": 1,
          "project": 1
        }
      }
    },
    "established": {
      "additionalProperty": {
        "name": "string",
        "icon": "string",
        "color": "string",
        "homepage": "string",
        "deprecated": true,
        "experimental": true,
        "description": "string",
        "categories": [
          "string"
        ],
        "compatibility": [
          "string"
        ],
        "builds": 1,
        "versions": {
          "minecraft": 1,
          "project": 1
        }
      }
    },
    "experimental": {
      "additionalProperty": {
        "name": "string",
        "icon": "string",
        "color": "string",
        "homepage": "string",
        "deprecated": true,
        "experimental": true,
        "description": "string",
        "categories": [
          "string"
        ],
        "compatibility": [
          "string"
        ],
        "builds": 1,
        "versions": {
          "minecraft": 1,
          "project": 1
        }
      }
    },
    "miscellaneous": {
      "additionalProperty": {
        "name": "string",
        "icon": "string",
        "color": "string",
        "homepage": "string",
        "deprecated": true,
        "experimental": true,
        "description": "string",
        "categories": [
          "string"
        ],
        "compatibility": [
          "string"
        ],
        "builds": 1,
        "versions": {
          "minecraft": 1,
          "project": 1
        }
      }
    },
    "limbos": {
      "additionalProperty": {
        "name": "string",
        "icon": "string",
        "color": "string",
        "homepage": "string",
        "deprecated": true,
        "experimental": true,
        "description": "string",
        "categories": [
          "string"
        ],
        "compatibility": [
          "string"
        ],
        "builds": 1,
        "versions": {
          "minecraft": 1,
          "project": 1
        }
      }
    }
  }
}
```
```

--------------------------------

### GET /api/v1/builds/{type}/{version}

Source: https://mcjars.app/api/index

Retrieves specific build information for a given server type and version.

```APIDOC
## GET /api/v1/builds/{type}/{version}

### Description
Retrieves specific build information for a given server type and version.

### Method
GET

### Endpoint
/api/v1/builds/{type}/{version}

### Parameters
#### Path Parameters
- **type** (string) - Required - The server type. Enum: VANILLA, PAPER, PUFFERFISH, SPIGOT, FOLIA
- **version** (string) - Required - The server version (e.g., 1.17.1).

### Request Example
```bash
curl https://mcjars.app/api/v1/builds/VANILLA/1.17.1
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **builds** (array) - An array of build objects, each containing details like `id`, `versionId`, `type`, `experimental`, `name`, `buildNumber`, `jarUrl`, `jarSize`, `zipUrl`, `zipSize`, `installation`, `changes`, and `created`.

#### Response Example
```json
{
  "success": true,
  "builds": [
    {
      "id": 1,
      "versionId": "string",
      "projectVersionId": "string",
      "type": "VANILLA",
      "experimental": true,
      "name": "string",
      "buildNumber": 1,
      "jarUrl": "string",
      "jarSize": null,
      "zipUrl": "string",
      "zipSize": null,
      "installation": [
        [
          {
            "url": "string",
            "file": "string",
            "size": 0,
            "type": "download"
          }
        ]
      ],
      "changes": [
        "string"
      ],
      "created": null
    }
  ]
}
```
```

--------------------------------

### GET /api/v1/builds/{type}

Source: https://mcjars.app/api/index

Retrieves information about available builds for a specific server type.

```APIDOC
## GET /api/v1/builds/{type}

### Description
Retrieves information about available builds for a specific server type.

### Method
GET

### Endpoint
/api/v1/builds/{type}

### Parameters
#### Path Parameters
- **type** (string) - Required - The server type. Enum: VANILLA, PAPER, PUFFERFISH, SPIGOT, FOLIA

### Request Example
```bash
curl https://mcjars.app/api/v1/builds/VANILLA
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **versions** (object) - An object containing version details. `additionalProperty` (object) - Details for a specific version, including `type`, `supported`, `java`, `builds`, `created`, and `latest` build information.

#### Response Example
```json
{
  "success": true,
  "versions": {
    "additionalProperty": {
      "type": "RELEASE",
      "supported": true,
      "java": 1,
      "builds": 1,
      "created": "2026-01-24T01:25:31.139Z",
      "latest": {
        "id": 1,
        "versionId": "string",
        "projectVersionId": "string",
        "type": "VANILLA",
        "experimental": true,
        "name": "string",
        "buildNumber": 1,
        "jarUrl": "string",
        "jarSize": null,
        "zipUrl": "string",
        "zipSize": null,
        "installation": [
          [
            {
              "url": "string",
              "file": "string",
              "size": 0,
              "type": "download"
            }
          ]
        ],
        "changes": [
          "string"
        ],
        "created": null
      }
    }
  }
}
```
```

--------------------------------

### Get Subuser Details (Shell Curl)

Source: https://mcjars.app/api/index

This example shows how to retrieve details for a specific subuser within an organization using cURL. It requires both the organization ID and the subuser's login name as path parameters.

```shell
curl https://mcjars.app/api/user/organizations/1/subusers/1
```

--------------------------------

### GET /api/organization/v1/types

Source: https://mcjars.app/api/index

Retrieves a detailed list of available server types and their properties.

```APIDOC
## GET /api/organization/v1/types

### Description
Retrieves a detailed list of available server types, including their names, icons, compatibility, and build information.

### Method
GET

### Endpoint
/api/organization/v1/types

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```
curl https://mcjars.app/api/organization/v1/types
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **types** (object) - An object where keys are server type identifiers and values are server type details.
  - **additionalProperty** (object) - Details for a specific server type.
    - **name** (string) - The name of the server type.
    - **icon** (string) - The icon for the server type.
    - **color** (string) - The color associated with the server type.
    - **homepage** (string) - The homepage URL for the server type.
    - **deprecated** (boolean) - Indicates if the server type is deprecated.
    - **experimental** (boolean) - Indicates if the server type is experimental.
    - **description** (string) - A description of the server type.
    - **categories** (array) - A list of categories the server type belongs to.
    - **compatibility** (array) - A list of compatible versions or platforms.
    - **builds** (integer) - The number of builds available for this type.
    - **versions** (object) - Version information.
      - **minecraft** (integer) - The Minecraft version compatibility.
      - **project** (integer) - The project version.

#### Response Example
```json
{
  "success": true,
  "types": {
    "additionalProperty": {
      "name": "string",
      "icon": "string",
      "color": "string",
      "homepage": "string",
      "deprecated": true,
      "experimental": true,
      "description": "string",
      "categories": [
        "string"
      ],
      "compatibility": [
        "string"
      ],
      "builds": 1,
      "versions": {
        "minecraft": 1,
        "project": 1
      }
    }
  }
}
```
```

--------------------------------

### GET /api/v2/builds/{type}

Source: https://mcjars.app/api/index

Retrieves a list of builds for a specific server type.

```APIDOC
## GET /api/v2/builds/{type}

### Description
Retrieves a list of builds for a specified server type.

### Method
GET

### Endpoint
/api/v2/builds/{type}

### Parameters
#### Path Parameters
- **type** (string) - Required - The server type (e.g., VANILLA, PAPER, SPIGOT).

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **builds** (object) - An object containing build information, keyed by additional properties.
  - **additionalProperty** (object) - Details about a specific build.
    - **type** (string) - The type of the build.
    - **supported** (boolean) - Indicates if the build is supported.
    - **java** (integer) - The required Java version.
    - **builds** (integer) - The number of builds.
    - **created** (string) - The creation date of the version.
    - **latest** (object) - Details of the latest build for this version.

#### Response Example
```json
{
  "success": true,
  "builds": {
    "additionalProperty": {
      "type": "RELEASE",
      "supported": true,
      "java": 1,
      "builds": 1,
      "created": "2026-01-24T01:25:31.139Z",
      "latest": {
        "id": 1,
        "versionId": "string",
        "projectVersionId": "string",
        "type": "VANILLA",
        "experimental": true,
        "name": "string",
        "buildNumber": 1,
        "jarUrl": "string",
        "jarSize": null,
        "zipUrl": "string",
        "zipSize": null,
        "installation": [
          [
            {
              "url": "string",
              "file": "string",
              "size": 0,
              "type": "download"
            }
          ]
        ],
        "changes": [
          "string"
        ],
        "created": null
      }
    }
  }
}
```
```

--------------------------------

### Get All Configurations (Shell Curl)

Source: https://mcjars.app/api/index

Retrieves a list of all available configurations. This endpoint does not require any parameters and returns a JSON object containing configuration details.

```shell
curl https://mcjars.app/api/v2/configs
```

--------------------------------

### GET /api/v1/builds/{type}/{version}/{build}

Source: https://mcjars.app/api/index

Retrieves a specific build by type, version, and build number or 'latest'.

```APIDOC
## GET /api/v1/builds/{type}/{version}/{build}

### Description
Retrieves a specific build by type, version, and build number or 'latest'.

### Method
GET

### Endpoint
/api/v1/builds/{type}/{version}/{build}

### Parameters
#### Path Parameters
- **type** (string) - Required - The server type. Enum: VANILLA, PAPER, PUFFERFISH, SPIGOT, FOLIA
- **version** (string) - Required - The server version (e.g., 1.17.1).
- **build** (string) - Required - The build number or 'latest'.

### Request Example
```bash
curl https://mcjars.app/api/v1/builds/VANILLA/1.17.1/latest
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **build** (object) - An object containing the specific build details, including `id`, `versionId`, `projectVersionId`, `type`, `experimental`, `name`, `buildNumber`, `jarUrl`, `jarSize`, `zipUrl`, `zipSize`, `installation`, `changes`, and `created`.

#### Response Example
```json
{
  "success": true,
  "build": {
    "id": 1,
    "versionId": "string",
    "projectVersionId": "string",
    "type": "VANILLA",
    "experimental": true,
    "name": "string",
    "buildNumber": 1,
    "jarUrl": "string",
    "jarSize": null,
    "zipUrl": "string",
    "zipSize": null,
    "installation": [
      [
        {
          "url": "string",
          "file": "string",
          "size": 0,
          "type": "download"
        }
      ]
    ],
    "changes": [
      "string"
    ],
    "created": null
  }
}
```
```

--------------------------------

### GET /api/organization/v1

Source: https://mcjars.app/api/index

Retrieves general information about the organization.

```APIDOC
## GET /api/organization/v1

### Description
Retrieves general information about the organization, including its icon, name, and types.

### Method
GET

### Endpoint
/api/organization/v1

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```
curl https://mcjars.app/api/organization/v1
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **infos** (object) - Contains organization details.
  - **icon** (string) - The icon representing the organization.
  - **name** (string) - The name of the organization.
  - **types** (array) - A list of organization types (e.g., "VANILLA").
- **stats** (object) - Contains statistics related to the organization.
  - **requests** (integer) - The number of requests made.
  - **userAgents** (array) - A list of user agents that have accessed the organization.
  - **origins** (array) - A list of origins from which the organization has been accessed.

#### Response Example
```json
{
  "success": true,
  "infos": {
    "icon": "string",
    "name": "string",
    "types": [
      "VANILLA"
    ]
  },
  "stats": {
    "requests": 0,
    "userAgents": [
      "string"
    ],
    "origins": [
      "string"
    ]
  }
}
```
```

--------------------------------

### GET /api/v2/lookups/versions/{type}

Source: https://mcjars.app/api/index

Retrieves version information for a specific server type.

```APIDOC
## GET /api/v2/lookups/versions/{type}

### Description
Retrieves version information for a specific server type.

### Method
GET

### Endpoint
/api/v2/lookups/versions/{type}

### Parameters
#### Path Parameters
- **type** (string) - Required - The server type. Allowed values: VANILLA, PAPER, PUFFERFISH, SPIGOT, FOLIA.

### Request Example
```json
{
  "example": "curl https://mcjars.app/api/v2/lookups/versions/VANILLA"
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **versions** (object) - Contains version information.
  - **additionalProperty** (object) - Details about the versions.
    - **total** (integer) - Total number of versions.
    - **uniqueIps** (integer) - Number of unique IPs.

#### Response Example
```json
{
  "success": true,
  "versions": {
    "additionalProperty": {
      "total": 1,
      "uniqueIps": 1
    }
  }
}
```
```

--------------------------------

### GET /api/v2/builds/{type}/{version}

Source: https://mcjars.app/api/index

Retrieves build information for a specific server type and version. Supports various server types like VANILLA, PAPER, SPIGOT, etc.

```APIDOC
## GET /api/v2/builds/{type}/{version}

### Description
Retrieves build information for a specific server type and version. Supports various server types like VANILLA, PAPER, SPIGOT, etc.

### Method
GET

### Endpoint
/api/v2/builds/{type}/{version}

### Parameters
#### Path Parameters
- **type** (string) - Required - The server type. Enum: VANILLA, PAPER, PUFFERFISH, SPIGOT, FOLIA.
- **version** (string) - Required - The server version (e.g., 1.17.1).

### Request Example
```bash
curl https://mcjars.app/api/v2/builds/VANILLA/1.17.1
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **builds** (array) - A list of build objects matching the query.
  - **id** (integer) - The unique identifier for the build.
  - **versionId** (string) - The ID of the project version.
  - **projectVersionId** (string) - The ID of the project.
  - **type** (string) - The type of the server build (e.g., VANILLA).
  - **experimental** (boolean) - Indicates if the build is experimental.
  - **name** (string) - The name of the build.
  - **buildNumber** (integer) - The build number.
  - **jarUrl** (string) - The URL to download the JAR file.
  - **jarSize** (integer) - The size of the JAR file in bytes (null if not available).
  - **zipUrl** (string) - The URL to download the ZIP file.
  - **zipSize** (integer) - The size of the ZIP file in bytes (null if not available).
  - **installation** (array) - An array detailing installation steps.
  - **changes** (array) - A list of changes included in this build.
  - **created** (string) - The creation timestamp of the build (null if not available).

#### Response Example
```json
{
  "success": true,
  "builds": [
    {
      "id": 1,
      "versionId": "string",
      "projectVersionId": "string",
      "type": "VANILLA",
      "experimental": true,
      "name": "string",
      "buildNumber": 1,
      "jarUrl": "string",
      "jarSize": null,
      "zipUrl": "string",
      "zipSize": null,
      "installation": [
        [
          {
            "url": "string",
            "file": "string",
            "size": 0,
            "type": "download"
          }
        ]
      ],
      "changes": [
        "string"
      ],
      "created": null
    }
  ]
}
```
```

--------------------------------

### GET /api/v1/script/{build}/powershell

Source: https://mcjars.app/api/index

Retrieves and executes a PowerShell script for a given build. It supports echoing the script's output.

```APIDOC
## GET /api/v1/script/{build}/powershell

### Description
Retrieves and executes a PowerShell script for a given build. It supports echoing the script's output.

### Method
GET

### Endpoint
/api/v1/script/{build}/powershell

### Parameters
#### Path Parameters
- **build** (string) - Required - The build number or hash to lookup

#### Query Parameters
- **echo** (boolean) - Required - Whether to echo inside the script

### Request Example
```bash
curl 'https://mcjars.app/api/v1/script/b1f3eeac53355d9ba5cf19e36abe8b2a30278c0e60942f3d07ac9ac9e4564951/powershell?echo=true'
```

### Response
#### Success Response (200)
- **text/plain** - The output of the PowerShell script.

#### Error Response (404)
- **text/plain** - Indicates that the specified build was not found.
```

--------------------------------

### GET /api/v2/lookups/versions

Source: https://mcjars.app/api/index

Provides lookup data for server versions, including total counts and unique IP addresses.

```APIDOC
## GET /api/v2/lookups/versions

### Description
Provides lookup data for server versions, including total counts and unique IP addresses.

### Method
GET

### Endpoint
/api/v2/lookups/versions

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **versions** (object) - An object containing lookup data for server versions.
  - **additionalProperty** (object) - Represents a specific server version's lookup data.
    - **total** (integer) - The total count for this version.
    - **uniqueIps** (integer) - The number of unique IP addresses associated with this version.

#### Response Example
```json
{
  "success": true,
  "versions": {
    "additionalProperty": {
      "total": 1,
      "uniqueIps": 1
    }
  }
}
```
```

--------------------------------

### GET /api/user

Source: https://mcjars.app/api/index

Retrieves information about the currently authenticated user.

```APIDOC
## GET /api/user

### Description
Retrieves detailed information about the currently authenticated user, including their ID, name, email, and administrative status.

### Method
GET

### Endpoint
/api/user

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```
curl https://mcjars.app/api/user
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **user** (object) - Contains user details.
  - **id** (integer) - The unique identifier for the user.
  - **githubId** (integer) - The GitHub user ID.
  - **admin** (boolean) - Indicates if the user has administrative privileges.
  - **name** (string) - The display name of the user.
  - **avatar** (string) - The URL of the user's avatar.
  - **email** (string) - The email address of the user.
  - **login** (string) - The login name of the user.

#### Response Example
```json
{
  "success": true,
  "user": {
    "id": 1,
    "githubId": 1,
    "admin": true,
    "name": "string",
    "avatar": "string",
    "email": "string",
    "login": "string"
  }
}
```
```

--------------------------------

### GET /api/v1/version/{version}/builds

Source: https://mcjars.app/api/index

Retrieves a list of all available builds for a specific Minecraft version. This endpoint is deprecated.

```APIDOC
## GET /api/v1/version/{version}/builds

### Description
Retrieves a list of all available builds for a specific Minecraft version. This endpoint is deprecated.

### Method
GET

### Endpoint
/api/v1/version/{version}/builds

### Parameters
#### Path Parameters
- **version** (string) - Required - The server version (e.g., "1.17.1")

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **builds** (object) - An object where keys are build identifiers and values are build details:
  - **additionalProperty** (array of objects) - Details for each build:
    - **id** (integer) - The unique identifier for the build.
    - **versionId** (string) - The ID of the Minecraft version this build belongs to.
    - **projectVersionId** (string) - The ID of the project version.
    - **type** (string) - The type of the build (e.g., "VANILLA").
    - **experimental** (boolean) - Indicates if the build is experimental.
    - **name** (string) - The name of the build.
    - **buildNumber** (integer) - The build number.
    - **jarUrl** (string) - URL to download the JAR file.
    - **jarSize** (integer or null) - Size of the JAR file in bytes.
    - **zipUrl** (string) - URL to download the ZIP file.
    - **zipSize** (integer or null) - Size of the ZIP file in bytes.
    - **installation** (array of arrays of objects) - Installation instructions.
    - **changes** (array of strings) - List of changes in this build.
    - **created** (string or null) - The creation date of the build (ISO 8601 format).

#### Error Response (404)
- **application/json** - Indicates that the specified version was not found.

### Response Example
```json
{
  "success": true,
  "builds": {
    "additionalProperty": [
      {
        "id": 1,
        "versionId": "string",
        "projectVersionId": "string",
        "type": "VANILLA",
        "experimental": true,
        "name": "string",
        "buildNumber": 1,
        "jarUrl": "string",
        "jarSize": null,
        "zipUrl": "string",
        "zipSize": null,
        "installation": [
          [
            {
              "url": "string",
              "file": "string",
              "size": 0,
              "type": "download"
            }
          ]
        ],
        "changes": [
          "string"
        ],
        "created": null
      }
    ]
  }
}
```
```

--------------------------------

### GET /api/v1/build/{build}

Source: https://mcjars.app/api/index

Retrieves information about a specific build, identified by its build number or hash. Returns details about the build, the latest version, and version information.

```APIDOC
## GET /api/v1/build/{build}

### Description
Retrieves information about a specific build, identified by its build number or hash. Returns details about the build, the latest version, and version information.

### Method
GET

### Endpoint
/api/v1/build/{build}

### Parameters
#### Path Parameters
- **build** (string) - Required - The build number or hash to lookup

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.
- **build** (object) - Details of the requested build.
  - **id** (integer) - The build ID.
  - **versionId** (string) - The ID of the version this build belongs to.
  - **projectVersionId** (string) - The ID of the project version.
  - **type** (string) - The type of build (e.g., VANILLA).
  - **experimental** (boolean) - Whether the build is experimental.
  - **name** (string) - The name of the build.
  - **buildNumber** (integer) - The build number.
  - **jarUrl** (string) - URL to the build's JAR file.
  - **jarSize** (integer or null) - Size of the JAR file in bytes.
  - **zipUrl** (string) - URL to the build's ZIP file.
  - **zipSize** (integer or null) - Size of the ZIP file in bytes.
  - **installation** (array of arrays of objects) - Installation instructions.
    - **url** (string) - Download URL.
    - **file** (string) - Filename.
    - **size** (integer) - File size.
    - **type** (string) - Type of installation step (e.g., download).
  - **changes** (array of strings) - List of changes in this build.
  - **created** (string or null) - Creation timestamp (ISO 8601 format).
- **latest** (object) - Details of the latest available build (same structure as 'build').
- **version** (object) - Information about the project version.
  - **id** (string) - The version ID.
  - **type** (string) - The type of version (e.g., RELEASE).
  - **supported** (boolean) - Whether this version is supported.
  - **java** (integer) - Required Java version.
  - **builds** (integer) - Number of builds for this version.
  - **created** (string) - Creation timestamp (ISO 8601 format).

#### Response Example
```json
{
  "success": true,
  "build": {
    "id": 1,
    "versionId": "string",
    "projectVersionId": "string",
    "type": "VANILLA",
    "experimental": true,
    "name": "string",
    "buildNumber": 1,
    "jarUrl": "string",
    "jarSize": null,
    "zipUrl": "string",
    "zipSize": null,
    "installation": [
      [
        {
          "url": "string",
          "file": "string",
          "size": 0,
          "type": "download"
        }
      ]
    ],
    "changes": [
      "string"
    ],
    "created": null
  },
  "latest": {
    "id": 1,
    "versionId": "string",
    "projectVersionId": "string",
    "type": "VANILLA",
    "experimental": true,
    "name": "string",
    "buildNumber": 1,
    "jarUrl": "string",
    "jarSize": null,
    "zipUrl": "string",
    "zipSize": null,
    "installation": [
      [
        {
          "url": "string",
          "file": "string",
          "size": 0,
          "type": "download"
        }
      ]
    ],
    "changes": [
      "string"
    ],
    "created": null
  },
  "version": {
    "id": "string",
    "type": "RELEASE",
    "supported": true,
    "java": 1,
    "builds": 1,
    "created": "2026-01-24T01:25:31.139Z"
  }
}
```
```

--------------------------------

### GET /api/v2/lookups/versions/history/{year}/{month}

Source: https://mcjars.app/api/index

Retrieves the version history for a specific year and month.

```APIDOC
## GET /api/v2/lookups/versions/history/{year}/{month}

### Description
Retrieves the version history for a specific year and month.

### Method
GET

### Endpoint
/api/v2/lookups/versions/history/{year}/{month}

### Parameters
#### Path Parameters
- **year** (integer) - Required - The year to get the version history for. Minimum value: 2024.
- **month** (integer) - Required - The month to get the version history for. Minimum value: 1, Maximum value: 12.

### Request Example
```json
{
  "example": "curl https://mcjars.app/api/v2/lookups/versions/history/2024/1"
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **versions** (object) - Contains version history data.
  - **additionalProperty** (array) - An array of version history entries.
    - **day** (integer) - The day of the month.
    - **total** (integer) - Total number of versions for that day.
    - **uniqueIps** (integer) - Number of unique IPs for that day.

#### Response Example
```json
{
  "success": true,
  "versions": {
    "additionalProperty": [
      {
        "day": 1,
        "total": 1,
        "uniqueIps": 1
      }
    ]
  }
}
```
```

--------------------------------

### GET /api/v1/version/{version}

Source: https://mcjars.app/api/index

Retrieves information about a specific Minecraft version, including its type, support status, required Java version, creation date, and available builds.

```APIDOC
## GET /api/v1/version/{version}

### Description
Retrieves information about a specific Minecraft version, including its type, support status, required Java version, creation date, and available builds.

### Method
GET

### Endpoint
/api/v1/version/{version}

### Parameters
#### Path Parameters
- **version** (string) - Required - The server version (e.g., "1.17.1")

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **version** (object) - Details about the Minecraft version:
  - **type** (string) - The type of the version (e.g., "RELEASE").
  - **supported** (boolean) - Indicates if the version is supported.
  - **java** (integer) - The required Java version.
  - **created** (string) - The creation date of the version entry (ISO 8601 format).
  - **builds** (object) - Information about builds for this version:
    - **additionalProperty** (integer) - Represents a specific build, value might be build number or ID.

#### Error Response (404)
- **application/json** - Indicates that the specified version was not found.

### Response Example
```json
{
  "success": true,
  "version": {
    "type": "RELEASE",
    "supported": true,
    "java": 1,
    "created": "2026-01-24T01:25:31.139Z",
    "builds": {
      "additionalProperty": 1
    }
  }
}
```
```

--------------------------------

### Get Builds by Type and Version (Shell Curl)

Source: https://mcjars.app/api/index

Retrieves builds for a specific server type and version. This endpoint requires both the server type and version as path parameters. It returns a JSON object detailing the builds.

```shell
curl https://mcjars.app/api/v1/builds/VANILLA/1.17.1
```

--------------------------------

### Get Project Types

Source: https://mcjars.app/api/index

Retrieves a list of supported project types available on mcjars.app. Each type includes details such as name, icon, color, homepage, and compatibility information. Returns a JSON object containing type details.

```curl
curl https://mcjars.app/api/v1/types
```

--------------------------------

### GET /api/v2/stats/version/{version}

Source: https://mcjars.app/api/index

Retrieves statistical data for a specific server version, including build counts and size information.

```APIDOC
## GET /api/v2/stats/version/{version}

### Description
Retrieves statistical data for a specific server version, including build counts and size information.

### Method
GET

### Endpoint
/api/v2/stats/version/{version}

### Parameters
#### Path Parameters
- **version** (string) - Required - The server version (e.g., 1.17.1).

### Request Example
```shell
curl https://mcjars.app/api/v2/stats/version/1.17.1
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **stats** (object) - Statistical data for the specified version.
  - **buids** (integer) - The number of builds.
  - **size** (object) - Information about the size of the server files.
    - **total** (object) - Total size of server files.
      - **jar** (integer) - Total size in JAR format.
      - **zip** (integer) - Total size in ZIP format.
    - **average** (object) - Average size of server files.
      - **jar** (integer) - Average size in JAR format.
      - **zip** (integer) - Average size in ZIP format.

#### Response Example
```json
{
  "success": true,
  "stats": {
    "buids": 1,
    "size": {
      "total": {
        "jar": 1,
        "zip": 1
      },
      "average": {
        "jar": 1,
        "zip": 1
      }
    }
  }
}
```
```

--------------------------------

### Get Server Stats by Type and Version (Shell)

Source: https://mcjars.app/api/index

Retrieves statistics for a specific server type and version. Requires 'type' and 'version' as path parameters. Returns a JSON object with success status and build statistics.

```shell
curl https://mcjars.app/api/v2/stats/VANILLA/1.17.1
```

--------------------------------

### GET /api/v2/lookups/versions/{type}/history/{year}/{month}

Source: https://mcjars.app/api/index

Retrieves the version history for a specific server type, year, and month.

```APIDOC
## GET /api/v2/lookups/versions/{type}/history/{year}/{month}

### Description
Retrieves the version history for a specific server type, year, and month.

### Method
GET

### Endpoint
/api/v2/lookups/versions/{type}/history/{year}/{month}

### Parameters
#### Path Parameters
- **type** (string) - Required - The server type. Allowed values: VANILLA, PAPER, PUFFERFISH, SPIGOT, FOLIA.
- **year** (integer) - Required - The year to get the version history for. Minimum value: 2024.
- **month** (integer) - Required - The month to get the version history for. Minimum value: 1, Maximum value: 12.

### Request Example
```json
{
  "example": "curl https://mcjars.app/api/v2/lookups/versions/VANILLA/history/2024/1"
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **versions** (object) - Contains version history data.
  - **additionalProperty** (array) - An array of version history entries.
    - **day** (integer) - The day of the month.
    - **total** (integer) - Total number of versions for that day.
    - **uniqueIps** (integer) - Number of unique IPs for that day.

#### Response Example
```json
{
  "success": true,
  "versions": {
    "additionalProperty": [
      {
        "day": 1,
        "total": 1,
        "uniqueIps": 1
      }
    ]
  }
}
```
```

--------------------------------

### Get Version Lookups (Shell Curl)

Source: https://mcjars.app/api/index

Retrieves lookup data for server versions. This endpoint does not require any parameters and returns a JSON object detailing versions and their associated metrics.

```shell
curl https://mcjars.app/api/v2/lookups/versions
```
Tokens:
Raw