---
title: "Subscription Key Type"
method: POST
path: "/api-regulated/v1/subscription-messages/subscription-key"
tags: ["SubscriptionMessages"]
---

# Subscription Key Type

`POST /api-regulated/v1/subscription-messages/subscription-key`

## Request

- Base URL: `https://api.currencyguard.com`
- URL: `https://api.currencyguard.com/api-regulated/v1/subscription-messages/subscription-key`
- Auth: HTTP bearer

SYNTHETIC ENDPOINT - DO NOT CALL!

Exposes the SubscriptionKey type used to identify and route message streams.

## Request body

- union
  - SubscriptionKeyCLOCK
    - `messageType` 'FX_PRICE' | 'MARKET_DATA' | 'GUARDS' | 'FX_OPTIONS' | 'GUARD_PRICE' | 'GUARD_PERFORMANCE' | 'CLOCK' | 'CLOCK_DATE_ROLL' | 'GUARD_QUOTES' | 'FX_VOL_SURFACE' | 'ZERO_RATE_CURVE' | 'PORTFOLIO_VALUATIONS' | 'PORTFOLIO_RISK' | 'FX_FORWARD_CURVE' | 'FX_POSITION_PNL_VALUATION' | 'MARKET_STATUS'
    - `frequency` number, double
  - SubscriptionKeyCLOCKDATEROLL
    - `messageType` 'FX_PRICE' | 'MARKET_DATA' | 'GUARDS' | 'FX_OPTIONS' | 'GUARD_PRICE' | 'GUARD_PERFORMANCE' | 'CLOCK' | 'CLOCK_DATE_ROLL' | 'GUARD_QUOTES' | 'FX_VOL_SURFACE' | 'ZERO_RATE_CURVE' | 'PORTFOLIO_VALUATIONS' | 'PORTFOLIO_RISK' | 'FX_FORWARD_CURVE' | 'FX_POSITION_PNL_VALUATION' | 'MARKET_STATUS'
  - SubscriptionKeyFXFORWARDCURVE
    - `messageType` 'FX_PRICE' | 'MARKET_DATA' | 'GUARDS' | 'FX_OPTIONS' | 'GUARD_PRICE' | 'GUARD_PERFORMANCE' | 'CLOCK' | 'CLOCK_DATE_ROLL' | 'GUARD_QUOTES' | 'FX_VOL_SURFACE' | 'ZERO_RATE_CURVE' | 'PORTFOLIO_VALUATIONS' | 'PORTFOLIO_RISK' | 'FX_FORWARD_CURVE' | 'FX_POSITION_PNL_VALUATION' | 'MARKET_STATUS'
    - `currencyPair` string
    - `forwardCurveSource` string
  - SubscriptionKeyFXOPTIONS
    - `messageType` 'FX_PRICE' | 'MARKET_DATA' | 'GUARDS' | 'FX_OPTIONS' | 'GUARD_PRICE' | 'GUARD_PERFORMANCE' | 'CLOCK' | 'CLOCK_DATE_ROLL' | 'GUARD_QUOTES' | 'FX_VOL_SURFACE' | 'ZERO_RATE_CURVE' | 'PORTFOLIO_VALUATIONS' | 'PORTFOLIO_RISK' | 'FX_FORWARD_CURVE' | 'FX_POSITION_PNL_VALUATION' | 'MARKET_STATUS'
  - SubscriptionKeyFXPOSITIONPNLVALUATION
    - `messageType` 'FX_PRICE' | 'MARKET_DATA' | 'GUARDS' | 'FX_OPTIONS' | 'GUARD_PRICE' | 'GUARD_PERFORMANCE' | 'CLOCK' | 'CLOCK_DATE_ROLL' | 'GUARD_QUOTES' | 'FX_VOL_SURFACE' | 'ZERO_RATE_CURVE' | 'PORTFOLIO_VALUATIONS' | 'PORTFOLIO_RISK' | 'FX_FORWARD_CURVE' | 'FX_POSITION_PNL_VALUATION' | 'MARKET_STATUS'
  - SubscriptionKeyFXPRICE
    - `messageType` 'FX_PRICE' | 'MARKET_DATA' | 'GUARDS' | 'FX_OPTIONS' | 'GUARD_PRICE' | 'GUARD_PERFORMANCE' | 'CLOCK' | 'CLOCK_DATE_ROLL' | 'GUARD_QUOTES' | 'FX_VOL_SURFACE' | 'ZERO_RATE_CURVE' | 'PORTFOLIO_VALUATIONS' | 'PORTFOLIO_RISK' | 'FX_FORWARD_CURVE' | 'FX_POSITION_PNL_VALUATION' | 'MARKET_STATUS'
    - `currencyPair` string
    - `source` string
    - `amount` number
  - SubscriptionKeyFXVOLSURFACE
    - `messageType` 'FX_PRICE' | 'MARKET_DATA' | 'GUARDS' | 'FX_OPTIONS' | 'GUARD_PRICE' | 'GUARD_PERFORMANCE' | 'CLOCK' | 'CLOCK_DATE_ROLL' | 'GUARD_QUOTES' | 'FX_VOL_SURFACE' | 'ZERO_RATE_CURVE' | 'PORTFOLIO_VALUATIONS' | 'PORTFOLIO_RISK' | 'FX_FORWARD_CURVE' | 'FX_POSITION_PNL_VALUATION' | 'MARKET_STATUS'
    - `currencyPair` string
    - `volSurfaceSource` string
  - SubscriptionKeyGUARDS
    - `messageType` 'FX_PRICE' | 'MARKET_DATA' | 'GUARDS' | 'FX_OPTIONS' | 'GUARD_PRICE' | 'GUARD_PERFORMANCE' | 'CLOCK' | 'CLOCK_DATE_ROLL' | 'GUARD_QUOTES' | 'FX_VOL_SURFACE' | 'ZERO_RATE_CURVE' | 'PORTFOLIO_VALUATIONS' | 'PORTFOLIO_RISK' | 'FX_FORWARD_CURVE' | 'FX_POSITION_PNL_VALUATION' | 'MARKET_STATUS'
  - SubscriptionKeyGUARDPERFORMANCE
    - `messageType` 'FX_PRICE' | 'MARKET_DATA' | 'GUARDS' | 'FX_OPTIONS' | 'GUARD_PRICE' | 'GUARD_PERFORMANCE' | 'CLOCK' | 'CLOCK_DATE_ROLL' | 'GUARD_QUOTES' | 'FX_VOL_SURFACE' | 'ZERO_RATE_CURVE' | 'PORTFOLIO_VALUATIONS' | 'PORTFOLIO_RISK' | 'FX_FORWARD_CURVE' | 'FX_POSITION_PNL_VALUATION' | 'MARKET_STATUS'
    - `guardId` string
  - SubscriptionKeyGUARDPRICE
    - `messageType` 'FX_PRICE' | 'MARKET_DATA' | 'GUARDS' | 'FX_OPTIONS' | 'GUARD_PRICE' | 'GUARD_PERFORMANCE' | 'CLOCK' | 'CLOCK_DATE_ROLL' | 'GUARD_QUOTES' | 'FX_VOL_SURFACE' | 'ZERO_RATE_CURVE' | 'PORTFOLIO_VALUATIONS' | 'PORTFOLIO_RISK' | 'FX_FORWARD_CURVE' | 'FX_POSITION_PNL_VALUATION' | 'MARKET_STATUS'
    - `guardId` string
  - SubscriptionKeyGUARDQUOTES
    - `messageType` 'FX_PRICE' | 'MARKET_DATA' | 'GUARDS' | 'FX_OPTIONS' | 'GUARD_PRICE' | 'GUARD_PERFORMANCE' | 'CLOCK' | 'CLOCK_DATE_ROLL' | 'GUARD_QUOTES' | 'FX_VOL_SURFACE' | 'ZERO_RATE_CURVE' | 'PORTFOLIO_VALUATIONS' | 'PORTFOLIO_RISK' | 'FX_FORWARD_CURVE' | 'FX_POSITION_PNL_VALUATION' | 'MARKET_STATUS'
  - SubscriptionKeyMARKETDATA
    - `messageType` 'FX_PRICE' | 'MARKET_DATA' | 'GUARDS' | 'FX_OPTIONS' | 'GUARD_PRICE' | 'GUARD_PERFORMANCE' | 'CLOCK' | 'CLOCK_DATE_ROLL' | 'GUARD_QUOTES' | 'FX_VOL_SURFACE' | 'ZERO_RATE_CURVE' | 'PORTFOLIO_VALUATIONS' | 'PORTFOLIO_RISK' | 'FX_FORWARD_CURVE' | 'FX_POSITION_PNL_VALUATION' | 'MARKET_STATUS'
    - `currencyPair` string
  - SubscriptionKeyMARKETSTATUS
    - `messageType` 'FX_PRICE' | 'MARKET_DATA' | 'GUARDS' | 'FX_OPTIONS' | 'GUARD_PRICE' | 'GUARD_PERFORMANCE' | 'CLOCK' | 'CLOCK_DATE_ROLL' | 'GUARD_QUOTES' | 'FX_VOL_SURFACE' | 'ZERO_RATE_CURVE' | 'PORTFOLIO_VALUATIONS' | 'PORTFOLIO_RISK' | 'FX_FORWARD_CURVE' | 'FX_POSITION_PNL_VALUATION' | 'MARKET_STATUS'
  - SubscriptionKeyPORTFOLIORISK
    - `messageType` 'FX_PRICE' | 'MARKET_DATA' | 'GUARDS' | 'FX_OPTIONS' | 'GUARD_PRICE' | 'GUARD_PERFORMANCE' | 'CLOCK' | 'CLOCK_DATE_ROLL' | 'GUARD_QUOTES' | 'FX_VOL_SURFACE' | 'ZERO_RATE_CURVE' | 'PORTFOLIO_VALUATIONS' | 'PORTFOLIO_RISK' | 'FX_FORWARD_CURVE' | 'FX_POSITION_PNL_VALUATION' | 'MARKET_STATUS'
  - SubscriptionKeyPORTFOLIOVALUATIONS
    - `messageType` 'FX_PRICE' | 'MARKET_DATA' | 'GUARDS' | 'FX_OPTIONS' | 'GUARD_PRICE' | 'GUARD_PERFORMANCE' | 'CLOCK' | 'CLOCK_DATE_ROLL' | 'GUARD_QUOTES' | 'FX_VOL_SURFACE' | 'ZERO_RATE_CURVE' | 'PORTFOLIO_VALUATIONS' | 'PORTFOLIO_RISK' | 'FX_FORWARD_CURVE' | 'FX_POSITION_PNL_VALUATION' | 'MARKET_STATUS'
  - SubscriptionKeyZERORATECURVE
    - `messageType` 'FX_PRICE' | 'MARKET_DATA' | 'GUARDS' | 'FX_OPTIONS' | 'GUARD_PRICE' | 'GUARD_PERFORMANCE' | 'CLOCK' | 'CLOCK_DATE_ROLL' | 'GUARD_QUOTES' | 'FX_VOL_SURFACE' | 'ZERO_RATE_CURVE' | 'PORTFOLIO_VALUATIONS' | 'PORTFOLIO_RISK' | 'FX_FORWARD_CURVE' | 'FX_POSITION_PNL_VALUATION' | 'MARKET_STATUS'
    - `currencyCode` string
    - `irCurveSource` string

## Response `200`

OK

---

[API](https://skmtc.dev/currencyguard/apis/currencyguard-trading-system-api-external.md) · [All operations](https://skmtc.dev/currencyguard/apis/currencyguard-trading-system-api-external/llms.txt) · [OpenAPI document](https://skmtc.dev/currencyguard/apis/currencyguard-trading-system-api-external/revisions/a1f3f854190d?raw)