Skip to content

Account API

The Account API returns details about your Easyparser account: the active plan, credit balance, per-minute credit limits for the Real-Time API and Bulk API, address quota, and usage history. Use it to monitor remaining credits, show account data in your own dashboards, build usage reports, or alert when your balance runs low.

Endpoint

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

Authenticate with your API key in the api_key query parameter. The Account API does not accept an Authorization: Bearer header. You find your key in the web app under Account > Plan at https://app.easyparser.com/account/plan. New accounts get 100 free credits per month, with no credit card required. See Getting Started for a step-by-step guide.

Parameters

ParameterTypeRequiredDescription
api_keystringYesYour Easyparser API key. Send it as a query parameter.

The endpoint takes no other parameters.

Example request

Terminal window
curl --get "https://account.easyparser.com/v1/account" \
--data-urlencode "api_key=YOUR_API_KEY"

Response fields

The response has two top-level objects: request_info and account_info.

request_info
success
account_info
api_key, name, email, plan
credits_used, credits_remaining, credits_limit, credits_reset_at
minutely_real_time_credit_limit, minutely_bulk_credit_limit
addresses_used, addresses_limit, addresses_available
usage_history[]
month, year, date, month_number, is_current_month, account_package_id
credits_total_per_day
<day>
day_total
REALTIME { total, operations }
BULK { total, operations }
month_summary

request_info

FieldTypeDescription
successbooleantrue when the request succeeded. Check it before reading account_info.

account_info

FieldTypeDescription
api_keystringThe API key the request was made with.
namestringAccount holder name.
emailstringEmail address linked to the account.
planstringName of the active subscription plan.
credits_usedintegerCredits used in the current billing cycle.
credits_remainingintegerCredits left in the current billing cycle.
credits_limitintegerTotal credits included in the billing cycle.
credits_reset_atstringWhen credits reset, as an ISO 8601 date-time.
minutely_real_time_credit_limitintegerMaximum Real-Time API credits you can spend per minute.
minutely_bulk_credit_limitintegerMaximum Bulk API credits you can spend per minute.
addresses_usedintegerNumber of saved addresses in use.
addresses_limitintegerMaximum number of saved addresses your plan allows.
addresses_availableintegerAddress slots still available.
usage_historyarrayMonthly usage records, newest first. See usage_history[].

Per-minute limits are measured in credits. A Real-Time API request above minutely_real_time_credit_limit returns HTTP 429 (Too Many Requests). Bulk API items above minutely_bulk_credit_limit are returned in rate_limit_exceeded (see Bulk Service Response). Creating an address beyond addresses_limit fails with "Maximum address count reached". See Address Management.

usage_history[]

Each entry covers one month.

FieldTypeDescription
monthstringMonth name, for example September.
yearintegerYear of the record.
datestringReference date for the record (YYYY-MM-DD).
month_numberintegerZero-based month index: 0 is January, 8 is September.
is_current_monthbooleantrue for the current month.
account_package_idintegerID of the plan that was active during the month.
credits_total_per_dayobjectDaily usage keyed by day of month ("1", "3"). See credits_total_per_day.<day>.
month_summaryobjectMonth total of successful credits, as { "success": N }.

credits_total_per_day.<day>

FieldTypeDescription
day_totalobjectSuccessful credits for the day across both services, as { "success": N }.
REALTIMEobjectReal-Time API usage for the day. See REALTIME and BULK.
BULKobjectBulk API usage for the day, in the same shape as REALTIME. Present only on days with bulk usage.

REALTIME and BULK

FieldTypeDescription
totalobjectSuccessful credits for the service that day, as { "success": N }.
operationsobjectUsage per operation code, for example DETAIL or SEARCH. Each value is { "success": N }.

Sample response

Sample response (Account API)
{
"request_info": {
"success": true
},
"account_info": {
"api_key": "YOUR_API_KEY",
"name": "MEMBER_NAME",
"email": "member_mail@mail.com",
"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": 28,
"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 }
}
]
}
}