zaralX Assets

https://zaralx.gitbook.io/assets
Admin
zaralX Assets is an open-source API for developers that provides Minecraft assets including item...
Tokens:1,822
Snippets:12
Trust Score:10
Update:7 months ago
Show doc for...
Tokens:
Raw
### GET /

Source: https://zaralx.gitbook.io/assets/default

Retrieves the base API information and version details.

```APIDOC
## GET /

### Description
Get API information and version details.

### Method
GET

### Endpoint
/

### Response
#### Success Response (200)
- **message** (string) - Project information message
- **sources** (object) - Object containing versioning details

#### Response Example
{
  "message": "zaralX Assets API",
  "sources": {
    "vanilla": {
      "version": "1.20.1"
    }
  }
}
```

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

### GET /v1/minecraft/vanilla/item/{item}/icon

Source: https://zaralx.gitbook.io/assets/default

Retrieves the icon image for a specific Minecraft item.

```APIDOC
## GET /v1/minecraft/vanilla/item/{item}/icon

### Description
Get the icon for a specific item.

### Method
GET

### Endpoint
/v1/minecraft/vanilla/item/{item}/icon

### Parameters
#### Path Parameters
- **item** (string) - Required - The item identifier

### Response
#### Success Response (200)
- **image** (binary) - The icon image in WebP format.

#### Error Response (404)
- **message** (string) - Item not found
```

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

### GET /v1/minecraft/vanilla/player/skin/{identifier}

Source: https://zaralx.gitbook.io/assets/default

Retrieves the Minecraft player skin image as a PNG file based on the provided UUID or nickname.

```APIDOC
## GET /v1/minecraft/vanilla/player/skin/{identifier}

### Description
Retrieves the skin image for a specific Minecraft player using their UUID or nickname.

### Method
GET

### Endpoint
https://assets.zaralx.ru/api/v1/minecraft/vanilla/player/skin/{identifier}

### Parameters
#### Path Parameters
- **identifier** (string) - Required - Player UUID or Minecraft nickname

### Request Example
GET https://assets.zaralx.ru/api/v1/minecraft/vanilla/player/skin/notch

### Response
#### Success Response (200)
- **image/png** (binary) - The player skin image file.

#### Response Example
[Binary Image Data]
```

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

### GET /swagger

Source: https://zaralx.gitbook.io/assets/default

Retrieves the OpenAPI/Swagger specification document for the API.

```APIDOC
## GET /swagger

### Description
Get OpenAPI/Swagger specification for the API.

### Method
GET

### Endpoint
/swagger

### Response
#### Success Response (200)
- **specification** (object) - The full OpenAPI 3.0 specification document.
```

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

### GET /v1/minecraft/vanilla/lang/{id}

Source: https://zaralx.gitbook.io/assets/default

Fetches language data for a given language identifier. Returns an object containing all translations for that language.

```APIDOC
## GET /v1/minecraft/vanilla/lang/{id}

### Description
Get language data by language identifier.

### Method
GET

### Endpoint
/v1/minecraft/vanilla/lang/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The language identifier

### Response
#### Success Response (200)
- **object** (object) - Language data object containing all translations

#### Error Response (400)
- **message** (string) - Bad request - unknown language
- **lang_keys** (array[string]) - Available language keys
```

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

### GET /v1/minecraft/vanilla/item/categories

Source: https://zaralx.gitbook.io/assets/default

Retrieves a list of all Minecraft item categories and their associated items.

```APIDOC
## GET /v1/minecraft/vanilla/item/categories

### Description
Get all categories with items.

### Method
GET

### Endpoint
/v1/minecraft/vanilla/item/categories

### Response
#### Success Response (200)
- **tools_and_utilities** (array) - List of items in category
- **building_blocks** (array) - List of items in category
- **food_and_drinks** (array) - List of items in category

#### Response Example
{
  "tools_and_utilities": ["diamond_pickaxe", "iron_shovel"],
  "building_blocks": ["stone", "oak_planks"]
}
```

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

### GET /v1/minecraft/vanilla/player/face/{identifier}

Source: https://zaralx.gitbook.io/assets/default

Retrieves a player's face image using their UUID or Minecraft nickname. Returns a PNG image.

```APIDOC
## GET /v1/minecraft/vanilla/player/face/{identifier}

### Description
Get player face image by UUID or nickname.

### Method
GET

### Endpoint
/v1/minecraft/vanilla/player/face/{identifier}

### Parameters
#### Path Parameters
- **identifier** (string) - Required - Player UUID or Minecraft nickname

### Response
#### Success Response (200)
- **binary** (image/png) - Player face image

#### Error Response (400)
- **message** (string) - Bad request - invalid UUID or nickname

#### Error Response (500)
- **message** (string) - Internal server error
- **error** (string) - Error message
```

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

### GET /v1/minecraft/vanilla/player/face/{identifier}/full

Source: https://zaralx.gitbook.io/assets/default

Retrieves a player's full face image, including layers, using their UUID or Minecraft nickname. Returns a PNG image.

```APIDOC
## GET /v1/minecraft/vanilla/player/face/{identifier}/full

### Description
Get full player face image (with layers) by UUID or nickname.

### Method
GET

### Endpoint
/v1/minecraft/vanilla/player/face/{identifier}/full

### Parameters
#### Path Parameters
- **identifier** (string) - Required - Player UUID or Minecraft nickname

### Response
#### Success Response (200)
- **binary** (image/png) - Full player face image

#### Error Response (400)
- **message** (string) - Bad request - invalid UUID or nickname

#### Error Response (500)
- **message** (string) - Internal server error
- **error** (string) - Error message
```

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

### GET /v1/minecraft/vanilla/item/{item}/lang/{lang}/name

Source: https://zaralx.gitbook.io/assets/default

Retrieves the localized name of a Minecraft item in a specified language. Supports various language codes.

```APIDOC
## GET /v1/minecraft/vanilla/item/{item}/lang/{lang}/name

### Description
Get the localized name of an item in a specific language.

### Method
GET

### Endpoint
/v1/minecraft/vanilla/item/{item}/lang/{lang}/name

### Parameters
#### Path Parameters
- **item** (string) - Required - The item identifier
- **lang** (string) - Required - The language code

### Response
#### Success Response (200)
- **string** (string) - The localized item name

#### Error Response (400)
- **message** (string) - Bad request - unknown language or item not found
- **lang_keys** (array[string]) - Available language keys (only present when language is unknown)
```

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

### Retrieve Player Face Images via OpenAPI

Source: https://zaralx.gitbook.io/assets/default

Fetches a PNG image of a player's face using their UUID or nickname. Includes endpoints for standard faces and full faces including character layers.

```json
{"openapi":"3.0.3","paths":{"/v1/minecraft/vanilla/player/face/{identifier}":{"get":{"description":"Get player face image"}},"/v1/minecraft/vanilla/player/face/{identifier}/full":{"get":{"description":"Get full player face image with layers"}}}}
```

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

### Retrieve Language Data via OpenAPI

Source: https://zaralx.gitbook.io/assets/default

Retrieves the complete language data object for a specified language identifier. Useful for client-side localization lookups.

```json
{"openapi":"3.0.3","info":{"title":"zaralX Assets","version":"1.1.0"},"paths":{"/v1/minecraft/vanilla/lang/{id}":{"get":{"description":"Get language data by language identifier","parameters":[{"name":"id","in":"path","required":true}]}}}}
```

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

### Retrieve Localized Item Name via OpenAPI

Source: https://zaralx.gitbook.io/assets/default

Fetches the localized name of a specific Minecraft item based on the provided item identifier and language code. Returns a string response or a 400 error if the inputs are invalid.

```json
{"openapi":"3.0.3","info":{"title":"zaralX Assets","version":"1.1.0"},"paths":{"/v1/minecraft/vanilla/item/{item}/lang/{lang}/name":{"get":{"description":"Get the localized name of an item in a specific language","parameters":[{"name":"item","in":"path","required":true},{"name":"lang","in":"path","required":true}]}}}}
```
Tokens:
Raw