Account Balance lets you check your ApyHub account subscription and credit balance with a simple authenticated request. Use it when you need to confirm account status before running jobs, throttling usage, or surfacing billing information in your own app.
Send your API key as apikey in the query string, and you can also pass output as a query parameter. The service exposes two read-only endpoints: one for subscription details at /v1/account/subscription, and one for credit balance at /v1/account/credit-balance.
The responses are defined by the API schema, so you can integrate them directly into account dashboards, usage guards, or internal admin tools. If your workflow depends on remaining credits or subscription state, Account Balance gives you the account lookup step without extra parsing or side effects.
Fetch the current subscription details by sending your API key and optional output format as query parameters.
curl -X GET "http://localhost:8080/pankajretestflows/account-system/v1/account/subscription?apikey=$APY_TOKEN&output=json"Returns a minimal acknowledgement; see the Docs tab for the full response shape.
Loading your default key…Retrieves the current account subscription information for the authenticated request. The output schema is not yet defined, so the exact response shape is not documented here.
| Attribute | Type | Mandatory | Description |
|---|---|---|---|
| apikey | String | No | API key used to authenticate the request. |
| output | String | No | Response format selector. |
The endpoint returns a minimal acknowledgement on success — the detailed shape is not yet captured in the schema.
Fetch the SERP classic locations for a query, with optional filters passed as query parameters.
curl -X GET "http://localhost:8080/pankajretestflows/account-system/v1/account/credit-balance?q=new%20york&include=all&country_code=us" \
-H "apy-token: $APY_TOKEN"Expected to return a list of matching locations — not yet confirmed from a sample response.
Loading your default key…Looks up SERP Classic-supported search locations, filterable by a free-text query, an include list, and/or a country code. Used to resolve valid location_id values before submitting a task (see Add Task endpoint), so you can target location-sensitive search queries correctly.
⚠️ No sample response was available for this endpoint yet. Everything under Response/Output Schema below is a reasonable assumption based on the endpoint's stated purpose (a location lookup) and its relationship to location_id used elsewhere in this API — it has not been confirmed from a real response. Treat it as a placeholder until a sample is captured. See "Notes / Discrepancies" below.
| Attribute | Type | Mandatory | Description |
|---|---|---|---|
| q | String | No | Search term used to look up locations. |
| include | String | No | Additional locations to include in the results. |
| country_code | String | No | Country code used to scope the location lookup. |
Expected to return a list of matching location objects (each likely including at minimum an id — matching the location_id field used in Add Task — plus a display name and possibly country/region info). Not confirmed from a sample response yet.
bad_requestRequired parameter missing or malformed body.
unauthorizedAPI key missing, revoked, or not authorized for this service.
rate_limitedYour plan's per-second rate exceeded. Retry with exponential backoff.
upstream_busyBackend temporarily unavailable. Try again in a few seconds.