> For the complete documentation index, see [llms.txt](https://docs.heyhal.xyz/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.heyhal.xyz/api-documentation/get-current-user.md).
# Get Current User
**Endpoint:** `GET /api/v1/me`
### Description
This endpoint returns information about the currently authenticated user. It uses the user information from the request object, which is populated by the authentication middleware.
### Authentication
Required: Yes
Type: Bearer Token (JWT)
### Request
#### Headers
#### Content-Type: application/json
#### Authorization: Bearer \
No query parameters or body required.
### Response
#### Success Response
Status Code: 200 OK
Content-Type: application/json
interface CurrentUserResponse {
user: {
id: string;
walletAddress: string;
username: string | null;
role: string;
lastLogin: string;
createdAt: string;
updatedAt: string;
}
}
Example Response:
{
"user": {
"id": "user123",
"walletAddress": "SolanaWalletAddress123...",
"username": "cryptoTrader",
"role": "user",
"lastLogin": "2024-02-20T12:00:00.000Z",
"createdAt": "2024-01-01T00:00:00.000Z",
"updatedAt": "2024-02-20T12:00:00.000Z"
}
}
### Example Usage
### // Basic implementation
### async function getCurrentUser() {
### try {
### const response = await fetch('', {
### headers: {
### 'Authorization': \`Bearer ${localStorage.getItem('auth\_token')}\`
### }
### });
### if (!response.ok) {
### throw new Error(\`HTTP error! status: ${response.status}\`);
### }
### const { user } = await response.json();
### return user;
### } catch (error) {
### console.error('Error fetching current user:', error);
### throw error;
### }
### }
### // React Hook example
### function useCurrentUser() {
### const \[user, setUser] = useState(null);
### const \[loading, setLoading] = useState(true);
### const \[error, setError] = useState(null);
### useEffect(() => {
### async function fetchUser() {
### try {
### const userData = await getCurrentUser();
### setUser(userData);
### } catch (err) {
### setError(err.message);
### } finally {
### setLoading(false);
### }
### }
### fetchUser();
### }, \[]);
### return { user, loading, error };
### }
### Implementation Notes
1\. Authentication Check
// Example middleware to verify authentication
function requireAuth(req: FastifyRequest, reply: FastifyReply) {
if (!req.user) {
reply.code(401).send({
error: 'Authentication required'
});
return;
}
}
User Session Management
class UserSessionManager {
private static instance: UserSessionManager;
private currentUser: any = null;
private lastFetch: number = 0;
private readonly CACHE\_DURATION = 300000; // 5 minutes
static getInstance() {
if (!UserSessionManager.instance) {
UserSessionManager.instance = new UserSessionManager();
}
return UserSessionManager.instance;
}
async getCurrentUser(forceRefresh = false) {
const now = Date.now();
if (
forceRefresh ||
!this.currentUser ||
now - this.lastFetch > this.CACHE\_DURATION
) {
const user = await getCurrentUser();
this.currentUser = user;
this.lastFetch = now;
}
return this.currentUser;
}
clearCache() {
this.currentUser = null;
this.lastFetch = 0;
}
}
Error Handling
class AuthenticationError extends Error {
constructor(message = 'Authentication required') {
super(message);
this.name = 'AuthenticationError';
}
}
async function getAuthenticatedUser() {
try {
const response = await fetch('', {
headers: {
'Authorization': \`Bearer ${localStorage.getItem('auth\_token')}\`
}
});
if (response.status === 401) {
throw new AuthenticationError();
}
if (!response.ok) {
throw new Error('Failed to fetch user data');
}
return response.json();
} catch (error) {
if (error instanceof AuthenticationError) {
// Handle authentication errors
window\.location.href = '/login';
}
throw error;
}
}
### Best Practices
1\. Token Management
class TokenManager {
private static readonly TOKEN\_KEY = 'auth\_token';
private static readonly TOKEN\_EXPIRY\_KEY = 'auth\_token\_expiry';
static getToken(): string | null {
const token = localStorage.getItem(this.TOKEN\_KEY);
const expiry = localStorage.getItem(this.TOKEN\_EXPIRY\_KEY);
if (!token || !expiry) {
return null;
}
if (Date.now() > Number(expiry)) {
this.clearToken();
return null;
}
return token;
}
static setToken(token: string, expiresIn: number) {
localStorage.setItem(this.TOKEN\_KEY, token);
localStorage.setItem(
this.TOKEN\_EXPIRY\_KEY,
String(Date.now() + expiresIn \* 1000)
);
}
static clearToken() {
localStorage.removeItem(this.TOKEN\_KEY);
localStorage.removeItem(this.TOKEN\_EXPIRY\_KEY);
}
}
User Data Validation
function validateUserData(user: any): boolean {
return !!(
user &&
typeof user.walletAddress === 'string' &&
typeof user.role === 'string' &&
typeof user.lastLogin === 'string'
);
}
function sanitizeUserData(user: any) {
return {
id: user.id,
walletAddress: user.walletAddress,
username: user.username || null,
role: user.role,
lastLogin: user.lastLogin,
createdAt: user.createdAt,
updatedAt: user.updatedAt
};
}
3\. Request Retry Logic
async function fetchWithRetry(
url: string,
options: RequestInit,
maxRetries = 3
) {
let attempts = 0;
while (attempts < maxRetries) {
try {
const response = await fetch(url, options);
if (response.ok) {
return response.json();
}
if (response.status === 401) {
throw new AuthenticationError();
}
} catch (error) {
attempts++;
if (attempts === maxRetries || error instanceof AuthenticationError) {
throw error;
}
await new Promise(resolve =>
setTimeout(resolve, 1000 \* attempts)
);
}
}
throw new Error('Max retry attempts reached');
}
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.heyhal.xyz/api-documentation/get-current-user.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.