Go Headless

Build Apps

Client

API Preview

Develop Websites

REST

Velo

GraphQL (Alpha)

# Site API

The Site API enables code within [Embedded Scripts](fallback::https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/wix-cli/supported-extensions/site-extensions/embedded-scripts/about-embedded-scripts-and-the-cli) and [Site Widgets](fallback::https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/wix-cli/supported-extensions/site-extensions/site-widgets/add-a-site-widget-extension-in-the-cli) created with the CLI to interact with a Wix site. For example, you can access site data and interact with other Wix Apps, such as Wix Stores and Wix Bookings.

> **Note:** This API is only available for use in [Wix Apps](fallback::https://dev.wix.com/docs/build-apps/develop-your-app/about-developing-apps) that run within a Wix site environment. It isn't compatible with Velo code executed in the Wix Editor or on sites not hosted by Wix.

## Setup

Install the `@wix/site` package using npm or Yarn:

```sh
npm install @wix/site
```

or

```sh
yarn add @wix/site
```

Next, create a [Wix Client](resourceId::2494d8e9-42aa-4802-8f67-b01c1a013c2c*fallback::https://github.com/wix-private/developer-docs/blob/master/js-sdk-docs/sdk/wix-client.md*original::../sdk/wix-client.md) with the relevant frontend modules. Supported modules are listed under **Frontend Modules** in the menu of this SDK reference. The following example uses the [seo module](fallback::https://dev.wix.com/docs/sdk/frontend-modules/seo/introduction):

```js
import { site } from "@wix/site";
import { createClient } from "@wix/sdk";
import { seo } from "@wix/site-seo"; // Frontend module of your choice

const client = createClient({
  host: site.host({ applicationId: '<your_app_id>' }),
  modules: {
    seo,
  },
});
```

> **Note:** You can find your app ID in the **OAuth** page of the [Wix Dev Center](fallback::https://dev.wix.com/apps/my-apps).

Finally, use the `client` constant to interact with the site via the frontend module. For example:

```js
client.seo.title().then((title) => {
  console.log("Site title:", title);
});
```