Developer docs

GET /v1/usage

Use this endpoint to read credit balance, rate class, scrape limits, plan data, and recent usage rows for the authenticated client.

Get API access OpenAPI reference

Usage response preview

{
  "clientCode": "demo-client",
  "rateClass": "standard",
  "creditsRemaining": 2480,
  "scrapeLimits": {
    "maxInFlightPerClient": 8,
    "maxInFlightPerToken": 4
  },
  "recent": []
}

API reference

Request shape and public routes.

Single requests send productUrl. Bulk requests send items[].productUrl. Bearer auth is required for product and usage routes.

Use case	Endpoint	Request body	Returns
Usage and credits	`GET /v1/usage`	`No request body`	Returns credit balance, rate class, limits, plan data, and recent usage rows for the authenticated token.

Example

Readable JSON before code snippets.

Use this page’s example to confirm the body shape, expected response fields, and endpoint mapping before copying language-specific code from the OpenAPI reference.

Request body

No request body

Response preview

{
  "clientCode": "demo-client",
  "rateClass": "standard",
  "creditsRemaining": 2480,
  "scrapeLimits": {
    "maxInFlightPerClient": 8,
    "maxInFlightPerToken": 4
  },
  "recent": []
}

Response fields

Fields this workflow usually reads.

Exact fields depend on endpoint, product page URL, and enabled coverage, but these are the fields this page is designed around.

clientCoderateClasscreditsRemainingscrapeLimitsrecent[]plan

Use cases

Where this page fits.

Each page targets a distinct workflow, field set, or buying question.

Credit monitoring

Display remaining credits and rate class in internal dashboards.

Operational guardrails

Check in-flight limits and recent usage before submitting larger batches.

Usage reconciliation

Review recent rows when finance or operations teams audit consumption.

Limitations

Coverage and operating boundaries.

Coverage is enabled by supported retailer, marketplace, and product page URL.

Polling cadence belongs to the client integration and is discussed during onboarding.

The API is not an official marketplace partner API and does not promise unlimited collection.

FAQ

Short answers for evaluation.

Visible answers are mirrored in structured data for eligible generated pages.

Do callers provide marketplace IDs or supplier IDs?

No. Callers send productUrl for single requests or items[].productUrl for bulk requests. Internal identifiers are derived by the API when the URL is supported.

Which endpoint should I use first?

Use product-stock for availability and offers, and product-information for catalog details.

Can I use bulk requests?

Yes. Dedicated stock and information bulk endpoints accept arrays of product page URLs and return per-item results.

How is coverage confirmed?

Share target retailers or marketplaces, expected volume, required fields, and sample product URLs during onboarding.