Account API

The Account API allows you to retrieve detailed information about your EasyParser account, including your current subscription plan, credit balance, and usage history.

This endpoint is especially useful for:

• Monitoring your remaining credits in real time.

• Displaying account details (plan, email, limits) inside dashboards or admin panels.

• Creating usage reports on a daily or monthly basis.

• Sending notifications when the credit balance is running low.

• Integrating billing or quota management workflows.

By using the Account API, you can ensure better visibility and control over your API consumption and keep track of limits across Bulk and Real-Time operations.

Endpoint

https://account.easyparser.com/v1/account

Required Parameter

Parameter	Type	Location	Description
api_key	String	Query Parameter	Your EasyParser API key used for authentication.

Full Example Request:

GET https://account.easyparser.com/v1/account?api_key=YOUR_API_KEY

Response Fields Table

Field	Description	Example
request_info.success	Indicates whether the API request was successful.	true
account_info.api_key	The API key associated with the account.	YOUR_API_KEY
account_info.name	The name of the account holder.	MEMBER_NAME
account_info.email	The email address linked to the account.	[e-mail]
account_info.plan	The active subscription plan.	YOUR_PLAN
account_info.credits_used	The total number of credits used in the current period.	3
account_info.credits_remaining	The remaining number of credits available.	14997
account_info.credits_reset_at	The date when the credits will reset (ISO 8601 format).	2025-09-15T13:53:27.000Z
account_info.credits_limit	The maximum number of credits allowed per billing cycle.	15000
account_info.usage_history	Historical usage records including monthly and daily breakdowns.	JSON object

Usage History (Detailed Structure)

Field	Description	Example
month	Name of the month.	September
year	Year of the usage record.	2025
is_current_month	Indicates whether the record belongs to the current month.	true
credits_total_for_month	Total credits consumed during that month.	1387
credits_total_per_day	Daily credit usage details (date-based breakdown).	{ "10": { "total": 1099, "BULK": { "DETAIL": 1097, "SEARCH": 2 } } }

Sample Output

{
  "request_info": {
    "success": true
  },
  "account_info": {
    "api_key": "YOUR_API_KEY",
    "name": "MEMBER.NAME",
    "email": "[e-mail] ",
    "plan": "YOUR_PLAN",
    "credits_used": 3,
    "credits_remaining": 14997,
    "credits_reset_at": "2025-09-15T13:53:27.000Z",
    "credits_limit": 15000,
    "usage_history": [
       {
        "month": "September",
        "year": 2025,
        "month_number": 8,
        "is_current_month": true,
        "credits_total_for_month": 3,
        "credits_total_per_day": {
          "14": {
            "total": 1,
            "REAL_TIME": {
              "SEARCH": 1
            }
          },
          "15": {
            "total": 2,
            "REAL_TIME": {
              "SEARCH": 2
            }
          }
        }
      },
      {
        "month": "September",
        "year": 2025,
        "month_number": 8,
        "is_current_month": true,
        "credits_total_for_month": 3,
        "credits_total_per_day": {
          "13": {
            "total": 3,
            "REAL_TIME": {
              "OFFER": 1,
              "DETAIL": 2
            }
          }
        }
      },
      {
        "month": "September",
        "year": 2025,
        "month_number": 8,
        "is_current_month": true,
        "credits_total_for_month": 3,
        "credits_total_per_day": {
          "11": {
            "total": 1,
            "REAL_TIME": {
              "DETAIL": 1
            }
          },
          "12": {
            "total": 2,
            "REAL_TIME": {
              "DETAIL": 2
            }
          }
        }
      }
        
    ]
  }
}