Skip to content

create spotMetaAndAssetCtxs function #42

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 21, 2024
Merged

create spotMetaAndAssetCtxs function #42

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d1b5e9f
create spotMetaAndAssetCtxs function
RaduGeorgescu Jun 19, 2024
690a18f
update documentation
RaduGeorgescu Jun 20, 2024
e5ab549
stashingupdate info.py to reflect real response format
RaduGeorgescu Jun 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 52 additions & 8 deletions hyperliquid/info.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
from hyperliquid.api import API
from hyperliquid.utils.types import Any, Callable, Meta, SpotMeta, Optional, Subscription, cast, Cloid
from hyperliquid.utils.types import Any, Callable, Meta, SpotMeta, SpotMetaAndAssetCtxs, Optional, Subscription, cast, Cloid
from hyperliquid.websocket_manager import WebsocketManager


Expand Down Expand Up @@ -179,24 +179,68 @@ def spot_meta(self) -> SpotMeta:

Returns:
{
tokens: [
universe: [
{
tokens: [int, int],
name: str,
szDecimals: int,
weiDecimals: int
index: int,
isCanonical: bool
},
...
],
universe: [
]
tokens: [
{
name: str,
tokens: [int, int]
szDecimals: int,
weiDecimals: int,
index: int,
tokenId: str,
isCanonical: bool
},
...
]
],
}
"""
return cast(SpotMeta, self.post("/info", {"type": "spotMeta"}))

def spot_meta_and_asset_ctxs(self) -> SpotMetaAndAssetCtxs:
"""Retrieve exchange spot asset contexts

POST /info

Returns:
[
{
universe: [
{
name: str,
tokens: [int, int]
}
...
],
tokens: [
{
name: str,
szDecimals: int,
weiDecimals int
},
...
]
},
[
{
dayNtlVlm: float,
markPx: float,
midPx: float,
prevDayPx: float,
circulatingSupply: float,
coin: str
}
...
]
]
"""
return cast(SpotMetaAndAssetCtxs, self.post("/info", {"type": "spotMetaAndAssetCtxs"}))

def funding_history(self, coin: str, startTime: int, endTime: Optional[int] = None) -> Any:
"""Retrieve funding history for a given coin
Expand Down
3 changes: 3 additions & 0 deletions hyperliquid/utils/types.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@
)
SpotMeta = TypedDict("SpotMeta", {"universe": List[SpotAssetInfo], "tokens": List[SpotTokenInfo]})

SpotAssetCtx = TypedDict("SpotAssetCtx", {"dayNtlVlm": str, "markPx": str, "midPx": Optional[str], "prevDayPx": str, "circulatingSupply": str, "coin": str})
SpotMetaAndAssetCtxs = Tuple[SpotMeta, List[SpotAssetCtx]]

AllMidsSubscription = TypedDict("AllMidsSubscription", {"type": Literal["allMids"]})
L2BookSubscription = TypedDict("L2BookSubscription", {"type": Literal["l2Book"], "coin": str})
TradesSubscription = TypedDict("TradesSubscription", {"type": Literal["trades"], "coin": str})
Expand Down