Generate a Vantafin API key in Settings and authenticate requests to the REST API, WebSocket, and MCP server. Includes examples.
Vantafin Team
An API key authenticates your requests to Vantafin's developer surfaces: the REST API, WebSocket streams, and the MCP server. Keys look like vf-live-... and are created in Settings. API access is available on the Pro and Ultimate plans. This guide shows how to generate a key and use it.
Example: setting the key as an environment variable
export VANTAFIN_API_KEY="vf-live-YOUR_KEY"
Then reference VANTAFIN_API_KEY from your code instead of hard-coding the key.
Rate limits and usage
Each plan has a per-minute request limit and requests are logged. You can monitor your usage and rate limits in Settings. Ultimate offers the highest limits. The exact numbers are on the pricing page.
Keep your key secure
Never commit keys to source control or ship them in frontend code.
Prefer environment variables or a secrets manager.