# About Site

The Site API provides information about a site's core configuration, structure, and regional settings. You can use this API to retrieve essential details such as the site’s display name, currency, language, and timezone, as well as information about the site’s pages and routing.

With the Site API you can:

- Access site-level settings like [language](fallback::https://dev.wix.com/docs/sdk/frontend-modules/site/language), [currency](fallback::https://dev.wix.com/docs/sdk/frontend-modules/site/currency), [timezone](fallback::https://dev.wix.com/docs/sdk/frontend-modules/site/timezone), and [regional preferences](fallback::https://dev.wix.com/docs/sdk/frontend-modules/site/regional-settings)
- Retrieve the [site structure](fallback::https://dev.wix.com/docs/sdk/frontend-modules/site/get-site-structure), [current page](fallback::https://dev.wix.com/docs/sdk/frontend-modules/site/current-page), and [site display name](fallback::https://dev.wix.com/docs/sdk/frontend-modules/site/get-site-display-name)
- Improve performance by [prefetching page resources](fallback::https://dev.wix.com/docs/sdk/frontend-modules/site/prefetch-page-resources)
- Get the [router sitemap](fallback::https://dev.wix.com/docs/sdk/frontend-modules/site/router-sitemap) for dynamic routing and SEO support

## Terminology

- **Currency code**: A short code (for example, `USD`, `EUR`) representing the site's configured currency, as set in the site's Dashboard.
- **Regional settings**: Settings that define how numbers, dates, and currencies are formatted on the site, based on regional preferences.
- **Site structure**: A flattened representation of all site pages and lightboxes (excluding menu structure), useful for navigation and routing logic.
- **Prefetching**: The process of loading page or lightbox resources in advance to improve performance during navigation.
- **Router sitemap**: A list of pages generated from a router or dynamic prefix, used to help search engines index dynamic content.

# Setup

@package_metadata:@wix/site-site

To use the Site API, install the `@wix/site-site` package.

## Install the package

Follow the installation instructions for your development environment.

| Development environment | Installation method |
|--|--|
| Wix sites (editor or IDE) | Use the [package manager](fallback::https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/packages/work-with-npm-packages-in-the-editor). |
| Wix sites (local IDE) | Run `wix install @wix/site-site` using the [Wix CLI](fallback::https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/packages/work-with-npm-packages-with-the-wix-cli).|
| Blocks apps | Use the same installation method as Wix sites. |
| CLI and self-hosted apps | Run `npm install @wix/site-site` or `yarn add @wix/site-site`. |

## Import the package

To import the package in your code:

```js
import { site } from "@wix/site-site";
```

Coding Examples

Sled Tests

Go Headless

Build Apps

Client

API Preview

Ricos

Develop Websites

REST

Velo

Picasso

GraphQL (Alpha)

SiteSite

Retrieves a code representing the site's currency.

The retrieved currency code corresponds to the currency that has been
 entered in the General Info section of a site's [dashboard](https://support.wix.com/en/article/about-your-wix-dashboard).

 The currency is used by a site with apps, for example Wix Stores or Wix Bookings, and other
 Wix features.

import { site } from '@wix/site-site';

// ...

const currency = await site.currency(); // "USD"

Get the site's currency

currency

string

Retrieves information about a current page or lightbox.

import { site } from '@wix/site-site';

// ...

const currentPage = await site.currentPage();

/* Promise resolves to:
 *  {
 *    "name": "Home",
 *    "type": "static",
 *    "url": "/home",
 *    "isHomePage": true
 *  }
 */

Get information about the current page

import { site } from '@wix/site-site';

// ...

const currentLightbox = await site.currentPage();

/* Promise resolves to:
 *  {
 *    "name": "Welcome (Full Screen)"
 *    "type": "lightbox"
 *  }
 */

Get information about the current lightbox

currentPage

List of fonts to be loaded, where each font is represented by a value of a `font` CSS property.

fonts

The options used when getting the HTML element.

options

getFontsHtmlOptions

Gets an HTML element containing CSS code to load fonts.

Use `getFontsHtml()` to get an HTML element containing the CSS code that loads 1 or more fonts.
Use `getFontsHtml()` when embedding a custom element in a Wix site where the page's stylesheet fonts
are inaccessible, such as when using a shadow root or an internal iframe.

getFontsHtml

Fulfilled - HTML element containing the CSS code that loads the fonts.

Gets the site display name.

Retrieves the site display name, which is the name
 entered in the **Website Settings** section of a site's [dashboard](https://support.wix.com/en/article/about-your-wix-dashboard).

import { site } from '@wix/site-site';

const siteName = await site.getSiteDisplayName(); // "My Site"

Get the site display name

getSiteDisplayName

Returns information about a site's pages, prefixes, and lightboxes.

The returned `SiteStructure` object is a flattened representation of a site.
 The structure doesn't include the headers and links from a site's **Pages** menu.

import { site } from '@wix/site-site';

// ...

const structure = await site.getSiteStructure();

/*
*  {
*    "pages": [
*      {
*        "name": "Home",
*        "type": "static",
*        "url": "/home",
*        "isHomePage": true
*      },
*      {
*        "name": "Page 1",
*        "type": "static",
*        "url:" /page-1"
*      },
*      {
*        "name": "Page 2",
*        "type": "static",
*        "url": "/page-2"
*      },
*      {
*        "name": "Parent Page",
*        "type": "static",
*        "url": "/parent-page"
*      },
*      {
*        "name": "Child Page",
*        "type": "static",
*        "url": "/child-page"
*      },
*      {
*        "name": "router-page",
*        "type": "template",
*        "prefix": "router"
*      },
*      {
*        "name": "MyCollection (Title)",
*        "type": "template",
*        "prefix": "MyCollection"
*      },
*      {
*        "name": "MyCollection (All)",
*        "type": "template",
*        "prefix": "MyCollection"
*      },
*      {
*        "name": "Dashboard Page",
*        "type": "static"
*      },
*      {
*        "name": "Shop",
*        "type": "template",
*        "url": "/shop",
*        "applicationId": "215238eb-22a5-4c36-9e7b-e7c08025e04e"
*      },
*      {
*        "name": "Product Page",
*        "type": "template",
*        "url": "/product-page",
*        "applicationId": "215238eb-22a5-4c36-9e7b-e7c08025e04e"
*      },
*      {
*        "name": "Thank You Page",
*        "type": "template",
*        "url": "/thank-you-page",
*        "applicationId": "215238eb-22a5-4c36-9e7b-e7c08025e04e"
*      },
*      {
*        "name": "Cart",
*        "type": "template",
*        "url": "/cart",
*        "applicationId": "215238eb-22a5-4c36-9e7b-e7c08025e04e"
*      },
*      {
*        "name": "Members",
*        "type": "template",
*        "url": "/members",
*        "applicationId": "14ad9202-3dd3-128a-57bd-e5675fd7e313"
*      }
*    ],
*    "prefixes": [
*      {
*        "name": "router",
*        "type": "router",
*        "prefix": "/router"
*      },
*      {
*        "name": "MyCollection",
*        "type": "dynamicPages",
*        "prefix": "/MyCollection"
*      },
*      {
*        "name": "MyCollection",
*        "type": "dynamicPages",
*        "prefix": "/MyCollection"
*      },
*      {
*        "name": "Shop",
*        "type": "app",
*        "prefix: "/shop",
*        "applicationId": "215238eb-22a5-4c36-9e7b-e7c08025e04e"
*      },
*      {
*        "name": "Product Page",
*        "type": "app",
*        "prefix": "/product-page",
*        "applicationId": "215238eb-22a5-4c36-9e7b-e7c08025e04e"
*      },
*      {
*        "name": "Thank You Page",
*        "type": "app",
*        "prefix": "/thank-you-page",
*        "applicationId": "215238eb-22a5-4c36-9e7b-e7c08025e04e"
*      },
*      {
*        "name": "Cart",
*        "type": "app",
*        "url": "/cart",
*        "applicationId": "215238eb-22a5-4c36-9e7b-e7c08025e04e"
*      },
*      {
*        "name": "Members",
*        "type": "app",
*        "prefix": "/members",
*        "applicationId": "14ad9202-3dd3-128a-57bd-e5675fd7e313"
*      }
*    ],
*    "lightboxes": [
*      {
*        "name": "Welcome (Full Screen)"
*      }
*    ]
*  }
*/


Get information about the site's pages, prefixes, and lightboxes

getSiteStructure

SiteStructure

An object that contains information about a site's pages, prefixes, and lightboxes.

getSiteThemeHtmlOptions

Gets the CSS code of the site's theme.
Use `getSiteThemeHtml()` to get an HTML element containing the CSS code of a site's
[theme colors and fonts](https://support.wix.com/en/article/wix-editor-customizing-your-sites-theme-and-design).
Use `getSiteThemeHtml()` when embedding a custom element in a Wix site where the page's stylesheet
is inaccessible, such as when using a shadow root or an internal iframe.

getSiteThemeHtml

Fulfilled - HTML element containing site's theme CSS.

Retrieves a code representing the site's language.

The retrieved language code corresponds to the main site language
 as found in the General Info section of a site's [dashboard](https://support.wix.com/en/article/about-your-wix-dashboard).

 > **Note:** If you have a multilingual site, and it's being viewed in a language
 that's not the main site language, the `language` property still returns
 the main site language. To work with the languages of a multilingual site,
 use the Multilingual API.

import { site } from '@wix/site-site';

// ...

const language = await site.language(); // "en"

Get the site's language

language

The items within the site to prefetch resources for.

prefetchItems

PrefetchItems

Optimizes resource fetching of pages and lightboxes in a site so they'll load faster.

Use the `prefetchPageResources()` method to optimize resource fetching of pages and
 lightboxes a site's visitors are likely to visit next. When a site
 visitor navigates to those pages or lightboxes, they'll load quicker than usual
 since some of their resources have already been retrieved.

 You can only prefetch resources from pages or lightboxes within the current site.

 A prefetch is considered successful if the specified pages and lightboxes exist in
 the current site. If any of the specified pages or lightboxes do not exist, the
 prefetch operation returns an error status and lists of the pages and lightboxes
 that were not found.

import { site } from '@wix/site-site';

const response = await site.prefetchPageResources( {
  "lightboxes": ["First Box", "Second Box"],
  "pages": ["/first-page", "/second-page"]
} );

if(response.errors) {
  // handle errors
}

/* Promise resolves to:
 *
 * {
 *   "message": "success"
 * }
 */

Prefetch resources successfully

import { site } from '@wix/site-site';

const response = await site.prefetchPageResources( {
  "lightboxes": ["My Lightbox", "Fake Lightbox"],
  "pages": ["/my-page", "/nonexistent-page"]
} );

if(response.errors) {
  // handle errors
}

/* Promise resolves to:
 * {
 *   "message": "some resources not found",
 *   "errors": {
 *     "lightboxes": ["Fake Lightbox"],
 *     "pages": ["/nonexistent-page"]
 *   }
 * }
 */

Prefetch resources unsuccessfully

prefetchPageResources

PrefetchResult

Retrieves a site's regional settings.

The retrieved regional settings corresponds to the regional settings
 that has been entered in the General Info section of a site's [dashboard](https://support.wix.com/en/article/about-your-wix-dashboard).

 The regional settings are used to determine how numbers, dates, and currencies
 are displayed on a site.

import { site } from '@wix/site-site';

// ...

const regionalSettings = await site.regionalSettings(); // "en-us"

Get the site's regionalSettings

regionalSettings

Retrieves the site revision ID.

The site revision ID is a unique identifier for the current revision of
 a site. Each time a site is manually saved or published
 following a change, a new revision is created.

You can view and manage a site's revisions in the [Site History](https://support.wix.com/en/article/viewing-and-managing-your-site-history).
You can use [site monitoring](https://support.wix.com/en/article/about-site-monitoring#site-revisions) to
monitor and debug new revisions of a site.

 > **Notes:**
 > + Since publishing a site may change the revision ID, the ID when
 >   previewing a site may be different than the ID for the published site.
>
>
> + The site revision ID is unique, but not meaningful.
>   Therefore, you can't predict future revision IDs before they're created.

import { site } from '@wix/site-site';

// ...

const revision = await site.revision(); // "4x2y"

Get the site revision ID

revision

The prefix of the router to get the sitemap for.

routerPrefix

Returns the sitemap for a router or dynamic page prefix.

The `routerSitemap()` method returns a Promise that resolves to a list of
 `WixSitemapEntry` objects. Each
 `WixSitemapEntry` includes
 information about a page, such as its URL, title, and name.

 A sitemap is used by search engines to find the links to the site's pages.

import { site } from '@wix/site-site';

// ...

site.routerSitemap("routerPrefix")
  .then( (routerSitemap) => {
  	const sitemap = routerSitemap;
  } );

/*
 * sitemap:
 *
 * [
 *   {
 *   	"url": "Ash",
 *   	"lastModified": null,
 *   	"changeFrequency": "",
 *   	"priority": null,
 *   	"title": "Ash Stowe",
 *   	"pageName": "Ash's Page"
 *   },
 *   {
 *   	"url": "Aiden",
 *   	"lastModified": null,
 *   	"changeFrequency": "",
 *   	"priority": null,
 *   	"title": "Aiden Johnson",
 *   	"pageName": "Aiden's page"
 *   },
 *   {
 *   	"url": "Jess",
 *   	"lastModified": null,
 *   	"changeFrequency": "",
 *   	"priority": null,
 *   	"title": "Jess White",
 *   	"pageName": "Jess's page"
 *   },
 *   {
 *   	"url": "Morgan",
 *   	"lastModified": null,
 *   	"changeFrequency": "",
 *   	"priority": null,
 *   	"title": "Morgan James",
 *   	"pageName": "Morgan's Page"
 *   }
 * ]
 */

Get the sitemap for a prefix

routerSitemap

WixRouterSitemapEntry

Fulfilled - A list of sitemap entries.
Rejected - The error that caused the rejection.

Retrieves a site's time zone.

The retrieved time zone is the time zone that has been
 entered in the General Info section of a site's [dashboard](https://support.wix.com/en/article/about-your-wix-dashboard).

 The time zone is used by a site with apps, for example Wix Stores or Wix Bookings, and other
 Wix features.

import { site } from '@wix/site-site';

// ...

const timezone = await site.timezone(); // "America/New_York"

Get the site's timezone

timezone

# About Site

The Site API provides information about a site's core configuration, structure, and regional settings. You can use this API to retrieve essential details such as the site’s display name, currency, language, and timezone, as well as information about the site’s pages and routing.

With the Site API you can:

- Access site-level settings like [language](https://dev.wix.com/docs/sdk/frontend-modules/site/language), [currency](https://dev.wix.com/docs/sdk/frontend-modules/site/currency), [timezone](https://dev.wix.com/docs/sdk/frontend-modules/site/timezone), and [regional preferences](https://dev.wix.com/docs/sdk/frontend-modules/site/regional-settings)
- Retrieve the [site structure](https://dev.wix.com/docs/sdk/frontend-modules/site/get-site-structure), [current page](https://dev.wix.com/docs/sdk/frontend-modules/site/current-page), and [site display name](https://dev.wix.com/docs/sdk/frontend-modules/site/get-site-display-name)
- Improve performance by [prefetching page resources](https://dev.wix.com/docs/sdk/frontend-modules/site/prefetch-page-resources)
- Get the [router sitemap](https://dev.wix.com/docs/sdk/frontend-modules/site/router-sitemap) for dynamic routing and SEO support

## Terminology

- **Currency code**: A short code (for example, `USD`, `EUR`) representing the site's configured currency, as set in the site's Dashboard.
- **Regional settings**: Settings that define how numbers, dates, and currencies are formatted on the site, based on regional preferences.
- **Site structure**: A flattened representation of all site pages and lightboxes (excluding menu structure), useful for navigation and routing logic.
- **Prefetching**: The process of loading page or lightbox resources in advance to improve performance during navigation.
- **Router sitemap**: A list of pages generated from a router or dynamic prefix, used to help search engines index dynamic content.

# Setup

@package_metadata:@wix/site-site

To use the Site API, install the `@wix/site-site` package.

## Install the package

Follow the installation instructions for your development environment.

| Development environment | Installation method |
|--|--|
| Wix sites (editor or IDE) | Use the [package manager](https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/packages/work-with-npm-packages-in-the-editor). |
| Wix sites (local IDE) | Run `wix install @wix/site-site` using the [Wix CLI](https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/packages/work-with-npm-packages-with-the-wix-cli).|
| Blocks apps | Use the same installation method as Wix sites. |
| CLI and self-hosted apps | Run `npm install @wix/site-site` or `yarn add @wix/site-site`. |

## Import the package

To import the package in your code:

```js
import { site } from "@wix/site-site";
```


site-site

Gets how frequently the page is likely to change.

The value of the `changeFrequency` property provides general information to
search engines and may not correlate exactly to how often they crawl the page.

Valid values:

+ `"always"`
+ `"hourly"`
+ `"daily"`
+ `"weekly"`
+ `"monthly"`
+ `"yearly"`
+ `"never"`

changeFrequency

Gets when the page data was last modified.

lastModified

pageName

Gets the priority of this URL relative to other URLs on your site.

The value of the `priority` property lets search engines know which pages
you deem most important. Its value does not affect how your pages are
compared to pages on other sites.

Valid values range from 0.0 to 1.0.

The default priority of a page is 0.5.

priority

title

The names of the lightboxes in a site to prefetch
 resources for.

 > **Note:** Pages are listed by relative or absolute URL, but lightboxes are listed by name.
 See `location.to` to learn how to find a page's relative
 URL. You can find a lightbox's name by selecting the lightbox and clicking the settings button.

lightboxes

The relative or absolute URLs of the pages in a site
 to prefetch resources for.

pages

errors

PrefetchResultError

message

The names of the lightbox for which prefetch failed.

The names of the pages for which prefetch failed.

Prefix

If the prefix is an app's prefix, the `applicationId` property is the app's ID.

applicationId

name

prefix

The type of the prefix.

 A site's routers, dynamic pages, and app pages all have prefixes.

 One of:

 + `"dynamicPages"`
 + `"router"`
 + `"app"`

type

The pages of a site.
 Pages can be regular pages, dynamic pages, router pages, or pages from an app.

The prefixes of the site's routers and dynamic pages.

prefixes

StructureLightbox

StructurePage

If the page is an app page, the `applicationId` property is the app's ID.

If the page is the Home page, `isHomePage` is `true`. Otherwise, it doesn't exist.

isHomePage

boolean

If the page is a router or dynamic page, the `prefix` property is the page's prefix.

URL of the page. If the page is a `static` page the `url` property is the page's SEO URL.

number

An identifier that's added in a `data-test-id` attribute on the returned HTML element. Use this identifier to locate the HTML element when testing your code.

testId

An identifier that's added in a `data-test-id` attribute on the returned HTML element. You can use this identifier to locate the HTML element when testing your code.

getSiteStructure( )