Skip to main content

Instrument Profiles

Overview

Instrument Profiles define display and operational conventions for groups of instruments. Rather than storing formatting metadata on every individual instrument, a profile name is assigned to an instrument and all consumers look up the profile to determine how to display prices, yields, and other values.

Every instrument in SDS has a profileName field. If this field is blank or not set by the source provider, SDS automatically assigns the _DEFAULT profile.

Default Profile

FieldDefault Value
name_DEFAULT
defaultValueTypePRICE
defaultValuePrecision3
defaultValueFormat(empty)
roundingModeCONVENTION
defaultCloseTime170000
defaultCloseTimeZoneAmerica/New_York

This profile is always available and cannot be deleted.

Fields

FieldTypeDescription
nameStringUnique profile name. Case is normalised to uppercase on save.
defaultValueTypeValueTypeThe market convention for instruments in this profile: PRICE, YIELD, PAR_RATE, SPREAD
defaultValuePrecisionbyteNumber of decimal places for default display
defaultValueFormatStringOptional format string for UI display
roundingModeRoundingModeCONVENTION, UP, DOWN, HALF_UP, HALF_DOWN
defaultCloseTimeString (HHMMSS)Default market close time for end-of-day calculations
defaultCloseTimeZoneStringIANA timezone for the close time, e.g. America/New_York, Europe/London
salesBookStringDefault sales book for instruments in this profile
salesDeskStringDefault sales desk
traderBookStringDefault trader book
traderDeskStringDefault trader desk
bbgYellowKeyStringBloomberg yellow key for instruments in this profile (e.g. Govt, Corp, Mtge)

Managing Profiles

Creating a Profile

  1. In Key UI, navigate to Instrument Profiles under Static Data Server and click New
  2. Fill in the profile fields. name is required and must be unique
  3. Save — the profile is immediately published to the platform

new instrument profile

Editing a Profile

To edit, click on the 'Editor' button for the profile you'd like to modify, update the desired field in the form and hit 'Save'

edit instrument profile

Assigning a Profile to an Instrument

  1. In Key UI, navigate to Instrument Search under Static Data Server
  2. Search for the instrument you want to update and click on it from the results
  3. In the instrument form, pick the desired profile from the list
  4. Save

SDS does not validate that the referenced profile exists when an instrument is ingested — it only applies the _DEFAULT fallback when profileName is blank.

assign instrument profile

Bloomberg Yellow Key

The bbgYellowKey field stores the Bloomberg market sector identifier for instruments in a profile. Common values:

Yellow KeySector
GovtGovernment bonds
CorpCorporate bonds
MuniMunicipal bonds
CurncyCurrencies

This field is used by Bloomberg connectivity integrations to route data requests to the correct Bloomberg data type.