Quickstart

Get your API key and make your first request in three steps.

1

Create your account

Sign up on the Stackr dashboard to get your API key. No credit card required for the free tier.

Your API keys will look like this:

# Test key (testnet) — safe for development

sk_test_a1b2c3d4e5f6g7h8i9j0...

# Live key (mainnet) — use in production

sk_live_a1b2c3d4e5f6g7h8i9j0...

Keep your secret keys safe. Never expose them in client-side code, public repos, or browser requests. Always call the Stackr API from your backend.

2

Make your first API call

Check that your key works by hitting the health endpoint, then try checking a balance:

# Verify your connection

curl https://api.usestackr.xyz/health
# {"status":"healthy","database":true,"redis":true,"stellar":true}

# Check a wallet balance

curl https://api.usestackr.xyz/api/v1/accounts/+250781234567/balance \
  -H "Authorization: Bearer sk_test_your_key_here"

# Send USDC

curl -X POST https://api.usestackr.xyz/api/v1/transfers \
  -H "Authorization: Bearer sk_test_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "sender_phone": "+250781234567",
    "recipient_phone": "+250789876543",
    "amount": "10.00",
    "pin": "1234"
  }'
3

Integrate into your app

Call the Stackr API from your backend. Here are examples in common languages:

Node.js / JavaScript

const response = await fetch("https://api.usestackr.xyz/api/v1/transfers", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.STACKR_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    sender_phone: "+250781234567",
    recipient_phone: "+250789876543",
    amount: "10.00",
    pin: "1234",
  }),
});

const result = await response.json();
console.log(result.tx_hash); // "3d8f4a2b..."

Python

import requests
import os

response = requests.post(
    "https://api.usestackr.xyz/api/v1/transfers",
    headers={"Authorization": f"Bearer {os.environ['STACKR_API_KEY']}"},
    json={
        "sender_phone": "+250781234567",
        "recipient_phone": "+250789876543",
        "amount": "10.00",
        "pin": "1234",
    },
)

result = response.json()
print(result["tx_hash"])  # "3d8f4a2b..."

Next steps

  • •Browse the API Reference for all 17 endpoints with request/response examples
  • •Read the Developer Guide to understand the USSD protocol, wallet system, and Stellar integration
  • •Review Security best practices for handling API keys and user data
  • •Check out Pricing to see which plan fits your usage