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.

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

Request shape and public routes.

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

Use caseEndpointRequest bodyReturns
Usage and creditsGET /v1/usageNo request bodyReturns credit balance, rate class, limits, plan data, and recent usage rows for the authenticated token.

Run it with curl, Node.js, or Python.

Put your API token in PIA_API_TOKEN, replace the example URL with a product page from a supported store, and run the snippet. API tokens are in your account console.

Errors return error.code, error.message, error.requestId, and error.retryable. When retryable is true, wait for the Retry-After seconds, then send the request again. Only successful requests use credits.

The OpenAPI reference lists every field and status code.

GET /v1/usage
Shell
curl -sS "https://api.productinformationapi.com/v1/usage?recent=3" \
  -H "Authorization: Bearer $PIA_API_TOKEN"

Fields this workflow usually reads.

Exact fields depend on the endpoint, the product page, and the store's coverage.

clientCoderateClasscreditsRemainingscrapeLimitsrecent[]plan

Where this page fits.

Typical jobs teams build on these endpoints.

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.

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.

Short answers for evaluation.

Answers to the questions teams ask before they integrate.

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.