Skip to content

docs: document HIP-3 dex parameter on Info methods #288

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

Open
claygeo wants to merge 1 commit into
base: master
Choose a base branch
from
+14 −0
Open

docs: document HIP-3 dex parameter on Info methods #288

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 14 additions & 0 deletions hyperliquid/info.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,8 @@ def user_state(self, address: str, dex: str = "") -> Any:
Args:
address (str): Onchain address in 42-character hexadecimal format;
e.g. 0x0000000000000000000000000000000000000000.
dex (str): Dex name for HIP-3 builder-deployed perpetuals.
Defaults to "" (the original dex).
Returns:
{
assetPositions: [
Expand Down Expand Up @@ -138,6 +140,8 @@ def open_orders(self, address: str, dex: str = "") -> Any:
Args:
address (str): Onchain address in 42-character hexadecimal format;
e.g. 0x0000000000000000000000000000000000000000.
dex (str): Dex name for HIP-3 builder-deployed perpetuals.
Defaults to "" (the original dex).
Returns: [
{
coin: str,
Expand All @@ -159,6 +163,8 @@ def frontend_open_orders(self, address: str, dex: str = "") -> Any:
Args:
address (str): Onchain address in 42-character hexadecimal format;
e.g. 0x0000000000000000000000000000000000000000.
dex (str): Dex name for HIP-3 builder-deployed perpetuals.
Defaults to "" (the original dex).
Returns: [
{
children:
Expand Down Expand Up @@ -189,6 +195,10 @@ def all_mids(self, dex: str = "") -> Any:

POST /info

Args:
dex (str): Dex name for HIP-3 builder-deployed perpetuals.
Defaults to "" (the original dex).

Returns:
{
ATOM: float string,
Expand Down Expand Up @@ -275,6 +285,10 @@ def meta(self, dex: str = "") -> Meta:

POST /info

Args:
dex (str): Dex name for HIP-3 builder-deployed perpetuals.
Defaults to "" (the original dex).

Returns:
{
universe: [
Expand Down