Skip to main content
GET
/
api
/
users
/
{userId}
curl -X GET https://oro-tradebook-devnet.up.railway.app/api/users/user-pda-address \
  -H "x-api-key: your-api-key"
{
  "success": true,
  "data": {
    "userId": "user-pda-address",
    "userPda": "user-pda-address",
    "kycHash": "Base58EncodedKycHash",
    "userWalletAddress": "UserSolanaWalletAddress",
    "metadata": {
      "referenceId": "user-123",
      "tags": ["retail"]
    },
    "balancesManagedByProgram": {
      "gold": {
        "amount": 1.5,
        "valueUsd": 7500
      }
    },
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-15T10:30:00.000Z"
  }
}

Overview

Get detailed information about a specific user including their balances. Authorization Required: Any partner scope (PARTNER_EXECUTIVE_AUTHORITY, PARTNER_UPDATE_AUTHORITY, or PARTNER_WITHDRAWAL_AUTHORITY)

Headers

x-api-key
string
required
Your API key for authentication

Path Parameters

userId
string
required
The unique identifier of the user (user PDA address)

Response

success
boolean
Whether the request was successful
data
object
curl -X GET https://oro-tradebook-devnet.up.railway.app/api/users/user-pda-address \
  -H "x-api-key: your-api-key"
{
  "success": true,
  "data": {
    "userId": "user-pda-address",
    "userPda": "user-pda-address",
    "kycHash": "Base58EncodedKycHash",
    "userWalletAddress": "UserSolanaWalletAddress",
    "metadata": {
      "referenceId": "user-123",
      "tags": ["retail"]
    },
    "balancesManagedByProgram": {
      "gold": {
        "amount": 1.5,
        "valueUsd": 7500
      }
    },
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-15T10:30:00.000Z"
  }
}