Skip to main content

​
The response envelope

Every successful scraping response shares the same shape. Your result is always in data; the two metadata fields tell you what the call cost and how long it took.
​
object | array
The scraped result. Its shape depends on the endpoint — see the API Reference for each one. Some endpoints return a single object, others return an array.
​
number
Credits that this request consumed. See Credits for how the amount is worked out.
​
number
Wall-clock time the request took, in milliseconds.

​
Credits

Bridgly is pay-as-you-go. In general, one call costs one credit. Some endpoints cost more, depending on the data they return. Each endpoint’s page in the API Reference states its price, and creditsCost on every response reports the exact amount charged. Error responses are never charged, including not-found (404), validation and server errors. A request that succeeds with an empty result is charged as a normal call. Where an endpoint’s price depends on how much data comes back, your balance needs to cover the most the request could cost. You are only charged for what is actually returned. Credits never expire, and you can enable auto top-up from the Billing page to replenish your balance when it reaches your configured threshold.

​
Errors

When something goes wrong, the response uses a uniform error body instead of the envelope:
The HTTP status code tells you the category:
Always branch on the HTTP status code rather than parsing the message string — messages are meant for humans and may change.