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

Vilna API (1.0.0)

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

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

API Endpoints

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

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

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

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

Система

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

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

Скачать описание OpenAPI
spec.json
spec.yaml
Обзор
URL
https://vilna.io
Vilna API Team
[email protected]
Лицензия
Apache 2.0
Условия предоставления услуг
Языки
Серверы
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

Операции

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

Операции

Get list of all assets

Запрос

Returns a paginated list of all blockchain assets with filtering options.

Безопасность
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""namespace""-namespace""reference""-reference""status""-status""created_at""-created_at"
Пример: sort_by=-created_at
chain_gidsArray of strings(ChainGID)

Filter assets by blockchain chain GIDs

Пример: chain_gids=eip155:1&chain_gids=eip155:56&chain_gids=eip155:137
namespacesArray of strings(AssetNamespace)

Filter assets by asset namespaces

Элементы Перечисление"erc20""trc20""bep20""token""slip44"
Пример: namespaces=erc20&namespaces=bep20
statusesArray of strings(AssetStatus)

Filter assets by status

Элементы Перечисление"active""unknown""invalid"
Пример: statuses=active&statuses=unknown
curl -i -X GET \
  'https://docs.vilna.io/_mock/ru/apis/spec/assets?limit=20&page=1&sort_by=-created_at&chain_gids=eip155%3A1%2Ceip155%3A56%2Ceip155%3A137&namespaces=erc20%2Cbep20&statuses=active%2Cunknown' \
  -H 'X-Api-Key: YOUR_API_KEY_HERE'

Ответы

List of assets with pagination metadata

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

Array of asset objects

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[].​statusstring(AssetStatus)обязательный

Current status of the asset

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

Timestamp when the resource was created

Пример: "2024-01-15T10:30:00Z"
items[].​updated_atstring(date-time)(UpdatedAt)обязательный

Timestamp when the resource was last updated

Пример: "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": {
    "total": 150,
    "page": 1,
    "limit": 100,
    "total_pages": 2
  }
}

Archive an asset

Запрос

Archives an asset by its Global Identifier (GID), removing it from active listings

Безопасность
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/assets/eip155:1/erc20:0x6B175474E89094C44Da98b954EedeAC495271d0F/actions/archive \
  -H 'X-Api-Key: YOUR_API_KEY_HERE'

Ответы

Asset activated successfully

Ответ
Нет содержимого

Restore an archived asset

Запрос

Restores a previously archived asset by its Global Identifier (GID), making it active again

Безопасность
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/assets/eip155:1/erc20:0x6B175474E89094C44Da98b954EedeAC495271d0F/actions/restore \
  -H 'X-Api-Key: YOUR_API_KEY_HERE'

Ответы

Asset deactivated successfully

Ответ
Нет содержимого