Skip to content
/
Get list of all known tok...

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

Get list of all known tokens

Request

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

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""address""-address""decimals""-decimals""name""-name""symbol""-symbol"
Example: sort_by=created_at
searchstring<= 32 characters

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

Example: search=USDT
chain_gidsArray of strings(ChainGID)

Filter tokens by blockchain chain GIDs

Example: chain_gids=eip155:1&chain_gids=eip155:56&chain_gids=eip155:137
curl -i -X GET \
  'https://docs.vilna.io/_mock/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'

Responses

Successful response returning a list of token entities

Bodyapplication/json
itemsArray of objects(Token)required

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...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[].​decimalsinteger(TokenDecimals)[ 0 .. 18 ]required

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

Example: 6
items[].​namestring(TokenName)required

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

Example: "Tether USD"
items[].​symbolstring(TokenSymbol)required

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

Example: "USDT"
items[].​created_atstring(date-time)(CreatedAt)required

Timestamp when the resource was created

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": {
    "page": 1,
    "limit": 20,
    "total": 2,
    "total_pages": 1
  }
}

Create a new token

Request

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

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/tokens/eip155:1/erc20:0x6B175474E89094C44Da98b954EedeAC495271d0F \
  -H 'X-Api-Key: YOUR_API_KEY_HERE'

Responses

Successful response returning a single token entity

Bodyapplication/json
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"
decimalsinteger(TokenDecimals)[ 0 .. 18 ]required

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

Example: 6
namestring(TokenName)required

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

Example: "Tether USD"
symbolstring(TokenSymbol)required

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

Example: "USDT"
created_atstring(date-time)(CreatedAt)required

Timestamp when the resource was created

Example: "2024-01-15T10:30:00Z"
Response
application/json
{
  "gid": "eip155:1/slip44:60",
  "symbol": "ETH",
  "name": "Ethereum",
  "decimals": 18,
  "created_at": "2024-01-01T00:00:00Z"
}

Get details of a specific token

Request

Returns detailed information about the specified token asset.

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 GET \
  https://docs.vilna.io/_mock/apis/spec/tokens/eip155:1/erc20:0x6B175474E89094C44Da98b954EedeAC495271d0F \
  -H 'X-Api-Key: YOUR_API_KEY_HERE'

Responses

Successful response returning a single token entity

Bodyapplication/json
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"
decimalsinteger(TokenDecimals)[ 0 .. 18 ]required

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

Example: 6
namestring(TokenName)required

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

Example: "Tether USD"
symbolstring(TokenSymbol)required

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

Example: "USDT"
created_atstring(date-time)(CreatedAt)required

Timestamp when the resource was created

Example: "2024-01-15T10:30:00Z"
Response
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

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