Skip to main content
Here, you will find all of the necessary documentation for our API, which will enable you to quickly get started. Before proceeding, it is important to note that you will need to obtain an API key from the dashboard as it is required for all routes.

​
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.
Two Ways to Use Oumla: You can interact with Oumla either through direct REST API calls (documented here) or through our TypeScript SDK (see SDK Reference). Both methods provide the same functionality - choose the one that best fits your project.

API Base URL

Production endpoint:

​
Authentication

API Key Required: All API requests require authentication using your API key. Include it in the x-api-key header.

​
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 with support for multiple blockchain networks.

Transaction Tracking

Track transactions by address, wallet, profile, or organization with comprehensive history and monitoring.

Asset Management

View and track assets across wallets and addresses with real-time 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 and retrieve constructor and function information.

Contract Interactions

Call read and write functions on deployed contracts. Fetch and manage contract ABIs with transaction receipt tracking.

Tokenization

Create and manage NFT collections (ERC-721, ERC-1155), mint and burn tokens, issue new tokens, or link existing contracts.

​
Supported Networks

Bitcoin

tBTC (testnet) - Available now
BTC (mainnet) - Requires activation

Ethereum

tETH (testnet - Sepolia) - Available now ETH (mainnet) - Requires activation
Mainnet Activation RequiredTo activate mainnet access for Bitcoin (BTC) and Ethereum (ETH), you need to contact our support team and await approval. We will whitelist your account and require more information about your business.

Request Mainnet Activation

Click to send a pre-filled email to our support team

​
Response Format

All successful API responses follow a consistent format for easy integration.
{
  "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

Quick Start Guide

New to Oumla? Follow our Quick Start guide to make your first API call in 5 minutes.
Use the interactive playground on each endpoint page to test API calls with your API key before integrating into your application.