Developer docs

GET /v1/usage

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

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

Which endpoint do I use?

Public callers send productUrl, or items[].productUrl for bulk requests. Source, supplier key, and method metadata are derived by the API.

Use case Endpoint Request body Returns
Usage GET /v1/usage No request body Returns credits remaining and recent API usage.

Do not send caller-provided source, externalId, or method values. Those fields may appear only as derived response metadata.

Fields this workflow usually reads.

The exact response depends on the endpoint, product URL, and source coverage, but these are the fields this page is designed around.

clientCoderateClasscreditsRemainingscrapeLimitsrecent[]deltareasonrequestId

Credit monitoring

Use the URL-first API contract to keep this workflow tied to product URLs instead of marketplace-specific request parameters.

Client dashboards

Use the URL-first API contract to keep this workflow tied to product URLs instead of marketplace-specific request parameters.

Operational guardrails

Use the URL-first API contract to keep this workflow tied to product URLs instead of marketplace-specific request parameters.

Usage reconciliation

Use the URL-first API contract to keep this workflow tied to product URLs instead of marketplace-specific request parameters.

Coverage is best effort by supported marketplace, retailer, and product URL.

Polling cadence is owned by the client integration.

The API does not claim official marketplace affiliation or unlimited scraping.

Is the API tied to one marketplace?

No. The public contract is URL-first and marketplace-neutral. Coverage is confirmed during onboarding.

Do callers provide source IDs or supplier IDs?

No. Callers send productUrl, or items[].productUrl for bulk requests. Source and supplier keys are derived internally.

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 URLs.