> ## Documentation Index
> Fetch the complete documentation index at: https://docs.oumla.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Oumla API Reference - Blockchain wallet management, tokenization, and smart contracts

export const apiKeysUrl = 'https://dashboard.oumla.com/dashboard/apikeys';

export const apiUrl = 'https://sandbox.oumla.com';

export const supportEmail = 'support@oumla.com';

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 <a href={apiKeysUrl} target="_blank" rel="noopener noreferrer">obtain an API key from the dashboard</a> 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.

<Info>
  **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](/sdk-reference/introduction)). Both methods provide the same functionality - choose the one that best fits your project.
</Info>

<Card title="API Base URL" icon="globe" href={apiUrl}>
  Production endpoint: {apiUrl}
</Card>

## Authentication

<Info>
  **API Key Required**: All API requests require authentication using your API key. Include it in the `x-api-key` header.
</Info>

## Key Features

<CardGroup cols={2}>
  <Card title="Profile Management" icon="user" href="/api-reference/profiles/create-profile">
    Create and manage user profiles for different types: Users, Departments, and Merchants.
  </Card>

  <Card title="Wallet Operations" icon="wallet" href="/api-reference/wallets/create-wallet">
    Generate and manage wallets for profiles and organizations with support for multiple blockchain networks.
  </Card>

  <Card title="Transaction Tracking" icon="clock-rotate-left" href="/api-reference/transactions/list-transactions-by-address">
    Track transactions by address, wallet, profile, or organization with comprehensive history and monitoring.
  </Card>

  <Card title="Asset Management" icon="coins" href="/api-reference/assets/retrieved-assets-for-address">
    View and track assets across wallets and addresses with real-time balances and holdings.
  </Card>

  <Card title="Withdrawals" icon="arrow-up-from-bracket" href="/api-reference/withdraw/withdraw">
    Create and execute withdrawal requests with multi-signature support.
  </Card>

  <Card title="Smart Contract Templates" icon="file-code" href="/api-reference/contract-templates/create-contract-template">
    Create and manage reusable smart contract templates. Deploy contracts from templates and retrieve constructor and function information.
  </Card>

  <Card title="Contract Interactions" icon="code" href="/api-reference/contract-interactions/call-read-function">
    Call read and write functions on deployed contracts. Fetch and manage contract ABIs with transaction receipt tracking.
  </Card>

  <Card title="Tokenization" icon="sparkles" href="/api-reference/tokenization/create-new-collection">
    Create and manage NFT collections (ERC-721, ERC-1155), mint and burn tokens, issue new tokens, or link existing contracts.
  </Card>
</CardGroup>

## Supported Networks

<CardGroup cols={2}>
  <Card title="Bitcoin" icon="bitcoin">
    **tBTC** (testnet) - Available now\
    **BTC** (mainnet) - Requires activation
  </Card>

  <Card title="Ethereum" icon="ethereum">
    **tETH** (testnet - Sepolia) - Available now
    **ETH** (mainnet) - Requires activation
  </Card>
</CardGroup>

<Warning>
  **Mainnet Activation Required**

  To 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.
</Warning>

<Card title="Request Mainnet Activation" href={`mailto:${supportEmail}?subject=Mainnet%20Activation%20Request&body=Hello%20Oumla%20Team,%0A%0AI%20would%20like%20to%20request%20mainnet%20activation%20for%20my%20account.%0A%0ACompany%20Details:%0A-%20Company%20Name:%20%0A-%20Website:%20%0A%0AMainnet%20Requirements:%0A-%20Networks%20Needed:%20(BTC%20/%20ETH%20/%20Both)%0A-%20Use%20Case:%20%0A-%20Expected%20Volume:%20%0A-%20Timeline:%20%0A%0APlease%20let%20me%20know%20what%20additional%20information%20you%20need.%0A%0AThank%20you!`}>
  Click to send a pre-filled email to our support team
</Card>

## Response Format

<Tip>
  All successful API responses follow a consistent format for easy integration.
</Tip>

```json theme={null}
{
  "message": "Operation successful",
  "data": {
    /* response data */
  },
  "success": true,
  "status": 200
}
```

<Note>
  Error responses include detailed field-level validation errors when applicable.
</Note>

## Pagination

<Info>
  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)
</Info>

## Getting Started

<Card title="Quick Start Guide" icon="rocket" href="/guides/quickstart">
  New to Oumla? Follow our Quick Start guide to make your first API call in 5 minutes.
</Card>

<Tip>
  Use the interactive playground on each endpoint page to test API calls with your API key before integrating into your application.
</Tip>