Get Account Information

This endpoint allows you to retrieve information about your account, including your email, name, API usage statistics, and quota details.

Here’s a sample request to get your account information:

GETAPI key required

								https://api.nudescan.io/v1/account
							
								
fetch('https://api.nudescan.io/v1/account', {
    method: 'GET',
    headers: {
        Authorization: 'Bearer YOUR_API_KEY'
    }
})
                
							

Parameters

No parameters are required for this endpoint besides the Authorization header with your API key.

Response

The API returns a JSON object with your account details.

								
{
    "email": "user@example.com",
    "name": "John Doe",
    "apiUsage": 150,
    "apiQuota": 1000,
    "usagePercentage": 15
}
                
							

Response Fields

email (string)

The email address associated with your account.

name (string)

Your account name.

apiUsage (integer)

The current number of API credits you’ve used.

apiQuota (integer)

Your total API credits quota (monthly if you have a paid plan).

usagePercentage (integer)

The percentage of your API quota that has been used.

plan (string)

Your current plan.

Error Responses

Status Code Description
401 Not authorized - Invalid or missing API key
403 Forbidden - You don’t have permission
404 Not Found - Account or user not found
500 Internal Server Error - An unexpected error occurred