GET API

This page provides a list of all available APIs with details.

Special variables

modelID

The model ID that you can get on the model page:

Location of the ID number

---

Get information about the model

GET /api/?type=getModel&id={modelID}

This API allows you to get detailed information about a model by its ID. You can use this query to extract data, including the model name, author, category, image, and additional parameters.

Parameters

Name	Value
type	getModel
id	modelID Description

Content-Type: application/json

Response scheme

200

Name	Type	Description
name	string	Model name
author	string	Author's name
category	string	Category name
img_url	string	Address of the model image
model_count	number	Number of elements in the model
commands	object	An object whose keys represent the line number and whose values represent Minecraft commands without / at the beginning
Passengers	json	An array of all block_display from all commands at once. SNBT format converted to familiar JSON format. Examine the sample responses before use.

400

Name	Type	Description
error	string	Error text

Response samples

200

{
  "name": "Oak",
  "author": "illystray",
  "category": "BDEngine Template",
  "img_url": "https://block-display.com/wp-content/uploads/2024/05/img_663c8ed90db728.47945094.png",
  "model_count": 57,
  "commands": {
    "1": "summon block_display ~-0.5 ~-0.5 ~-0.5 {Passengers:[{},{},{}]}",
    "2": "summon block_display ~-0.5 ~-0.5 ~-0.5 {Passengers:[{},{},{}]}"
  },
  "Passengers": [ {},{},{},{},{},{} ]
}

400

{
  "error": "There is no such ID Block Display"
}