Builder Service Documentation

Welcome to the Ostium Builder Service documentation. This service validates trading inputs and produces on-chain transactions for the Ostium protocol.

What is the Builder Service?

The Builder Service is a critical component of the Ostium trading infrastructure that:

• Validates trading requests and ensures data integrity
• Builds properly formatted on-chain transactions
• Supports both self-custody and delegated (gasless) trading modes
• Provides both HTTP and WebSocket APIs for different use cases

Key Features

Flexible Authentication

• Default mode: Returns unsigned transactions for self-custody
• Delegated mode: Executes transactions on behalf of verified delegate wallets

Multiple Integration Options

• RESTful HTTP API for standard operations
• WebSocket API for real-time trading and streaming
• OpenAPI specification for automated tool generation

Comprehensive Trading Operations

• Open, modify, and close positions
• Manage collateral and margins
• Set and update stop-loss and take-profit orders
• Cancel pending orders

Built-in Safety Features

• Request validation and error handling
• Rate limiting for API protection
• Secure delegate wallet management
• Precise decimal handling for financial data

Documentation Structure

Quick Links

• Base URL: https://builder.ostiscan.xyz
• API Version: v1
• OpenAPI Spec: View