Skip to main content

1. Get an API key

Sign in to your Bridgly dashboard, open the API Keys page, and click Create key. Copy the key that appears — it starts with bgly_ and is shown only once.
Store the key somewhere safe the moment you create it. For security we only keep a hashed version, so it can never be shown again. If you lose it, revoke it and create a new one.

2. Make your first call

Every scraping endpoint is a POST that takes a JSON body and returns JSON. Send your key in the Authorization header as a bearer token.

3. Read the response

Every successful scraping response wraps your result in the same envelope. The scraped data is always in data; timeMs and creditsCost tell you how long the call took and what it cost. This example uses illustrative values:

Try other platforms

Swap the URL and body for any endpoint. A few to get you started:

Next steps

Browse every endpoint

See each request schema and try calls live in the playground.

Understand responses

The envelope, credit costs, and how errors are reported.

Rate limits

Default limits and how to handle a 429 response.