Account API

Retrieve your account details, credit balance, per-minute limits, address quota, and usage history.

The Account API allows you to retrieve detailed information about your Easyparser account, including your current subscription plan, credit balance, per-minute limits, address quota, 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 gain better visibility and control over your API consumption and can track limits across Bulk and Real-Time operations.

API Authentication

To use Easyparser features, you need a private API key to authenticate your requests.

You can quickly find your key under the Account > Plan section in your Easyparser Dashboard. New accounts instantly receive 100 free credits upon signing up.

If you need a step-by-step visual guide on how to locate and copy your token, please follow our Getting Started Guide.

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

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	Total credits used in the current period.	9629
account_info.credits_remaining	Remaining credits available to the account.	990371
account_info.credits_reset_at	When the credits reset (ISO 8601 format).	2028-12-09T08:46:47.000Z
account_info.credits_limit	Maximum credits allowed per billing cycle.	1000000
account_info.minutely_real_time_credit_limit	Maximum Real-Time credits you can spend per minute.	500
account_info.minutely_bulk_credit_limit	Maximum Bulk credits you can spend per minute.	5000
account_info.addresses_used	Number of custom addresses currently in use.	2
account_info.addresses_limit	Maximum number of custom addresses your plan allows.	30
account_info.addresses_available	Number of address slots still available.	2
account_info.usage_history	Historical usage records, with monthly and daily breakdowns.	Array of objects

Usage History (Detailed Structure)

Each entry in usage_history represents one month, ordered newest first.

Field	Type	Parent	Description
month	string	usage_history[]	Name of the month (e.g. September).
year	number	usage_history[]	Year of the record.
date	string	usage_history[]	Reference date for the record.
month_number	number	usage_history[]	Zero-based month index (0 = January, so 8 = September).
is_current_month	boolean	usage_history[]	Whether this record is the current month.
account_package_id	number	usage_history[]	Identifier of the plan active during that month.
credits_total_per_day	object	usage_history[]	Per-day usage, keyed by day of month. See below.
month_summary	object	usage_history[]	Totals for the month, as { "success": N }.

Each day inside credits_total_per_day is keyed by the day number and contains:

Field	Type	Parent	Description
day_total	object	credits_total_per_day.*	Total successful credits for the day, as { "success": N }.
REALTIME	object	credits_total_per_day.*	Real-Time usage for the day: a total object plus an operations map keyed by operation name.
BULK	object	credits_total_per_day.*	Bulk usage for the day, in the same shape as REALTIME. Present only when bulk requests were made that day.

Within REALTIME and BULK, total holds the day's combined count as { "success": N }, and operations maps each operation name (e.g. DETAIL, SEARCH) to its own { "success": N } count.

Sample Output

{
  "request_info": {
    "success": true
  },
  "account_info": {
    "api_key": "YOUR_API_KEY",
    "name": "MEMBER_NAME",
    "email": "[e-mail]",
    "plan": "YOUR_PLAN",
    "credits_used": 9629,
    "credits_remaining": 990371,
    "credits_reset_at": "2028-12-09T08:46:47.000Z",
    "credits_limit": 1000000,
    "minutely_real_time_credit_limit": 500,
    "minutely_bulk_credit_limit": 5000,
    "addresses_used": 2,
    "addresses_limit": 30,
    "addresses_available": 2,
    "usage_history": [
      {
        "month": "September",
        "year": 2026,
        "date": "2026-09-03",
        "account_package_id": 2446,
        "month_number": 8,
        "is_current_month": true,
        "credits_total_per_day": {
          "1": {
            "day_total": { "success": 10 },
            "REALTIME": {
              "total": { "success": 10 },
              "operations": {
                "DETAIL": { "success": 5 },
                "SEARCH": { "success": 3 },
                "OFFER": { "success": 1 },
                "SELLER_PRODUCTS": { "success": 1 }
              }
            }
          },
          "3": {
            "day_total": { "success": 4 },
            "REALTIME": {
              "total": { "success": 3 },
              "operations": {
                "SEARCH": { "success": 1 },
                "DETAIL": { "success": 1 },
                "OFFER": { "success": 1 }
              }
            },
            "BULK": {
              "total": { "success": 1 },
              "operations": {
                "DETAIL": { "success": 1 }
              }
            }
          }
        },
        "month_summary": { "success": 21 }
      }
    ]
  }
}