mirror of
https://github.com/bitcoinresearchkit/brk.git
synced 2026-05-19 06:14:47 -07:00
50 lines
1.6 KiB
Markdown
50 lines
1.6 KiB
Markdown
[**brk-client**](../README.md)
|
|
|
|
***
|
|
|
|
[brk-client](../globals.md) / UrpdBucket
|
|
|
|
# Interface: UrpdBucket
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1300](https://github.com/bitcoinresearchkit/brk/blob/6e8be1af2225890fe02f0a4598e3a4fa8251f535/modules/brk-client/index.js#L1300)
|
|
|
|
## Properties
|
|
|
|
### priceFloor
|
|
|
|
> **priceFloor**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1301](https://github.com/bitcoinresearchkit/brk/blob/6e8be1af2225890fe02f0a4598e3a4fa8251f535/modules/brk-client/index.js#L1301)
|
|
|
|
Lower bound of the bucket, in USD. Equals the exact realized price for `Raw`.
|
|
|
|
***
|
|
|
|
### realizedCap
|
|
|
|
> **realizedCap**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1303](https://github.com/bitcoinresearchkit/brk/blob/6e8be1af2225890fe02f0a4598e3a4fa8251f535/modules/brk-client/index.js#L1303)
|
|
|
|
Realized cap contribution in USD: sum of `realized_price * supply` over the coins in this bucket.
|
|
|
|
***
|
|
|
|
### supply
|
|
|
|
> **supply**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1302](https://github.com/bitcoinresearchkit/brk/blob/6e8be1af2225890fe02f0a4598e3a4fa8251f535/modules/brk-client/index.js#L1302)
|
|
|
|
Supply held with a last-move price inside this bucket, in BTC.
|
|
|
|
***
|
|
|
|
### unrealizedPnl
|
|
|
|
> **unrealizedPnl**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1304](https://github.com/bitcoinresearchkit/brk/blob/6e8be1af2225890fe02f0a4598e3a4fa8251f535/modules/brk-client/index.js#L1304)
|
|
|
|
Unrealized P&L in USD against the close on the snapshot date: `close * supply - realized_cap`. Can be negative.
|