mirror of
https://github.com/bitcoinresearchkit/brk.git
synced 2026-05-19 14:24:47 -07:00
64 lines
1.9 KiB
Markdown
64 lines
1.9 KiB
Markdown
[**brk-client**](../README.md)
|
|
|
|
***
|
|
|
|
[brk-client](../globals.md) / Urpd
|
|
|
|
# Interface: Urpd
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1195](https://github.com/bitcoinresearchkit/brk/blob/76869ed2b6aad1e1c3da7aff4c90e9b5788fb606/modules/brk-client/index.js#L1195)
|
|
|
|
## Properties
|
|
|
|
### aggregation
|
|
|
|
> **aggregation**: [`UrpdAggregation`](../type-aliases/UrpdAggregation.md)
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1198](https://github.com/bitcoinresearchkit/brk/blob/76869ed2b6aad1e1c3da7aff4c90e9b5788fb606/modules/brk-client/index.js#L1198)
|
|
|
|
Aggregation strategy applied to the buckets.
|
|
|
|
***
|
|
|
|
### buckets
|
|
|
|
> **buckets**: [`UrpdBucket`](UrpdBucket.md)[]
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1201](https://github.com/bitcoinresearchkit/brk/blob/76869ed2b6aad1e1c3da7aff4c90e9b5788fb606/modules/brk-client/index.js#L1201)
|
|
|
|
***
|
|
|
|
### close
|
|
|
|
> **close**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1199](https://github.com/bitcoinresearchkit/brk/blob/76869ed2b6aad1e1c3da7aff4c90e9b5788fb606/modules/brk-client/index.js#L1199)
|
|
|
|
Close price on `date`, in USD. Anchor for `unrealized_pnl`.
|
|
|
|
***
|
|
|
|
### cohort
|
|
|
|
> **cohort**: [`Cohort`](../type-aliases/Cohort.md)
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1196](https://github.com/bitcoinresearchkit/brk/blob/76869ed2b6aad1e1c3da7aff4c90e9b5788fb606/modules/brk-client/index.js#L1196)
|
|
|
|
***
|
|
|
|
### date
|
|
|
|
> **date**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1197](https://github.com/bitcoinresearchkit/brk/blob/76869ed2b6aad1e1c3da7aff4c90e9b5788fb606/modules/brk-client/index.js#L1197)
|
|
|
|
***
|
|
|
|
### totalSupply
|
|
|
|
> **totalSupply**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1200](https://github.com/bitcoinresearchkit/brk/blob/76869ed2b6aad1e1c3da7aff4c90e9b5788fb606/modules/brk-client/index.js#L1200)
|
|
|
|
Sum of `supply` across all buckets, in BTC.
|