> For the complete documentation index, see [llms.txt](https://zaralx.gitbook.io/assets/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://zaralx.gitbook.io/assets/zaralx-assets.md).

# zaralX Assets

Open source API for Minecraft assets: item icons rendered like in game, block textures, languages and player skins

Source code: <https://github.com/zaralX/zaralx-assets&#x20>;

Base URL: `https://assets.zaralx.ru/api`

### Quick start

* Item icon: `/v2/minecraft/latest/items/diamond_sword/icon?size=64`
* Item name in Russian: `/v2/minecraft/latest/items/diamond_sword?lang=ru_ru`
* Textures of each block side: `/v2/minecraft/latest/blocks/oak_log`
* Texture: `/v2/minecraft/latest/textures/block/stone.png?size=64`
* Player face: `/v2/minecraft/players/Notch/face?size=64`

### Versions

`{version}` in routes is a version id like `26.3` or `1.21.5`, `latest` for the newest release or `latest-snapshot`. Every release since 1.21.4 is supported, new releases are added automatically. The list is at `/v2/minecraft/versions`.

Icons are rendered at 16, 32, 64, 128 and 256 px like at every GUI scale, other sizes are scaled from the next larger one. `format` is `webp` (default) or `png`.

### Caching

Responses for a version id are cached for a day, for `latest` for an hour. The `iconBlobs` and `blob` fields link to `/v2/blobs/{sha1}` files that never change and are shared by all versions.

### v1

The v1 routes still work with the same responses and serve 1.21.5. They are marked deprecated in the reference.
