Skip to content
/
Overview
Last updated

Platform API

Use the Platform API to monitor your addresses and reconcile incoming payments through one interface. Shared resource formats and CAIP identifiers let you work with data from different chains consistently. Available balances, transactions and notifications depend on the network; check the network matrix.

api.vilna.io/v2 vilna_api_ · project REST · JSON CAIP ids

Resource limits

Get project limits returns current used counts and effective max values. A max of 0 prevents new creations; used can exceed a lowered maximum. These values are informational and do not reserve capacity.

Disabled subscriptions and channels still count, as do child public keys. Open invoice usage counts occupied payment windows; trusted asset usage counts project trust entries. Reading limits requires api:limits:read. Existing API keys do not receive this permission automatically; issue a replacement key if needed.

What you can do

Blockchain data

  • Blockchains - supported networks and chain metadata.
  • Tokens - the asset catalog with verification and trust marks; see the tokens guide.

Addresses & wallets

  • Addresses - track external and HD-derived addresses across chains.
  • Public keys - register HD wallet extended public keys and derive new addresses.

Money

  • Balances - current token holdings across your monitored addresses.
  • Transactions - lookups and history, with filtering and sorting.
  • Activity - a stream of balance changes across every monitored address.
  • Invoices - crypto payment requests with automatic payment detection.

Operations

  • Notification channels - webhook and Telegram destinations, with notification history.
  • Subscriptions - bind a channel to a transaction family and a trigger; see triggers.
  • Notification history - per-channel delivery attempts and status; see notification history.
  • Simulation - preview an EVM transaction's effects before it is broadcast.

Supported networks

The Platform API supports nine networks, with Solana limited to addresses and the token catalog. See Networks for capability limits and CAIP-2 IDs; GET /blockchains returns the live list.

A subscription’s trigger determines when it sends a notification.

Key facts

  • Base URL - https://api.vilna.io/v2
  • Authentication - a vilna_api_ key in the X-Api-Key header. See Authentication.
  • Conventions - JSON requests and responses, CAIP-2 / CAIP-19 ids, structured amounts and pagination. See Core concepts.
  • Errors - RFC 7807 problem+json.

Full endpoint reference: Platform API reference.

Errors

Webhooks