Skip to main content

​
Welcome to the Oumla API

The Oumla API is a comprehensive Cloud platform providing wallet management, tokenization, contract interactions, and blockchain services. This API reference is automatically generated from our OpenAPI specification.

API Base URL

Production endpoint: https://sandbox.oumla.com

​
Authentication

Oumla API uses API Key authentication:
  • API Key: Include in the x-api-key header
All API requests require authentication using your API key.

​
Key Features

​
Profile Management

Create and manage user profiles for different types: Users, Departments, and Merchants.

​
Wallet Operations

  • Generate and manage wallets for profiles and organizations
  • Support for multiple blockchain networks (BTC, tBTC, ETH, tETH)
  • Address generation and management

​
Transaction Tracking

  • Track transactions by address, wallet, profile, or organization
  • Comprehensive transaction history and monitoring

​
Asset Management

  • View and track assets across wallets and addresses
  • Real-time asset balances and holdings

​
Withdrawals

Create and execute withdrawal requests with multi-signature support.

​
Smart Contract Templates

  • Create and manage reusable smart contract templates
  • Deploy contracts from templates
  • Retrieve contract constructor and function information

​
Contract Interactions

  • Call read and write functions on deployed contracts
  • Fetch and manage contract ABIs
  • Transaction receipt tracking

​
Tokenization

  • Issue new tokens (ERC-20, ERC-721, ERC-1155)
  • Create and manage NFT collections
  • Mint and burn tokens
  • Link existing contracts to the platform

​
Supported Networks

  • Bitcoin: BTC (mainnet), tBTC (testnet)
  • Ethereum: ETH (mainnet), tETH (testnet)

​
Response Format

All successful API responses follow this format: 
{
  "message": "Operation successful",
  "data": {
    /* response data */
  },
  "success": true,
  "status": 200
}
Error responses include detailed field-level validation errors when applicable.

​
Pagination

List endpoints support pagination with the following query parameters:
  • skip: Number of records to skip (default: 0)
  • take: Number of records to retrieve (default: 10, max: 100)

​
Getting Started

Explore the endpoints in the sidebar to learn how to integrate with the Oumla API. Each endpoint includes detailed request/response schemas and an interactive playground for testing.
⌘I