WebScrapingAPI Docs
HomeLoginRegister
  • Introduction
    • Registration
    • Pricing
    • Free APIs
    • API Errors
    • Custom Response Headers
  • Browser API
    • Getting Started
      • Access the API
      • Authentication
      • API Parameters
    • Basic API Requests
      • GET Request
      • POST, PUT & PATCH Requests
      • Proxy Mode
    • Advanced API Features
      • Awaiting
      • Geolocation
      • Sessions
      • Forcing Timeouts
      • Custom Headers
      • Custom Cookies
      • Device Type
      • Viewport Sizing
      • Screenshot
      • Screenshot Options
      • Extraction Rules
      • JavaScript Instructions
      • Full JSON Response
      • JSON DOM Response
      • Block Resources
      • Captcha Solving
  • WebScrapingAPI
    • Getting Started
      • Access the API
      • API Parameters
    • Basic API Requests
      • GET Request
      • POST, PUT & PATCH Requests
    • Advanced API Features
      • Geolocation
      • Extraction Rules
      • Full JSON Response
      • JSON DOM Response
      • Rendering JavaScript
  • WebStealthProxy
    • Getting Started
      • Access the Proxy
      • Usage and Statistics
    • Basic Proxy Requests
    • Advanced Proxy Requests
      • Sessions
      • Geolocation
      • Custom Headers
      • Custom Cookies
      • Screenshots
  • Google Search API
    • Getting Started
      • Access the API
      • API Parameters
    • Google Search Engines
      • Google Search API
      • Google Maps API
      • Google Maps Reviews API
      • Google Reverse Image API
      • Google Trends API
        • Geo Parameter Options List
        • Google Trends Categories List
  • WB CUSTOM SEARCH API
    • Getting Started
      • Access the API
      • API Parameters
    • WB Custom Search Engines
      • Wayfair Product API
      • Best Buy Product API
      • Nordstrom Product API
  • Amazon Search API
    • Getting Started
      • API Parameters
      • Access the API
      • Supported Domains
    • Amazon Search Types
      • Amazon Search
      • Amazon Seller
        • Amazon Seller Products
        • Amazon Seller Profile
        • Amazon Seller Feedback
      • Amazon Product
      • Amazon Category
      • Amazon Bestsellers
      • Amazon New Releases
      • Amazon Deals
  • Bing Search API
    • Getting Started
      • Access the API
      • API Parameters
    • Basic API Requests
Powered by GitBook
On this page
  • Custom Cookies Example
  • Integration Examples
  1. Browser API
  2. Advanced API Features

Custom Cookies

Add your own cookies to BrowserAPI and receive customised responses.

Custom cookies are an extremely powerful feature of BrowserAPI. For example, they can be successfully used to scrape personalized content on a e-commerce site.

BrowserAPI does not allow the use of custom cookies for authentication purposes.

Only the following cookies can be overwritten:

  • ADSHUFFLER

  • AWSALB

  • AWSALBCORS

  • AWSALBTG

  • AWSALBTGCORS

  • CF_CLEARANCE

  • CONSENT

  • CUSTOMER_CONTEXT

  • LANG

  • REF

  • REMOVAL

  • VISITS

  • VISIT_COUNT

Additional cookies may be added per domain by contacting our support.

Custom Cookies Example

When using JavaScript rendering, custom cookies should be passed in a list in the cookies parameter. Each cookie object will have 3 properties: name, value and domain. Here is an example:

[{"name":"CUSTOMER_CONTEXT", "value":"{\"customerId\":\"12345\"}", "domain":"httpbin.org"}]

And this is the URL encoded value from the example above:

%5B%7B%22name%22%3A%22CUSTOMER_CONTEXT%22%2C%20%22value%22%3A%22%7B%5C%22customerId%5C%22%3A%5C%2212345%5C%22%7D%22%2C%20%22domain%22%3A%22httpbin.org%22%7D%5D

Warning! Please make sure that you passed the correct domain value in the cookie objects. We used "domain":"httpbin.org" in the examples below because we want those cookies to be set on the httpbin.org domain.

Integration Examples

curl --request GET --url "https://api.webscrapingapi.com/v1?api_key=<YOUR_API_KEY>&url=http%3A%2F%2Fhttpbin.org%2Fcookies&cookies=%5B%7B%22name%22%3A%22CUSTOMER_CONTEXT%22%2C%20%22value%22%3A%22%7B%5C%22customerId%5C%22%3A%5C%2212345%5C%22%7D%22%2C%20%22domain%22%3A%22httpbin.org%22%7D%5D"
const http = require("https");

const options = {
  "method": "GET",
  "hostname": "api.webscrapingapi.com",
  "port": null,
  "path": "v1?api_key=<YOUR_API_KEY>&url=http%3A%2F%2Fhttpbin.org%2Fcookies&cookies=%5B%7B%22name%22%3A%22CUSTOMER_CONTEXT%22%2C%20%22value%22%3A%22%7B%5C%22customerId%5C%22%3A%5C%2212345%5C%22%7D%22%2C%20%22domain%22%3A%22httpbin.org%22%7D%5D"
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();
import requests

API_KEY = '<YOUR_API_KEY>'
SCRAPER_URL = 'https://api.webscrapingapi.com/v1'
COOKIES = '%5B%7B%22name%22%3A%22CUSTOMER_CONTEXT%22%2C%20%22value%22%3A%22%7B%5C%22customerId%5C%22%3A%5C%2212345%5C%22%7D%22%2C%20%22domain%22%3A%22httpbin.org%22%7D%5D'

TARGET_URL = 'https://httpbin.org/cookies'

PARAMS = {
    "api_key": API_KEY,
    "url": TARGET_URL,
    "render_js": 1,
    "cookies": COOKIES
}

response = requests.get(SCRAPER_URL, params=PARAMS, headers=HEADERS)

print(response.text)
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.webscrapingapi.com/v1?api_key=<YOUR_API_KEY>&url=http%3A%2F%2Fhttpbin.org%2Fcookies&cookies=%5B%7B%22name%22%3A%22CUSTOMER_CONTEXT%22%2C%20%22value%22%3A%22%7B%5C%22customerId%5C%22%3A%5C%2212345%5C%22%7D%22%2C%20%22domain%22%3A%22httpbin.org%22%7D%5D",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET"
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://api.webscrapingapi.com/v1?api_key=<YOUR_API_KEY>&url=http%3A%2F%2Fhttpbin.org%2Fcookies&cookies=%5B%7B%22name%22%3A%22CUSTOMER_CONTEXT%22%2C%20%22value%22%3A%22%7B%5C%22customerId%5C%22%3A%5C%2212345%5C%22%7D%22%2C%20%22domain%22%3A%22httpbin.org%22%7D%5D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.webscrapingapi.com/v1?api_key=<YOUR_API_KEY>&url=http%3A%2F%2Fhttpbin.org%2Fcookies&cookies=%5B%7B%22name%22%3A%22CUSTOMER_CONTEXT%22%2C%20%22value%22%3A%22%7B%5C%22customerId%5C%22%3A%5C%2212345%5C%22%7D%22%2C%20%22domain%22%3A%22httpbin.org%22%7D%5D")
  .asString();
var client = new RestClient("https://api.webscrapingapi.com/v1?api_key=<YOUR_API_KEY>&url=http%3A%2F%2Fhttpbin.org%2Fcookies&cookies=%5B%7B%22name%22%3A%22CUSTOMER_CONTEXT%22%2C%20%22value%22%3A%22%7B%5C%22customerId%5C%22%3A%5C%2212345%5C%22%7D%22%2C%20%22domain%22%3A%22httpbin.org%22%7D%5D");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.webscrapingapi.com/v1?api_key=<YOUR_API_KEY>&url=http%3A%2F%2Fhttpbin.org%2Fcookies&cookies=%5B%7B%22name%22%3A%22CUSTOMER_CONTEXT%22%2C%20%22value%22%3A%22%7B%5C%22customerId%5C%22%3A%5C%2212345%5C%22%7D%22%2C%20%22domain%22%3A%22httpbin.org%22%7D%5D")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
Response Example
<html><head><meta name="color-scheme" content="light dark"><meta charset="utf-8"></head><body><pre>{
  "cookies": {
    "CUSTOMER_CONTEXT": "{\"customerId\":\"12345\"}"
  }
}
</pre><div class="json-formatter-container"></div></body></html>

Important! The url parameter has to be encoded.

( i.e. &url=https%3A%2F%2Fwww.webscrapingapi.com%2F )

PreviousCustom HeadersNextDevice Type

Last updated 7 months ago