header-generator

`header-generator`

header-generator is a part of the fingerprint-suite developed by Apify. Make sure to check out the main repository for all the anti-fingerprinting tools!

header-generator is a Node.js package for generating browser-like HTTP headers.

Installation
Usage
Presets
Result example
API Reference

Installation

Run the npm install header-generator command. No further setup is needed afterwards.

Usage

To use the generator, you need to create an instance of the HeaderGenerator class which is exported from this package. Constructor of this class accepts a HeaderGeneratorOptions object, which can be used to globally specify what kind of headers you are looking for:

import { HeaderGenerator } from 'header-generator';
let headerGenerator = new HeaderGenerator({
    browsers: [
        { name: 'firefox', minVersion: 90 },
        { name: 'chrome', minVersion: 110 },
        'safari',
    ],
    devices: ['desktop'],
    operatingSystems: ['windows'],
});

You can then get the headers using the getHeaders method, either with no argument, or with another HeaderGeneratorOptions object, this time specifying the options only for this call (overwriting the global options when in conflict) and using the global options specified beforehands for the unspecified options:

let headers = headerGenerator.getHeaders({
    operatingSystems: ['linux'],
    locales: ['en-US', 'en'],
});

This method always generates a random realistic set of headers, excluding the request dependant headers (e.g. the Host header or HTTP2 pseudo-headers), which need to be filled in afterwards. Since the generation is randomized, multiple calls to this method with the same parameters can generate multiple different outputs.

Presets

Presets are setting templates for common use cases. It saves time writing the same configuration over and over.

import { HeaderGenerator, PRESETS } = from 'header-generator';
let headerGenerator = new HeaderGenerator(PRESETS.MODERN_WINDOWS_CHROME);

This preset will fill the configuration for the latest five versions of chrome for windows desktops. Checkout the available presets list here.

Result example

A result that can be generated for the usage example above:

{
    "sec-ch-ua-mobile": "?0",
    "sec-ch-ua-platform": "\"Windows\"",
    "user-agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36 Edg/119.0.0.0",
    "accept-encoding": "gzip, deflate, br",
    "accept": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.7",
    "sec-ch-ua": "\"Microsoft Edge\";v=\"119\", \"Chromium\";v=\"119\", \"Not?A_Brand\";v=\"24\"",
    "upgrade-insecure-requests": "1",
    "accept-language": "en-US",
    "sec-fetch-site": "same-site",
    "sec-fetch-mode": "navigate",
    "sec-fetch-user": "?1",
    "sec-fetch-dest": "document"
}

API Reference

All public classes, methods and their parameters can be inspected in this API reference.