CodeAPI

API Overview

Wix Code APIs empower you to take full control of your site’s functionality. Use the APIs to interact with page elements, your site’s database content, and external services. The APIs also give you access to information about your site, its users, and more.

To use the APIs, you’ll need a working knowledge of JavaScript, including ES2015 features, such as Promises and modules. The APIs include lots of code examples to help you get started.

The following APIs are available:

$w

The $w namespace contains everything you need in order to work with your site's components. It contains all of the UI elements, nodes, and events that make up your site. It also includes the $w(), onReady(), and at() functions.

The APIs in $w can only be used in front-end code.

You do not need to import $w.

wix-crm

The wix-crm module contains functionality for working with your site's contacts from client-side code.

wix-crm-backend

The wix-crm-backend module contains functionality for working with your site's contacts from backend code.

wix-data

The wix-data module contains functionality for working with data in collections.

wix-dataset

A dataset connects page elements to a set of items in a data collection.

wix-fetch

An implementation of the standard Javascript Fetch API which can be used in public and backend code for fetching resources from 3rd party services using HTTPS.

wix-http-functions

HTTP functions are used to expose an API of your site's functionality.

wix-location

The wix-location module contains functionality for getting information about the URL of the current page and for navigating to other pages.

wix-pay

The wix-pay module contains functionality for working with payments from client-side code.

wix-pay-backend

The wix-pay-backend module contains functionality for working with payments from backend code.

wix-router

This module contains the APIs for code routers and data binding router hooks.

wix-site

The wix-site module contains functionality for obtaining information about your site and its pages.

wix-storage

The wix-storage module contains functionality for the persistent storage of key/value data in the user's browser.

wix-stores

The wix-stores module contains functionality for working with your site's store from from client-side code.

wix-stores-backend

The wix-stores-backend module contains functionality for working with your site's store from backend code.

wix-users

The wix-users module contains functionality for working with your site's users from client-side code.

wix-users-backend

The wix-users-backend module contains functionality for working with your site's users from backend code.

wix-window

The wix-window module contains functionality that pertains to the current browser window.