---
updatedAt: 2026-09-09T06:44:11.000Z
agentTools:
  siteIndex: https://documentation.bloomreach.com/llms.txt
  projectIndex: https://documentation.bloomreach.com/discovery/llms.txt
---

# Parameters for the Widget API

<Callout icon="📘" theme="info">
  ### Tip

  You can escape non-alphanumeric characters in your parameter values, using [URL percent-encoding conventions](http://www.w3schools.com/tags/ref_urlencode.asp).
</Callout>

## Endpoints

* **Production**: Please reach out to your Account Manager or Technical Consultant for your endpoint
* **Staging**: `https://bsapi-test.brsrvr.com`

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "widget-api",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://bsapi-test.brsrvr.com"
    }
  ],
  "security": [
    {}
  ],
  "paths": {
    "/v3/fetch_widget": {
      "get": {
        "summary": "Parameters for the Widget API",
        "description": "",
        "operationId": "parameters-for-the-widget-api",
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "description": "The URL for the webpage that is sending the request.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "acct_auth",
            "in": "query",
            "description": "The Bloomreach-provided authentication key for your account ID.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "acct_id",
            "in": "query",
            "description": "The Bloomreach-provided ID for your account.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "ptype",
            "in": "query",
            "description": "The page type.",
            "required": true,
            "schema": {
              "type": "string",
              "enum": [
                "product",
                "category",
                "other"
              ]
            }
          },
          {
            "name": "ref",
            "in": "query",
            "description": "The URL of the HTTP referrer for the webpage where the request is made. If the value is not available, then leave this parameter empty.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "user_agent",
            "in": "query",
            "description": "The browser user agent, which lets Bloomreach track web crawling. Take this parameter value directly from the HTTP headers supplied by your customer's browser request.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "prod_id",
            "in": "query",
            "description": "The unique identifier for the product in your product catalog or database. This parameter affects product pages only. Not needed for category requests.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "prod_name",
            "in": "query",
            "description": "The name of the product in your product catalog or database. Not needed for category requests.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "pstatus",
            "in": "query",
            "description": "The status of a product on the page. This parameter affects product pages only.",
            "schema": {
              "type": "string",
              "enum": [
                "ok",
                "outofstock",
                "discontinued",
                "invalid",
                "other"
              ]
            }
          },
          {
            "name": "output_format",
            "in": "query",
            "description": "The format in which you'd like to receive the response. Use **html** to return an HTML response, use **br_json** to return a JSON response.",
            "schema": {
              "type": "string",
              "enum": [
                "html",
                "br_json"
              ],
              "default": "html"
            }
          }
        ]
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```