Get user profile and optional portfolio
Retrieves user profile information. If authenticated with an API key and requesting
your own profile, portfolio information will also be included.
Include your API key in the Authorization
header as Bearer YOUR_API_KEY
.
curl --request GET \
--url https://hyperrich.fun/api/users/{userIdentifier}
{
"user": {
"id": "<string>",
"username": "<string>",
"image_url": "<string>",
"referralCode": "<string>"
},
"tokens": [
{
"id": "<string>",
"name": "<string>",
"symbol": "<string>",
"description": "<string>",
"short_description": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"price": 123,
"market_cap": 123,
"total_supply": 123,
"image_url": "<string>",
"website": "<string>",
"x_account": "<string>",
"wallet_address": "<string>",
"wallet_chain": "<string>",
"usdc_pool_balance": 123,
"developer_lock_end": "2023-11-07T05:31:56Z"
}
],
"portfolio": {
"positions": [
{
"token_id": "<string>",
"token_amount": 123,
"usdc_spent": 123,
"usdc_received": 123,
"wallet_address": "<string>",
"token": {
"name": "<string>",
"symbol": "<string>",
"price": 123
}
}
]
}
}
Path Parameters
User ID or username
Response
List of tokens launched by the user
The unique identifier of the token
Name of the token
Symbol of the token
Description of the token
Short description of the token
Timestamp when the token was created
Timestamp when the token was last updated
Current price of the token
Market capitalization of the token
Total supply of the token
URL of the token's image
Token's website URL
Token's X (Twitter) account
Token's wallet address
Blockchain network of the token
Balance of USDC in the pool (total value locked)
End time of developer lock period
Portfolio information (only included for self-requests with API key)
Token ID
Amount of token held
Total USDC spent on this token
Total USDC received from selling this token
Wallet address holding the tokens
curl --request GET \
--url https://hyperrich.fun/api/users/{userIdentifier}
{
"user": {
"id": "<string>",
"username": "<string>",
"image_url": "<string>",
"referralCode": "<string>"
},
"tokens": [
{
"id": "<string>",
"name": "<string>",
"symbol": "<string>",
"description": "<string>",
"short_description": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"price": 123,
"market_cap": 123,
"total_supply": 123,
"image_url": "<string>",
"website": "<string>",
"x_account": "<string>",
"wallet_address": "<string>",
"wallet_chain": "<string>",
"usdc_pool_balance": 123,
"developer_lock_end": "2023-11-07T05:31:56Z"
}
],
"portfolio": {
"positions": [
{
"token_id": "<string>",
"token_amount": 123,
"usdc_spent": 123,
"usdc_received": 123,
"wallet_address": "<string>",
"token": {
"name": "<string>",
"symbol": "<string>",
"price": 123
}
}
]
}
}