Back to Home

API Documentation

Welcome to The Redstone Index API Documentation, providing specifications and examples for integrating the API with Minecraft servers or mods.

Schematics

List of Schematic Details (JSON)

Query String Parameters:

  • username (optional) - Filter schematics to matching username. Defaults to alphanumeric username order.
  • offset (optional) - Skip the first offset rows. Defaults to 0.
  • limit (optional) - Define the number of returned rows. Defaults to 20.

Example Request:

GET /api/schematics?username=SuperPlasma

Example Response:

[
    {
        "id": 1,
        "created_at": "2024-01-03T06:42:20.566248+00:00",
        "author": {
            "username": "SuperPlasma",
            "numeric_id": 1
        },
    },
    // ...other schematic details
]

Get Schematic Details (JSON)

Route Parameters:

  • Schematic ID (required) - ID for the schematic.

Example Request:

GET /api/schematics/1

Example Response:

[
    {
        "id": 1,
        "created_at": "2024-01-03T06:42:20.566248+00:00",
        "author": {
            "username": "SuperPlasma",
            "numeric_id": 1
        }
    }
]

Upload Schematic

Header Parameters:

  • x-api-token (required) - API token configured for your Redstone Index account.

Body Data:

  • Blob file data (required) - Schematic file data

Example Request:

curl -X POST \
  -H "x-api-token: 9417210271194205" \
  -H "Content-Type: application/octet-stream" \
  --data-binary "@./static/piston_trapdoor.nbt" \
  http://redstoneindex.org/api/schematics

Example Response:

{
    "success": true,
    "id": 320
}

Note: After upload, the schematic will appear in your account in your schematics list.

Download Schematic

Route Parameters:

  • Schematic ID (required) - ID for the schematic.

Example Request:

GET /api/schematics/304/download

Downloaded File: schematic_304.nbt