> ## 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.

# Currency

> Public channel for streaming available currencies used within trading.

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

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

## 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 Currency stream configuration.

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

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

  <Tab title="Example">
    ```json theme={null}
    {
      "reqid": 3,
      "type": "subscribe",
      "streams": [
        {
          "name": "Currency"
        }
      ]
    }
    ```
  </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 Currency data.

      <Expandable title="properties">
        <ParamField path="Timestamp" type="number" required>
          Timestamp of message publication as nanoseconds since the Unix epoch.
        </ParamField>

        <ParamField path="UpdateAction" type="string" required>
          "Update" or "Remove" where the latter indicates the Currency is no longer available. Possible values: `Update`, `Remove`
        </ParamField>

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

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

        <ParamField path="MinIncrement" type="string" required>
          Minimum increment for Currency.
        </ParamField>

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

        <ParamField path="Description" type="string" required>
          Description of Currency.
        </ParamField>
      </Expandable>
    </ParamField>
  </Tab>

  <Tab title="Example">
    ```json theme={null}
    {
      "reqid": 3,
      "type": "Currency",
      "ts": "2021-09-14T22:11:47.512168Z",
      "initial": true,
      "seqNum": 1,
      "data": [
        {
          "Timestamp": 1676936489075207000,
          "UpdateAction": "Update",
          "CurrencyID": 2,
          "Symbol": "USD",
          "MinIncrement": "0.01",
          "DefaultIncrement": "0.01",
          "Description": "U.S. Dollar"
        },
        {
          "Timestamp": 1676936515053193000,
          "UpdateAction": "Update",
          "CurrencyID": 17,
          "Symbol": "ETH",
          "MinIncrement": "0.00000001",
          "DefaultIncrement": "0.0001",
          "Description": "Ethereum"
        }
      ]
    }
    ```
  </Tab>
</Tabs>
