Skip to content
Patrimoine
v9.1.0

Concentration Endpoint

GET
/api/v1/charts/concentration
curl --request GET \
  --url https://example.com/api/v1/charts/concentration

Concentration analysis — HHI index + per-institution breakdown.

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
ConcentrationResponse

Concentration analysis response — HHI index + per-institution breakdown.

object
hhi
required
Hhi
number
risk_level
required
Risk Level
string
total_net_worth
required
Total Net Worth
string
institutions
required
Institutions
Array<object>
ConcentrationItem

Single institution’s concentration breakdown.

object
name
required
Name
string
total
required
Total
string
percentage
required
Percentage
number
account_count
required
Account Count
integer
exceeds_fgd_limit
required
Exceeds Fgd Limit
boolean
top_concentration_pct
required
Top Concentration Pct
number

Example generated

{
  "hhi": 1,
  "risk_level": "example",
  "total_net_worth": "example",
  "institutions": [
    {
      "name": "example",
      "total": "example",
      "percentage": 1,
      "account_count": 1,
      "exceeds_fgd_limit": true
    }
  ],
  "top_concentration_pct": 1
}