Needful Program Management


    2.0.0 • Public • Published

    Build Status npm version

    VAST Client JS

    Vast Client JS is a JavaScript library to fetch and parse Digital Video Ad Serving Template (VAST) documents.

    This library provides three components:

    • A VAST Client to fetch and parse VAST XML resources into JavaScript Objects.
    • A VAST Parser to directly parse a VAST XML.
    • A VAST Tracker to batch and call tracking URLs.

    For the full API documentation go here.

    Complies with the VAST 3.0 specification provided by the Interactive Advertising Bureau (IAB).

    Get Started

    VAST Client JS is available as an NPM package and can be easily installed with:

    npm i vast-client

    Then import the components you need.


    If you need to fetch and parse VAST documents, you can use the VASTClient:

    import { VASTClient } from 'vast-client'
    const vastClient = new VASTClient();
      .then(res => {
        // Do something with the parsed VAST response
      .catch(err => {
        // Deal with the error

    In addition to fetching and parsing a VAST resource, VASTClient provides options to filter a sequence of calls based on count and time of execution, together with the possibility to track URLs using VASTTracker.


    To directly parse a VAST XML you can use the VASTParser:

    import { VASTParser } from 'vast-client'
    const vastParser = new VASTParser();
    vastParser.parseVAST(vastXml, (err, res) => {
      .then(res => {
        // Do something with the parsed VAST response
      .catch(err => {
        // Deal with the error


    To track the execution of an ad use the VASTTracker:

    import { VASTTracker } from 'vast-client'
    const vastTracker = new VASTTracker(vastClient, ad, creative);
    // Track an impression for the given ad

    API Documentation

    The API documentation is organized by components:

    ⚠️ IMPORTANT ⚠️ : the release of the 2.0 version of the library introduced many breaking changes in the API.

    Read the 2.0 migration guide to update your project or follow the 1.x API documentation if you're still using the old version.

    Support and compatibility

    The library is 100% written in JavaScript and the source code uses modern features like es6 modules. Make sure your environment supports these features, or transpile the library when bundling your project.

    A pre-bundled version of VAST Client JS is available: vast-client.js. You can add the script directly to your page and access the library's components through the VAST object.

    Build / Contribute



    npm i @l5i/vast-client

    DownloadsWeekly Downloads






    Unpacked Size

    425 kB

    Total Files


    Last publish


    • loreleiaurora