Choose How to Use vBase

Compare the Web App, Python clients, REST API, CLI, and Excel tools to pick the right vBase integration

vBase can stamp and verify predictive datasets, alternative data, portfolios, and other files. It works from the browser, Python, the command line, and Excel. Pick the path that fits your environment.

What you want to do	Recommended option
Stamp or verify in your browser	Web App
Automate from Python	vbase-api
Integrate from another language	REST API
Explore REST endpoints interactively	Swagger UI
Stamp from Excel	Excel and COM Tools
Run command-line workflows	CLI
Low-level or direct blockchain access	vbase

Web App

Use app.vbase.com to manage Collections and create or verify Stamps without installing software. Get started by making an account.

vbase-api: Python REST client

The recommended option for Python users. It handles REST authentication, file uploads, and response parsing. Its package name is vbase-api; its import name is vbase_api.

pip install vbase-api

• Package: vbase-api on PyPI

• Source: validityBase/vbase-api-py on GitHub

• Docs: Python client API reference

• Quickstart: Python REST Client Quickstart

• Private stamping: Private Stamping with Delayed Reveal

REST API

The REST API works with any language or tool that can make HTTP requests, including R, JavaScript, C#, and shell scripts. vbase-api wraps this interface; the lower-level vbase SDK does not.

• Base URL: https://app.vbase.com/api/v1/

• Swagger UI: app.vbase.com/swagger/

• Docs: REST API User Guide

Excel and COM tools

Stamp and verify from Excel or another COM-compatible application. See the COM Library Overview.

CLI

Stamp and verify from a terminal or shell script. See the Command Line Interface.

vbase: Core Python SDK

Use vbase for direct, low-level access to commitment services and blockchains. It supports Content ID (CID) computation, sets and objects, batch operations, point-in-time simulation, and typed objects. Most users should use vbase-api.

Appropriate use cases:

• Custom CID computation and typed data

• Batch commitments

• Point-in-time simulation

• Low-level integrations that do not use the REST API

pip install vbase

• Package: vbase on PyPI

• Source: validityBase/vbase-py on GitHub

• Docs: vbase API reference