API Overview

Programmatic access to the same trades, orders, listings, and tasks you work with on the Baalvion trade platform.

What the API Is For

The Baalvion API lets you integrate trade platform data and actions into your own systems: syncing orders into an ERP, automating listing updates, pulling reports for internal dashboards, or reacting to trade events in real time via webhooks. It mirrors the same permission boundaries as the web application — an API key tied to a buyer account can only do what that buyer could do in the dashboard.

Base URL

bash
https://api.baalvion.com/v1

Request & Response Format

All requests and responses use JSON. Every response follows the same envelope:

Response envelope
{
  "success": true,
  "data": { },
  "error": null,
  "meta": {
    "total": 1,
    "page": 1,
    "limit": 20
  }
}

meta is only present on paginated list endpoints. On errors, success is false and data is null — see Error Handling.

Versioned from day one
The current API version is v1, included in the base URL. Breaking changes will ship under a new version rather than modifying v1 in place.

How It’s Organized