Перейти к содержимому

Vilna API (1.0.0)

Добро пожаловать в справочник Vilna API. Это полная спецификация OpenAPI для всех endpoints API.

Быстрые ссылки

API Endpoints

Управление активами

  • Активы - Обнаружение и управление цифровыми активами

Операции с адресами

Мониторинг и уведомления

Система

Нужна помощь?

Посетите наш портал документации для подробных руководств и примеров.

Скачать описание OpenAPI
Языки
Серверы
Mock server
https://docs.vilna.io/_mock/ru/apis/spec/
Production environment
https://{namespace}.vilna.app/{version}/

system

System and service status operations

Операции

blockchain

Operations related to supported blockchains for monitoring and balance queries

Операции

block

Operations for retrieving and filtering blockchain blocks

Операции

token

Manage blockchain tokens such as native and ERC-20 assets

Операции

Запрос

Returns a list of all token assets. Includes native tokens and ERC-20 tokens.

Безопасность
ApiKeyAuth
Запрос
limitinteger[ 1 .. 100 ]

Maximum number of items to return

По умолчанию 20
Пример: limit=20
pageinteger>= 1

Page number for pagination

По умолчанию 1
Пример: page=1
sort_bystring

Field to sort results by. Use "-" prefix for descending order

По умолчанию "created_at"
Перечисление"gid""-gid""address""-address""decimals""-decimals""name""-name""symbol""-symbol"
Пример: sort_by=created_at
searchstring<= 32 characters

Search filter for token address, symbols, or names (partial match, case-insensitive)

Пример: search=USDT
chain_gidsArray of strings(ChainGID)

Filter tokens by blockchain chain GIDs

Пример: chain_gids=eip155:1&chain_gids=eip155:56&chain_gids=eip155:137
curl -i -X GET \
  'https://docs.vilna.io/_mock/ru/apis/spec/tokens?limit=20&page=1&sort_by=created_at&search=USDT&chain_gids=eip155%3A1%2Ceip155%3A56%2Ceip155%3A137' \
  -H 'X-Api-Key: YOUR_API_KEY_HERE'

Ответы

Successful response returning a list of token entities

Телоapplication/json
itemsArray of objects(Token)обязательный

List of tokens managed in the system, including native coins and token contracts (e.g., ERC-20, BEP-20)

items[].​gidstring(AssetGID)^[-a-zA-Z0-9]{1,32}:[-a-zA-Z0-9]{1,64}/[-a-zA...обязательный

Asset identifier in CAIP-19 format. Identifies a asset across blockchains. Format: <chain_gid>/<asset_namespace>:<asset_reference> Examples: - Ethereum ETH: eip155:1/slip44:60 - Ethereum USDT ERC-20: eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7

Пример: "eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7"
items[].​decimalsinteger(TokenDecimals)[ 0 .. 18 ]обязательный

Number of decimal places for the token (e.g., 6 for USDT, 18 for ETH)

Пример: 6
items[].​namestring(TokenName)обязательный

Full token name (e.g., "Tether USD", "Ethereum", "Binance Coin")

Пример: "Tether USD"
items[].​symbolstring(TokenSymbol)обязательный

Token symbol (e.g., "USDT", "ETH", "BNB")

Пример: "USDT"
items[].​created_atstring(date-time)(CreatedAt)обязательный

Timestamp when the resource was created

Пример: "2024-01-15T10:30:00Z"
metaobject(PaginationMeta)обязательный
meta.​limitinteger(uint)>= 1обязательный

Number of items per page

Пример: 20
meta.​pageinteger(uint)>= 1обязательный

Current page number

Пример: 1
meta.​totalinteger(uint)>= 0обязательный

Total number of items available

Пример: 42
meta.​total_pagesinteger(uint)>= 0обязательный

Total number of pages available

Пример: 3
Ответ
application/json
{ "items": [ {}, {} ], "meta": { "page": 1, "limit": 20, "total": 2, "total_pages": 1 } }

Запрос

Creates a new token using its CAIP-19 identifier and automatically retrieves its metadata (name, symbol, decimals, type) from the blockchain.

Безопасность
ApiKeyAuth
Путь
chain_gidstring(ChainGID)^[a-z0-9]{3,8}:[-_a-zA-Z0-9]{1,32}$обязательный

Blockchain identifier in CAIP-2 format (namespace:reference)

Пример: eip155:1
asset_pathstring(AssetPath)^[a-z0-9]{3,8}:[-.%a-zA-Z0-9]{1,128}$обязательный

Asset type identifier in CAIP-19 format (asset_namespace:asset_reference)

Пример: erc20:0x6B175474E89094C44Da98b954EedeAC495271d0F
curl -i -X POST \
  https://docs.vilna.io/_mock/ru/apis/spec/tokens/eip155:1/erc20:0x6B175474E89094C44Da98b954EedeAC495271d0F \
  -H 'X-Api-Key: YOUR_API_KEY_HERE'

Ответы

Successful response returning a single token entity

Телоapplication/json
gidstring(AssetGID)^[-a-zA-Z0-9]{1,32}:[-a-zA-Z0-9]{1,64}/[-a-zA...обязательный

Asset identifier in CAIP-19 format. Identifies a asset across blockchains. Format: <chain_gid>/<asset_namespace>:<asset_reference> Examples: - Ethereum ETH: eip155:1/slip44:60 - Ethereum USDT ERC-20: eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7

Пример: "eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7"
decimalsinteger(TokenDecimals)[ 0 .. 18 ]обязательный

Number of decimal places for the token (e.g., 6 for USDT, 18 for ETH)

Пример: 6
namestring(TokenName)обязательный

Full token name (e.g., "Tether USD", "Ethereum", "Binance Coin")

Пример: "Tether USD"
symbolstring(TokenSymbol)обязательный

Token symbol (e.g., "USDT", "ETH", "BNB")

Пример: "USDT"
created_atstring(date-time)(CreatedAt)обязательный

Timestamp when the resource was created

Пример: "2024-01-15T10:30:00Z"
Ответ
application/json
{ "gid": "eip155:1/slip44:60", "symbol": "ETH", "name": "Ethereum", "decimals": 18, "created_at": "2024-01-01T00:00:00Z" }

Запрос

Returns detailed information about the specified token asset.

Безопасность
ApiKeyAuth
Путь
chain_gidstring(ChainGID)^[a-z0-9]{3,8}:[-_a-zA-Z0-9]{1,32}$обязательный

Blockchain identifier in CAIP-2 format (namespace:reference)

Пример: eip155:1
asset_pathstring(AssetPath)^[a-z0-9]{3,8}:[-.%a-zA-Z0-9]{1,128}$обязательный

Asset type identifier in CAIP-19 format (asset_namespace:asset_reference)

Пример: erc20:0x6B175474E89094C44Da98b954EedeAC495271d0F
curl -i -X GET \
  https://docs.vilna.io/_mock/ru/apis/spec/tokens/eip155:1/erc20:0x6B175474E89094C44Da98b954EedeAC495271d0F \
  -H 'X-Api-Key: YOUR_API_KEY_HERE'

Ответы

Successful response returning a single token entity

Телоapplication/json
gidstring(AssetGID)^[-a-zA-Z0-9]{1,32}:[-a-zA-Z0-9]{1,64}/[-a-zA...обязательный

Asset identifier in CAIP-19 format. Identifies a asset across blockchains. Format: <chain_gid>/<asset_namespace>:<asset_reference> Examples: - Ethereum ETH: eip155:1/slip44:60 - Ethereum USDT ERC-20: eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7

Пример: "eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7"
decimalsinteger(TokenDecimals)[ 0 .. 18 ]обязательный

Number of decimal places for the token (e.g., 6 for USDT, 18 for ETH)

Пример: 6
namestring(TokenName)обязательный

Full token name (e.g., "Tether USD", "Ethereum", "Binance Coin")

Пример: "Tether USD"
symbolstring(TokenSymbol)обязательный

Token symbol (e.g., "USDT", "ETH", "BNB")

Пример: "USDT"
created_atstring(date-time)(CreatedAt)обязательный

Timestamp when the resource was created

Пример: "2024-01-15T10:30:00Z"
Ответ
application/json
{ "gid": "eip155:1/slip44:60", "symbol": "ETH", "name": "Ethereum", "decimals": 18, "created_at": "2024-01-01T00:00:00Z" }

public_key

Public key (BIP44/49/84) management operations for HD wallets

Операции

address

Address management operations for tracking blockchain addresses

Операции

notification_channel

Notification delivery channel management for alerts and event notifications

Операции

transaction

Blockchain transaction tracking and monitoring operations

Операции

simulate

Transaction simulation operations for various blockchain networks

asset

Asset management operations for blockchain assets

Операции