Skip to main content
In this quickstart we run one company search with cURL, Python or Node.js and read the three parts of the response: req_id, meta and documents.

Prerequisites

  • A Bright Data account with Business Search access. Business Search is in early access; if you don’t have access, email sales@brightdata.com

Step 1: Get and set your API key

Go to the user settings page in your Bright Data account and create an API key, or use one you already have. Your API key is shown only once when created, so copy and store it securely. See Authentication. We store the key in an environment variable so it never appears in a command history or a committed file. The request in the next step reads it from there:
We use Instant mode to find US software companies with 50 to 500 employees. view: "summary" asks for a compact record instead of the default id_only:
The request returns HTTP 200 and a JSON body that starts with req_id. Every tab prints that body. If the body is {"error":"Invalid token"} with HTTP 401, the key is missing, invalid or expired. Check the value you exported in Step 1. HTTP 403 means the account behind the key is inactive or not on the Business Search allowlist yet. Email sales@brightdata.com to request access.

Step 3: Read the response

A successful response contains request metadata and a documents array. This is the first of the 10 records from a real run, with url and logo omitted:
Your req_id, matched count and records will differ from this sample. The index refreshes daily, so results move between runs. req_id identifies the request. Keep it for troubleshooting and include it in support tickets. How to read what came back:
  • An empty documents array means the search ran and matched nothing. It is not proof that no such company exists.
  • meta.matched is a lower bound on the matches the search reached, not a total, and it moves between runs.
  • meta.coverage_percent below 100 means part of the index did not answer in time, so the result set is partial.

What you built and where to go next

We sent a natural-language company search and read the records it returned. Next, decide whether you need a broad candidate set or a ranked shortlist in What is Business Search?. Then write your first structured query with Business Search query syntax.