GET api/NaturalBehavior/GetMarketMood/{PersonID}/{PortfolioValue}

Market MoodTM is the real-time measurement of investor’s market fear or exuberance. Market Mood allows firms to predict how clients are reacting to market events (in real time) to proactively behaviorally manage them. Market Mood helps advisors and Fintech prevent clients from making inappropriate financial decisions, sell assets at the wrong time, or let their market fear affect their advisor / client relationship. This endpoint is to retrieve Market Mood details.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
PersonID

PersonID is a unique identifier to get Market Mood for a particular person.

globally unique identifier

This is a required parameter

PortfolioValue

By default, DNA measures Market Mood based on real-time S&P 500 market data. If you wish to measure market mood by another indices or client’s own portfolio performance, you an enter a unique value which must range from -25 to 12.50 to get the market mood for a particular client.

integer

None

Body Parameters

None

Response Information

Resource Description

Market Mood Details as per the PersonID and Portfolio value available for Natural Behavior Discovery.

NameDescriptionTypeAdditional information
PersonID

PersonID is a unique identifier for a particular Person.

globally unique identifier

None

CreditID

CreditID is a latest Credit ID for a particular Person.

integer

None

LanguageID

LanguageID is a value which specify the type of language.

integer

None

RiskScore

Risk Appetite Score (0-100) measured from Financial DNA or any other risk profile questionnaire or risk appetite assessment.

integer

None

RiskGroup

RiskGroupID is a value to specify which group a particular Person belongs to for risk factor.

integer

None

MarketPercentage

MarketPercentage is a percenatge on which market mood was calculated for a particular Person.

decimal number

None

Mood

Mood is a market mood for a particular Person.

string

None

Color

There are 4 colors, they are: Green, Grey, Yellow and Red that indicates nature of investing in market for a particular Person.

string

None

BehaviorTypeID

BehaviorTypeID is a value to specify behaviour type for a particular Person.

integer

None

BehavioralTypeName

BehavioralTypeName is a value specifies the behavior name based on behavior type of a particular Person.

string

None

MarketUpDescription1

MarketUpDescription1 is a first market up description if market is up for a particular Person.

string

None

MarketUpDescription2

MarketUpDescription2 is a second market description if market is up for a particular Person.

string

None

MarketDownDescription1

MarketDownDescription1 is a first market down description if market is down for a particular Person.

string

None

MarketDownDescription2

MarketDownDescription2 is a second market description if market is down for a particular Person.

string

None

KeyDescription

KeyDescription is a key description for a particular Person.

string

None

MarketConditionDescription1

MarketConditionDescription1 is a first market description for a particular Person.

string

None

MarketConditionDescription2

MarketConditionDescription2 is a second market condition description if market is down for a particular Person.

string

None

MarketUpQuestion1

MarketUpQuestion1 is a second market up question if market is up for a particular Person.

string

None

MarketUpQuestion2

MarketUpQuestion2 is a second market question if market is up for a particular Person.

string

None

MarketDownQuestion1

MarketDownQuestion1 is a second market down question if market is down for a particular Person.

string

None

MarketDownQuestion2

MarketDownQuestion2 is a second market question if market is down for a particular Person.

string

None

ActionItem

ActionItem is a value specifies the action item based on behavior type of a particular Person.

string

None

ActionItemDescription

ActionItemDescription is a value specifies the action item description based on behavior type of a particular Person.

string

None

Response Formats

application/json, text/json

Sample:
{
  "PersonID": "9411740a-14cf-4280-b7f8-9ea09b513385",
  "CreditID": 1,
  "LanguageID": 1,
  "RiskScore": 1,
  "RiskGroup": 1,
  "MarketPercentage": 1.0,
  "Mood": "sample string 2",
  "Color": "sample string 3",
  "BehaviorTypeID": 1,
  "BehavioralTypeName": "sample string 4",
  "MarketUpDescription1": "sample string 5",
  "MarketUpDescription2": "sample string 6",
  "MarketDownDescription1": "sample string 7",
  "MarketDownDescription2": "sample string 8",
  "KeyDescription": "sample string 9",
  "MarketConditionDescription1": "sample string 10",
  "MarketConditionDescription2": "sample string 11",
  "MarketUpQuestion1": "sample string 12",
  "MarketUpQuestion2": "sample string 13",
  "MarketDownQuestion1": "sample string 14",
  "MarketDownQuestion2": "sample string 15",
  "ActionItem": "sample string 16",
  "ActionItemDescription": "sample string 17"
}

application/xml, text/xml

Sample:
<MarketMoodDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DnaBehavior.WebApi.Models">
  <ActionItem>sample string 16</ActionItem>
  <ActionItemDescription>sample string 17</ActionItemDescription>
  <BehaviorTypeID>1</BehaviorTypeID>
  <BehavioralTypeName>sample string 4</BehavioralTypeName>
  <Color>sample string 3</Color>
  <CreditID>1</CreditID>
  <KeyDescription>sample string 9</KeyDescription>
  <LanguageID>1</LanguageID>
  <MarketConditionDescription1>sample string 10</MarketConditionDescription1>
  <MarketConditionDescription2>sample string 11</MarketConditionDescription2>
  <MarketDownDescription1>sample string 7</MarketDownDescription1>
  <MarketDownDescription2>sample string 8</MarketDownDescription2>
  <MarketDownQuestion1>sample string 14</MarketDownQuestion1>
  <MarketDownQuestion2>sample string 15</MarketDownQuestion2>
  <MarketPercentage>1</MarketPercentage>
  <MarketUpDescription1>sample string 5</MarketUpDescription1>
  <MarketUpDescription2>sample string 6</MarketUpDescription2>
  <MarketUpQuestion1>sample string 12</MarketUpQuestion1>
  <MarketUpQuestion2>sample string 13</MarketUpQuestion2>
  <Mood>sample string 2</Mood>
  <PersonID>9411740a-14cf-4280-b7f8-9ea09b513385</PersonID>
  <RiskGroup>1</RiskGroup>
  <RiskScore>1</RiskScore>
</MarketMoodDetails>