{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-apis/platform/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["cards","card"]},"type":"markdown"},"seo":{"title":"Platform API - Blockchain Monitoring","projectTitle":"Vilna Docs","description":"Complete REST API reference for Vilna. Endpoints for blockchain monitoring, wallet management, address tracking, and transaction querying.","siteUrl":"https://docs.vilna.io","keywords":["crypto asset management","blockchain monitoring","digital asset security","cryptocurrency API","wallet tracking","blockchain analytics","enterprise crypto","real-time blockchain","CAIP-19","BIP44"],"lang":"en-US","image":"https://cdn.vilna.io/docs/previews/platform-api.png","meta":[{"name":"og:type","content":"website"},{"name":"og:site_name","content":"Vilna Documentation"},{"name":"og:image:width","content":"1200"},{"name":"og:image:height","content":"630"},{"name":"twitter:card","content":"summary_large_image"}],"llmstxt":{"title":"Vilna API Documentation","description":"Vilna is a blockchain monitoring and wallet management platform. It provides a single unified REST API for tracking addresses, transactions, balances, and activity across top blockchains - Bitcoin, Ethereum, Solana, TRON, TON, Cosmos, and others. The API uses CAIP-2/CAIP-19 standards for cross-chain identification, HD wallet management (BIP-32/44) for address derivation, and RFC 7807 for error responses. Authentication is via API key in the X-Api-Key header.\n","excludeFiles":["legal/**/*.md","@l10n/**/*.md"],"sections":[{"title":"Overview","description":"What Vilna is, supported blockchains, and target audience","includeFiles":["overview.md"],"excludeFiles":[]},{"title":"Getting Started","description":"Quickstart guide and core API concepts","includeFiles":["guides/quickstart.md","guides/dashboard.md","guides/core-concepts.md","guides/authentication.md"],"excludeFiles":[]},{"title":"API Reference","description":"Platform API and Management API endpoint documentation","includeFiles":["apis/platform/index.md","apis/mgmt/index.md","apis/rpc/index.md","apis/platform/api.yaml","apis/mgmt/api.yaml"],"excludeFiles":[]},{"title":"Developer Guides","description":"Integration patterns, events, notifications, SDK, and error handling","includeFiles":["guides/events.md","guides/channels.md","guides/integration-patterns.md","guides/sdk.md","guides/mcp.md","guides/errors.md","guides/simulation.md","guides/invoices.md"],"excludeFiles":[]},{"title":"Business","description":"Value proposition, use cases, and onboarding","includeFiles":["business/index.md","business/use-cases.md"],"excludeFiles":[]},{"title":"Optional","description":"Additional reference material","includeFiles":["guides/blockchain-basics.md","guides/faq.md","apis/mgmt/guide.md","guides/widget.md","guides/storage-client.md","apis/platform/caip-standards.md","apis/mgmt/authorization.md"],"excludeFiles":[]}],"hide":false},"priority":0.9,"jsonLd":{"@context":"https://schema.org","@graph":[{"@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https://docs.vilna.io/"},{"@type":"ListItem","position":2,"name":"Platform API"}]},{"@type":"WebAPI","name":"Vilna Platform API","description":"RESTful API for blockchain monitoring, wallet management, address tracking, and transaction querying across major blockchains.","url":"https://docs.vilna.io/apis/platform/","documentation":"https://docs.vilna.io/apis/platform/","termsOfService":"https://docs.vilna.io/legal/terms","provider":{"@type":"Organization","name":"Vilna","url":"https://vilna.io"}}]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"platform-api","__idx":0},"children":["Platform API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Vilna Platform API is a RESTful service for blockchain monitoring, wallet management, and payment reconciliation. It provides a unified interface across multiple blockchain networks using ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/apis/platform/caip-standards"},"children":["CAIP standards"]}," for chain and asset identification."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Full endpoint documentation is available in the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/apis/platform/api"},"children":["Platform API reference"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"authentication","__idx":1},"children":["Authentication"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All requests require an API key passed in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X-Api-Key"]}," header. See the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/authentication"},"children":["authentication guide"]}," for setup instructions."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"base-url","__idx":2},"children":["Base URL"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"https://api.vilna.io/v1\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To get an API key, ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://app.vilna.io"},"children":["sign up at app.vilna.io"]}," and create a project."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"api-resources","__idx":3},"children":["API resources"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"blockchain-data-api","__idx":4},"children":["Blockchain data API"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Blockchains"]}," - query supported networks and chain metadata"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Tokens"]}," - look up asset metadata (name, symbol, decimals) by chain and contract address"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"address-management","__idx":5},"children":["Address management"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Addresses"]}," - track external addresses and HD-derived addresses across chains"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Public keys"]}," - register HD wallet extended public keys and derive new addresses"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"transaction-and-financial-data","__idx":6},"children":["Transaction and financial data"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Balances"]}," - query current token holdings across tracked addresses"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Transactions"]}," - look up transaction details and history with filtering and sorting"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Activity"]}," - stream of balance changes (transfers, approvals) across all tracked addresses"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"payments","__idx":7},"children":["Payments"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Invoices"]}," - create and manage crypto payment invoices with automatic payment detection"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"notifications","__idx":8},"children":["Notifications"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Notification channels"]}," - configure webhook and Telegram alert destinations, view delivery logs"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"tools","__idx":9},"children":["Tools"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Simulation"]}," - preview EVM transaction effects (balance changes, gas estimates) before broadcasting"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"security","__idx":10},"children":["Security"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Keep API keys server-side only - never expose them in frontend code or public repositories."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Store keys in environment variables or a secrets manager, not in source code."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Rotate keys periodically and revoke compromised keys immediately via the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/apis/mgmt/"},"children":["Management API"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Requests that exceed rate limits receive a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["429 Too Many Requests"]}," response."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To report a vulnerability, contact ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"mailto:security@vilna.io"},"children":["security@vilna.io"]},". For authentication details, see the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/authentication"},"children":["authentication guide"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"see-also","__idx":11},"children":["See also"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/core-concepts"},"children":["Core concepts"]}," - response format, pagination, amounts, and identification standards"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/errors"},"children":["Errors and troubleshooting"]}," - RFC 7807 problem details and common error codes"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"sdks-and-tools","__idx":12},"children":["SDKs and tools"]},{"$$mdtype":"Tag","name":"Cards","attributes":{"columns":2,"cardMinWidth":240},"children":[{"$$mdtype":"Tag","name":"Card","attributes":{"title":"TypeScript SDK","imagePosition":"start","iconPosition":"auto","layout":"vertical","align":"start","variant":"filled","to":"/guides/sdk"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Type-safe client with full OpenAPI types"]}]},{"$$mdtype":"Tag","name":"Card","attributes":{"title":"API Reference","imagePosition":"start","iconPosition":"auto","layout":"vertical","align":"start","variant":"filled","to":"/apis/platform/api"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Interactive endpoint documentation with try-it-out"]}]},{"$$mdtype":"Tag","name":"Card","attributes":{"title":"CAIP Standards","imagePosition":"start","iconPosition":"auto","layout":"vertical","align":"start","variant":"filled","to":"/apis/platform/caip-standards"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Chain and asset identification formats used across the API"]}]},{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Management API","imagePosition":"start","iconPosition":"auto","layout":"vertical","align":"start","variant":"filled","to":"/apis/mgmt/"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Workspace, project, and API key management"]}]}]}]},"headings":[{"value":"Platform API","id":"platform-api","depth":1},{"value":"Authentication","id":"authentication","depth":2},{"value":"Base URL","id":"base-url","depth":2},{"value":"API resources","id":"api-resources","depth":2},{"value":"Blockchain data API","id":"blockchain-data-api","depth":3},{"value":"Address management","id":"address-management","depth":3},{"value":"Transaction and financial data","id":"transaction-and-financial-data","depth":3},{"value":"Payments","id":"payments","depth":3},{"value":"Notifications","id":"notifications","depth":3},{"value":"Tools","id":"tools","depth":3},{"value":"Security","id":"security","depth":2},{"value":"See also","id":"see-also","depth":2},{"value":"SDKs and tools","id":"sdks-and-tools","depth":2}],"frontmatter":{"seo":{"title":"Platform API - Blockchain Monitoring","description":"Complete REST API reference for Vilna. Endpoints for blockchain monitoring, wallet management, address tracking, and transaction querying.","priority":0.9,"image":"https://cdn.vilna.io/docs/previews/platform-api.png","jsonLd":{"@context":"https://schema.org","@graph":[{"@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https://docs.vilna.io/"},{"@type":"ListItem","position":2,"name":"Platform API"}]},{"@type":"WebAPI","name":"Vilna Platform API","description":"RESTful API for blockchain monitoring, wallet management, address tracking, and transaction querying across major blockchains.","url":"https://docs.vilna.io/apis/platform/","documentation":"https://docs.vilna.io/apis/platform/","termsOfService":"https://docs.vilna.io/legal/terms","provider":{"@type":"Organization","name":"Vilna","url":"https://vilna.io"}}]}}},"lastModified":"2026-05-26T20:25:55.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/apis/platform","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}