Wallet

Get user wallets

AuthBearer (JWT)
GroupWallet
Rate limitSee Rate Limits
GET/api/wallet

SDK setup

Create a client and set credentials (JWT and/or API key) before calling the API. Match the authentication type shown above.

import { Configuration, WalletApi } from 'mudbase-sdk';

const configuration = new Configuration({
  basePath: 'https://cloud.mudbase.dev',
  accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig',
});

const wallet = new WalletApi(configuration);
import { Configuration, WalletApi } from 'mudbase-sdk';

const configuration = new Configuration({
  basePath: 'https://cloud.mudbase.dev',
  accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig',
});

const wallet = new WalletApi(configuration);

Example request

Call this endpoint using the client from SDK setup. Use View HTTP for a raw cURL example.

const { data: result } = await wallet.getUserWallets();
const { data: result } = await wallet.getUserWallets();

Playground

live

Test this endpoint with your own credentials. Your requests will be sent to the live API.

Use the auth endpoints to obtain a JWT.

No Request Yet

Send a request to see the full inspector

Authentication

Requires JWT
Note
Include your JWT in the Authorization: Bearer YOUR_TOKEN header (user-facing apps, RBAC). View authentication guide →

Query Parameters

NameTypeRequiredDescription
projectIdstringNo
currencystringNo

Responses

200User wallets list (custodial; for testing)
json
{
  "success": true,
  "data": [
    {
      "_id": "65a1b2c3d4e5f6789012345a",
      "currency": "BTC",
      "address": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",
      "balance": "0.001",
      "isCustomKey": false,
      "project": "65a1b2c3d4e5f6789012347",
      "createdAt": "2024-01-15T10:00:00.000Z"
    }
  ]
}
{
  "success": true,
  "data": [
    {
      "_id": "65a1b2c3d4e5f6789012345a",
      "currency": "BTC",
      "address": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",
      "balance": "0.001",
      "isCustomKey": false,
      "project": "65a1b2c3d4e5f6789012347",
      "createdAt": "2024-01-15T10:00:00.000Z"
    }
  ]
}
401

Errors

CodeMeaning
401
Edit this page on GitHub