Last active
January 26, 2026 13:55
-
-
Save patcito/faf2b20cc2863e73e5df0426e2ce00e9 to your computer and use it in GitHub Desktop.
PUT Dashboard API - Raw USD Values Documentation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # PUT Dashboard API - USD Field Naming | |
| ## Field Naming Convention | |
| For each USD value, there are now two fields: | |
| - `*Usd` - Raw decimal value with 2 decimal places (e.g., `"28870000.00"`) | |
| - `*UsdFormatted` - Formatted with K/M/B suffixes (e.g., `"28.87M"`) | |
| This follows the existing pattern used throughout the API: `deployed` / `deployedFormatted`. | |
| ## Example Response | |
| ```json | |
| { | |
| "circuitBreaker": { | |
| "mainBufferUsd": "28870000.00", | |
| "mainBufferUsdFormatted": "28.87M", | |
| "totalValueUsd": "150000000.00", | |
| "totalValueUsdFormatted": "150.00M" | |
| }, | |
| "metrics": { | |
| "ftTotalPutValueUsd": "1234567.89", | |
| "ftTotalPutValueUsdFormatted": "1.23M", | |
| "collateralTotalPutValueUsd": "9876543.21", | |
| "collateralTotalPutValueUsdFormatted": "9.88M", | |
| "allTimeYieldClaimedUsd": "12345.67", | |
| "allTimeYieldClaimedUsdFormatted": "12.35K", | |
| "series": { | |
| "ftPutValues": [ | |
| { "date": "2026-01-25", "valueUsd": "1234567.89", "valueUsdFormatted": "1.23M" } | |
| ], | |
| "collateralPutValues": [ | |
| { "date": "2026-01-25", "valueUsd": "9876543.21", "valueUsdFormatted": "9.88M" } | |
| ], | |
| "cumulativeYieldClaimed": [ | |
| { "date": "2026-01-25", "valueUsd": "12345.67", "valueUsdFormatted": "12.35K" } | |
| ] | |
| } | |
| } | |
| } | |
| ``` | |
| ## Fields Updated | |
| | Field | Type | Description | | |
| |-------|------|-------------| | |
| | `mainBufferUsd` | string | Raw USD value with 2 decimals | | |
| | `mainBufferUsdFormatted` | string | Formatted with K/M/B | | |
| | `totalValueUsd` | string | Raw USD value with 2 decimals | | |
| | `totalValueUsdFormatted` | string | Formatted with K/M/B | | |
| | `totalStrategyValueUsd` | string | Raw USD value with 2 decimals | | |
| | `totalStrategyValueUsdFormatted` | string | Formatted with K/M/B | | |
| | `ftTotalPutValueUsd` | string | Raw USD value with 2 decimals | | |
| | `ftTotalPutValueUsdFormatted` | string | Formatted with K/M/B | | |
| | `collateralTotalPutValueUsd` | string | Raw USD value with 2 decimals | | |
| | `collateralTotalPutValueUsdFormatted` | string | Formatted with K/M/B | | |
| | `allTimeYieldClaimedUsd` | string | Raw USD value with 2 decimals | | |
| | `allTimeYieldClaimedUsdFormatted` | string | Formatted with K/M/B | | |
| | `valueUsd` (in series) | string | Raw USD value with 2 decimals | | |
| | `valueUsdFormatted` (in series) | string | Formatted with K/M/B | | |
| ## Related PRs | |
| - ft-api: https://github.com/flyingtulipdotcom/ft-api/pull/173 | |
| - ft-usd2: https://github.com/flyingtulipdotcom/ftusd-web/pull/324 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment