Skip to main content
Returns details about your authenticated account, including your username, email address, wallet balances, and account status. For ledger balances broken out by currency, use GET /me/balances/.

Endpoint

GET https://api.futuur.com/me/

Authentication

This endpoint requires HMAC-SHA512 authentication. Include the following headers with every request:
HeaderDescription
KeyYour public API key
TimestampCurrent Unix timestamp
HMACSHA-512 signature of the request

Parameters

This endpoint takes no parameters.

Response

Returns a UserPrivate object.
id
integer
required
Unique numeric identifier for your account.
username
string
Your account username.
email
string
required
The email address associated with your account.
wallet
object
required
Dictionary of balances keyed by currency code (for example, OOM, USDC, USDT, USD). Values are decimal strings.
email_confirmed
boolean
required
Whether you have confirmed your email address.
real_currency_enabled
boolean
required
Whether real money trading is enabled for your account.
kyc_status
string
required
Current KYC status. One of no_need, requested, initialized, refused, approved, or by_passed.
date_joined
string
ISO 8601 timestamp of when you joined Futuur.

Register a Safe address

If you use a Safe smart account, register it with Futuur by calling POST /me/safe/. The request body requires both a safe_address and a chain_id. On success, the response is the same UserPrivate object returned by GET /me/.

Example

curl --request GET \
  --url https://api.futuur.com/me/ \
  --header 'Key: YOUR_PUBLIC_KEY' \
  --header 'Timestamp: 1712345678' \
  --header 'HMAC: YOUR_HMAC_SIGNATURE'
{
  "id": 42,
  "username": "trader_jane",
  "email": "jane@example.com",
  "wallet": {
    "OOM": "5000.00",
    "USDC": "100.00",
    "USDT": "0.00",
    "USD": "0.00"
  },
  "email_confirmed": true,
  "real_currency_enabled": true,
  "kyc_status": "approved",
  "date_joined": "2024-03-15T10:00:00Z"
}