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

# Borderless Benchmark

The Borderless Benchmark widget displays fiat/stablecoin exchange rates for the last 30 days.

The chart renders:

* Average buy/sell prices (lines)
* Min/Max bands across Borderless providers

<Note>
  If you're just getting started, please check out our [quick start guide](/docs/quick-start-guide).
</Note>

## Production widget URL

Please use the following URL when embedding the widget or using it in additional context:

[https://widget.borderless.xyz/rates](https://widget.borderless.xyz/rates)

## Quick start

Embed the widget via an iframe:

<CodeGroup>
  ```bash bash theme={null}
  <iframe
    src="https://widget.borderless.xyz/rates"
    allow="clipboard-write"
    width="100%"
    height="800"
    style="border: 0;"
    loading="lazy"
    referrerpolicy="no-referrer"
  ></iframe>
  ```
</CodeGroup>

## Query parameters

You can control defaults and UI visibility with URL params.

<Tabs>
  <Tab title="Core Parameters">
    <ParamField path="fiat" type="string" required>
      The specified local fiat currency. (e.g. ARS, USD, BRL, EUR)
    </ParamField>

    <ParamField path="asset" type="string" required>
      The stablecoin to display and compare against. (e.g. USDC, USDT)
    </ParamField>

    <ParamField path="centralMetric" type="median | average" default="average">
      The metric value visualized in the widget. (e.g. average or median)
    </ParamField>

    <ParamField path="orientation" type="forward | reversed" default="forward">
      The direction the rates data is visualized. (e.g. sorting)
    </ParamField>
  </Tab>

  <Tab title="UI Elements">
    <ParamField path="chartOnly" type="boolean" default="false">
      Hides all other elements except the chart object.
    </ParamField>

    <ParamField path="hideControls" type="boolean" default="chartOnly">
      Hides the top control bar. (i.e. the fiat and stablecoin selectors)
    </ParamField>

    <ParamField path="hideHeader" type="boolean" default="chartOnly">
      Hides the title and subtitles.
    </ParamField>

    <ParamField path="hideContainer" type="boolean" default="chartOnly">
      Removes the outer padding and framing to fit tight embeds.
    </ParamField>

    <ParamField path="hideBackground" type="boolean" default="chartOnly">
      Remove the background. This can be useful for seamless embedding.
    </ParamField>
  </Tab>

  <Tab title="Chart Elements">
    <ParamField path="curve" type="catmullRom | linear | monotoneX | monotoneY | natural | step | stepBefore | stepAfter | bumpY | bumpX" default="monotoneX">
      This parameter defines the shape of the line on the chart, and how it curves to connect between points.
    </ParamField>

    <ParamField path="buyColor" type="any hex,rgb,or css color" default="#00a76f">
      The color of the buy rate line. Please use encodeURIComponent or replace `#` to `%23` to work in URL.
    </ParamField>

    <ParamField path="sellColor" type="any hex,rgb,or css color" default="#ff5730">
      The color of the sell rate line. Please use encodeURIComponent or replace `#` to `%23` to work in URL.
    </ParamField>

    <ParamField path="xLabel" type="string | null" default="null">
      X-axis label text. (e.g. "Date")
    </ParamField>

    <ParamField path="yLabel" type="string | null" default="null">
      Y-axis label text. (e.g.)
      Available additional parameters: centralMetric, base, and quote. (e.g. "centralMetric-(base/quote)" will be shown like "Average - USD/USDC")
    </ParamField>

    <ParamField path="yLabelPosition" type="left | right" default="right">
      Position of Y Label on Chart.
    </ParamField>
  </Tab>
</Tabs>

<Note>
  Boolean syntax supported: ?hideHeader=true/1/yes/on or false/0/no/off.
</Note>

## Preselected fiat/asset

<CodeGroup>
  ```bash bash theme={null}
  <iframe
    src="https://widget.borderless.xyz/rates?fiat=USD&asset=USDC"
  	allow="clipboard-write"
    width="100%"
    height="800p"
    style="border: 0;"
    loading="lazy"
    referrerpolicy="no-referrer"
  ></iframe>
  ```
</CodeGroup>

## Only Chart with preselected values

<CodeGroup>
  ```bash bash theme={null}
  <iframe
    src="https://widget.borderless.xyz/rates?fiat=USD&asset=USDC&chartOnly"
  	allow="clipboard-write"
    width="100%"
    height="600"
    style="border: 0;"
    loading="lazy"
    referrerpolicy="no-referrer"
  ></iframe>
  ```
</CodeGroup>

<Note>
  **Recommendations**

  * Sizing: Set width="100%" and adjust height (600-1000px recommended).

  * Background: If you pass hideBackground, also set style="background:transparent;" on the iframe to match the host page.

  * Accessibility: Provide a descriptive title on the iframe, e.g., title="Exchange Rates (ARS/USDC)".
</Note>

<Info>
  If you have any questions, please don't hesitate to reach out to us via [email](mailto:support@borderless.xyz) or slack.
</Info>
