# Platform API

The Vilna Platform API is a RESTful service for blockchain monitoring, wallet management, and payment processing. It provides a unified interface across multiple blockchain networks using [CAIP standards](/apis/platform/caip-standards) for chain and asset identification.

Full endpoint documentation is available in the [Platform API reference](/apis/platform/api).

## Authentication

All requests require an API key passed in the `X-Api-Key` header. See the [authentication guide](/guides/authentication) for setup instructions.

## Base URL


```
https://api.vilna.io/v1
```

To get an API key, [sign up at app.vilna.io](https://app.vilna.io) and create a project.

## API resources

### Blockchain data API

- **Blockchains** - query supported networks and chain metadata
- **Tokens** - look up asset metadata (name, symbol, decimals) by chain and contract address


### Address management

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


### Transaction and financial data

- **Balances** - query current token holdings across tracked addresses
- **Transactions** - look up transaction details and history with filtering and sorting
- **Activity** - stream of balance changes (transfers, approvals) across all tracked addresses


### Payments

- **Invoices** - create and manage crypto payment invoices with automatic payment detection


### Notifications

- **Notification channels** - configure webhook and Telegram alert destinations, view delivery logs


### Tools

- **Simulation** - preview EVM transaction effects (balance changes, gas estimates) before broadcasting


## Security

- Keep API keys server-side only - never expose them in frontend code or public repositories.
- Store keys in environment variables or a secrets manager, not in source code.
- Rotate keys periodically and revoke compromised keys immediately via the [Management API](/apis/mgmt/).
- Requests that exceed rate limits receive a `429 Too Many Requests` response.


To report a vulnerability, contact [security@vilna.io](mailto:security@vilna.io). For authentication details, see the [authentication guide](/guides/authentication).

## See also

- [Core concepts](/guides/core-concepts) - response format, pagination, amounts, and identification standards
- [Errors and troubleshooting](/guides/errors) - RFC 7807 problem details and common error codes


## SDKs and tools

TypeScript SDK
Type-safe client with full OpenAPI types

API Reference
Interactive endpoint documentation with try-it-out

CAIP Standards
Chain and asset identification formats used across the API

Management API
Workspace, project, and API key management