Skip to main content
Get up and running with the Wealthyhood API in 5 steps:
1

Obtain your credentials

Contact the Wealthyhood team at [email protected] to receive your client_id and client_secret credentials.
Once approved, you’ll receive credentials for both sandbox and production environments.
2

Retrieve an access token

Use the OAuth 2.0 client credentials flow to obtain a bearer token:
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>"
  }'
Store the access_token from the response—you’ll need it for all subsequent API requests.
See the Authentication API for full details.
3

Create a test user

Create a user account in the platform:
curl -X POST "https://api.sandbox.wealthyhood.com/users" \
  -H "Authorization: Bearer <access_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "firstName": "Jane",
    "lastName": "Doe",
    "email": "[email protected]",
    "dateOfBirth": "1990-01-15",
    "phoneNumber": "+1234567890"
  }'
Save the user ID from the response—you’ll use it in the x-user-id header for user-specific requests.
Learn more in the Users API documentation.
4

Retrieve user's portfolio

Fetch the user’s portfolio holdings:
curl -X GET "https://api.sandbox.wealthyhood.com/portfolio/holdings" \
  -H "Authorization: Bearer <access_token>" \
  -H "x-user-id: <user-id>"
Successfully retrieving portfolio data confirms your integration is working correctly.
Explore the Portfolios API for more endpoints.
5

Submit an order

Create a test order to buy an asset:
curl -X POST "https://api.sandbox.wealthyhood.com/investments/orders" \
  -H "Authorization: Bearer <access_token>" \
  -H "x-user-id: <user-id>" \
  -H "Content-Type: application/json" \
  -d '{
    "isin": "US0378331005",
    "side": "buy",
    "amount": 1000,
    "currency": "USD"
  }'
Your order has been submitted! Check the Investment Orders API to learn how to track order status and manage orders.

​
Next steps

Now that you have your first integration working, explore more capabilities:

Authentication guide

Learn about OAuth 2.0 authentication and user identification headers.

Environments

Understand sandbox vs production environments.

API reference

Explore all available endpoints with interactive examples.

Order execution flow

Deep dive into the complete order execution workflow.