> ## Documentation Index
> Fetch the complete documentation index at: https://docs.blazemonitors.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Schema

> Schema for the Websockets API

## Site Object

The `site` object contains the following fields:

| Field          | Type      | Description                                                    |
| -------------- | --------- | -------------------------------------------------------------- |
| `platformName` | `String`  | Name of the platform (e.g. amazon)                             |
| `siteName`     | `String`  | Name of the site (e.g. AmazonUS)                               |
| `siteUrl`      | `String`  | The URL of the site                                            |
| `siteCurrency` | `String`  | The currency used on the site                                  |
| `siteImg`      | `String`  | An image URL for the site                                      |
| `hasLists`     | `Boolean` | Whether or not the site supports lists                         |
| `hasProducts`  | `Boolean` | Whether or not the site supports products                      |
| `hasReleases`  | `Boolean` | Whether or not the site has scrapers                           |
| `hasForceAdd`  | `Boolean` | Whether or not the site supports force adding                  |
| `queryType`    | `String`  | The type of query used for the site (productSku or productUrl) |
| `restockTypes` | `Array`   | An array of restock types supported by the site                |
| `altNames`     | `Array`   | An array of alternative names for the site                     |

## Instore Object

The `instore` object contains the following fields:

| Field          | Type     | Description                              |
| -------------- | -------- | ---------------------------------------- |
| `storeId`      | `String` | ID of the store                          |
| `storeName`    | `String` | Name of the store                        |
| `storeAddress` | `String` | Address of the store                     |
| `storeStock`   | `String` | Total stock for the product at the store |

## Antibot Object

The `antibot` object contains the following fields:

| Field    | Type     | Description           |
| -------- | -------- | --------------------- |
| `name`   | `String` | Name of the antibot   |
| `url`    | `String` | URL of the antibot    |
| `type`   | `String` | Type of the antibot   |
| `status` | `String` | Status of the antibot |

## Product Object

The `product` object contains the following fields:

| Field                | Type      | Description                             |
| -------------------- | --------- | --------------------------------------- |
| `productSku`         | `String`  | SKU of the product                      |
| `productImg`         | `String`  | Image of the product                    |
| `productName`        | `String`  | Name of the product                     |
| `productPrice`       | `String`  | Price of the product                    |
| `productUrl`         | `String`  | URL of the product                      |
| `productSite`        | `String`  | Site of the product                     |
| `productStyle`       | `String`  | Style of the product                    |
| `productColor`       | `String`  | Color of the product                    |
| `productType`        | `String`  | Type of the product                     |
| `productDescription` | `String`  | Description of the product              |
| `productStock`       | `String`  | Stock of the product                    |
| `offerId`            | `String`  | Offer ID of the product                 |
| `lastRestocked`      | `Integer` | Last restocked timestamp of the product |
| `firstAdded`         | `Integer` | First added timestamp of the product    |
| `productVariants`    | `Array`   | Product variants                        |

## Variant Object

The `variant` object contains the following fields:

| Field        | Type     | Description                |
| ------------ | -------- | -------------------------- |
| `id`         | `String` | ID of the variant          |
| `sizeId`     | `String` | Size ID of the variant     |
| `sizeLabel`  | `String` | Size label of the variant  |
| `colorId`    | `String` | Color ID of the variant    |
| `colorLabel` | `String` | Color label of the variant |
| `url`        | `String` | URL of the variant         |
| `img`        | `String` | Image of the variant       |
| `stock`      | `String` | Stock of the variant       |
| `qt`         | `String` | QT URL of the variant      |