Skip to content

Vilna API (1.0.0)

Welcome to the Vilna API Reference. This is the complete OpenAPI specification for all API endpoints.

Quick Links

API Endpoints

Asset Management

  • Assets - Discover and manage digital assets

Address Operations

Monitoring and Notifications

System

Need Help?

Visit our documentation portal for detailed guides and examples.

Download OpenAPI description
spec.json
spec.yaml
Overview
URL
https://vilna.io
Vilna API Team
[email protected]
License
Apache 2.0
Terms of Service
Languages
Servers
Mock server
https://docs.vilna.io/_mock/apis/spec/
Production environment
https://{namespace}.vilna.app/{version}/

system

System and service status operations

Operations

blockchain

Operations related to supported blockchains for monitoring and balance queries

Operations

block

Operations for retrieving and filtering blockchain blocks

Operations

token

Manage blockchain tokens such as native and ERC-20 assets

Operations

public_key

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

Operations

address

Address management operations for tracking blockchain addresses

Operations

notification_channel

Notification delivery channel management for alerts and event notifications

Operations

transaction

Blockchain transaction tracking and monitoring operations

Operations

simulate

Transaction simulation operations for various blockchain networks

asset

Asset management operations for blockchain assets

Operations

Get list of all assets

Request

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

Security
ApiKeyAuth
Query
limitinteger[ 1 .. 100 ]

Maximum number of items to return

Default 20
Example: limit=20
pageinteger>= 1

Page number for pagination

Default 1
Example: page=1
sort_bystring

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

Default "-created_at"
Enum"gid""-gid""namespace""-namespace""reference""-reference""status""-status""created_at""-created_at"
Example: sort_by=-created_at
chain_gidsArray of strings(ChainGID)

Filter assets by blockchain chain GIDs

Example: chain_gids=eip155:1&chain_gids=eip155:56&chain_gids=eip155:137
namespacesArray of strings(AssetNamespace)

Filter assets by asset namespaces

Items Enum"erc20""trc20""bep20""token""slip44"
Example: namespaces=erc20&namespaces=bep20
statusesArray of strings(AssetStatus)

Filter assets by status

Items Enum"active""unknown""invalid"
Example: statuses=active&statuses=unknown
curl -i -X GET \
  'https://docs.vilna.io/_mock/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'

Responses

List of assets with pagination metadata

Bodyapplication/json
itemsArray of objects(Asset)required

Array of asset objects

items[].​gidstring(AssetGID)^[-a-zA-Z0-9]{1,32}:[-a-zA-Z0-9]{1,64}/[-a-zA...required

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

Example: "eip155:1/erc20:0xdAC17F958D2ee523a2206206994597C13D831ec7"
items[].​statusstring(AssetStatus)required

Current status of the asset

Enum"active""unknown""invalid"
Example: "active"
items[].​created_atstring(date-time)(CreatedAt)required

Timestamp when the resource was created

Example: "2024-01-15T10:30:00Z"
items[].​updated_atstring(date-time)(UpdatedAt)required

Timestamp when the resource was last updated

Example: "2024-01-15T10:30:00Z"
metaobject(PaginationMeta)required
meta.​limitinteger(uint)>= 1required

Number of items per page

Example: 20
meta.​pageinteger(uint)>= 1required

Current page number

Example: 1
meta.​totalinteger(uint)>= 0required

Total number of items available

Example: 42
meta.​total_pagesinteger(uint)>= 0required

Total number of pages available

Example: 3
Response
application/json
{
  "items": [
    { … },
    { … }
  ],
  "meta": {
    "total": 150,
    "page": 1,
    "limit": 100,
    "total_pages": 2
  }
}

Archive an asset

Request

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

Security
ApiKeyAuth
Path
chain_gidstring(ChainGID)^[a-z0-9]{3,8}:[-_a-zA-Z0-9]{1,32}$required

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

Example: eip155:1
asset_pathstring(AssetPath)^[a-z0-9]{3,8}:[-.%a-zA-Z0-9]{1,128}$required

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

Example: erc20:0x6B175474E89094C44Da98b954EedeAC495271d0F
curl -i -X POST \
  https://docs.vilna.io/_mock/apis/spec/assets/eip155:1/erc20:0x6B175474E89094C44Da98b954EedeAC495271d0F/actions/archive \
  -H 'X-Api-Key: YOUR_API_KEY_HERE'

Responses

Asset activated successfully

Response
No content

Restore an archived asset

Request

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

Security
ApiKeyAuth
Path
chain_gidstring(ChainGID)^[a-z0-9]{3,8}:[-_a-zA-Z0-9]{1,32}$required

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

Example: eip155:1
asset_pathstring(AssetPath)^[a-z0-9]{3,8}:[-.%a-zA-Z0-9]{1,128}$required

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

Example: erc20:0x6B175474E89094C44Da98b954EedeAC495271d0F
curl -i -X POST \
  https://docs.vilna.io/_mock/apis/spec/assets/eip155:1/erc20:0x6B175474E89094C44Da98b954EedeAC495271d0F/actions/restore \
  -H 'X-Api-Key: YOUR_API_KEY_HERE'

Responses

Asset deactivated successfully

Response
No content