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

# Security

> Public channel for streaming the list of available securities and real-time updates to their properties.

<Note>Public channel. Connect to: `wss://wss.prime.kraken.com/ws/v1`</Note>

Request for stream of available securities for trading. On initial request, a snapshot of all available securities is provided. All subsequent messages are deltas to the securities snapshot.

Kraken maintains a security master which contains up-to-date information about the securities supported over API that are available to trade.

## Subscribe Request

<Tabs>
  <Tab title="Subscribe Schema">
    <ParamField path="reqid" type="number" required>
      Request ID - will be echoed back in the response structure.
    </ParamField>

    <ParamField path="type" type="string" required>
      Request type. Value: `subscribe`
    </ParamField>

    <ParamField path="streams" type="array" required>
      Array containing the Security stream configuration.

      <Expandable title="properties">
        <ParamField path="name" type="string" required>
          Subscription name. Value: `Security`
        </ParamField>

        <ParamField path="Symbols" type="array">
          Optional list of symbols to filter the subscription on.
        </ParamField>
      </Expandable>
    </ParamField>
  </Tab>

  <Tab title="Example">
    ```json theme={null}
    {
      "reqid": 2,
      "type": "subscribe",
      "streams": [
        {
          "name": "Security"
        }
      ]
    }
    ```
  </Tab>
</Tabs>

## Response

<Tabs>
  <Tab title="Response Schema">
    <ParamField path="reqid" type="number" required>
      A number that relates this response to a request.
    </ParamField>

    <ParamField path="type" type="string" required>
      The type of message sent.
    </ParamField>

    <ParamField path="ts" type="string" required>
      An ISO-8601 UTC string of the form `2019-02-13T05:17:32.000000Z`.
    </ParamField>

    <ParamField path="initial" type="boolean">
      If this is initial data for a request, the initial flag will be set.
    </ParamField>

    <ParamField path="seqNum" type="number" required>
      The sequence number for this response per request.
    </ParamField>

    <ParamField path="action" type="string">
      "Update" or "Remove" - tells the client if the given entity should be removed or added/updated.
    </ParamField>

    <ParamField path="data" type="array" required>
      Array of Security data.

      <Expandable title="properties">
        <ParamField path="Timestamp" type="string" required>
          Timestamp of message publication in ISO-8601 UTC format.
        </ParamField>

        <ParamField path="UpdateAction" type="string" required>
          "Update" or "Remove" where the latter indicates the Security is no longer available.
        </ParamField>

        <ParamField path="SecurityID" type="number" required>
          System ID for Security - for information only.
        </ParamField>

        <ParamField path="Symbol" type="string" required>
          Symbol for security.
        </ParamField>

        <ParamField path="MinPriceIncrement" type="string" required>
          Minimum Price Increment for Security.
        </ParamField>

        <ParamField path="MinSizeIncrement" type="string" required>
          Minimum Size Increment for Security. This increment is used to validate orders and RFQS expressed in base currency of the security.
        </ParamField>

        <ParamField path="MinAmtIncrement" type="string">
          Minimum Amount Increment for Security. This increment is used to validate orders and RFQS expressed in quote currency of the security.
        </ParamField>

        <ParamField path="MinimumSize" type="string" required>
          Minimum Size for an Order on this Security.
        </ParamField>

        <ParamField path="MaximumSize" type="string">
          Maximum Size for an Order on this Security.
        </ParamField>

        <ParamField path="QuoteCurrency" type="string" required>
          Currency in which the Security is quoted.
        </ParamField>

        <ParamField path="BaseCurrency" type="string" required>
          Base currency for the Security.
        </ParamField>

        <ParamField path="EndTime" type="string">
          Date this security was Disabled.
        </ParamField>

        <ParamField path="DefaultPriceIncrement" type="string" required>
          Default price increment used in all Market Data and Orders.
        </ParamField>

        <ParamField path="DefaultSizeIncrement" type="string" required>
          Default size increment used in all Market Data and Orders.
        </ParamField>

        <ParamField path="PriceDisplaySpec" type="string" required>
          String specification describing the price display.
        </ParamField>

        <ParamField path="SizeDisplaySpec" type="string" required>
          String specification describing the size display.
        </ParamField>

        <ParamField path="NormalSize" type="string">
          Normal size of Security.
        </ParamField>

        <ParamField path="ProductType" type="string">
          Product type of Security.
        </ParamField>

        <ParamField path="PositionCurrency" type="string" required>
          Currency in which any position on this Security is tracked.
        </ParamField>

        <ParamField path="SettlementCurrency" type="string">
          Currency in which any settlement on this Security is negotiated.
        </ParamField>

        <ParamField path="NotionalMultiplier" type="string">
          Notional Multiplier of Security.
        </ParamField>

        <ParamField path="Expiration" type="string">
          Expiration of Security.
        </ParamField>

        <ParamField path="SizeBuckets" type="array" required>
          Default array of Size Buckets for Market Data Snapshot Streams.
        </ParamField>

        <ParamField path="DisplaySymbol" type="string" required>
          Display symbol for Security.
        </ParamField>

        <ParamField path="Description" type="string" required>
          Description of Security.
        </ParamField>

        <ParamField path="Rank" type="number">
          Security rank.
        </ParamField>
      </Expandable>
    </ParamField>
  </Tab>

  <Tab title="Example">
    ```json theme={null}
    {
      "reqid": 2,
      "type": "Security",
      "ts": "2021-09-14T22:11:47.512168Z",
      "initial": true,
      "seqNum": 1,
      "data": [
        {
          "Timestamp": "2021-09-14T22:11:47.512168Z",
          "UpdateAction": "Update",
          "SecurityID": 2,
          "Symbol": "ETH-USD",
          "MinPriceIncrement": "0.01",
          "MinSizeIncrement": "0.00000001",
          "MinAmtIncrement": "0.01",
          "MinimumSize": "0.00000001",
          "MaximumSize": "10000000",
          "QuoteCurrency": "USD",
          "BaseCurrency": "ETH",
          "DefaultPriceIncrement": "0.01",
          "DefaultSizeIncrement": "0.0001",
          "PriceDisplaySpec": "M.m",
          "SizeDisplaySpec": "M.m",
          "NormalSize": "2",
          "ProductType": "Spot",
          "PositionCurrency": "ETH",
          "SettlementCurrency": "USD",
          "NotionalMultiplier": "1",
          "SizeBuckets": [
            {
              "Size": "0"
            }
          ],
          "DisplaySymbol": "ETH-USD",
          "Description": "Ethereum/U.S. Dollar",
          "Rank": 2
        }
      ]
    }
    ```
  </Tab>
</Tabs>