Protocol Documentation
Table of Contents
Top
frequenz/api/common/v1/market/price.proto
Price
Represents a monetary price for electricity trading, including
the amount and currency. The currency used should align with the
delivery area's standard currency.
!!! caution "Validation Required"
It's essential to ensure that the currency aligns with the
standard currency of the associated delivery area. Failure to
do so may result in the API service rejecting the request due to currency
mismatches.
!!! info "Relation to Delivery Area"
The currency specified is intrinsically related to the delivery area
for the contract. Make sure the chosen currency is compatible with
the delivery area's currency standards.
Price.Currency
List of supported currencies.
!!! info "Extensibility"
New currencies can be added to this enum to support additional markets.
Name |
Number |
Description |
CURRENCY_UNSPECIFIED |
0 |
|
CURRENCY_USD |
1 |
|
CURRENCY_CAD |
2 |
|
CURRENCY_EUR |
3 |
|
CURRENCY_GBP |
4 |
|
CURRENCY_CHF |
5 |
|
CURRENCY_CNY |
6 |
|
CURRENCY_JPY |
7 |
|
CURRENCY_AUD |
8 |
|
CURRENCY_NZD |
9 |
|
CURRENCY_SGD |
10 |
|
Scalar Value Types
.proto Type |
Notes |
C++ |
Java |
Python |
Go |
C# |
PHP |
Ruby |
double |
|
double |
double |
float |
float64 |
double |
float |
Float |
float |
|
float |
float |
float |
float32 |
float |
float |
Float |
int32 |
Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. |
int32 |
int |
int |
int32 |
int |
integer |
Bignum or Fixnum (as required) |
int64 |
Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. |
int64 |
long |
int/long |
int64 |
long |
integer/string |
Bignum |
uint32 |
Uses variable-length encoding. |
uint32 |
int |
int/long |
uint32 |
uint |
integer |
Bignum or Fixnum (as required) |
uint64 |
Uses variable-length encoding. |
uint64 |
long |
int/long |
uint64 |
ulong |
integer/string |
Bignum or Fixnum (as required) |
sint32 |
Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. |
int32 |
int |
int |
int32 |
int |
integer |
Bignum or Fixnum (as required) |
sint64 |
Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. |
int64 |
long |
int/long |
int64 |
long |
integer/string |
Bignum |
fixed32 |
Always four bytes. More efficient than uint32 if values are often greater than 2^28. |
uint32 |
int |
int |
uint32 |
uint |
integer |
Bignum or Fixnum (as required) |
fixed64 |
Always eight bytes. More efficient than uint64 if values are often greater than 2^56. |
uint64 |
long |
int/long |
uint64 |
ulong |
integer/string |
Bignum |
sfixed32 |
Always four bytes. |
int32 |
int |
int |
int32 |
int |
integer |
Bignum or Fixnum (as required) |
sfixed64 |
Always eight bytes. |
int64 |
long |
int/long |
int64 |
long |
integer/string |
Bignum |
bool |
|
bool |
boolean |
boolean |
bool |
bool |
boolean |
TrueClass/FalseClass |
string |
A string must always contain UTF-8 encoded or 7-bit ASCII text. |
string |
String |
str/unicode |
string |
string |
string |
String (UTF-8) |
bytes |
May contain any arbitrary sequence of bytes. |
string |
ByteString |
str |
[]byte |
ByteString |
string |
String (ASCII-8BIT) |