Skip to main content
This API reference is powered by OpenAPI specs. Use the sections below to explore endpoints and interactive examples.

​
API Sections

Authentication API

Obtain OAuth 2.0 access tokens using client credentials flow.

Users API

Create and manage user accounts with personal information and tax details.

Cash API

Access user cash balances across multiple currencies.

Savings Vault API

Access user savings vault balances across all savings products.

Portfolios API

Portfolio holdings, prices, and returns by tenor.

Daily Summaries API

Historical daily portfolio snapshots with performance metrics and market insights.

Investment products API

Listed instruments, fundamentals, tickers, and asset-specific data.

Investment Orders API

Submit single-instrument trades and receive enriched transaction responses.

Savings Orders API

Create and manage top up and withdrawal orders for user savings plans.

Learn API

Editorial content, learning guides, news articles, and glossary endpoints.

Test API

Test endpoints for sandbox environments. Create test users, simulate deposits, and manage test data.

​
Authentication

All API endpoints require authentication using OAuth 2.0 bearer tokens. To make authenticated requests:

​
Step 1: Obtain an access token

Use the Authentication API to obtain a bearer token via the OAuth 2.0 client credentials flow: 
curl -X POST "<auth-endpoint-url>" \
  -H "Content-Type: application/json" \
  -d '{
    "grant_type": "client_credentials",
    "audience": "<audience>",
    "client_id": "<your-client-id>",
    "client_secret": "<your-client-secret>"
  }'
Contact [email protected] to receive your client_id and client_secret.

​
Step 2: Include the bearer token in requests

Add the access token to the Authorization header of all API requests: 
Authorization: Bearer <access_token>

​
Step 3: Include user identification header

Most endpoints require an additional header to identify the user whose data you’re accessing. The header name varies by API:
  • x-user-id
The following APIs use the x-user-id header:
  • Investment Orders API - Submit and manage investment orders
  • Portfolios API - Access portfolio holdings and returns
  • Cash API - Retrieve user cash balances
  • Investment Products API (some endpoints) - Asset-specific data with user context
x-user-id: <user-identifier>
The user identifier must match a valid user in the Wealthyhood platform. See the Users API for user creation. Always check the specific endpoint documentation for the exact header requirement.

​
Complete request example

curl -X GET "https://api.sandbox.wealthyhood.com/cash" \
  -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..." \
  -H "x-user-id: user-12345"