Skip to content

Commit 618948a

Browse files
author
Zach Banks
committed
DOC: list_unit_prices, get_shape
1 parent 0005a27 commit 618948a

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

databento/historical/api/metadata.py

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -204,9 +204,9 @@ def list_unit_prices(
204204
dataset: Union[Dataset, str],
205205
mode: Optional[Union[FeedMode, str]] = None,
206206
schema: Optional[Union[Schema, str]] = None,
207-
) -> Dict[str, Any]:
207+
) -> Union[float, Dict[str, Any]]:
208208
"""
209-
Request data schema prices per GB unit from Databento.
209+
List unit prices for each data schema in dollars per gigabyte.
210210
211211
Makes a `GET /metadata.list_unit_prices` HTTP request.
212212
@@ -221,8 +221,9 @@ def list_unit_prices(
221221
222222
Returns
223223
-------
224-
Dict[str, Any]
225-
A map of dataset to feed mode to unit price.
224+
float or Dict[str, Any]
225+
If both `mode` and `schema` are specified, the unit price is returned as a single number.
226+
Otherwise, return a map of feed mode to schema to unit price.
226227
227228
"""
228229
validate_maybe_enum(schema, Schema, "schema")

0 commit comments

Comments
 (0)