API documentation

Getting started

  • Where Can I find API integration examples using my account credentials?

    Once you are logged in to your Bright Data account, Go to API and examples  page.There you can find all the relevant API integrations methods, including ports, zones preferences or other common flags used by API The page contains d...

  • What is the API documentation and how should I use it?

    The API documentation describes how to use Bright Data's API commands and optional flags used for automating and controlling recurrent actions executed on the account's settings, a specific zone or product, or a specific proxy. API...

  • Terms

    ZONE — The zone name for which you want to get the info. view my Zones CUSTOMER — Your account id which you can get from your control panel PASSWORD — Your zone password. view my Zones COUNTRY — The country code you wish to filter...

Statistics

  • Get the bandwidth stats for a Zone

    API endpoint: GET /api/zone/bw Optional parameters: from=2018-07-01T00:00:00&to=2018-07-02T00:00:00   Example response:{"ID:":{"customer_id":"CUSTOMER_ID","from":"2022-10-01T00:00:00.000Z","to":"2022-11-23T00:00:00.000Z","data":{"s...

  • Get the bandwidth stats for all your Zones

    API endpoint: GET /api/customer/bw Optional parameters: from=2018-07-01T00:00:00&to=2018-07-02T00:00:00 Example response:{"ID":{"customer_id":"CUST_ID","from":"2022-10-01T00:00:00.000Z","to":"2022-11-24T00:00:00.000Z","data":{"data...

  • Get the total cost and bandwidth stats for a Zone

    API endpoint: GET /api/zone/cost Optional parameters: from=2018-07-01T00:00:00&to=2018-07-02T00:00:00 Response of Bandwidth zones:  Example response:{"ID":{"back_m2":{"bw":0,"cost":0},"back_m1":{"bw":36557298,"cost":0},"back_m0":{"...

Proxy IPs management

  • Get amount of available Datacenter and ISP IPs

    API endpoint: GET /api/zone/count_available_ips Parameters: zone=ZONE [string] - name of the Zone plan={...} [JSON object] - abstract plan parameters pool_ip_type=static_res [string] - use in case you want to get the amount of IS...

  • Get recent IPs attempting to use your Zone

    API endpoint: GET /api/zone/recent_ips Parameter: zones=ZONE - To get attempting IPs to any of your zone : zones=* Sample Response: {"ZONE":["255.0.0.127","10.0.0.1"]}   Shell curl "https://api.brightdata.com/zone/recent_ips?zones=...

  • Get the available Data center/ISP IPs per Zone

    API endpoint: GET /api/zone/route_ips Parameter: zone=ZONE[string] [required] country=COUNTRY_CODE[string] [optional] Sample Response: 10.0.0.0/24   Shell curl "https://api.brightdata.com/zone/route_ips?zone=ZONE&country=COUNTRY"...

  • Get all available dedicated residential IPs per Zone

    API endpoint: GET /api/zone/route_vips Sample Response: ["us_7922_fl_hollywood_0","ma_36903_01_tetouan_5","br_52894_mg_montesclaros_99"]   Shell curl "https://api.brightdata.com/zone/route_vips?zone=ZONE" -H "Authorization: Bearer ...

SERP-API

  • SERP API JSON Output

    Bright Data SERP API solution collects SERP structured JSON data with added calculated fields, like rank and global rank, to help you understand an element's position. In this article you will find the meaning of each JSON field an...

  • SERP API - Google Autocomplete Search Results

    In this article, we will show how to use SERP API to Extract Google suggestions for any keyword as a real user   Workflow Target Endpoint: https://www.google.com/complete/search?q=<Search_Query> Build a Customized Endpoint: On SERP...

  • What is Bright Data SERP API?

    Bright Data SERP API automatically extracts public data from search engines. Search engines are constantly changing their SERP structure and algorithms. Search Engine Results Pages (SERP or SERPs) are also dynamic, meaning the res...

  • Why should I use Bright Data's SERP API?

    Accuracy – Use real user devices with laser-focused geotargeting (including city-level) to collect accurate Search Engine Result Pages (SERPs) from major search engines as a real user. Built for volume – Bright Data can support yo...

  • How to run SERP API with Postman

    Postman is an API platform for building and using APIs. It is available as SaaS or as a desktop application. To configure SERP API with Postman, follow these steps: In the Bright Data control panel: Set your SERP API proxy to work...

  • What are the ranking fields in SERP API's response JSON?

    Search engine providers want to answer users’ queries as quickly as possible in the search results pages, which often forces users to click on multiple results and wait for the applicable website to load, or fine-tune their query. ...

See all 10 articles

Account management

  • Get total balance through API

    API endpoint: GET /api/customer/balance Sample Response: {"balance":456,"pending_costs":123} balance : the amount of money in your account pending_costs : the amount of money you will be billed for, as of this moment, in the next ...

  • Get Zone info

    API endpoint: GET /api/zone Sample Response: {"ips":"any","password":["PASSWORD"],"plans":[{"start":"2019-07-15T18:08:59.269Z","type":"static","ips_type":"shared","ip_alloc_preset":"shared_block","bandwidth":"payperusage"}]}   Shel...

  • Add a Zone

    API endpoint: POST /api/zone POST body : zone [JSON] [Required] name=NAME [string] - Zone name plan [JSON] [Required] type="static|resident|unblocker" [string] 'static' : Datacenter, ISP 'resident' : Residential, Mobile, SE...

  • Remove Zone

    API endpoint: DELETE /api/zone   Shell curl -X DELETE "https://api.brightdata.com/zone" -H "Content-Type: application/json" -H "Authorization: Bearer API_TOKEN" -d "{\"zone\":\"ZONE\"}" Node.js #!/usr/bin/env node require('request-...

  • Get Zone passwords

    API endpoint: GET /api/zone/passwords Sample Response: {"passwords":["psw1","psw2"]}   Shell curl "https://api.brightdata.com/zone/passwords?zone=ZONE" -H "Authorization: Bearer API_TOKEN" Node.js #!/usr/bin/env node require('reque...

  • Get Zone permissions

    API endpoint: GET /api/zone/permissions Sample Response: {"perms":["city","google"]}   Shell curl "https://api.brightdata.com/zone/permissions?zone=ZONE" -H "Authorization: Bearer API_TOKEN" Node.js #!/usr/bin/env node require('req...

See all 28 articles

Others

  • Get current service status

    API endpoint: GET /api/network_status/NETWORK_TYPENETWORK_TYPE - can be one of : all - All network type res - Residential dc - Datacenter mobile - Mobile   Sample Response: {"status":true}   Shell curl "https://api.brightdata.co...

  • Get country cities

    API endpoint: GET /api/cities Parameter: country="COUNTRY_CODE" Sample Response:[{"c_id":"US","region":"Texas","r_id":"TX","country":"United States","name":"Cherokee"}]   Shell curl "https://api.brightdata.com/cities?country=US" -H...

  • Get list of available cities of static network per country

    API endpoint: GET /api/zone/static/cities Parameters: country [string] (required) - Country pool_ip_type [string] - Network type, optional values : dc - Datacenter (default) static_res - ISP   Sample Response: ["us-chicago",...

Proxy Manager API

  • Refresh Cloud Proxy Manager port sessions

    API endpoint: GET /api/refresh_sessions/{PORT}*PORT : existing proxy port number   Shell curl -X POST "https://pmgr-customer-{CUSTOMER_ID}.brd.superproxy.io:22999/api/refresh_sessions/{PORT}" Node.js #!/usr/bin/env node require('r...

  • Apply specific configuration version of Cloud Proxy Manager

    This article explains on how to apply a specific configuration version of Cloud Proxy Manager with an API command. API endpoint: PUT /lpm/apply_conf/ Query parameters: lpm_token - {TOKEN|CUSTOMER_NAME}, required Body parameters: i...

  • Get Cloud Proxy Manager Configuration versions

    This article explains how to get Cloud Proxy Manager Configuration versions with an API command. API endpoint: GET /lpm/conf_states Query parameters: lpm_token - {TOKEN|CUSTOMER_NAME}, required limit - number of records, 0-100 Samp...

  • Get Proxy Manager version

    API endpoint: GET /api/version Sample Response: {"version":"1.280.385","argv":""}   Shell curl "http://127.0.0.1:22999/api/version" Node.js #!/usr/bin/env node require('request-promise')({ url: 'http://127.0.0.1:22999/api/version'...

  • Get latest Proxy Manager versions

    API endpoint: GET /api/last_version Sample Response: {"version": "1.280.385","newer": false,"versions": [{"ver": "1.280.385","type": "stable","changes": [{"type": "star","text": "Add render option for unblocker and serp zones"}]}]}...

  • Get currently running NodeJS version

    API endpoint: GET /api/node_version Sample Response: {"current":{"options":{"loose":false,"includePrerelease":false},"loose":false,"raw":"v12.16.1\n","major":12,"minor":16,"patch":1,"prerelease":[],"build":[],"version":"12.16.1"},"...

See all 38 articles

Data Collector API

  • IDE - API Documentation

    Available commands navigate Navigate the browser to a URL. A 404 status code will throw a dead_page error by default. Use opt.allow_status to override this. Examples navigate(<url>); navigate(input.url); navigate('https://example....

  • Getting started

    The Data Collector product offers a JSON API to control and inspect your data collectors programmatically. Getting started: Signup (or login) to our control panel Insert target URL (website to collect data from) or choose a ready-...

  • Trigger a collector for batch collection method

    API endpoint: POST /dca/trigger?collector={ID_COLLECTOR} Parameters : collector={ID_COLLECTOR} - A unique identification of collector version=dev - (Optional) Trigger the development version of the collector name={human_name} - (...

  • Receive batch data

    API endpoint: GET /dca/dataset?id={id_dataset} Parameters : id={id_dataset} – An unique identification of data set. Payload : Header: Authorization Bearer Key -H "Authorization: Bearer API_TOKEN" Sample Response : Waitin...

  • Trigger a collector for real-time collection

    API endpoint: POST /dca/trigger_immediate?collector={ID_COLLECTOR} Parameters : collector={ID_COLLECTOR} - A unique identification of collector version=dev - (Optional) Trigger the development version of the collector name={human...

  • Receive data from real-time work collector

    API endpoint: GET /dca/get_result?response_id={ID_RESPONSE} Parameters : response_id={ID_RESPONSE} – An unique identification of response Payload : Header: Authorization Bearer Key -H "Authorization: Bearer API_TOKEN" Sam...

See all 8 articles