Oumla Docs
  • Quick start
  • Introduction
  • Security
  • Networks
  • Authentication
  • Use cases
  • SDK
    • Oumla client
    • Create a Profile
    • Getting Profiles
    • Generate a Wallet
    • Getting Wallets
    • Generate Addresses
    • Getting Addresses
    • Getting Transactions
    • Sending Transactions
    • SDK reference
  • API Reference
    • Organization routes
    • Profiles routes
    • Wallet routes
    • Addresses routes
    • Transactions routes
  • Types
  • FAQs
Powered by GitBook
On this page
  1. SDK

Oumla client

How to start with the Oumla client

Oumla client is an interface for our API that enables users to build applications with ease. This is a guide on how to quickly get started with the client.

Oumla client requires some properties to initiate the connection with the APIs:

property
description
required
type

apiKey

API key generated from the dashboard.

required

string

baseUrl

the base URL for the infrastructure. default value is https://sandbox.oumla.com

optional

string

env

the environment, this could be testnet or mainnet the default is testnet

optional

testnet | mainnet

You can obtain the API key from our dashboard and it should start with oumla

Code example

Remember to install our SDK first

// Import our SDK
import { Oumla } from "@oumla/sdk";

const client = new Oumla({
   apiKey: process.env.OUMLA_API_KEY,
   baseUrl: "https://sandbox.oumla.com" // by default it is https://sandbox.oumla.com
});
PreviousSDKNextCreate a Profile

Last updated 8 months ago