Parsing and response format configuration
You can control and override the default API response format setup defined during API creation in Bright Data control panel. We allow either override by URL parameterbrd_json or by relaying a header x-unblock-data-format
Get response as raw HTML
Add header paramater:x-unblock-data-format: html .
Example:
Get response as Full JSON
Add header paramater:x-unblock-data-format: jsonor add URL parameter: brd_json=1.
Examples:
Header parameter
URL Parameter
Get Full JSON with a structue holding the full HTML as string
Add URL parameter: brd_json=html or header parameter: x-unblock-data-format: html
Example:
JSON+HTML
Get light JSON
Add header parameter:x-unblock-data-format: parsed_light or URL parameter brd_json=parsed_light to get a faster response (works twice as fast than Full SERP) with less componenets.
Full schema documentation can be seen here: https://docs.brightdata.com/scraping-automation/serp-api/parsed-json-results/parsing-search-results#google-response-schema-light-json
Examples:
Header parameter
URL parameter
Get response as screenshot
Add header paramater:x-unblock-data-format: screenshot . Response will be a binary PNG image. In the example below add --output flag to curl to capture response to image file.
Example:
Get element rectangle information BETA
Add URL parameterbrd_rects=1 in order to get results rectangle area as displayed on search result screen. This allows you to know when, in relation to viewport (which signifies screen resolution used to render the page) how much space does the result take on the visible screen.viewport (screen size) can be found in general elememt.
Notes:
- Getting rectangle data will increase response time. Expect response time to range between 5 seconds to 60 seconds per request.
- In BETA version you must also relay
brd_json=1URL parameter in addition tobrd_rects=1.
organicvideosimagespeople_also_askai_overviewrelated_searchesperspectivesforumspaginationlatest_posts
How to configure routing
Pin requests to the same IP withx-brd-session. This feature will attempt to keep the same proxy IP address which was used previously.
Page Load configuration
Wait for a specific element withx-brd-expect (requires custom_expect permission).
Use this option in order to prevent premature response, and wait till specific element is rendered by google.
URL Control configuration
Append a URL fragment withx-brd-url-fragment:
Use this option if you need to maintain a base URL address, and append a suffix by your logic.
Get current rate limit
Get rate limit info withx-brd-get-rate-limit:
Get current target website rate limit, response is